ADC CLI Commands

cluster-nodegroup

The following operations can be performed on “cluster-nodegroup”:

add show set rm unset unbind bind

add cluster nodegroup

Adds a nodegroup to the cluster. A nodegroup is a set of cluster nodes to which entities can be bound. Entities that are bound to a specific nodegroup are active on all the nodes of the group and not active on the nodes that are not part of the group.

Synopsis

add cluster nodegroup @ [-strict ( YES | NO )] [-sticky ( YES | NO )] [-state ] [-priority ]

Arguments

name Name of the nodegroup. The name uniquely identifies the nodegroup on the cluster.

strict Specifies whether cluster nodes, that are not part of the nodegroup, will be used as backup for the nodegroup.

  • Enabled - When one of the nodes goes down, no other cluster node is picked up to replace it. When the node comes up, it will continue being part of the nodegroup.
  • Disabled - When one of the nodes goes down, a non-nodegroup cluster node is picked up and acts as part of the nodegroup. When the original node of the nodegroup comes up, the backup node will be replaced.

Possible values: YES, NO Default value: NO

sticky Only one node can be bound to nodegroup with this option enabled. It specifies whether to prempt the traffic for the entities bound to nodegroup when owner node goes down and rejoins the cluster.

  • Enabled - When owner node goes down, backup node will become the owner node and takes the traffic for the entities bound to the nodegroup. When bound node rejoins the cluster, traffic for the entities bound to nodegroup will not be steered back to this bound node. Current owner will have the ownership till it goes down.
  • Disabled - When one of the nodes goes down, a non-nodegroup cluster node is picked up and acts as part of the nodegroup. When the original node of the nodegroup comes up, the backup node will be replaced.

Possible values: YES, NO Default value: NO

state State of the nodegroup. All the nodes binding to this nodegroup must have the same state. ACTIVE/SPARE/PASSIVE

Possible values: ACTIVE, SPARE, PASSIVE Default value: VAL_NOT_SET

priority Priority of Nodegroup. This priority is used for all the nodes bound to the nodegroup for Nodegroup selection Default value: -1 Minimum value: 0 Maximum value: 31

Example

add cluster nodegroup ng1 -strict yes

show cluster nodegroup

Displays information about the available nodegroups.

Synopsis

show cluster nodegroup []

Arguments

name Name of the nodegroup to be displayed. If a name is not provided, information about all nodegroups is displayed.

Output

node Nodes in the nodegroup

strict Specifies whether cluster nodes, that are not part of the nodegroup, will be used as backup for the nodegroup.

  • Enabled - When one of the nodes goes down, no other cluster node is picked up to replace it. When the node comes up, it will continue being part of the nodegroup.
  • Disabled - When one of the nodes goes down, a non-nodegroup cluster node is picked up and acts as part of the nodegroup. When the original node of the nodegroup comes up, the backup node will be replaced.

sticky Only one node can be bound to nodegroup with this option enabled. It specifies whether to prempt the traffic for the entities bound to nodegroup when owner node goes down and rejoins the cluster.

  • Enabled - When owner node goes down, backup node will become the owner node and takes the traffic for the entities bound to the nodegroup. When bound node rejoins the cluster, traffic for the entities bound to nodegroup will not be steered back to this bound node. Current owner will have the ownership till it goes down.
  • Disabled - When one of the nodes goes down, a non-nodegroup cluster node is picked up and acts as part of the nodegroup. When the original node of the nodegroup comes up, the backup node will be replaced.

vServer vserver that need to be bound to this nodegroup.

currentNodeMask Bitmap of current nodes in this nodegroup

backupNodeMask Bitmap of backup nodes in this nodegroup

boundedEntitiesCntFromPE Count of bounded entities to this nodegroup accoding to PE

boundedConfigEntitiesCnt Number of configs bound to this nodegroup

activeList Active node list of this nodegroup

backupList Backup node list of this nodegroup

identifierName stream identifier and rate limit identifier that need to be bound to this nodegroup.

gslbSite vserver that need to be bound to this nodegroup.

service name of the service bound to this nodegroup.

stateflag cfgflags This contains the flags for Cluster Nodegroup in DB

state State of the nodegroup. All the nodes binding to this nodegroup must have the same state. ACTIVE/SPARE/PASSIVE

priority Priority of Nodegroup. This priority is used for all the nodes bound to the nodegroup for Nodegroup selection

devno count

set cluster nodegroup

Modifies the attributes of a cluster nodegroup.

Synopsis

set cluster nodegroup @ [-strict ( YES | NO )] [-state ] [-priority ]

Arguments

name Name of the nodegroup to be modified.

strict Specifies whether cluster nodes, that are not part of the nodegroup, will be used as backup for the nodegroup.

  • Enabled - When one of the nodes goes down, no other cluster node is picked up to replace it. When the node comes up, it will continue being part of the nodegroup.
  • Disabled - When one of the nodes goes down, a non-nodegroup cluster node is picked up and acts as part of the nodegroup. When the original node of the nodegroup comes up, the backup node will be replaced.

Possible values: YES, NO Default value: NO

state State of the nodegroup. All the nodes binding to this nodegroup must have the same state. ACTIVE/SPARE/PASSIVE

Possible values: ACTIVE, SPARE, PASSIVE Default value: VAL_NOT_SET

priority Priority of Nodegroup. This priority is used for all the nodes bound to the nodegroup for Nodegroup selection Default value: -1 Minimum value: 0 Maximum value: 31

Example

set cluster nodegroup ng1 -strict yes

rm cluster nodegroup

Removes a nodegroup from the cluster.

Synopsis

rm cluster nodegroup @

Arguments

name Name of the nodegroup to be removed.

Example

rm cluster nodegroup ng1

unset cluster nodegroup

Unset nodes from the given nodegroup or unset strict option.Refer to the set cluster nodegroup command for meanings of the arguments.

Synopsis

unset cluster nodegroup @ [-strict]

Example

unset cluster nodegroup ng1 -strict

unbind cluster nodegroup

Unbinds a cluster node or an entity from a given nodegroup.

Synopsis

unbind cluster nodegroup (-node @ | -vServer | -identifierName | -gslbSite | -service )

Arguments

name Name of the nodegroup from which you want to unbind a cluster node or an entity.

node ID of the node to be unbound from the nodegroup. Default value: -1 Minimum value: 0 Maximum value: 31

vServer Name of the virtual server to be unbound from the nodegroup.

identifierName Name of stream or limit identifier to be unbound from the nodegroup.

gslbSite Name of the GSLB site to be unbound from the nodegroup.

service Name of the service to be unbound from the nodegroup.

Example

unbind cluster nodegroup ng1 -vserver v1

bind cluster nodegroup

Binds a cluster node or an entity to the given nodegroup. A node can be bound to more than one nodegroup.

Synopsis

bind cluster nodegroup (-node @ | -vServer | -identifierName | -gslbSite | -service )

Arguments

name Name of the nodegroup to which you want to bind a cluster node or an entity.

node ID of the node to be bound to the nodegroup. Default value: -1 Minimum value: 0 Maximum value: 31

vServer Name of the virtual server to be bound to the nodegroup.

identifierName Name of stream or limit identifier to be bound to the nodegroup.

gslbSite Name of the GSLB site to be associated with the nodegroup.

service Name of the ADNS or ADNS-TCP service to be associated with the nodegroup. This parameter is used to support GSLB in a cluster.

Example

bind cluster nodegroup ng1 -vserver v1

cluster-nodegroup