zone_auth : DNS Authoritative Zone object.

An authoritative zone is a zone for which the local (primary or secondary) server references its own data when responding to queries. The local server is authoritative for the data in this zone and responds to queries for this data without referencing another server.

If operating in a Cloud API environment and if the zone is in a delegated network view, grid_primary is a required field.

There are two types of authoritative zones:

  • Forwarding-mapping: An authoritative forward-mapping zone is an area of domain name space for which one or more name servers have the responsibility to respond authoritatively to name-to-address queries.
  • Reverse-mapping: A reverse-mapping zone is an area or network space for which one or more name servers have the responsibility to respond to address-to-name queries.

Object Reference

References to zone_auth are object references. The name part of a DNS Auth Zone object reference has the following components:

  • FQDN of the zone
  • Name of the view

Example: zone_auth/ZG5zLmhvc3QkLl9kZWZhd3QuaDE:zone.com/default

Restrictions

The object does not support the following operations:

In addition the object does not support the following operations when managed on Cloud Platform members:

  • Function calls

Fields

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): fqdn, view.

The following fields are required to create this object:

Field Notes
fqdn  
NOTE:
A named ACL (Access Control List) is a list of IPv4/IPv6 addresses, networks, TSIG-based anonymous access controls, and other named ACLs. Only one named ACL is allowed for each field.

address

address

The IP address of the server that is serving this zone.

Type

String.

Search

The field is not available for search.

Notes

The address cannot be updated.

address cannot be written.

allow_active_dir

allow_active_dir

This field allows the zone to receive GSS-TSIG authenticated DDNS updates from DHCP clients and servers in an AD domain.

Note that addresses specified in this field ignore the permission set in the struct which will be set to ‘ALLOW’.

Type

A/An Address ac struct array.

Create

The default value is:

empty

Search

The field is not available for search.

Notes

allow_active_dir is associated with the field use_allow_active_dir (see use flag).

allow_fixed_rrset_order

allow_fixed_rrset_order

The flag that allows to enable or disable fixed RRset ordering for authoritative forward-mapping zones.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

allow_gss_tsig_for_underscore_zone

allow_gss_tsig_for_underscore_zone

The flag that allows DHCP clients to perform GSS-TSIG signed updates for underscore zones.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

allow_gss_tsig_zone_updates

allow_gss_tsig_zone_updates

The flag that enables or disables the zone for GSS-TSIG updates.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

allow_query

allow_query

Determines whether DNS queries are allowed from a named ACL, or from a list of IPv4/IPv6 addresses, networks, and TSIG keys for the hosts.

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.

Notes

allow_query is associated with the field use_allow_query (see use flag).

allow_transfer

allow_transfer

Determines whether zone transfers are allowed from a named ACL, or from a list of IPv4/IPv6 addresses, networks, and TSIG keys for the hosts.

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.

Notes

allow_transfer is associated with the field use_allow_transfer (see use flag).

allow_update

allow_update

Determines whether dynamic DNS updates are allowed from a named ACL, or from a list of IPv4/IPv6 addresses, networks, and TSIG keys for the hosts.

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.

Notes

allow_update is associated with the field use_allow_update (see use flag).

allow_update_forwarding

allow_update_forwarding

The list with IP addresses, networks or TSIG keys for clients, from which forwarded dynamic updates are allowed.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

allow_update_forwarding is associated with the field use_allow_update_forwarding (see use flag).

aws_rte53_zone_info

aws_rte53_zone_info

Additional information for Route53 zone.

Type

A/An ‘Aws Rte53 Zone Info struct.

Search

The field is not available for search.

Notes

The aws_rte53_zone_info cannot be updated.

aws_rte53_zone_info cannot be written.

cloud_info

cloud_info

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

comment

Comment for the zone; maximum 256 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

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

copy_xfer_to_notify

copy_xfer_to_notify

If this flag is set to True then copy allowed IPs from Allow Transfer to Also Notify.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

copy_xfer_to_notify is associated with the field use_copy_xfer_to_notify (see use flag).

create_ptr_for_bulk_hosts

create_ptr_for_bulk_hosts

Determines if PTR records are created for hosts automatically, if necessary, when the zone data is imported. This field is meaningful only when import_from is set.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

