Class: Ansible::Ruby::Modules::Bigip_profile_dns

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb

Overview

Manage DNS profiles on a BIG-IP. Many DNS profiles; each with their own adjustments to the standard C(dns) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#cache_name ⇒ Object?

Returns Specifies the user-created cache that the system uses to cache DNS responses.,When you select a cache for the system to use, you must also set C(enable_dns_cache) to C(yes).

Returns:

  • (Object, nil) —

    Specifies the user-created cache that the system uses to cache DNS responses.,When you select a cache for the system to use, you must also set C(enable_dns_cache) to C(yes)



51
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 51

attribute :cache_name

#enable_cache ⇒ Symbol?

Returns Specifies whether the system caches DNS responses.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,When C(yes), the BIG-IP system caches DNS responses handled by the virtual servers associated with this profile. When you enable this setting, you must also specify a value for C(cache_name).,When C(no), the BIG-IP system does not cache DNS responses handled by the virtual servers associated with this profile. However, the profile retains the association with the DNS cache in the C(cache_name) parameter. Disable this setting when you want to debug the system.

Returns:

  • (Symbol, nil) —

    Specifies whether the system caches DNS responses.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,When C(yes), the BIG-IP system caches DNS responses handled by the virtual servers associated with this profile. When you enable this setting, you must also specify a value for C(cache_name).,When C(no), the BIG-IP system does not cache DNS responses handled by the virtual servers associated with this profile. However, the profile retains the association with the DNS cache in the C(cache_name) parameter. Disable this setting when you want to debug the system.



47
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 47

attribute :enable_cache

#enable_dns_express ⇒ Symbol?

Returns Specifies whether the DNS Express engine is enabled.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,The DNS Express engine receives zone transfers from the authoritative DNS server for the zone. If the C(enable_zone_transfer) setting is also C(yes) on this profile, the DNS Express engine also responds to zone transfer requests made by the nameservers configured as zone transfer clients for the DNS Express zone.

Returns:

  • (Symbol, nil) —

    Specifies whether the DNS Express engine is enabled.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,The DNS Express engine receives zone transfers from the authoritative DNS server for the zone. If the C(enable_zone_transfer) setting is also C(yes) on this profile, the DNS Express engine also responds to zone transfer requests made by the nameservers configured as zone transfer clients for the DNS Express zone.



19
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 19

attribute :enable_dns_express

#enable_dns_firewall ⇒ Symbol?

Returns Specifies whether DNS firewall capability is enabled.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Symbol, nil) —

    Specifies whether DNS firewall capability is enabled.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



43
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 43

attribute :enable_dns_firewall

#enable_dnssec ⇒ Symbol?

Returns Specifies whether the system signs responses with DNSSEC keys and replies to DNSSEC specific queries (e.g., DNSKEY query type).,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Symbol, nil) —

    Specifies whether the system signs responses with DNSSEC keys and replies to DNSSEC specific queries (e.g., DNSKEY query type).,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 27

attribute :enable_dnssec

#enable_gtm ⇒ Symbol?

Returns Specifies whether the system uses Global Traffic Manager to manage the response.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Symbol, nil) —

    Specifies whether the system uses Global Traffic Manager to manage the response.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 31

attribute :enable_gtm

#enable_zone_transfer ⇒ Symbol?

Returns Specifies whether the system answers zone transfer requests for a DNS zone created on the system.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,The C(enable_dns_express) and C(enable_zone_transfer) settings on a DNS profile affect how the system responds to zone transfer requests.,When the C(enable_dns_express) and C(enable_zone_transfer) settings are both C(yes), if a zone transfer request matches a DNS Express zone, then DNS Express answers the request.,When the C(enable_dns_express) setting is C(no) and the C(enable_zone_transfer) setting is C(yes), the BIG-IP system processes zone transfer requests based on the last action and answers the request from local BIND or a pool member.

Returns:

  • (Symbol, nil) —

    Specifies whether the system answers zone transfer requests for a DNS zone created on the system.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,The C(enable_dns_express) and C(enable_zone_transfer) settings on a DNS profile affect how the system responds to zone transfer requests.,When the C(enable_dns_express) and C(enable_zone_transfer) settings are both C(yes), if a zone transfer request matches a DNS Express zone, then DNS Express answers the request.,When the C(enable_dns_express) setting is C(no) and the C(enable_zone_transfer) setting is C(yes), the BIG-IP system processes zone transfer requests based on the last action and answers the request from local BIND or a pool member.



23
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 23

attribute :enable_zone_transfer

#name ⇒ String

Returns Specifies the name of the DNS profile.

Returns:

  • (String) —

    Specifies the name of the DNS profile.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 12

attribute :name

#parent ⇒ Object?

Returns Specifies the profile from which this profile inherits settings.,When creating a new profile, if this parameter is not specified, the default is the system-supplied C(dns) profile.

Returns:

  • (Object, nil) —

    Specifies the profile from which this profile inherits settings.,When creating a new profile, if this parameter is not specified, the default is the system-supplied C(dns) profile.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 16

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



58
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 58

attribute :partition

#process_recursion_desired ⇒ Symbol?

Returns Specifies whether to process client-side DNS packets with Recursion Desired set in the header.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,If set to C(no), processing of the packet is subject to the unhandled-query-action option.

Returns:

  • (Symbol, nil) —

    Specifies whether to process client-side DNS packets with Recursion Desired set in the header.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.,If set to C(no), processing of the packet is subject to the unhandled-query-action option.



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 35

attribute :process_recursion_desired

#state ⇒ :present, ...

Returns When C(present), ensures that the profile exists.,When C(absent), ensures the profile is removed.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the profile exists.,When C(absent), ensures the profile is removed.



62
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 62

attribute :state

#unhandled_query_action ⇒ :allow, ...

Returns Specifies the action to take when a query does not match a Wide IP or a DNS Express Zone.,When C(allow), the BIG-IP system forwards queries to a DNS server or pool member. If a pool is not associated with a listener and the Use BIND Server on BIG-IP setting is set to Enabled, requests are forwarded to the local BIND server.,When C(drop), the BIG-IP system does not respond to the query.,When C(reject), the BIG-IP system returns the query with the REFUSED return code.,When C(hint), the BIG-IP system returns the query with a list of root name servers.,When C(no-error), the BIG-IP system returns the query with the NOERROR return code.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (:allow, :drop, :reject, :hint, :"no-error", nil) —

    Specifies the action to take when a query does not match a Wide IP or a DNS Express Zone.,When C(allow), the BIG-IP system forwards queries to a DNS server or pool member. If a pool is not associated with a listener and the Use BIND Server on BIG-IP setting is set to Enabled, requests are forwarded to the local BIND server.,When C(drop), the BIG-IP system does not respond to the query.,When C(reject), the BIG-IP system returns the query with the REFUSED return code.,When C(hint), the BIG-IP system returns the query with a list of root name servers.,When C(no-error), the BIG-IP system returns the query with the NOERROR return code.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



54
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 54

attribute :unhandled_query_action

#use_local_bind ⇒ Symbol?

Returns Specifies whether the system forwards non-wide IP queries to the local BIND server on the BIG-IP system.,For best performance, disable this setting when using a DNS cache.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.

Returns:

  • (Symbol, nil) —

    Specifies whether the system forwards non-wide IP queries to the local BIND server on the BIG-IP system.,For best performance, disable this setting when using a DNS cache.,When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.



39
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_profile_dns.rb', line 39

attribute :use_local_bind