cluster instance¶
The following operations can be performed on "cluster instance":
add | rm | set | unset | enable | disable | show | stat
add cluster instance¶
Adds a cluster instance to the appliance. Execute this command on only the first node that you add to the cluster.
Synopsys¶
add cluster instance <clId> [-deadInterval <secs>] [-helloInterval <msecs>] [-preemption ( ENABLED | DISABLED )] [-quorumType ( MAJORITY | NONE )] [-inc ( ENABLED | DISABLED )] [-processLocal ( ENABLED | DISABLED )]
Arguments¶
clId
Unique number that identifies the cluster.
Minimum value: 1
Maximum value: 16
deadInterval
Amount of time, in seconds, after which nodes that do not respond to the heartbeats are assumed to be down.
Default value: 3
Minimum value: 3
Maximum value: 60
helloInterval
Interval, in milliseconds, at which heartbeats are sent to each cluster node to check the health status.
Default value: 200
Minimum value: 200
Maximum value: 1000
preemption
Preempt a cluster node that is configured as a SPARE if an ACTIVE node becomes available.
Possible values: ENABLED, DISABLED
Default value: DISABLED
quorumType
Quorum Configuration Choices - "Majority" (recommended) requires majority of nodes to be online for the cluster to be UP. "None" relaxes this requirement.
Possible values: MAJORITY, NONE
Default value: MAJORITY
inc
This option is required if the cluster nodes reside on different networks.
Possible values: ENABLED, DISABLED
Default value: DISABLED
processLocal
By turning on this option packets destined to a service in a cluster will not under go any steering.
Possible values: ENABLED, DISABLED
Default value: DISABLED
Example¶
add cluster instance 1
rm cluster instance¶
Removes the cluster instance from the node. You must execute this command on the NetScaler IP (NSIP) address of the node.
Synopsys¶
rm cluster instance <clId>
Arguments¶
clId
Unique number that identifies the cluster.
Minimum value: 1
Maximum value: 16
Example¶
rm cluster instance 1
set cluster instance¶
Modifies the specified attributes of a cluster instance.
Synopsys¶
set cluster instance <clId> [-deadInterval <secs>] [-helloInterval <msecs>] [-preemption ( ENABLED | DISABLED )] [-quorumType ( MAJORITY | NONE )] [-inc ( ENABLED | DISABLED )] [-processLocal ( ENABLED | DISABLED )] [-nodegroup <string>]
Arguments¶
clId
ID of the cluster instance to be modified.
Minimum value: 1
Maximum value: 16
deadInterval
Amount of time, in seconds, after which nodes that do not respond to the heartbeats are assumed to be down.
Default value: 3
Minimum value: 3
Maximum value: 60
helloInterval
Interval, in milliseconds, at which heartbeats are sent to each cluster node to check the health status.
Default value: 200
Minimum value: 200
Maximum value: 1000
preemption
Preempt a cluster node that is configured as a SPARE if an ACTIVE node becomes available.
Possible values: ENABLED, DISABLED
Default value: DISABLED
quorumType
Quorum Configuration Choices - "Majority" (recommended) requires majority of nodes to be online for the cluster to be UP. "None" relaxes this requirement.
Possible values: MAJORITY, NONE
Default value: MAJORITY
inc
This option is required if the cluster nodes reside on different networks.
Possible values: ENABLED, DISABLED
Default value: DISABLED
processLocal
By turning on this option packets destined to a service in a cluster will not under go any steering.
Possible values: ENABLED, DISABLED
Default value: DISABLED
nodegroup
The node group in a Cluster system used for transition from L2 to L3.
Example¶
set cluster instance 1 -preemption ENABLED
unset cluster instance¶
Use this command to remove cluster instance settings.Refer to the set cluster instance command for meanings of the arguments.
Synopsys¶
unset cluster instance <clId> [-deadInterval] [-helloInterval] [-preemption] [-quorumType] [-inc] [-processLocal] [-nodegroup]
enable cluster instance¶
Enables a cluster instance.
Synopsys¶
enable cluster instance <clId>
Arguments¶
clId
ID of the cluster instance that you want to enable.
Minimum value: 1
Maximum value: 16
Example¶
enable cluster instance 1
disable cluster instance¶
Disables a cluster instance.
Synopsys¶
disable cluster instance <clId>
Arguments¶
clId
ID of the cluster instance that you want to disable.
Minimum value: 1
Maximum value: 16
Example¶
disable cluster instance 1
show cluster instance¶
Displays information about the cluster instance and its nodes.
Synopsys¶
show cluster instance [<clId>]
Arguments¶
clId
Unique number that identifies the cluster.
Minimum value: 1
Maximum value: 16
Outputs¶
deadInterval
Amount of time, in seconds, after which nodes that do not respond to the heartbeats are assumed to be down.
helloInterval
Interval, in milliseconds, at which heartbeats are sent to each cluster node to check the health status.
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 commands on the cluster. This will not impact the execution of commands 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.
nodeId
The unique number that identiies a cluster.
IPAddress
The IP Address of the node.
flags
The flags for this entry.
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.
flag
Cluster Flag.
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.
RSSKeyMismatch
This argument is used to determine if there is a RSS key mismatch at cluster instance level.
NodegroupStateWarning
This argumnt is used to determind whether all the cluster nodes are bound to nodegroup with state set.
LicenseMismatch
This argument is used to determine if there is a License mismatch at cluster instance level.
JumboNotSupported
This argument is used to determine if Jumbo framework is not supported at cluster instance level.
ClusterNoHeartbeatOnNode
HB is not seen on the backplane interface of member node
ClusterNoLinksetMBF
MBF is enabled but linkset is not configured
ClusterNoSpottedIp
There is no spotted SNIP or MIP
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.
stateflag
State Flag.
operationalPropState
Cluster Operational Propagation State.
devno
count
Example¶
An example of the command's output is as follows:1)Cluster ID: 1 Dead Interval: 3 secs Hello Interval: 200 msecs Preemption: DISABLED Propagation: ENABLED Cluster Status: ENABLED(admin), ENABLED(operational), UP Member Nodes: Node ID Node IP Health Admin State Operational State ------- ------- ------ ----------- -----------------1) 1 1.1.1.1 UP ACTIVE ACTIVE(Configuration Coordinator)2) 2 1.1.1.2 UP ACTIVE ACTIVE Done : Local node
stat cluster instance¶
Displays statistics for a cluster instance.
Synopsys¶
stat cluster instance [<clId>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]
Arguments¶
clId
ID of the cluster instance for which to display statistics.
Minimum value: 1
Maximum value: 16
detail
Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.
fullValues
Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated
ntimes
The number of times, in intervals of seven seconds, the statistics should be displayed.
Default value: 1
Minimum value: 0
logFile
The name of the log file to be used as input.
clearstats
Clear the statsistics / counters
Possible values: basic, full
Outputs¶
count
devno
stateflag
Outputs¶
Cluster size (CLNumNodes)
Number of nodes in the cluster.
Cluster status (CLCurEnable)
State of the cluster.
Configuration coordinator (CLViewLeader)
NSIP address of the Configuration Coordinator of the cluster.
Total steered packets (TotSteeredPkts)
Total number of packets steered on the cluster backplane.
Traffic received (Bkplane Rx)
Traffic received on backplane (in mbits)
Traffic transmitted (Bkplane Tx)
Traffic transmitted from backplane (in mbits)
Dropped steered packets (DFDdropPkts)
Number of steered packets that are dropped.
Propagation timeout (propTimeout)
Number of times the update to the client timed-out.