create_ptr_for_bulk_hosts is not readable.

create_ptr_for_hosts

create_ptr_for_hosts

Determines if PTR records are created for hosts automatically, if necessary, when the zone data is imported. This field is meaningful only when import_from is set.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

create_ptr_for_hosts is not readable.

create_underscore_zones

create_underscore_zones

Determines whether automatic creation of subzones is enabled or not.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

ddns_force_creation_timestamp_update

ddns_force_creation_timestamp_update

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).

ddns_principal_group

ddns_principal_group

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).

ddns_principal_tracking

ddns_principal_tracking

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).

ddns_restrict_patterns

ddns_restrict_patterns

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).

ddns_restrict_patterns_list

ddns_restrict_patterns_list

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).

ddns_restrict_protected

ddns_restrict_protected

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).

ddns_restrict_secure

ddns_restrict_secure

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).

ddns_restrict_static

ddns_restrict_static

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).

disable

disable

Determines whether a zone is disabled or not. When this is set to False, the zone is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

disable_forwarding

disable_forwarding

Determines whether the name servers that host the zone should forward queries (ended with the domain name of the zone) to any configured forwarders.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

display_domain

display_domain

The displayed name of the DNS zone.

Type

String.

Search

The field is not available for search.

Notes

The display_domain cannot be updated.

display_domain cannot be written.

dns_fqdn

dns_fqdn

The name of this DNS zone in punycode format. For a reverse zone, this is in “address/cidr” format. For other zones, this is in FQDN format in punycode format.

Type

String.

Search

The field is not available for search.

Notes

The dns_fqdn cannot be updated.

dns_fqdn cannot be written.

dns_integrity_enable

dns_integrity_enable

If this is set to True, DNS integrity check is enabled for this zone.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

dns_integrity_frequency

dns_integrity_frequency

The frequency, in seconds, of DNS integrity checks for this zone.

Type

Unsigned integer.

Create

The default value is 3600.

Search

The field is not available for search.

dns_integrity_member

dns_integrity_member

The Grid member that performs DNS integrity checks for this zone.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

dns_integrity_verbose_logging

dns_integrity_verbose_logging

If this is set to True, more information is logged for DNS integrity checks for this zone.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

dns_soa_email

dns_soa_email

The SOA email for the zone in punycode format.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The dns_soa_email cannot be updated.

dns_soa_email cannot be written.

dnssec_key_params

dnssec_key_params

This structure contains the DNSSEC key parameters for this zone.

Type

A/An DNSSEC Key parameters struct.

Create

The default value is:

  { 'enable_ksk_auto_rollover': False,
'ksk_algorithm': '8',
'ksk_algorithms': [{ 'algorithm': 'RSASHA256', 'size': 2048}],
'ksk_email_notification_enabled': False,
'ksk_rollover': 31536000,
'ksk_rollover_notification_config': 'REQUIRE_MANUAL_INTERVENTION',
'ksk_size': 2048,
'ksk_snmp_notification_enabled': True,
'next_secure_type': 'NSEC3',
'nsec3_iterations': 10,
'nsec3_salt_max_length': 15,
'nsec3_salt_min_length': 1,
'signature_expiration': 345600,
'zsk_algorithm': '8',
'zsk_algorithms': [{ 'algorithm': 'RSASHA256', 'size': 1024}],
'zsk_rollover': 2592000,
'zsk_rollover_mechanism': 'PRE_PUBLISH',
'zsk_size': 1024}

Search

The field is not available for search.

Notes

dnssec_key_params is associated with the field use_dnssec_key_params (see use flag).

dnssec_keys

dnssec_keys

A list of DNSSEC keys for the zone.

Type

A/An DNSSEC Key struct array.

Create

The default value is:

empty

Search

The field is not available for search.

dnssec_ksk_rollover_date

dnssec_ksk_rollover_date

The rollover date for the Key Signing Key.

Type

Timestamp.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

The dnssec_ksk_rollover_date cannot be updated.

dnssec_ksk_rollover_date cannot be written.

dnssec_zsk_rollover_date

dnssec_zsk_rollover_date

The rollover date for the Zone Signing Key.

Type

Timestamp.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

