zone_forward : DNS Forward Zone object.

When you want to forward queries for data in a particular zone, define the zone as a forward zone and specify one or more name servers that can resolve queries for the zone. For example, define a forward zone so that the NIOS appliance forwards queries about a partners internal site to a name server, which the partner hosts, configured just for other partners to access.

Object Reference

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

  • FQDN of the zone
  • Name of the view

Example: zone_forward/ZG5zLmhvc3QkLZhd3QuaDE:zone.com/default

Restrictions

The object does not support the following operations:

The object cannot be managed on Cloud Platform members.

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

The following fields are required to create this object:

Field Notes
forward_to  
fqdn  

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.

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)

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_ns_generation

disable_ns_generation

Determines whether a auto-generation of NS records in parent zone is disabled or not. When this is set to False, the auto-generation is enabled.

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.

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_ns_group

external_ns_group

A forward stub server name server group.

Type

String.

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

Create

The default value is undefined.

Search

The field is not available for search.

forward_to

forward_to

The information for the remote name servers to which you want the Infoblox appliance to forward queries for a specified domain name.

Type

A/An External Server struct array.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

The forward_to is part of the base object.

forwarders_only

forwarders_only

Determines if the appliance sends queries to forwarders only, and not to other internal or Internet root servers.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

forwarding_servers

forwarding_servers

The information for the Grid members to which you want the Infoblox appliance to forward queries for a specified domain name.

Type

A/An Forwarding Member 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.

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.

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

ns_group

ns_group

A forwarding member name server group.

Type

String.

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

Create

The default value is undefined.

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.

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.

Function Calls

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

Fields List

Field Type Req R/O Base Search
address String N Y N N/A
comment String N N N : = ~
disable Bool N N N N/A
disable_ns_generation Bool N N N N/A
display_domain String N Y N N/A
dns_fqdn String N Y N N/A
extattrs Extattr N N N ext
external_ns_group String N N N N/A
forward_to [struct] Y N Y N/A
forwarders_only Bool N N N N/A
forwarding_servers [struct] N N N N/A
fqdn String Y N Y = ~
locked Bool N N N N/A
locked_by String N Y N N/A
mask_prefix String N Y N N/A
ms_ad_integrated Bool N N N N/A
ms_ddns_mode String N N N N/A
ms_managed String N Y N N/A
ms_read_only Bool N Y N N/A
ms_sync_master_name String N Y N N/A
ns_group String N N N N/A
parent String N Y N =
prefix String 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 =