nsupdate module - Platform - BlueCat Gateway - 21.11.2

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
21.11.2

Various functions for performing dynamic DNS operations via nsupdate. There are Python modules to do this directly but it is not clear how well debugged these are hence sticking to running nsupdate.

bluecat.nsupdate.create_a(server_ip, name, addr, ttl, tsig_key_file=None, zone=None)

Dynamically create an A record.

Parameters Description
server_ip The IP address of the DNS server on which to create the record.
name The name of the new record to create.
addr The address of the new record to create.
ttl The TTL of the new record to create.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.create_aaaa(server_ip, name, addr, ttl, tsig_key_file=None, zone=None)

Dynamically create an AAAA record.

Parameters Description
server_ip The IP address of the DNS server on which to create the record.
name The name of the new record to create.
addr The address of the new record to create.
ttl The TTL of the new record to create.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.create_cname(server_ip, name, host_name, ttl, tsig_key_file=None, zone=None)

Dynamically create a CNAME record.

Parameters Description
server_ip The IP address of the DNS server on which to create the record.
name The name of the new record to create.
host_name The name of the host record the CNAME record is for.
ttl The TTL of the new record to create.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.create_host_record(host_type, server_ip, name, addr, ttl, tsig_key_file=None, zone=None)

Dynamically create a host record.

Parameters Description
host_type The type of host record (‘a’ or ‘aaaa’).
server_ip The IP address of the DNS server on which to create the record.
name The name of the new record to create.
addr The address of the new record to create.
ttl The TTL of the new record to create.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.create_ptr(server_ip, name, reverse_name, ttl, tsig_key_file=None)

Dynamically create a PTR record.

Parameters Description
server_ip The IP address of the DNS server on which to create the record.
name The name of the new record to create.
reverse_name The reverse space name of the new record to create.
ttl The TTL of the new record to create.
tsig_key_file The name of the optional TSIG key file to use.

bluecat.nsupdate.delete_a(server_ip, name, tsig_key_file=None, zone=None, rdata=None)

Dynamically delete an A record.

Parameters Description
server_ip The IP address of the DNS server on which to delete the record.
name The name of the record to delete.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.
rdata rdata associated with host record to delete.

bluecat.nsupdate.delete_aaaa(server_ip, name, tsig_key_file=None, zone=None)

Dynamically delete an AAAA record.

Parameters Description
server_ip The IP address of the DNS server on which to delete the record.
name The name of the record to delete.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.delete_cname(server_ip, name, tsig_key_file=None, zone=None)

Dynamically delete an AAAA record.

Parameters Description
server_ip The IP address of the DNS server on which to delete the record.
name The name of the record to delete.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.delete_host_record(host_type, server_ip, name, tsig_key_file=None, zone=None, rdata=None)

Dynamically delete a host record.

Parameters Description
host_type The type of host record (‘a’ or ‘aaaa’).
server_ip The IP address of the DNS server on which to delete the record.
name The name of the record to delete.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.
rdata rdata associated with host record to delete.

bluecat.nsupdate.delete_ptr(server_ip, reverse_name, tsig_key_file=None)

Dynamically delete a PTR record.

Parameters Description
server_ip The IP address of the DNS server on which to delete the record.
reverse_name The reverse space name of the record to delete.
tsig_key_file The name of the optional TSIG key file to use.

bluecat.nsupdate.run_nsupdate(command_file, tsig_key_file=None)

Run an nsupdate command file optionally using a TSIG key.

Parameters Description
command_file The name of a file containing some nsupdate commands.
tsig_key_file The name of TSIG key file (can be None).

bluecat.nsupdate.update_a(server_ip, name, addr, ttl, tsig_key_file=None, zone=None)

Dynamically update an A record.

Parameters Description
server_ip The IP address of the DNS server on which to update the record.
name The name of the record to update.
addr the new address of the record to update.
ttl The new TTL of the record to update.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.update_aaaa(server_ip, name, addr, ttl, tsig_key_file=None, zone=None)

Dynamically update an AAAA record.

Parameters Description
server_ip The IP address of the DNS server on which to update the record.
name The name of the record to update.
addr The new address of the record to update.
ttl The new TTL of the record to update.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.update_cname(server_ip, name, new_name, host_name, ttl, tsig_key_file=None, zone=None)

Dynamically update an CNAME record.

Parameters Description
server_ip The IP address of the DNS server on which to update the record.
name The name of the record to update.
new_name The new name of the record to update.
host_name The name of the host record the CNAME record is for.
ttl The new TTL of the record to update.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.update_cname_linked(server_ip, absolute_name, linked_record, ttl, tsig_key_file=None, zone=None)

Dynamically update an CNAME linked record.

Parameters Description
server_ip(str) The IP address of the DNS server on which to update the record.
absolute_name(str) The name of the record to update.
linked_record(str) The name of the host record the CNAME record is for.
ttl(str) The new TTL of the record to update.
tsig_key_file(str) The name of the optional TSIG key file to use.
zone(str) The zone the record belongs to.

bluecat.nsupdate.update_cname_linked_record(server_ip, absolute_name, linked_record, ttl, tsig_key_file=None, zone=None)

Dynamically update a CNAME linked record.

Parameters Description
server_ip(str) The IP address of the DNS server on which to update the record.
absolute_name(str) The absolute name of the cname record to update.
linked_record(str) The absolute name of the new linked record.
ttl(str) The new TTL of the record to update.
tsig_key_file(str) The name of the optional TSIG key file to use.
zone(str) The zone the record belongs to.

bluecat.nsupdate.update_cname_record(host_type, server_ip, name, new_name, host_name, ttl, tsig_key_file=None, zone=None)

Dynamically update an CNAME record.

Parameters Description
host_type The type of CNAME record (‘cname’).
server_ip The IP address of the DNS server on which to update the record.
name The name of the record to update.
new_name The new name of the record to update.
host_name The name of the host record the CNAME record is for.
ttl The new TTL of the record to update.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.

bluecat.nsupdate.update_host_record(host_type, server_ip, name, addr, ttl, tsig_key_file=None, zone=None)

Dynamically update a host record.

Parameters Description
host_type The type of host record (‘a’ or ‘aaaa’).
server_ip The IP address of the DNS server on which to update the record.
name The name of the record to update.
addr The new address of the record.
ttl The new TTL of the record to update.
tsig_key_file The name of the optional TSIG key file to use.
zone The zone the record belongs to.