The dnssec_zsk_rollover_date cannot be updated.

dnssec_zsk_rollover_date cannot be written.

do_host_abstraction

do_host_abstraction

Determines if hosts and bulk hosts are automatically created when the zone data is imported. This field is meaningful only when import_from is set.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

do_host_abstraction is not readable.

effective_check_names_policy

effective_check_names_policy

The value of the check names policy, which indicates the action the appliance takes when it encounters host names that do not comply with the Strict Hostname Checking policy. This value applies only if the host name restriction policy is set to “Strict Hostname Checking”.

Type

String.

Valid values are:
  • FAIL
  • WARN

Create

The default value is WARN.

Search

The field is not available for search.

effective_record_name_policy

effective_record_name_policy

The selected hostname policy for records under this zone.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The effective_record_name_policy cannot be updated.

effective_record_name_policy cannot be written.

extattrs

extattrs

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.

external_primaries

external_primaries

The list of external primary servers.

Type

A/An External Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

external_secondaries

external_secondaries

The list of external secondary servers.

Type

A/An External Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

fqdn

fqdn

The name of this DNS zone. For a reverse zone, this is in “address/cidr” format. For other zones, this is in FQDN format. This value can be in unicode format.

Note that for a reverse zone, the corresponding zone_format value should be set.

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

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The fqdn is part of the base object.

The fqdn cannot be updated.

grid_primary

grid_primary

The grid primary servers for this zone.

Type

A/An Member Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

grid_primary_shared_with_ms_parent_delegation

grid_primary_shared_with_ms_parent_delegation

Determines if the server is duplicated with parent delegation.

Type

Bool.

Search

The field is not available for search.

Notes

The grid_primary_shared_with_ms_parent_delegation cannot be updated.

grid_primary_shared_with_ms_parent_delegation cannot be written.

grid_secondaries

grid_secondaries

The list with Grid members that are secondary servers for this zone.

Type

A/An Member Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

import_from

import_from

The IP address of the Infoblox appliance from which zone data is imported. Setting this address to ‘255.255.255.255’ and do_host_abstraction to ‘true’ will create Host records from A records in this zone without importing zone data.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

Notes

import_from is associated with the field use_import_from (see use flag).

import_from is not readable.

is_dnssec_enabled

is_dnssec_enabled

This flag is set to True if DNSSEC is enabled for the zone.

Type

Bool.

Search

The field is not available for search.

Notes

The is_dnssec_enabled cannot be updated.

is_dnssec_enabled cannot be written.

is_dnssec_signed

is_dnssec_signed

Determines if the zone is DNSSEC signed.

Type

Bool.

Search

The field is not available for search.

Notes

The is_dnssec_signed cannot be updated.

is_dnssec_signed cannot be written.

is_multimaster

is_multimaster

Determines if multi-master DNS is enabled for the zone.

Type

Bool.

Search

The field is not available for search.

Notes

The is_multimaster cannot be updated.

is_multimaster cannot be written.

last_queried

last_queried

The time the zone was last queried on.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_queried cannot be updated.

last_queried cannot be written.

locked

locked

If you enable this flag, other administrators cannot make conflicting changes. This is for administration purposes only. The zone will continue to serve DNS data even when it is locked.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

locked_by

locked_by

The name of a superuser or the administrator who locked this zone.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The locked_by cannot be updated.

locked_by cannot be written.

mask_prefix

mask_prefix

IPv4 Netmask or IPv6 prefix for this zone.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The mask_prefix cannot be updated.

mask_prefix cannot be written.

member_soa_mnames

member_soa_mnames

The list of per-member SOA MNAME information.

Type

A/An Per-master SOA MNAME Information struct array.

Create

The default value is:

empty

Search

The field is not available for search.

member_soa_serials

member_soa_serials

The list of per-member SOA serial information.

Type

A/An Per-master SOA Serial Information struct array.

Search

The field is not available for search.

Notes

The member_soa_serials cannot be updated.

member_soa_serials cannot be written.

ms_ad_integrated

ms_ad_integrated

The flag that determines whether Active Directory is integrated or not. This field is valid only when ms_managed is “STUB”, “AUTH_PRIMARY”, or “AUTH_BOTH”.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

ms_allow_transfer

