LocalLB::ProfileDNS¶
Introduced : BIG-IP_v9.2.0
The ProfileDNS interface enables you to manipulate a local load
balancer&aposs DNS profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified DNS profiles. | BIG-IP_v9.2.0 |
| delete_all_profiles | Deletes all DNS profiles. | BIG-IP_v9.2.0 |
| delete_profile | Deletes the specified DNS profiles. | BIG-IP_v9.2.0 |
| get_all_statistics | Gets the statistics for all the DNS profiles. | BIG-IP_v9.2.0 |
| get_avr_dnsstat_sample_rate | Gets the sample rates for AVR DNS statistics, allows AVR to store DNS statistics for sample queries. AVR DNS statistics contain query name, query type, client IP and virtual server IP. | BIG-IP_v11.3.0 |
| get_default_profile | Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v9.2.0 |
| get_description | Gets the descriptions for a set of DNS profiles. | BIG-IP_v11.0.0 |
| get_dns64_additional_section_rewrite | Gets DNS64 additional section rewrite behavior for the specified profiles. | BIG-IP_v11.0.0 |
| get_dns64_mode | Gets the DNS64 translation mode for the specified profiles. | BIG-IP_v11.0.0 |
| get_dns64_prefix | Gets the IPv6 prefix for DNS64 mapping for the specified DNS profiles. | BIG-IP_v11.0.0 |
| get_dns_cache | Gets the DNS cache used for the specified profiles. | BIG-IP_v11.2.0 |
| get_dns_cache_enabled_state | Gets DNS cache enabled state for the specified profiles. | BIG-IP_v11.2.0 |
| get_dns_express_enabled_state | Gets the state that if true, enables DNS express for the specified profiles. | BIG-IP_v11.0.0 |
| get_dns_firewall_state | Gets the DNS Firewall enabled state for the specified profiles. | BIG-IP_v11.4.0 |
| get_dns_last_action | Gets the last action to take when there is no matching zone name. | BIG-IP_v11.0.0 |
| get_dns_logging_enabled_state | Gets DNS logging enabled state for the specified profiles. | BIG-IP_v11.3.0 |
| get_dns_logging_profile | Gets the DNS logging profile used for the specified DNS profiles. | BIG-IP_v11.3.0 |
| get_dns_rapid_response_enabled_state | Gets the state that if true, allows DNS Rapid Response to handle DNS resolution for DNS queries and responses that match a DNS-Express Zone. | BIG-IP_v11.6.0 |
| get_dns_rapid_response_last_action | Gets the DNS Rapid Response last actions for the specified profiles. | BIG-IP_v11.6.0 |
| get_dns_security_profile | Gets the DNS Security profile used for the specified DNS profiles. | BIG-IP_v11.4.0 |
| get_dnssec_enabled_state | Gets the DNSSEC enabled state for the specified profiles. | BIG-IP_v11.2.0 |
| get_gtm_enabled_state | Gets the state that if true, allows GTM to handle DNS resolution for DNS queries and responses that contain wide IP names. | BIG-IP_v9.2.0 |
| get_hardware_caching_enabled_state | Gets the hardware caching enabled state for the specified profiles. DNS hardware caching stores egressed responses for answering subsequent ingress queries without involving software. | BIG-IP_v12.0.0 |
| get_hardware_validation_enabled_state | Gets the hardware validation enabled state for the specified profiles. DNS hardware validation will ensure ingress queries are well formed according the DNS RFCs (e.g. 1035). | BIG-IP_v12.0.0 |
| get_list | Gets a list of all DNS profiles. | BIG-IP_v9.2.0 |
| get_statistics | Gets the statistics for the specified DNS profiles. | BIG-IP_v9.2.0 |
| get_statistics_by_virtual | Gets the statistics for the specified DNS profiles, by virtual server. | BIG-IP_v11.0.0 |
| get_use_local_bind_state | Gets the state that if true, causes the system to use local BIND as a DNS resource. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.2.0 |
| get_zone_transfer_state | Gets the states indicating whether to process zone transfers for the specified profiles. | BIG-IP_v11.5.0 |
| is_base_profile | Determines whether the specified DNS profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). | BIG-IP_v9.2.0 |
| is_system_profile | Determines whether the specified DNS profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). | BIG-IP_v9.0 |
| reset_statistics | Resets the statistics for the specified DNS profiles. | BIG-IP_v9.2.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified DNS profiles, for specified virtual servers. | BIG-IP_v11.0.0 |
| set_avr_dnsstat_sample_rate | Sets the sample rate for AVR DNS statistics, allows AVR to store DNS statistics for sample queries. The sample rate is an integer value. When it is zero, no queries will be stored in the analytics database. When it is one, all queries will be stored. When it is N (N>1), 1/N queries will be stored. AVR DNS statistics contain query name (eg. www.f5.com), query type (eg. A, NS, MX), client IP and virtual server IP. The client IP is the IP where the query comes from. The virtual server IP is the IP of the listener which answers the query. | BIG-IP_v11.3.0 |
| set_default_profile | Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. | BIG-IP_v9.2.0 |
| set_description | Sets the description for a set of DNS profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_dns64_additional_section_rewrite | Sets DNS64 additional section rewrite behavior for the specified profiles. | BIG-IP_v11.0.0 |
| set_dns64_mode | Sets the DNS64 translation mode for the specified profiles. Please see DNS64Mode for information on the modes. | BIG-IP_v11.0.0 |
| set_dns64_prefix | Sets the IPv6 prefix for DNS64 mapping for the specified DNS profiles. The system uses this when mapping A records into AAAA. | BIG-IP_v11.0.0 |
| set_dns_cache | Sets the DNS Cache used for the specified profiles. | BIG-IP_v11.2.0 |
| set_dns_cache_enabled_state | Sets the DNS cache enabled state for the specified profiles. | BIG-IP_v11.2.0 |
| set_dns_express_enabled_state | Sets the state that if true, enables DNS Express for the specified profiles. | BIG-IP_v11.0.0 |
| set_dns_firewall_state | Sets the DNS Firewall enabled state for the specified profiles. | BIG-IP_v11.4.0 |
| set_dns_last_action | Sets the last action to take when there is no matching zone name. See ProfileDNSLastAction for more information. | BIG-IP_v11.0.0 |
| set_dns_logging_enabled_state | Sets the DNS logging enabled state for the specified profiles. Enabling the logging profile requires a DNS logging profile to be configured first. Based on the settings inside log profile, DNS queries or/and responses are logged. | BIG-IP_v11.3.0 |
| set_dns_logging_profile | Configures the specified DNS profiles with DNS logging profiles. If logging is enabled on the DNS profile, the configured log profile contains all the details for logging such as the log destination, contents, and format. | BIG-IP_v11.3.0 |
| set_dns_rapid_response_enabled_state | Sets the state that if true, allows DNS Rapid Response to handle DNS resolution for DNS queries which match a DNS-Express Zone. | BIG-IP_v11.6.0 |
| set_dns_rapid_response_last_action | Sets the DNS Rapid Response last action to apply when a query does not match a DNS-Express zone. | BIG-IP_v11.6.0 |
| set_dns_security_profile | Sets the DNS Security Profile for the specified profiles. If a DNS Security Profile is set, DNS packets will be dropped according to the rules defined by the DNS Security Profile. | BIG-IP_v11.4.0 |
| set_dnssec_enabled_state | Sets the DNSSEC enabled state for the specified profiles. | BIG-IP_v11.2.0 |
| set_gtm_enabled_state | Sets the state that if true, allows GTM to handle DNS resolution for DNS queries and responses that contain wide IP names. | BIG-IP_v9.2.0 |
| set_hardware_caching_enabled_state | Sets the hardware caching enabled state for the specified profiles. DNS hardware caching stores egressed responses for answering subsequent ingress queries without involving software. | BIG-IP_v12.0.0 |
| set_hardware_validation_enabled_state | Sets the hardware validation enabled state for the specified profiles. DNS hardware validation will ensure ingress queries are well formed according the DNS RFCs (e.g. 1035). | BIG-IP_v12.0.0 |
| set_use_local_bind_state | Sets the state that if true, causes the system to use local BIND as a DNS resource. | BIG-IP_v11.0.0 |
| set_zone_transfer_state | Sets the states indicating whether to process zone transfers for the specified profiles. If the state of a profile is set to be disabled, virtual servers with this profile will not allow DNS Express to transfer zone data to the clients. | BIG-IP_v11.5.0 |
Structures¶
Structure
Description
ProfileDNS64AdditionalSectionRewrite
A structure that specifies the DNS64 additional section rewrite setting.
A structure that specifies the DNS64 mode.
A structure that specifies the last action.
ProfileDNSRapidResponseLastAction
A structure that specifies the last action for DNS Rapid Response.
A struct that describes statistics for a particular DNS profile.
A struct that describes profile statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| DNS64AdditionalSectionRewrite | Controls system behavior when a DNS response contains AAAA or A record(s) in the additional section. When DNS64 is enabled, this option selects how to rewrite (or not rewrite) these entries. |
| DNS64Mode | DNS64 modes specify whether to peform DNS64 translation, and how to perform it. This allows one to represent an IPv4 world using IPv6. |
| DNSLastAction | Last actions to take if there is no matching zone name, i.e. a DNS query does not match a GTM wideip name, is not a DNSSEC query type (e.g. DNSKEY, etc.), and does not match a DNS-Express Zone name. |
| DNSRapidResponseLastAction | Action to take if DNS Rapid Response is enabled and the query name does not match a DNS-Express zone. |
Aliases¶
| Alias | Type | Description |
| DNS64AdditionalSectionRewriteSequence | DNS64AdditionalSectionRewrite [] | A sequence of DNS64 additional section rewrite settings. |
| DNS64ModeSequence | DNS64Mode [] | A sequence of DNS64 modes. |
| DNSLastActionSequence | DNSLastAction [] | A sequence of last actions. |
| DNSRapidResponseLastActionSequence | DNSRapidResponseLastAction [] | A sequence of last actions. |
| ProfileDNS64AdditionalSectionRewriteSequence | ProfileDNS64AdditionalSectionRewrite [] | A sequence of DNS64 additional section rewrite settings. |
| ProfileDNS64ModeSequence | ProfileDNS64Mode [] | A sequence of DNS64 mode specifications. |
| ProfileDNSLastActionSequence | ProfileDNSLastAction [] | A sequence of last action specifications. |
| ProfileDNSRapidResponseLastActionSequence | ProfileDNSRapidResponseLastAction [] | A sequence of last action specifications. |
| ProfileDNSStatisticEntrySequence | ProfileDNSStatisticEntry [] | A sequence of ProfileDNS statistics. |
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.