record:ns : DNS NS record object.

A DNS NS record identifies an authoritative DNS server for a domain. Each authoritative DNS server must have an NS record. The appliance automatically creates an NS record when you assign a grid member as the primary server for a zone. You can manually create NS records for other zones.

Object Reference

References to record:ns are object references. The name part of a NS record object reference has the following components:

  • Name of the authoritative server
  • Name of the record
  • Name of the view

Example: record:ns/ZG5zLmhvc3RjkuMC4xLg:ns1.server.com/some.name.com/default

Restrictions

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

The following fields are required to create this object:

Field Notes
addresses  
name  
nameserver  

addresses

addresses

The list of zone name servers.

Type

A/An Zone Name Server struct array.

Create

The field is required on creation.

Search

The field is not available for search.

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.

creator

creator

The record creator.

Type

String.

Valid values are:
  • STATIC
  • SYSTEM

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The creator cannot be updated.

creator cannot be written.

dns_name

dns_name

The name of the NS record 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_name cannot be updated.

dns_name cannot be written.

last_queried

last_queried

The time of the last DNS query in Epoch seconds format.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_queried cannot be updated.

last_queried cannot be written.

ms_delegation_name

ms_delegation_name

The MS delegation point name.

Type

String.

Create

The default value is Empty string.

Search

The field is not available for search.

name

name

The name of the NS record in FQDN format. This value can be in unicode format.

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

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

Notes

The name is part of the base object.

The name cannot be updated.

nameserver

nameserver

The domain name of an authoritative server for the redirected zone.

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

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

Notes

The nameserver is part of the base object.

policy

policy

The host name policy for the record.

Type

String.

Search

The field is not available for search.

Notes

The policy cannot be updated.

policy cannot be written.

view

view

The name of the DNS view in which the record 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.

The view cannot be updated.

zone

zone

The name of the zone in which the record resides. Example: “zone.com”. If a view is not specified when searching by zone, the default view is 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 zone cannot be updated.

zone cannot be written.

Fields List

Field Type Req R/O Base Search
addresses [struct] Y N N N/A
cloud_info struct N Y N N/A
creator String N Y N =
dns_name String N Y N N/A
last_queried Timestamp N Y N N/A
ms_delegation_name String N N N N/A
name String Y N Y : = ~
nameserver String Y N Y : = ~
policy String N Y N N/A
view String N N Y =
zone String N Y N =