ms_allow_transfer

The list of DNS clients that are allowed to perform zone transfers from a Microsoft DNS server.

This setting applies only to zones with Microsoft DNS servers that are either primary or secondary servers. This setting does not inherit any value from the Grid or from any member that defines an allow_transfer value. This setting does not apply to any grid member. Use the allow_transfer field to control which DNS clients are allowed to perform zone transfers on Grid members.

Type

A/An Address ac struct array.

Create

The default value is:

empty

Search

The field is not available for search.

ms_allow_transfer_mode

ms_allow_transfer_mode

Determines which DNS clients are allowed to perform zone transfers from a Microsoft DNS server.

Valid values are:

“ADDRESS_AC”, to use ms_allow_transfer field for specifying IP addresses, networks and Transaction Signature (TSIG) keys for clients that are allowed to do zone transfers.

“ANY”, to allow any client.

“ANY_NS”, to allow only the nameservers listed in this zone.

“NONE”, to deny all zone transfer requests.

Type

String.

Valid values are:
  • ADDRESS_AC
  • ANY
  • ANY_NS
  • NONE

Create

The default value is NONE.

Search

The field is not available for search.

ms_dc_ns_record_creation

ms_dc_ns_record_creation

The list of domain controllers that are allowed to create NS records for authoritative zones.

Type

A/An An Infoblox Active Directory Domain Controller object struct array.

The field also supports automatic selection of the domain controllers list based on the specified Auth Zone or MS Server. You can specify the source object in the following ways:

Using the IP addresses of all MS Servers belonging to the same Active Directory domain as the MS Server which is specified by reference or address:

  • func:getdcnsrecordcreationlist:SERVERS_IN_DOMAIN,<reference>
  • func:getdcnsrecordcreationlist:SERVERS_IN_DOMAIN,<address>

Using the list from an existing Active Directory zone which is specified by reference or fqdn/view (optional, if the view is not specified, the default view will be used):

  • func:getdcnsrecordcreationlist:ZONE,<reference>
  • func:getdcnsrecordcreationlist:ZONE,<fqdn>[,<view>]

NOTE: Automatic selection is supported only for JSON and XML requests.

Examples:

  • func:getdcnsrecordcreationlist:SERVERS_IN_DOMAIN,msserver/ZG54dfgsrDEFfsfsLzA:10.0.0.1
  • func:getdcnsrecordcreationlist:SERVERS_IN_DOMAIN,10.0.0.1
  • func:getdcnsrecordcreationlist:ZONE,auth_zone/ZG54dfgsrDEFfsfsLzA:zone.com/default
  • func:getdcnsrecordcreationlist:ZONE,zone.com,external

Create

The default value is:

empty

Search

The field is not available for search.

ms_ddns_mode

ms_ddns_mode

Determines whether an Active Directory-integrated zone with a Microsoft DNS server as primary allows dynamic updates. Valid values are:

“SECURE” if the zone allows secure updates only.

“NONE” if the zone forbids dynamic updates.

“ANY” if the zone accepts both secure and nonsecure updates.

This field is valid only if ms_managed is either “AUTH_PRIMARY” or “AUTH_BOTH”. If the flag ms_ad_integrated is false, the value “SECURE” is not allowed.

Type

String.

Valid values are:
  • ANY
  • NONE
  • SECURE

Create

The default value is NONE.

Search

The field is not available for search.

ms_managed

ms_managed

The flag that indicates whether the zone is assigned to a Microsoft DNS server. This flag returns the authoritative name server type of the Microsoft DNS server. Valid values are:

“NONE” if the zone is not assigned to any Microsoft DNS server.

“STUB” if the zone is assigned to a Microsoft DNS server as a stub zone.

“AUTH_PRIMARY” if only the primary server of the zone is a Microsoft DNS server.

“AUTH_SECONDARY” if only the secondary server of the zone is a Microsoft DNS server.

“AUTH_BOTH” if both the primary and secondary servers of the zone are Microsoft DNS servers.

Type

String.

Valid values are:
  • AUTH_BOTH
  • AUTH_PRIMARY
  • AUTH_SECONDARY
  • NONE
  • STUB

Search

The field is not available for search.

Notes

