Home > Configuration > Cluster

Use this method to adds a cluster instance to the appliance. Execute this method on only the first node that you add to the cluster.

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

Use this method to 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.

Use this method to bind routemonitor to cluster node.

Use this method to bind gslbsite to cluster nodegroup.

Use this method to bind identifier to cluster nodegroup.

Use this method to bind node to cluster nodegroup.

Use this method to bind service to cluster nodegroup.

Use this method to bind vserver to cluster nodegroup.

Use this method to clears the cluster propagation status, works only on CLIP

Use this method to disables a cluster instance.

Use this method to enables a cluster instance.

Use this method to synchronize the configurations of a cluster node from the configuration coordinator (CCO). This method must be executed from the NSIP of the node that is to be synchronized.

Use this method to get information about the cluster instance and its nodes.

Use this method to get information about the cluster node.

Use this method to get information about the available nodegroups.

Use this method to get the cluster propagation status

Use this method to get the method execution failures occurred during Cluster Configuration Synchronization.

Use this method to joins the appliance to the cluster. You must execute this method from the Citrix ADC IP (NSIP) address of the node that you want to add to the cluster.
This method is the second part of the two-step process of adding a cluster node. The first part is adding this node to the cluster by using the add cluster node method from the cluster IP address. This operation is not permitted if any node in the cluster is in the Sync state.

Use this method to removes the cluster instance from the node. You must execute this method on the Citrix ADC IP (NSIP) address of the node.

Use this method to removes a node from the cluster and removes the cluster instance from the node. You must execute this method on the cluster IP address.

Use this method to removes a nodegroup from the cluster.

Use this method to set view based on heartbeat only on bkplane interface

Use this method to set this field controls the proxy arp feature in cluster. By default the flag is enabled.

Use this method to set 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

Use this method to set flag to add ext l2 header during steering. By default the flag is disabled.

Use this method to set 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

Use this method to set this option is required if the cluster nodes reside on different networks.

Use this method to set the node group in a Cluster system used for transition from L2 to L3.

Use this method to set preempt a cluster node that is configured as a SPARE if an ACTIVE node becomes available.

Use this method to set by turning on this option packets destined to a service in a cluster will not under go any steering.

Use this method to set quorum Configuration Choices - "Majority" (recommended) requires majority of nodes to be online for the cluster to be UP. "None" relaxes this requirement.

Use this method to set 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.

Use this method to set by turning on this option cluster heartbeats will have security enabled.

Use this method to set 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.

Use this method to set 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.

Use this method to set applicable for Passive node and node becomes passive after this timeout (in minutes)

Use this method to set 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.

Use this method to set 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.

Use this method to set to set the tunnel mode

Use this method to set priority of Nodegroup. This priority is used for all the nodes bound to the nodegroup for Nodegroup selection

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

Use this method to set 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.

Use this method to synchronizes SSL Certificates, SSL CRL lists, SSL VPN bookmarks, and other files from the configuration coordinator (CCO) to the other cluster nodes. Execute this method from the cluster IP address only. This method is automatically triggered from the CCO when a new node is added to a cluster and periodically triggered to synchronize updated files between the cluster nodes.
Note: Files on non-CCO nodes are not deleted if they do no not exist on the CCO.

Use this method to unbind routemonitor from cluster node.

Use this method to unbind gslbsite from cluster nodegroup.

Use this method to unbind identifier from cluster nodegroup.

Use this method to unbind node from cluster nodegroup.

Use this method to unbind service from cluster nodegroup.

Use this method to unbind vserver from cluster nodegroup.

Remove cluster instance backplanebasedview setting.

Remove cluster instance clusterproxyarp setting.

Remove cluster instance deadinterval setting.

Remove cluster instance dfdretainl2params setting.

Remove cluster instance hellointerval setting.

Remove cluster instance inc setting.

Remove cluster instance nodegroup setting.

Remove cluster instance preemption setting.

Remove cluster instance processlocal setting.

Remove cluster instance quorumtype setting.

Remove cluster instance retainconnectionsoncluster setting.

Remove cluster instance secureheartbeats setting.

Remove cluster instance syncstatusstrictmode setting.

Remove cluster node backplane setting.

Remove cluster node delay setting.

Remove cluster node priority setting.

Remove cluster node state setting.

Remove cluster node tunnelmode setting.

Remove cluster nodegroup strict setting.