| getclusterinstanceResult Structure Definition |
The getclusterinstanceResult structure defines the return type for getclusterinstance 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. |
clusterinstanceList |
List of clusterinstances |
| clusterinstance Structure Definition |
The clusterinstance structure defines the actual return type values for getclusterinstance API. |
Syntax |
Members |
clid |
Unique number that identifies the cluster. |
deadinterval |
Amount of time, in seconds, after which nodes that do not respond to the heartbeats are assumed to be down.If the value is less than 3 sec, set the helloInterval parameter to 200 msec |
hellointerval |
Interval, in milliseconds, at which heartbeats are sent to each cluster node to check the health status.Set the value to 200 msec, if the deadInterval parameter is less than 3 sec |
preemption |
Preempt a cluster node that is configured as a SPARE if an ACTIVE node becomes available. |
adminstate |
Cluster Admin State. |
quorumtype |
Quorum Configuration Choices - "Majority" (recommended) requires majority of nodes to be online for the cluster to be UP. "None" relaxes this requirement. |
propstate |
Enable/Disable the execution of methods on the cluster. This will not impact the execution of methods on individual cluster nodes by using the NSIP. |
inc |
This option is required if the cluster nodes reside on different networks. |
nodegroup |
The node group in a Cluster system used for transition from L2 to L3. |
processlocal |
By turning on this option packets destined to a service in a cluster will not under go any steering. |
validmtu |
Correct MTU value that has to be set on backplane. |
retainconnectionsoncluster |
This option enables you to retain existing connections on a node joining a Cluster system or when a node is being configured for passive timeout. By default, this option is disabled. |
heterogeneousflag |
This field diplay if heterogeneous is detected in the cluster system. |
backplanebasedview |
View based on heartbeat only on bkplane interface |
syncstatusstrictmode |
strict mode for sync status of cluster. Depending on the the mode if there are any errors while applying config, sync status is displayed accordingly. By default the flag is disabled. |
dfdretainl2params |
flag to add ext l2 header during steering. By default the flag is disabled. |
clusterproxyarp |
This field controls the proxy arp feature in cluster. By default the flag is enabled. |
secureheartbeats |
By turning on this option cluster heartbeats will have security enabled. |
nodeid |
The unique number that identiies a cluster. |
ipaddress |
The IP Address of the node. |
masterstate |
Master state. |
health |
Node Health state. |
clusterhealth |
Node clusterd state. |
effectivestate |
Node effective health state. |
state |
Active, Spare or Passive. An active node serves traffic. A spare node serves as a backup for active nodes. A passive node does not serve traffic. This may be useful during temporary maintenance activity where it is desirable that the node takes part in the consensus protocol, but not serve traffic. |
operationalstate |
Cluster Operational State. |
status |
Cluster Operational State. |
isconfigurationcoordinator |
This argument is used to determine whether the node is configuration coordinator (CCO). |
islocalnode |
This argument is used to determine whether it is local node. |
nodersskeymismatch |
This argument is used to determine if there is a RSS key mismatch at cluster node level. |
nodelicensemismatch |
This argument is used to determine if there is a License mismatch at cluster node level. |
nodejumbonotsupported |
This argument is used to determine if Jumbo framework not supported at cluster node level. |
operationalpropstate |
Cluster Operational Propagation State. |
_nextgenapiresource |
See Also |