The ms_managed cannot be updated.

ms_managed cannot be written.

ms_primaries

ms_primaries

The list with the Microsoft DNS servers that are primary servers for the zone. Although a zone typically has just one primary name server, you can specify up to ten independent servers for a single zone.

Type

A/An Msserver Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

ms_read_only

ms_read_only

Determines if a Grid member manages the zone served by a Microsoft DNS server in read-only mode. This flag is true when a Grid member manages the zone in read-only mode, false otherwise.

When the zone has the ms_read_only flag set to True, no changes can be made to this zone.

Type

Bool.

Search

The field is not available for search.

Notes

The ms_read_only cannot be updated.

ms_read_only cannot be written.

ms_secondaries

ms_secondaries

The list with the Microsoft DNS servers that are secondary servers for the zone.

Type

A/An Msserver Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

ms_sync_disabled

ms_sync_disabled

This flag controls whether this zone is synchronized with Microsoft DNS servers.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

ms_sync_master_name

ms_sync_master_name

The name of MS synchronization master for this zone.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The ms_sync_master_name cannot be updated.

ms_sync_master_name cannot be written.

network_associations

network_associations

The list with the associated network/network container information.

Type

An array of the following objects: network, networkcontainer, ipv6network, ipv6networkcontainer.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The network_associations cannot be updated.

network_associations cannot be written.

network_view

network_view

The name of the network view in which this zone resides.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The network_view cannot be updated.

network_view cannot be written.

notify_delay

notify_delay

The number of seconds in delay with which notify messages are sent to secondaries.

Type

Unsigned integer.

Create

The default value is 5.

Search

The field is not available for search.

Notes

notify_delay is associated with the field use_notify_delay (see use flag).

ns_group

ns_group

The name server group that serves DNS for this zone.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

parent

parent

The parent zone of this zone.

Note that when searching for reverse zones, the “in-addr.arpa” notation should be used.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The parent cannot be updated.

parent cannot be written.

prefix

prefix

The RFC2317 prefix value of this DNS zone.

Use this field only when the netmask is greater than 24 bits; that is, for a mask between 25 and 31 bits. Enter a prefix, such as the name of the allocated address block. The prefix can be alphanumeric characters, such as 128/26 , 128-189 , or sub-B.

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 not available for search.

primary_type

primary_type

The type of the primary server.

Type

String.

Valid values are:
  • External
  • Grid
  • Microsoft
  • None

Search

The field is not available for search.

Notes

The primary_type cannot be updated.

primary_type cannot be written.

record_name_policy

record_name_policy

The hostname policy for records under this zone.

Type

String.

Create

The default value is empty.

Search

The field is not available for search.

Notes

record_name_policy is associated with the field use_record_name_policy (see use flag).

records_monitored

records_monitored

Determines if this zone is also monitoring resource records.

Type

Bool.

Search

The field is not available for search.

Notes

The records_monitored cannot be updated.

records_monitored cannot be written.

restart_if_needed

restart_if_needed

Restarts the member service.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

restart_if_needed is not readable.

rr_not_queried_enabled_time

rr_not_queried_enabled_time

The time data collection for Not Queried Resource Record was enabled for this zone.

Type

Timestamp.

Search

The field is not available for search.

Notes

The rr_not_queried_enabled_time cannot be updated.

rr_not_queried_enabled_time cannot be written.

scavenging_settings

scavenging_settings

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).

set_soa_serial_number

set_soa_serial_number

The serial number in the SOA record incrementally changes every time the record is modified. The Infoblox appliance allows you to change the serial number (in the SOA record) for the primary server so it is higher than the secondary server, thereby ensuring zone transfers come from the primary server (as they should). To change the serial number you need to set a new value at “soa_serial_number” and pass “set_soa_serial_number” as True.

Type

Bool.

Create

The default value is empty.

Search

The field is not available for search.

Notes

set_soa_serial_number is not readable.

soa_default_ttl

soa_default_ttl

The Time to Live (TTL) value of the SOA record of this zone. This value is the number of seconds that data is cached.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Notes

soa_default_ttl is associated with the field use_grid_zone_timer (see use flag).

soa_email

soa_email

The SOA email value for this zone. This value can be in unicode format.

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 not available for search.

