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

cluster-identity-get cluster-identity-modify cluster-node-get cluster-node-get-iter cluster-node-modify | This set of APIs allows managing the cluster and its attributes.

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

cluster-node-get | [top]

> Returns information about a node in a cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | cluster-node-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.
> node-name |  | node-name | The textual name of a node.
> Output Name | Range | Type | Description
> attributes |  | cluster-node-info | The attributes of the cluster.

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

cluster-node-get-iter | [top]

> Returns information about nodes in a cluster.

> Input Name | Range | Type | Description
> desired-attributes |  | cluster-node-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.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | cluster-node-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the cluster object. All cluster objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | cluster-node-info[] optional | The list of attributes of cluster objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more cluster objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

cluster-node-modify | [top]

> Modifies state of a node in a cluster.

> Input Name | Range | Type | Description
> is-node-eligible |  | boolean optional | This parameter states nodes that are eligible to participate in the cluster. A boolean value of true means the node is eligible.
> is-node-epsilon |  | boolean optional | You can designate a node as epsilon to add weight to its voting in a cluster with an even number of nodes. In a cluster, only one node can be designated as epsilon at any given time. A boolean value of true means the node is epsilon.
> node-name |  | node-name | The textual name of a node.

> 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, that designates the cluster forever, assigned during cluster creation Attributes: non-creatable, non-modifiable
> rdb-uuid |  | uuid optional | The 128-bit universally-unique identifier for the RDB Attributes: non-creatable, non-modifiable

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

> Information that identifies state of nodes in a 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
> is-node-eligible |  | boolean optional | This parameter states nodes that are eligible to participate in the cluster. A boolean value of true means the node is eligible. Attributes: non-creatable, modifiable
> is-node-epsilon |  | boolean optional | You can designate a node as epsilon to add weight to its voting in a cluster with an even number of nodes. In a cluster, only one node can be designated as epsilon at any given time. A boolean value of true means the node is epsilon. Attributes: non-creatable, modifiable
> is-node-healthy |  | boolean optional | This parameter is used to determine health of a node in a cluster. A boolean value of true means the node is healthy. Attributes: non-creatable, non-modifiable
> node-name |  | node-name optional | The textual name of a node. Attributes: key, non-creatable, non-modifiable
> node-uuid |  | uuid optional | The 128-bit universally-unique identifier, that designates a node forever, assigned during node creation. Attributes: non-creatable, non-modifiable

Element definition: node-name | [top]

> The node's name

> [none]

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]