LocalLB::DNSZone

Introduced : BIG-IP_v11.5.0
The DNSZone interface allows you to create and maintain DNS zones. A DNS zone may have one DNS Express server and several transfer clients. A DNS Express server is a name server which is used to transfer zone data to BIG-IP. A transfer client is a name server which is allowed to transfer zone data from BIG-IP.

Methods

Method Description Introduced
add_transfer_client Adds/associates a list of servers which are allowed to transfer zone data from BIG-IP for the specified zones. BIG-IP_v11.5.0
create Creates DNS zones. BIG-IP_v11.5.0
delete_all_zones Deletes all DNS zones. BIG-IP_v11.5.0
delete_zone Deletes DNS zones. BIG-IP_v11.5.0
get_all_statistics Gets the statistics for all zones. BIG-IP_v11.5.0
get_dns_express_notify_action Gets the NOTIFY actions used by DNS Express zones. BIG-IP_v11.5.0
get_dns_express_server Gets the servers to transfer zone data to DNS Express for the specified zones. BIG-IP_v11.5.0
get_dns_express_state Gets DNS Express enabled state of the specified zones. BIG-IP_v11.5.0
get_dns_express_verify_notify_tsig_state Gets the NOTIFY TSIG verification state of the specified DNS Express zones. BIG-IP_v11.5.0
get_dns_express_zone_db_statistics Gets zone database statistics for a list of DNS Express zones. BIG-IP_v11.5.0
get_list Gets a list of all DNS zones. BIG-IP_v11.5.0
get_object_status Gets the statuses of the specified zones. This gives information on the current transfer state. BIG-IP_v11.5.0
get_response_policy_state Gets RPZ state of the specified zones. BIG-IP_v11.6.0
get_server_tsig_key Gets the TSIG keys of a list of DNS zones. BIG-IP_v11.5.0
get_statistics Gets the statistics for a list of zones. BIG-IP_v11.5.0
get_transfer_client Gets a list of servers which are allowed to transfer zone data from BIG-IP for the specified zones. There could be multiple clients allowed to transfer zone data from BIP-IP for each zone. BIG-IP_v11.5.0
get_version Get the version information for this interface. BIG-IP_v11.5.0
remove_all_transfer_clients Removes all the servers which are allowed to transfer data from BIG-IP for the specified zones. BIG-IP_v11.5.0
remove_transfer_client Removes servers which are allowed to transfer zone data from BIG-IP for the specified zones. BIG-IP_v11.5.0
reset_statistics Resets the query statistics for a list of zones. BIG-IP_v11.5.0
set_dns_express_notify_action Sets the action for handling NOTIFY of a DNS Express zone. BIG-IP_v11.5.0
set_dns_express_server Sets the servers to transfer zone data to DNS Express for the specified zones. There is no more than one server to transfer zone data to DNS Express for each zone. BIG-IP_v11.5.0
set_dns_express_state Sets DNS Express enabled state of the specified zones. If DNS Express is enabled for the specified zone, then DNS Express will process queries for this zone, otherwise not. BIG-IP_v11.5.0
set_dns_express_verify_notify_tsig_state Sets the NOTIFY TSIG verification state of the specified DNS Express zone. By default the system expects a TSIG to be in a NOTIFY if the Zone is configured with a TSIG key. If not, the NOTIFY is treated as bogus and dropped. If disabled, the system will not expect a TSIG in the NOTIFY from the master DNS server and allow an unsigned NOTIFY to trigger a zone transfer. BIG-IP_v11.5.0
set_response_policy_state Sets RPZ state of the specified zones. If response policy is enabled on a zone, the zone can be used by a DNS Cache as an RPZ. BIG-IP_v11.6.0
set_server_tsig_key Sets the TSIG keys of a list of DNS zones. The TSIG key for each zone is the server side TSIG key. It should match the TSIG key associcated with the master name server. If a zone does not have a server side TSIG key, it will use the client side TSIG key associated with a DNS transfer server. BIG-IP_v11.5.0

Structures

Structure

Description

DNSExpressZoneDBEntry

A struct that describes one DNS Express zone database entry.

DNSExpressZoneDBStatisticEntry

A struct that describes zone database statistics for a specified DNS Express zone.

DNSExpressZoneDBStatistics

A struct that describes DNS Express zone database statistics and timestamp.

DNSZoneStatisticEntry

A struct that describes statistics for a specified DNS zone.

DNSZoneStatistics

A struct that describes DNS zone statistics and timestamp.


Enumerations

Enumeration Description
NOTIFYAction A list of DNS Express NOTIFY actions which dictate the action to take when a NOTIFY query is received for a DNS Express zone.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
DNSExpressZoneDBEntrySequence DNSExpressZoneDBEntry [] A sequence of DNS Express zone database entries.
DNSExpressZoneDBStatisticEntrySequence DNSExpressZoneDBStatisticEntry [] A sequence of DNS Express zone database statistics.
DNSZoneStatisticEntrySequence DNSZoneStatisticEntry [] A sequence of DNS zone statistics.
NOTIFYActionSequence NOTIFYAction [] A sequence of NOTIFYAction.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.