Notes

soa_email is associated with the field use_soa_email (see use flag).

soa_expire

soa_expire

This setting defines the amount of time, in seconds, after which the secondary server stops giving out answers about the zone because the zone data is too old to be useful. The default is one week.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Notes

soa_expire is associated with the field use_grid_zone_timer (see use flag).

soa_negative_ttl

soa_negative_ttl

The negative Time to Live (TTL) value of the SOA of the zone indicates how long a secondary server can cache data for “Does Not Respond” responses.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Notes

soa_negative_ttl is associated with the field use_grid_zone_timer (see use flag).

soa_refresh

soa_refresh

This indicates the interval at which a secondary server sends a message to the primary server for a zone to check that its data is current, and retrieve fresh data if it is not.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Notes

soa_refresh is associated with the field use_grid_zone_timer (see use flag).

soa_retry

soa_retry

This indicates how long a secondary server must wait before attempting to recontact the primary server after a connection failure between the two servers occurs.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

Notes

soa_retry is associated with the field use_grid_zone_timer (see use flag).

soa_serial_number

soa_serial_number

The serial number in the SOA record incrementally changes every time the record is modified. The Infoblox appliance allows you to change the serial number (in the SOA record) for the primary server so it is higher than the secondary server, thereby ensuring zone transfers come from the primary server (as they should). To change the serial number you need to set a new value at “soa_serial_number” and pass “set_soa_serial_number” as True.

Type

Unsigned integer.

Create

The default value is empty.

Search

The field is not available for search.

srgs

srgs

The associated shared record groups of a DNS zone.

If a shared record group is associated with a zone, then all shared records in a shared record group will be shared in the zone.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

update_forwarding

update_forwarding

Use this field to allow or deny dynamic DNS updates that are forwarded from specific IPv4/IPv6 addresses, networks, or a named ACL. You can also provide TSIG keys for clients that are allowed or denied to perform zone updates. This setting overrides the member-level setting.

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.

use_allow_active_dir

use_allow_active_dir

Use flag for: allow_active_dir

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_allow_query

use_allow_query

Use flag for: allow_query

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_allow_transfer

use_allow_transfer

Use flag for: allow_transfer

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_allow_update

use_allow_update

Use flag for: allow_update

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_allow_update_forwarding

use_allow_update_forwarding

Use flag for: allow_update_forwarding

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_check_names_policy

use_check_names_policy

Apply policy to dynamic updates and inbound zone transfers (This value applies only if the host name restriction policy is set to “Strict Hostname Checking”.)

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_copy_xfer_to_notify

use_copy_xfer_to_notify

Use flag for: copy_xfer_to_notify

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ddns_force_creation_timestamp_update

use_ddns_force_creation_timestamp_update

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_ddns_patterns_restriction

use_ddns_patterns_restriction

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_ddns_principal_security

use_ddns_principal_security

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_ddns_restrict_protected

use_ddns_restrict_protected

Use flag for: ddns_restrict_protected

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_ddns_restrict_static

use_ddns_restrict_static

Use flag for: ddns_restrict_static

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_dnssec_key_params

use_dnssec_key_params

Use flag for: dnssec_key_params

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_external_primary

use_external_primary

This flag controls whether the zone is using an external primary.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_grid_zone_timer

use_grid_zone_timer

Use flag for: soa_default_ttl , soa_expire, soa_negative_ttl, soa_refresh, soa_retry

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_import_from

use_import_from

Use flag for: import_from

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_notify_delay

use_notify_delay

Use flag for: notify_delay

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_record_name_policy

use_record_name_policy

Use flag for: record_name_policy

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_scavenging_settings

use_scavenging_settings

Use flag for: scavenging_settings

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_soa_email

use_soa_email

Use flag for: soa_email

Type

Bool.

Create

The default value is None.

Search

The field is not available for search.

using_srg_associations

using_srg_associations

This is true if the zone is associated with a shared record group.

Type

Bool.

Search

The field is not available for search.

Notes

The using_srg_associations cannot be updated.

using_srg_associations cannot be written.

view

view

The name of the DNS view in which the zone resides. Example “external”.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is The default DNS view.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The view is part of the base object.

zone_format

zone_format

