HA node

Updated: 2013-09-18

[ add | rm | set | unset | bind | unbind | show | stat ]

add HA node

Synopsis

add HA node <id> <IPAddress> [-inc ( ENABLED | DISABLED )]

Description

Adds a peer node to an HA configuration. Each node must add the other as a peer. An algorithm determines which node becomes primary and which becomes secondary.

Parameters

id
Number that uniquely identifies the peer node. Minimum value: 1 Maximum value: 64
IPAddress
The NSIP or NSIP6 address of the node to be added for an HA configuration. This setting is neither propagated nor synchronized.
inc
This option is required if the HA nodes reside on different networks. When this mode is enabled, the following independent network entities and configurations are neither propagated nor synced to the other node: MIPs, SNIPs, VLANs, routes (except LLB routes), route monitors, RNAT rules (except any RNAT rule with a VIP as the NAT IP), and dynamic routing configurations. They are maintained independently on each node. Possible values: ENABLED, DISABLED Default value: DISABLED

rm HA node

Synopsis

rm HA node <id>

Description

Removes the peer node from the HA configuration. To completely remove both the nodes from the HA configuration, you have to log on to each node and remove its peer node.

Parameters

id
Number that uniquely identifies the peer node. CLI users: To learn the ID of the peer node, run the show HA node command on the local node. Maximum value: 64

set HA node

Synopsis

set HA node [-haStatus <haStatus>] [-haSync ( ENABLED | DISABLED )] [-haProp ( ENABLED | DISABLED )] [-helloInterval <msecs>] [-deadInterval <secs>] [-failSafe ( ON | OFF )] [-maxFlips <positive_integer>] [-maxFlipTime <positive_integer>] [-syncvlan <positive_integer>]

Description

Sets the specified HA related parameters for the node. The settings are neither propagated nor synchronized to the peer node.

Parameters

id
Number that uniquely identifies the peer node. Maximum value: 64
haStatus
The HA status of the node. The HA status STAYSECONDARY is used to force the secondary device stay as secondary independent of the state of the Primary device. For example, in an existing HA setup, the Primary node has to be upgraded and this process would take few seconds. During the upgradation, it is possible that the Primary node may suffer from a downtime for a few seconds. However, the Secondary should not take over as the Primary node. Thus, the Secondary node should remain as Secondary even if there is a failure in the Primary node. STAYPRIMARY configuration keeps the node in primary state in case if it is healthy, even if the peer node was the primary node initially. If the node with STAYPRIMARY setting (and no peer node) is added to a primary node (which has this node as the peer) then this node takes over as the new primary and the older node becomes secondary. ENABLED state means normal HA operation without any constraints/preferences. DISABLED state disables the normal HA operation of the node. Possible values: ENABLED, STAYSECONDARY, DISABLED, STAYPRIMARY
haSync
Automatically maintain synchronization by duplicating the configuration of the primary node on the secondary node. This setting is not propagated. Automatic synchronization requires that this setting be enabled (the default) on the current secondary node. Synchronization uses TCP port 3010. Possible values: ENABLED, DISABLED Default value: ENABLED
haProp
Automatically propagate all commands from the primary to the secondary node, except the following: * All HA configuration related commands. For example, add ha node, set ha node, and bind ha node. * All Interface related commands. For example, set interface and unset interface. * All channels related commands. For example, add channel, set channel, and bind channel. The propagated command is executed on the secondary node before it is executed on the primary. If command propagation fails, or if command execution fails on the secondary, the primary node executes the command and logs an error. Command propagation uses port 3011. Note: After enabling propagation, run force synchronization on either node. Possible values: ENABLED, DISABLED Default value: ENABLED
helloInterval
Interval, in milliseconds, between heartbeat messages sent to the peer node. The heartbeat messages are UDP packets sent to port 3003 of the peer node. Default value: 200 Minimum value: 200 Maximum value: 1000
deadInterval
Number of seconds after which a peer node is marked DOWN if heartbeat messages are not received from the peer node. Default value: 3 Minimum value: 3 Maximum value: 60
failSafe
Keep one node primary if both nodes fail the health check, so that a partially available node can back up data and handle traffic. This mode is set independently on each node. Possible values: ON, OFF Default value: OFF
maxFlips
Max number of flips allowed before becoming sticky primary
maxFlipTime
Interval after which flipping of node states can again start
syncvlan
Vlan on which HA related communication is sent. This include sync, propagation , connection mirroring , LB persistency config sync, persistent session sync and session state sync. However HA heartbeats can go all interfaces. Minimum value: 1 Maximum value: 4096

unset HA node

Synopsis

unset HA node [-haStatus] [-haSync] [-haProp] [-helloInterval] [-deadInterval] [-failSafe] [-maxFlips] [-maxFlipTime] [-syncvlan]

Description

Use this command to remove HA node settings.Refer to the set HA node command for meanings of the arguments.

bind HA node

Synopsis

bind HA node [<id>] (-routeMonitor <ip_addr|ipv6_addr|*> [<netmask>])

Description

Adds a route monitor to the local node. When a NetScaler appliance has only static routes for reaching a network, and you want to create a route monitor for the network, you must enable monitored static routes (MSR) for the static routes. Route Monitors are supported both in non-INC and INC modes.

Parameters

id
Number that uniquely identifies the local node. The ID of the local node is always 0. Maximum value: 64
routeMonitor
A route that you want the NetScaler appliance to monitor in its internal routing table. You can specify an IPv4 address or network, or an IPv6 address or network prefix. If you specify an IPv4 network address or IPv6 network prefix, the appliance monitors any route that matches the network or prefix.

unbind HA node

Synopsis

unbind HA node [<id>] (-routeMonitor <ip_addr|ipv6_addr|*> [<netmask>])

Description

Removes a route monitor entry from the local node. The NetScaler appliance stops monitoring the route in its internal routing table.

Parameters

id
Number that uniquely identifies the local node. The ID of the local node is always 0. Maximum value: 64
routeMonitor
The route specified in the route monitor entry that you want to remove from the NetScaler appliance. Can be an IPv4 address or network, or an IPv6 address or network prefix.

show HA node

Synopsis

show HA node [<id>]

Description

Displays the HA settings of both nodes or, if you specify a node, just the specified node. You can use this command to display the master state (primary or secondary) of the nodes in a HA configuration.

Parameters

id
ID of the node whose HA settings you want to display. (The ID of the local node is always 0.) Maximum value: 64

Example

An example of the command's output is as follows:
2 configured nodes:
1) Node ID: 0 IP: 192.168.100.5 Primary node
2) Node ID: 2 IP: 192.168.100.112 Secondary node

stat HA node

Synopsis

stat HA node [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]

Description

Display the statistics related to HA configuration.

Parameters

clearstats
Clear the statsistics / counters Possible values: basic, full

Contact Careers Terms of Use Privacy Governance Follow Us
© Citrix Systems, Inc. All rights reserved.