nsgroup : DNS name server group object.

A name server group is a collection of one or more primary DNS servers and one or more secondary DNS servers. Grouping a commonly used set of primary and secondary DNS servers together simplifies zone creation, allowing you to specify a single name server group instead of specifying multiple name servers individually.

Object Reference

References to nsgroup are object references.

The name part of the name server group object reference has the following components:

  • Name of the name server group

Example: nsgroup/ZG5zLmJpbmRfY25h:nsgroup1

Restrictions

The object does not support the following operations:

  • Scheduling
  • CSV export

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

The following fields are required to create this object:

Field Notes
name  

comment

comment

Comment for the name server group; 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)

Notes

The comment is part of the base object.

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.

grid_primary

grid_primary

The grid primary servers for this group.

Type

A/An Member Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

grid_secondaries

grid_secondaries

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

Type

A/An Member Server struct array.

Create

The default value is:

empty

Search

The field is not available for search.

is_grid_default

is_grid_default

Determines if this name server group is the Grid default.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

is_multimaster

is_multimaster

Determines if the “multiple DNS primaries” feature is enabled for the group.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Notes

The is_multimaster cannot be updated.

name

name

The name of this name server group.

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.

use_external_primary

use_external_primary

This flag controls whether the group is using an external primary. Note that modification of this field requires passing values for “grid_secondaries” and “external_primaries”.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
comment String N N Y : = ~
extattrs Extattr N N N ext
external_primaries [struct] N N N N/A
external_secondaries [struct] N N N N/A
grid_primary [struct] N N N N/A
grid_secondaries [struct] N N N N/A
is_grid_default Bool N N N N/A
is_multimaster Bool N N N N/A
name String Y N Y : = ~
use_external_primary Bool N N N N/A