DNS views provide the ability to serve one version of DNS data to one set of clients and another version to another set of clients. With DNS views, the appliance can provide a different answer to the same query, depending on the source of the query.
References to view are object references. The name part of a view object reference has the following components:
- Name of DNS view
- Displays ‘true’ for the default DNS view, ‘false’ otherwise
Example: view/ZG5zLm5ldHdvcmtfdmlldyQxMTk:default/true
The object does not support the following operations:
In addition the object does not support the following operations when managed on Cloud Platform members:
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): comment, is_default, name.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name |
The action to perform when a domain name matches the pattern defined in a rule that is specified by the blacklist_ruleset method. Valid values are “REDIRECT” or “REFUSE”. The default value is “REFUSE”.
Type
String.
Create
The default value is REDIRECT.
Search
The field is available for search via
Notes
blacklist_action is associated with the field use_blacklist (see use flag).
The flag that indicates whether blacklist redirection queries are logged. Specify “true” to enable logging, or “false” to disable it. The default value is “false”.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
blacklist_log_query is associated with the field use_blacklist (see use flag).
The array of IP addresses the appliance includes in the response it sends in place of a blacklisted IP address.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
blacklist_redirect_addresses is associated with the field use_blacklist (see use flag).
The Time To Live (TTL) value of the synthetic DNS responses resulted from blacklist redirection. The TTL value is a 32-bit unsigned integer that represents the TTL in seconds.
Type
Unsigned integer.
Create
The default value is 60.
Search
The field is not available for search.
Notes
blacklist_redirect_ttl is associated with the field use_blacklist (see use flag).
The name of the Ruleset object assigned at the Grid level for blacklist redirection.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
blacklist_rulesets is associated with the field use_blacklist (see use flag).
Structure containing all cloud API related information for this object.
Type
A/An Cloud Information struct.
Search
The field is not available for search.
Notes
The cloud_info cannot be updated.
cloud_info cannot be written.
Comment for the DNS view; maximum 64 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is available for search via
Notes
The comment is part of the base object.
The list of customized root name servers. You can either select and use Internet root name servers or specify custom root name servers by providing a host name and IP address to which the Infoblox appliance can send queries. Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Type
A/An External Server struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
custom_root_name_servers is associated with the field use_root_name_server (see use flag).
Defines whether creation timestamp of RR should be updated ‘ when DDNS update happens even if there is no change to ‘ the RR.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_force_creation_timestamp_update is associated with the field use_ddns_force_creation_timestamp_update (see use flag).
The DDNS Principal cluster group name.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
ddns_principal_group is associated with the field use_ddns_principal_security (see use flag).
The flag that indicates whether the DDNS principal track is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_principal_tracking is associated with the field use_ddns_principal_security (see use flag).
The flag that indicates whether an option to restrict DDNS update request based on FQDN patterns is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_restrict_patterns is associated with the field use_ddns_patterns_restriction (see use flag).
The unordered list of restriction patterns for an option of to restrict DDNS updates based on FQDN patterns.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
ddns_restrict_patterns_list is associated with the field use_ddns_patterns_restriction (see use flag).
The flag that indicates whether an option to restrict DDNS update request to protected resource records is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_restrict_protected is associated with the field use_ddns_restrict_protected (see use flag).
The flag that indicates whether DDNS update request for principal other than target resource record’s principal is restricted.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_restrict_secure is associated with the field use_ddns_principal_security (see use flag).
The flag that indicates whether an option to restrict DDNS update request to resource records which are marked as ‘STATIC’ is enabled or disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ddns_restrict_static is associated with the field use_ddns_restrict_static (see use flag).
Determines if the DNS view is disabled or not. When this is set to False, the DNS view is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the DNS64 s enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
dns64_enabled is associated with the field use_dns64 (see use flag).
The list of DNS64 synthesis groups associated with this DNS view.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
dns64_groups is associated with the field use_dns64 (see use flag).
Determines if the DNS security extension is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
dnssec_enabled is associated with the field use_dnssec (see use flag).
Determines if the DNS security extension accepts expired signatures or not.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
dnssec_expired_signatures_enabled is associated with the field use_dnssec (see use flag).
A list of zones for which the server does not perform DNSSEC validation.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
The list of trusted keys for the DNS security extension.
Type
A/An DNSSEC Trusted Key struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
dnssec_trusted_keys is associated with the field use_dnssec (see use flag).
Determines if the DNS security validation is enabled or not.
Type
Bool.
Create
The default value is True.
Search
The field is available for search via
Notes
dnssec_validation_enabled is associated with the field use_dnssec (see use flag).
Advertises the EDNS0 buffer size to the upstream server. The value should be between 512 and 4096 bytes. The recommended value is between 512 and 1220 bytes.
Type
Unsigned integer.
Create
The default value is 1220.
Search
The field is not available for search.
Notes
edns_udp_size is associated with the field use_edns_udp_size (see use flag).
Determines if the blacklist in a DNS view is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
enable_blacklist is associated with the field use_blacklist (see use flag).
Determines if the fixed RRset order FQDN is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_fixed_rrset_order_fqdns is associated with the field use_fixed_rrset_order_fqdns (see use flag).
Determines if the ‘match-recursive-only’ option in a DNS view is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
The type of AAAA filtering for this DNS view object.
Type
String.
Create
The default value is NO.
Search
The field is available for search via
Notes
filter_aaaa is associated with the field use_filter_aaaa (see use flag).
Applies AAAA filtering to a named ACL, or to a list of IPv4/IPv6 addresses and networks from which queries are received. This field does not allow TSIG keys.
Type
A/An Address ac struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
filter_aaaa_list is associated with the field use_filter_aaaa (see use flag).
The fixed RRset order FQDN. If this field does not contain an empty value, the appliance will automatically set the enable_fixed_rrset_order_fqdns field to ‘true’, unless the same request sets the enable field to ‘false’.
Type
A/An Fixed RRset order FQDN struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
fixed_rrset_order_fqdns is associated with the field use_fixed_rrset_order_fqdns (see use flag).
Determines if this DNS view sends queries to forwarders only or not. When the value is True, queries are sent to forwarders only, and not to other internal or Internet root servers.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
forward_only is associated with the field use_forwarders (see use flag).
The list of forwarders for the DNS view. A forwarder is a name server to which other name servers first send their off-site queries. The forwarder builds up a cache of information, avoiding the need for other name servers to send queries off-site.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
forwarders is associated with the field use_forwarders (see use flag).
The NIOS appliance provides one default DNS view. You can rename the default view and change its settings, but you cannot delete it. There must always be at least one DNS view in the appliance.
Type
Bool.
Search
The field is available for search via
Notes
The is_default is part of the base object.
The is_default cannot be updated.
is_default cannot be written.
Determines last queried ACL for the specified IPv4 or IPv6 addresses and networks in scavenging settings.
Type
A/An Address ac struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
last_queried_acl is associated with the field use_scavenging_settings (see use flag).
A list of forwarders for the match clients. This list specifies a named ACL, or a list of IPv4/IPv6 addresses, networks, TSIG keys of clients that are allowed or denied access to the DNS view.
Type
One of the following: Address ac struct, TSIG ac struct array.
Create
The default value is:
empty
Search
The field is not available for search.
A list of forwarders for the match destinations. This list specifies a name ACL, or a list of IPv4/IPv6 addresses, networks, TSIG keys of clients that are allowed or denied access to the DNS view.
Type
One of the following: Address ac struct, TSIG ac struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The maximum number of seconds to cache ordinary (positive) answers.
Type
Unsigned integer.
Create
The default value is 604800.
Search
The field is not available for search.
Notes
max_cache_ttl is associated with the field use_max_cache_ttl (see use flag).
The maximum number of seconds to cache negative (NXDOMAIN) answers.
Type
Unsigned integer.
Create
The default value is 10800.
Search
The field is not available for search.
Notes
max_ncache_ttl is associated with the field use_max_ncache_ttl (see use flag).
The value is used by authoritative DNS servers to never send DNS responses larger than the configured value. The value should be between 512 and 4096 bytes. The recommended value is between 512 and 1220 bytes.
Type
Unsigned integer.
Create
The default value is 1220.
Search
The field is not available for search.
Notes
max_udp_size is associated with the field use_max_udp_size (see use flag).
Name of the DNS view.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The name of the network view object associated with this DNS view.
Type
String.
Create
The default value is The default DNS view.
Search
The field is available for search via
The number of seconds of delay the notify messages are sent to secondaries.
Type
Unsigned integer.
Create
The default value is 5.
Search
The field is not available for search.
The flag that indicates whether NXDOMAIN redirection queries are logged. Specify “true” to enable logging, or “false” to disable it. The default value is “false”.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
nxdomain_log_query is associated with the field use_nxdomain_redirect (see use flag).
Determines if NXDOMAIN redirection in a DNS view is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
nxdomain_redirect is associated with the field use_nxdomain_redirect (see use flag).
The array with IPv4 addresses the appliance includes in the response it sends in place of an NXDOMAIN response.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
nxdomain_redirect_addresses is associated with the field use_nxdomain_redirect (see use flag).
The array with IPv6 addresses the appliance includes in the response it sends in place of an NXDOMAIN response.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
nxdomain_redirect_addresses_v6 is associated with the field use_nxdomain_redirect (see use flag).
The Time To Live (TTL) value of the synthetic DNS responses resulted from NXDOMAIN redirection. The TTL value is a 32-bit unsigned integer that represents the TTL in seconds.
Type
Unsigned integer.
Create
The default value is 60.
Search
The field is not available for search.
Notes
nxdomain_redirect_ttl is associated with the field use_nxdomain_redirect (see use flag).
The names of the Ruleset objects assigned at the grid level for NXDOMAIN redirection.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
Notes
nxdomain_rulesets is associated with the field use_nxdomain_redirect (see use flag).
Determines if recursion is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is available for search via
Notes
recursion is associated with the field use_recursion (see use flag).
The response rate limiting settings for the DNS View.
Type
A/An DNS Response Rate Limiting struct.
Create
The default value is:
{ 'enable_rrl': False,
'log_only': False,
'responses_per_second': 100,
'slip': 2,
'window': 15}
Search
The field is not available for search.
Notes
response_rate_limiting is associated with the field use_response_rate_limiting (see use flag).
Determines the type of root name servers.
Type
String.
Create
The default value is INTERNET.
Search
The field is available for search via
Notes
root_name_server_type is associated with the field use_root_name_server (see use flag).
Enables the appliance to ignore RPZ-IP triggers with prefix lengths less than the specified minimum prefix length.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
rpz_drop_ip_rule_enabled is associated with the field use_rpz_drop_ip_rule (see use flag).
The minimum prefix length for IPv4 RPZ-IP triggers. The appliance ignores RPZ-IP triggers with prefix lengths less than the specified minimum IPv4 prefix length.
Type
Unsigned integer.
Create
The default value is 29.
Search
The field is not available for search.
Notes
rpz_drop_ip_rule_min_prefix_length_ipv4 is associated with the field use_rpz_drop_ip_rule (see use flag).
The minimum prefix length for IPv6 RPZ-IP triggers. The appliance ignores RPZ-IP triggers with prefix lengths less than the specified minimum IPv6 prefix length.
Type
Unsigned integer.
Create
The default value is 112.
Search
The field is not available for search.
Notes
rpz_drop_ip_rule_min_prefix_length_ipv6 is associated with the field use_rpz_drop_ip_rule (see use flag).
The flag that indicates whether recursive RPZ lookups are enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
rpz_qname_wait_recurse is associated with the field use_rpz_qname_wait_recurse (see use flag).
The scavenging settings.
Type
A/An DNS scavenging settings struct.
Create
The default value is:
{ 'ea_expression_list': [],
'enable_auto_reclamation': False,
'enable_recurrent_scavenging': False,
'enable_rr_last_queried': False,
'enable_scavenging': False,
'enable_zone_last_queried': False,
'expression_list': [],
'reclaim_associated_records': False}
Search
The field is not available for search.
Notes
scavenging_settings is associated with the field use_scavenging_settings (see use flag).
A sort list that determines the order of IP addresses in responses sent to DNS queries.
Type
A/An DNS Sortlist struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
sortlist is associated with the field use_sortlist (see use flag).
Use flag for: blacklist_action , blacklist_log_query, blacklist_redirect_addresses, blacklist_redirect_ttl, blacklist_rulesets, enable_blacklist
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_force_creation_timestamp_update
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_restrict_patterns_list , ddns_restrict_patterns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_restrict_secure , ddns_principal_tracking, ddns_principal_group
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_restrict_protected
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_restrict_static
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: dns64_enabled , dns64_groups
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: dnssec_enabled , dnssec_expired_signatures_enabled, dnssec_validation_enabled, dnssec_trusted_keys
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: edns_udp_size
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: filter_aaaa , filter_aaaa_list
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: fixed_rrset_order_fqdns , enable_fixed_rrset_order_fqdns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: forwarders , forward_only
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: max_cache_ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: max_ncache_ttl
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: max_udp_size
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: nxdomain_redirect , nxdomain_redirect_addresses, nxdomain_redirect_addresses_v6, nxdomain_redirect_ttl, nxdomain_log_query, nxdomain_rulesets
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: recursion
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: response_rate_limiting
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: custom_root_name_servers , root_name_server_type
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: rpz_drop_ip_rule_enabled , rpz_drop_ip_rule_min_prefix_length_ipv4, rpz_drop_ip_rule_min_prefix_length_ipv6
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: rpz_qname_wait_recurse
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This function performs the scavenging of the DNS Records.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
action ( String. Valid values are: “ANALYZE”, “RECLAIM”, “ANALYZE_RECLAIM”, “RESET” ). This parameter is mandatory. The scavenging action to perform.
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| blacklist_action | String | N | N | N | = |
| blacklist_log_query | Bool | N | N | N | = |
| blacklist_redirect_addresses | [String] | N | N | N | N/A |
| blacklist_redirect_ttl | Unsigned int | N | N | N | N/A |
| blacklist_rulesets | [String] | N | N | N | N/A |
| cloud_info | struct | N | Y | N | N/A |
| comment | String | N | N | Y | : = ~ |
| custom_root_name_servers | [struct] | N | N | N | N/A |
| ddns_force_creation_timestamp_update | Bool | N | N | N | N/A |
| ddns_principal_group | String | N | N | N | N/A |
| ddns_principal_tracking | Bool | N | N | N | N/A |
| ddns_restrict_patterns | Bool | N | N | N | N/A |
| ddns_restrict_patterns_list | [String] | N | N | N | N/A |
| ddns_restrict_protected | Bool | N | N | N | N/A |
| ddns_restrict_secure | Bool | N | N | N | N/A |
| ddns_restrict_static | Bool | N | N | N | N/A |
| disable | Bool | N | N | N | N/A |
| dns64_enabled | Bool | N | N | N | = |
| dns64_groups | [String] | N | N | N | N/A |
| dnssec_enabled | Bool | N | N | N | = |
| dnssec_expired_signatures_enabled | Bool | N | N | N | = |
| dnssec_negative_trust_anchors | [String] | N | N | N | N/A |
| dnssec_trusted_keys | [struct] | N | N | N | N/A |
| dnssec_validation_enabled | Bool | N | N | N | = |
| edns_udp_size | Unsigned int | N | N | N | N/A |
| enable_blacklist | Bool | N | N | N | = |
| enable_fixed_rrset_order_fqdns | Bool | N | N | N | N/A |
| enable_match_recursive_only | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| filter_aaaa | String | N | N | N | = |
| filter_aaaa_list | [struct] | N | N | N | N/A |
| fixed_rrset_order_fqdns | [struct] | N | N | N | N/A |
| forward_only | Bool | N | N | N | = |
| forwarders | [String] | N | N | N | N/A |
| is_default | Bool | N | Y | Y | = |
| last_queried_acl | [struct] | N | N | N | N/A |
| match_clients | [struct] | N | N | N | N/A |
| match_destinations | [struct] | N | N | N | N/A |
| max_cache_ttl | Unsigned int | N | N | N | N/A |
| max_ncache_ttl | Unsigned int | N | N | N | N/A |
| max_udp_size | Unsigned int | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| network_view | String | N | N | N | = |
| notify_delay | Unsigned int | N | N | N | N/A |
| nxdomain_log_query | Bool | N | N | N | = |
| nxdomain_redirect | Bool | N | N | N | = |
| nxdomain_redirect_addresses | [String] | N | N | N | N/A |
| nxdomain_redirect_addresses_v6 | [String] | N | N | N | N/A |
| nxdomain_redirect_ttl | Unsigned int | N | N | N | N/A |
| nxdomain_rulesets | [String] | N | N | N | N/A |
| recursion | Bool | N | N | N | = |
| response_rate_limiting | struct | N | N | N | N/A |
| root_name_server_type | String | N | N | N | = |
| rpz_drop_ip_rule_enabled | Bool | N | N | N | N/A |
| rpz_drop_ip_rule_min_prefix_length_ipv4 | Unsigned int | N | N | N | N/A |
| rpz_drop_ip_rule_min_prefix_length_ipv6 | Unsigned int | N | N | N | N/A |
| rpz_qname_wait_recurse | Bool | N | N | N | N/A |
| scavenging_settings | struct | N | N | N | N/A |
| sortlist | [struct] | N | N | N | N/A |
| use_blacklist | Bool | N | N | N | N/A |
| use_ddns_force_creation_timestamp_update | Bool | N | N | N | N/A |
| use_ddns_patterns_restriction | Bool | N | N | N | N/A |
| use_ddns_principal_security | Bool | N | N | N | N/A |
| use_ddns_restrict_protected | Bool | N | N | N | N/A |
| use_ddns_restrict_static | Bool | N | N | N | N/A |
| use_dns64 | Bool | N | N | N | N/A |
| use_dnssec | Bool | N | N | N | N/A |
| use_edns_udp_size | Bool | N | N | N | N/A |
| use_filter_aaaa | Bool | N | N | N | N/A |
| use_fixed_rrset_order_fqdns | Bool | N | N | N | N/A |
| use_forwarders | Bool | N | N | N | N/A |
| use_max_cache_ttl | Bool | N | N | N | N/A |
| use_max_ncache_ttl | Bool | N | N | N | N/A |
| use_max_udp_size | Bool | N | N | N | N/A |
| use_nxdomain_redirect | Bool | N | N | N | N/A |
| use_recursion | Bool | N | N | N | N/A |
| use_response_rate_limiting | Bool | N | N | N | N/A |
| use_root_name_server | Bool | N | N | N | N/A |
| use_rpz_drop_ip_rule | Bool | N | N | N | N/A |
| use_rpz_qname_wait_recurse | Bool | N | N | N | N/A |
| use_scavenging_settings | Bool | N | N | N | N/A |
| use_sortlist | Bool | N | N | N | N/A |
vdiscoverytask : Discovery task object.