Home > Configuration > Cluster > addclusternode

addclusternode

Use this method to adds a Citrix ADC to a cluster.

Syntax



Parameters

nodeid

Unique number that identifies the cluster node.
This is mandatory parameter.
Maximum value = 31.

ipaddress

Citrix ADC IP (NSIP) address of the appliance to add to the cluster. Must be an IPv4 address.
This is mandatory parameter.

state

Admin state of the cluster node. The available settings function as follows: ACTIVE - The node serves traffic. SPARE - The node does not serve traffic unless an ACTIVE node goes down. PASSIVE - The node does not serve traffic, unless you change its state. PASSIVE state is useful during temporary maintenance activities in which you want the node to take part in the consensus protocol but not to serve traffic.
Default value = NSACL_NODEST_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.

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.
Default value = 31.
Minimum value = 0.
Maximum value = 31.

nodegroup

The default node group in a Cluster system.
Default value = DEFAULT_NG.

delay

Applicable for Passive node and node becomes passive after this timeout (in minutes)
Default value = 0.
Maximum value = 1440.

tunnelmode

To set the tunnel mode
Default value = NACL_TUNNELMODE_NONE.

Return Value

Returns simpleResult

See Also