HostRecord class - Platform - BlueCat Gateway - 20.1.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
20.1.1

class host_record.HostRecord(api, api_entity)

Bases: bluecat.entity.Entity

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 record.

Parameter 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 record. If there is not a suitable deployment role set for the relevant network this method will do nothing.

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

for the relevant network this method will do nothing.

dynamic_delete_forward(tsig_key_file=None)

Dynamically delete the forward DNS record.

Parameter 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 record. If there is not a suitable deployment role set for the relevant network this method will do nothing.

Parameter 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 record.

Parameter 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 record. If there is not a suitable deployment role set for the relevant network this method will do nothing.

Parameter 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_configuration()

Get the owning configuration.

get_full_name()

Get the fully qualified domain name of the host record.

get_ip4_addresses()

Get the IP4 address instances associated with the host record.

get_ip6_addresses()

Get the IP6 address instances associated with the host record.

get_specific_ttl()

If there is a specific TTL set for the host record, return it, otherwise return -1.

get_ttl(server=None)

Find the applicable TTL for the resource record.

This involves walking the entity tree in many cases.

get_view()

Get the owning view.

get_zone()

Get the parent zone.

set_addresses(addresses)

Set the address(es) for a host record.

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