Determines the format of this zone.

Type

String.

Valid values are:
  • FORWARD
  • IPV4
  • IPV6

Create

The default value is FORWARD.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The zone_format cannot be updated.

zone_not_queried_enabled_time

zone_not_queried_enabled_time

The time when “DNS Zones Last Queried” was turned on for this zone.

Type

Timestamp.

Search

The field is not available for search.

Notes

The zone_not_queried_enabled_time cannot be updated.

zone_not_queried_enabled_time cannot be written.

Function Calls

copyzonerecords

This function is used to copy records from this zone to another authoritative zone.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

clear_destination_first ( Bool. ) Determines whether the records in destination zone are removed before copying. The default value is “False”.

destination_zone ( String. ). This parameter is mandatory. The destination DNS zone.

replace_existing_records ( Bool. ) Determines whether the records in destination zone are replaced by copying records. The default value is “False”.

select_records ( String. Valid values are: “A”, “AAAA”, “CNAME”, “MX”, “PTR”, “SRV”, “TLSA”, “TXT”, “HOST”, “BULK_HOST”, “DNAME”, “NAPTR”, “CAA”, “Unknown” ) The types of records that should be copied. Omit this parameter to copy all records.

Output fields

None

dnssec_export

This function is used to download DNSSEC zone DS and DNSKEY records and trust anchors for this particular zone from the appliance.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

operation ( String. Valid values are: “EXPORT_DS”, “EXPORT_ANCHORS”, “EXPORT_DNSKEY” ). This parameter is mandatory. Export operation.

Output fields

token ( String. ) The token used for calling the downloadcomplete function.

url ( String. ) For local (not remote) uploads, the URL from which the requested file is downloaded.

dnssec_get_zone_keys

This function is used to download DNSSEC zone keys for this particular zone from the appliance.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

key_pair_type ( String. Valid values are: “KSK”, “ZSK” ). This parameter is mandatory. Key pair to export.

Output fields

token ( String. ) The token used for calling the downloadcomplete function.

url ( String. ) For local (not remote) uploads, the URL from which the requested file is downloaded.

dnssec_operation

This function performs DNSSEC operations on the zone.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

buffer ( String. ) This field contains the imported KSK or DS record. The value must be a KSK or DS record, and it must belong to an immediate subzone of the zone to which the record is being imported. For more information, refer to the “DS Resource Records” section in the Infoblox NIOS Administrator Guide.”

operation ( String. Valid values are: “IMPORT_DS”, “ROLLOVER_KSK”, “SIGN”, “UNSIGN”, “ROLLOVER_ZSK”, “RESIGN” ). This parameter is mandatory. The DNSSEC operation to perform. When importing a keyset via “IMPORT_DS” the buffer field is mandatory; otherwise, it is ignored.

Output fields

None

dnssec_set_zone_keys

This function is used to upload DNSSEC zone keys for this particular zone.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

key_pair_type ( String. Valid values are: “KSK”, “ZSK” ). This parameter is mandatory. Key pair to import.

token ( String. ). This parameter is mandatory. The token returned by the uploadinit function call.

Output fields

None

dnssecgetkskrollover

This function is used to get the KSK rollover information.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

num_days_to_countdown ( Unsigned integer. ) The number of days since the warning has been sent and before the rollover period expires. The default value is “7”.

Output fields

zones ( A/An The zone rollover information structure struct array. ) The list of rollover information per zone.

execute_dns_parent_check

This function executes a check for DNS records from parent domain name servers for the zone.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

None

Output fields

None

lock_unlock_zone

This function is used to lock or unlock a zone to prevent other administrators from making conflicting changes.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

operation ( String. Valid values are: “LOCK”, “UNLOCK” ). This parameter is mandatory. The operation to perform.

Output fields

None

run_scavenging

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

Fields List

