ddns:principalcluster:group : DDNS Principal Cluster Group object.

The DDNS Principal Cluster Group object represents a set of DDNS Principal Clusters. A single group can be active at any time.

Object Reference

References to ddns:principalcluster:group are object references.

The name part of the DDNS Principal Cluster Group object reference has the following components:

  • Name of the DDNS Principal Cluster Group

Example: ddns:principalcluster:group/ZG5zLmJpbmRfY25h:group1

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

The following fields are required to create this object:

Field Notes
name  

clusters

clusters

The list of equivalent DDNS principal clusters.

Type

A/An ddns:principalcluster object array.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The clusters cannot be updated.

clusters cannot be written.

comment

comment

Comment for the DDNS Principal Cluster Group.

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.

name

name

The name of this DDNS Principal Cluster 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.

Fields List

Field Type Req R/O Base Search
clusters [obj] N Y N N/A
comment String N N Y : = ~
name String Y N Y : = ~