APIs in Category: cluster | Cluster-Mode API version 1.15

cluster-identity-get cluster-identity-modify | This set of APIs allow managing the cluster and its attributes including the name and serial number.

NetApp Manage ONTAP

cluster-identity-get | [top]

> Returns the cluster identity information.

> Input Name | Range | Type | Description
> desired-attributes |  | cluster-identity-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> Output Name | Range | Type | Description
> attributes |  | cluster-identity-info | The attributes of the cluster.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

cluster-identity-modify | [top]

> Modifies the cluster identity information.

> Input Name | Range | Type | Description
> cluster-contact |  | string optional | The contact information for the cluster
> cluster-location |  | string optional | The location of the cluster
> cluster-name |  | string optional | The textual name of the cluster

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

Element definition: cluster-identity-info | [top]

> Information that identifies a given cluster. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> cluster-contact |  | string optional | The contact information for the cluster Attributes: non-creatable, modifiable
> cluster-location |  | string optional | The location of the cluster Attributes: non-creatable, modifiable
> cluster-name |  | string optional | The textual name of the cluster Attributes: non-creatable, modifiable
> cluster-serial-number |  | cluster-serial-number optional | Serial number of the cluster in the form x-xx-xxxxxx Attributes: non-creatable, non-modifiable
> cluster-uuid |  | uuid optional | The 128-bit universally-unique identifier assigned during cluster creation Attributes: non-creatable, non-modifiable

Element definition: cluster-serial-number | [top]

> Assigned Cluster serial-number during cluster create

> [none]

Element definition: uuid | [top]

> The 128-bit universally-unique identifier (UUID). UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

> [none]