Field Type Req R/O Base Search
address String N Y N N/A
allow_active_dir [struct] N N N N/A
allow_fixed_rrset_order Bool N N N N/A
allow_gss_tsig_for_underscore_zone Bool N N N N/A
allow_gss_tsig_zone_updates Bool N N N N/A
allow_query [struct] N N N N/A
allow_transfer [struct] N N N N/A
allow_update [struct] N N N N/A
allow_update_forwarding Bool N N N N/A
aws_rte53_zone_info struct N Y N N/A
cloud_info struct N Y N N/A
comment String N N N : = ~
copy_xfer_to_notify Bool N N N N/A
create_ptr_for_bulk_hosts Bool N N N N/A
create_ptr_for_hosts Bool N N N N/A
create_underscore_zones Bool 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
disable_forwarding Bool N N N N/A
display_domain String N Y N N/A
dns_fqdn String N Y N N/A
dns_integrity_enable Bool N N N N/A
dns_integrity_frequency Unsigned int N N N N/A
dns_integrity_member String N N N N/A
dns_integrity_verbose_logging Bool N N N N/A
dns_soa_email String N Y N N/A
dnssec_key_params struct N N N N/A
dnssec_keys [struct] N N N N/A
dnssec_ksk_rollover_date Timestamp N Y N < = >
dnssec_zsk_rollover_date Timestamp N Y N < = >
do_host_abstraction Bool N N N N/A
effective_check_names_policy String N N N N/A
effective_record_name_policy String N Y N N/A
extattrs Extattr N N N ext
external_primaries [struct] N N N N/A
external_secondaries [struct] N N N N/A
fqdn String Y N Y = ~
grid_primary [struct] N N N N/A
grid_primary_shared_with_ms_parent_delegation Bool N Y N N/A
grid_secondaries [struct] N N N N/A
import_from String N N N N/A
is_dnssec_enabled Bool N Y N N/A
is_dnssec_signed Bool N Y N N/A
is_multimaster Bool N Y N N/A
last_queried Timestamp N Y N N/A
locked Bool N N N N/A
locked_by String N Y N N/A
mask_prefix String N Y N N/A
member_soa_mnames [struct] N N N N/A
member_soa_serials [struct] N Y N N/A
ms_ad_integrated Bool N N N N/A
ms_allow_transfer [struct] N N N N/A
ms_allow_transfer_mode String N N N N/A
ms_dc_ns_record_creation [struct] N N N N/A
ms_ddns_mode String N N N N/A
ms_managed String N Y N N/A
ms_primaries [struct] N N N N/A
ms_read_only Bool N Y N N/A
ms_secondaries [struct] N N N N/A
ms_sync_disabled Bool N N N N/A
ms_sync_master_name String N Y N N/A
network_associations obj N Y N N/A
network_view String N Y N N/A
notify_delay Unsigned int N N N N/A
ns_group String N N N N/A
parent String N Y N =
prefix String N N N N/A
primary_type String N Y N N/A
record_name_policy String N N N N/A
records_monitored Bool N Y N N/A
restart_if_needed Bool N N N N/A
rr_not_queried_enabled_time Timestamp N Y N N/A
scavenging_settings struct N N N N/A
set_soa_serial_number Bool N N N N/A
soa_default_ttl Unsigned int N N N N/A
soa_email String N N N N/A
soa_expire Unsigned int N N N N/A
soa_negative_ttl Unsigned int N N N N/A
soa_refresh Unsigned int N N N N/A
soa_retry Unsigned int N N N N/A
soa_serial_number Unsigned int N N N N/A
srgs [String] N N N N/A
update_forwarding [struct] N N N N/A
use_allow_active_dir Bool N N N N/A
use_allow_query Bool N N N N/A
use_allow_transfer Bool N N N N/A
use_allow_update Bool N N N N/A
use_allow_update_forwarding Bool N N N N/A
use_check_names_policy Bool N N N N/A
use_copy_xfer_to_notify 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_dnssec_key_params Bool N N N N/A
use_external_primary Bool N N N N/A
use_grid_zone_timer Bool N N N N/A
use_import_from Bool N N N N/A
use_notify_delay Bool N N N N/A
use_record_name_policy Bool N N N N/A
use_scavenging_settings Bool N N N N/A
use_soa_email Bool N N N N/A
using_srg_associations Bool N Y N N/A
view String N N Y =
zone_format String N N N =
zone_not_queried_enabled_time Timestamp N Y N N/A

Table Of Contents

Previous topic

vlanview : VLAN View object.

Next topic

zone_auth_discrepancy : Zone discrepancy information object.