host_record module - Platform - BlueCat Gateway - 21.11.2

Gateway Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
21.11.2

Host Record

class bluecat.host_record.HostRecord(api, api_entity)

Bases: bluecat.resource_record.ResourceRecord

Instantiate host record.

Parameters Description
api API instance used by the entity to communicate with BAM.
api_entity The entity returned by the BAM API.

dynamic_create_forward(tsig_key_file=None)

Dynamically create the forward DNS space for a record.

Parameters Description
tsig_key_file file containing the TSIG key (if any) to use.

dynamic_create_reverse(tsig_key_file=None)

Dynamically create the reverse DNS space for a record. If there is not a suitable deployment role set for the relevant network this method will do nothing.

Parameters Description
tsig_key_file File containing the TSIG key (if any) to use.

dynamic_delete_forward(tsig_key_file=None)

Dynamically delete the forward DNS space for a record.

Parameters Description
tsig_key_file File containing the TSIG key (if any) to use.

dynamic_delete_reverse(tsig_key_file=None)

Dynamically delete the reverse DNS space for a record. If there is not a suitable deployment role set for the relevant network this method will do nothing.

Parameters Description
tsig_key_file file containing the TSIG key (if any) to use.

dynamic_update_forward(tsig_key_file=None)

Dynamically update the forward DNS space for a record.

Parameters Description
tsig_key_file file containing the TSIG key (if any) to use.

dynamic_update_reverse(tsig_key_file=None)

Dynamically update the reverse DNS space for a record. If there is not a suitable deployment role set for the relevant network this method will do nothing.

Parameters Description
tsig_key_file file containing the TSIG key (if any) to use.

get_addresses()

Get the addresses for a host record in the form of a list of strings.

get_ip4_addresses()

Get the IP4 address instances associated with the host record.

Returns: The addresses of the host record as a list of Gateway IP4Address Entities.

get_ip6_addresses()

Get the IP6 address instances associated with the host record.

set_addresses(addresses)

Set the address(es) for a host record.

Parameters Description
addresses List of addresses in the form of strings for the host record. For example, [‘192.168.0.1’, ‘192.168.0.2’].

Returns: None.