| getclusternodeResult Structure Definition |
The getclusternodeResult structure defines the return type for getclusternode API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
clusternodeList |
List of clusternodes |
| clusternode Structure Definition |
The clusternode structure defines the actual return type values for getclusternode API. |
Syntax |
Members |
nodeid |
ID of the cluster node for which to display information. |
ipaddress |
The IP Address of the node. |
clusterhealth |
Node clusterd state. |
effectivestate |
Node effective health state. |
operationalsyncstate |
Node Operational Reconciliation state. |
syncfailurereason |
Displays the additional information along with cluster sync status |
masterstate |
Node Master state. |
health |
Node Health state. |
state |
Active, Spare or Passive. |
backplane |
Interface through which the node communicates with the other nodes in the cluster. Must be specified in the three-tuple form n/c/u, where n represents the node ID and c/u refers to the interface on the appliance. |
syncstate |
Enable/Disable the synchronization of cluster configurations on the node. |
priority |
Preference for selecting a node as the configuration coordinator. The node with the lowest priority value is selected as the configuration coordinator.
When the current configuration coordinator goes down, the node with the next lowest priority is made the new configuration coordinator. When the original node comes back up, it will preempt the new configuration coordinator and take over as the configuration coordinator.
Note: When priority is not configured for any of the nodes or if multiple nodes have the same priority, the cluster elects one of the nodes as the configuration coordinator. |
nodelist |
Nodelist for displaying Heartbeat not seen interfaces on a cluster node |
ifaceslist |
Interface list corresponding to nodelist for Heartbeat not seen interfaces on a cluster node |
enabledifaces |
Enabled Interfaces on a cluster node. |
disabledifaces |
Disabled Interfaces on a cluster node. |
partialfailifaces |
Partial Failure Interfaces on a cluster node. |
hamonifaces |
Hamon Interfaces on a cluster node. |
nodegroup |
The default node group in a Cluster system. |
name |
Name of the state specific nodegroup. |
cfgflags |
Flag indicates whether the node is bound to cluster nodegroup |
routemonitor |
The IP address (IPv4 or IPv6). |
routemonstate |
Current routemonstate |
netmask |
The netmask. |
delay |
Applicable for Passive node and node becomes passive after this timeout (in minutes) |
tunnelmode |
To set the tunnel mode |
_nextgenapiresource |
routemonnetwork |
routemonnetmask |
See Also |