The cluster object contains information that the node uses to communicate with the cluster. You can retrieve this information with the GetClusterConfig API method.
This object contains the following members:
Name | Description | Type |
---|---|---|
cipi | Network interface used for cluster communication. | string |
cluster | Unique cluster name. | string |
encryptionCapable | Indicates if the node supports drive encryption. | boolean |
ensemble | The nodes that are participating in the cluster. | string array |
mipi | The network interface used for node management. | string |
name | The cluster name. | string |
nodeID | The node ID of the node in the cluster. | string |
pendingNodeID | The ID of the pending node in the cluster. | integer |
role | Identifies the role of the node. | integer |
sipi | The network interface used for storage traffic. | string |
state | The current state of the node. Possible values:
|
string |
version | The version of software running on the node. | string |
This table indicates whether or not the object parameters can be modified at each possible node state.
Parameter name | Available state | Pending state | Active state |
---|---|---|---|
cipi | No | No | No |
cluster | Yes | Yes | No |
encryptionCapable | No | No | No |
ensemble | No | No | No |
mipi | Yes | Yes | No |
name | Yes | Yes | Yes |
nodeID | No | No | No |
pendingNodeID | No | No | No |
role | No | No | No |
sipi | No | No | No |
state | No | No | No |
version | No | No | No |