/
authzones (dnsconfig)
Document toolboxDocument toolbox

authzones (dnsconfig)

Owned by Sri Raghu
Last updated: Sept 17, 2024
3 min read

Mandatory parameters are denoted by an * (asterisk).

header

type

description

required

encoding

sample

object_headers

 

 

 

 

 

 

 

 

 

header

type

description

required

encoding

sample

object_headers

 

 

 

 

 

 

 

 

 

HEADER-dnsconfig-v2-authzone*

string

The primary identifier of the header stating the type of object.

TRUE

string

 

 

 

 

 

 

 

 

 

 

 

key*

string

The primary identifier of an individual object.
For DNS Auth Zone, a combination of view name and authzone fqdn is used as the key.
Example: viewnew,prizone.site.

TRUE

string

 

 

 

 

 

 

 

 

 

 

 

fqdn*

string

The FQDN supplied at creation will be converted to the canonical form. Read-only after creation.

TRUE

string

 

 

 

 

 

 

 

 

 

 

 

comment

string

The comment for a zone configuration.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

disabled

boolean

Set this field to disable the object.
While a configuration is generated, a disabled object is effectively non-existent.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

transfer_acl

array

To receive zone transfers, clients must match the ACL.

FALSE

nios

 

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

 

external_primaries

array

DNS primaries external to Universal DDI. The order is not significant.

FALSE

nios

 

fqdn

address

tsig_enabled

type

nsg

tsig_key

tsig_key_name

tsig_key_algorithm

tsig_key_secret

tsig_key_comment

internal_secondaries

array

Universal DDI hosts acting as internal secondaries. The order is not significant.

FALSE

stringarray

 

 

 

 

 

 

 

 

 

 

 

nsgs

array

Authoritative DNS Server Groups. The order is not significant.

FALSE

stringarray

 

 

 

 

 

 

 

 

 

 

 

transfer_acl_action

string

The configuration of inheritance for the transfer_acl field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

query_acl_action

string

The configuration of inheritance for the query_acl field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

update_acl_action

string

The configuration of inheritance for the update_acl field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

use_forwarders_for_subzones_action

string

The configuration of inheritance for the use_forwarders_for_subzones field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

refresh_action

string

The configuration of inheritance for the refresh field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

retry_action

string

The configuration of inheritance for the retry field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

expire_action

string

The configuration of inheritance for the expire field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

default_ttl_action

string

The configuration of inheritance for the default_ttl field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

negative_ttl_action

string

The configuration of inheritance for the negative_ttl field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

rname_action

string

The configuration of inheritance for the rname field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

protocol_rname_action

string

The configuration of inheritance for the protocol_rname field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

mname_block_action

string

The configuration of inheritance for the mname_block field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

notify_action

string

The configuration of inheritance for the notify field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

gss_tsig_enabled_action

string

The configuration of inheritance for the gss_tsig_enabled field from an AuthZone object.

FALSE

string

inherit

 

 

 

 

 

 

 

 

 

 

tags

string

The tags for the DNS AuthZone, in JSON format.

FALSE

expandtags

 

 

 

 

 

 

 

 

 

 

 

view*

string

Parent DNS view. Read-only after creation.

TRUE

string

default

 

 

 

 

 

 

 

 

 

 

primary_type*

string

Primary type for an authoritative zone. Read-only after creation. Allowed values:* external: zone data is owned by an external nameserver,* cloud: zone data is owned by a Universal DDI host.

TRUE

string

 

 

 

 

 

 

 

 

 

 

 

query_acl

array

To make authoritative queries, clients must match this ACL. Also used for recursive queries, if that ACL is unset.

FALSE

nios

 

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

 

update_acl

array

Specifies which hosts are allowed to submit Dynamic DNS updates for authoritative zones of the primary_type cloud.

FALSE

nios

 

element

access

address

acl

tsig_key

tsig_name

tsig_comment

tsig_algorithm

tsig_secret

 

use_forwarders_for_subzones

boolean

Use default forwarders to resolve queries for subzones.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

refresh

integer

ZoneAuthority refresh.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

retry

integer

ZoneAuthority retry.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

expire

integer

ZoneAuthority expiration time, in seconds.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

default_ttl

integer

ZoneAuthority default TTL (in seconds) for resource records in the zone.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

negative_ttl

integer

ZoneAuthority negative caching (minimum) TTL, in seconds.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

rname

string

ZoneAuthority rname.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

mname

string

ZoneAuthority master nameserver (partially qualified domain name).

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

use_default_mname

boolean

Use the default value for the master nameserver.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

initial_soa_serial

integer

On-create-only. SOA serial may be set when the authoritative zone is created.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

external_secondaries

array

DNS secondaries external to Universal DDI. The order is not significant.

FALSE

nios

 

fqdn

protocol_fqdn

address

tsig_enabled

tsig_key

tsig_key_name

tsig_key_algorithm

tsig_key_secret

tsig_key_comment

stealth

notify

boolean

If enabled, it notifies all external secondary DNS servers.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

gss_tsig_enabled

boolean

Enables or disables GSS-TSIG signed dynamic updates.

FALSE

string

 

 

 

 

 

 

 

 

 

 

 

access_view

string

Contains the name of the access view that the object belongs to. If you have used compartment_id, modify the field name to access_view before importing data into the Infoblox Portal.

FALSE

string

marketing