LocalLB::DNSExpress¶
Introduced : BIG-IP_v11.0.0
The DNSExpress interface allows you to create and maintain DNS Express
zones and manage DNS Express TSIG keys. A DNS Express zone allows the
system to answer DNS requests authoritatively based on information
transferred from a DNS server (the transfer target).
Methods¶
| Method | Description | Introduced |
| create | Creates DNS Express zones. | BIG-IP_v11.0.0 |
| create_tsig_key | Creates DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| delete_all_tsig_keys | Deletes all DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| delete_all_zones | Deletes all DNS Express zones. | BIG-IP_v11.0.0 |
| delete_tsig_key | Deletes DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| delete_zone | Deletes DNS Express zones. | BIG-IP_v11.0.0 |
| get_all_statistics | Gets the statistics for all DNS Express zones. | BIG-IP_v11.0.0 |
| get_enabled_state | Gets the enabled state of the specified DNS Express zones. | BIG-IP_v11.0.0 |
| get_list | Gets a list of all DNS Express zones. | BIG-IP_v11.0.0 |
| get_notify_action | Gets the NOTIFY actions used by DNS Express zones. | BIG-IP_v11.4.0 |
| get_object_status | Gets the statuses of the specified zones. This gives information on the current transfer state. | BIG-IP_v11.0.0 |
| get_statistics | Gets the statistics for a list of DNS Express zones. | BIG-IP_v11.0.0 |
| get_transfer_target | Gets the transfer targets for the specified DNS Express zones. | BIG-IP_v11.0.0 |
| get_tsig_key | Gets the TSIG keys for the specified DNS Express zones. | BIG-IP_v11.0.0 |
| get_tsig_key_algorithm | Gets the algorithms to use with the specified DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| get_tsig_key_list | Gets a list of all DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| get_tsig_key_secret | Gets the secrets to use with the specified DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| get_verify_notify_tsig_state | Gets the NOTIFY TSIG verification state of the specified DNS Express zones. | BIG-IP_v11.4.0 |
| get_version | Get the version information for this interface. | BIG-IP_v11.0.0 |
| get_zone_db_statistics | Gets zone database statistics for a list of DNS Express zones. | BIG-IP_v11.0.0 |
| set_enabled_state | Sets the enabled state of the specified DNS Express zones. | BIG-IP_v11.0.0 |
| set_notify_action | Sets the action for handling NOTIFY of a DNS Express zone. | BIG-IP_v11.4.0 |
| set_transfer_target | Sets the transfer targets for the specified DNS Express zones. A transfer target is an IP address (of a DNS server) from which to retrieve zone information (i.e. zone transfer). The update frequency of a zone is established by using the retry and refresh intervals of its SOA resource record. | BIG-IP_v11.0.0 |
| set_tsig_key | Sets the TSIG keys for the specified DNS Express zones. A TSIG key is a key to use when retrieving information from a transfer target. This is optional. During zone transfer, AXFR/IXFR requests use TSIG if this name string is non-empty. | BIG-IP_v11.0.0 |
| set_tsig_key_algorithm | Sets the algorithms to use with the specified DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| set_tsig_key_secret | Sets the secrets to use with the specified DNS Express TSIG keys. | BIG-IP_v11.0.0 |
| set_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.4.0 |
Structures¶
Structure
Description
A struct that describes statistics for a specified DNS Express zone.
A struct that describes DNS Express zone statistics and timestamp.
A struct that describes one DNS Express zone database entry.
DNSExpressZoneDBStatisticEntry
A struct that describes zone database statistics for a specified DNS Express zone.
A struct that describes DNS Express zone database 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. |
| TSIGKeyAlgorithm | A list of DNS Express TSIG key algorithm types. |
Aliases¶
| Alias | Type | Description |
| DNSExpressStatisticEntrySequence | DNSExpressStatisticEntry [] | A sequence of DNS Express zone statistics. |
| DNSExpressZoneDBEntrySequence | DNSExpressZoneDBEntry [] | A sequence of DNS Express zone database entries. |
| DNSExpressZoneDBStatisticEntrySequence | DNSExpressZoneDBStatisticEntry [] | A sequence of DNS Express zone database statistics. |
| NOTIFYActionSequence | NOTIFYAction [] | A sequence of NOTIFYAction. |
| TSIGKeyAlgorithmSequence | TSIGKeyAlgorithm [] | A sequence of DNS Express TSIG key algorithms. |
See Also¶
iControl ::
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.