Settings for high availability clusters

You apply settings to HA clusters at the settings device-mgmt ha-cluster level.

To create an HA cluster, use the following command:

Admin@nodename# create settings device-mgmt ha-clusters

Provide the following parameters:

Parameter

Description

enabled

Enable/disable the HA cluster:

  • on

  • off

name

HA cluster name.

description

HA cluster description.

mode

Select cluster operation mode:

  • active-passive: Active-Passive mode (one server operates as the master node that processes traffic while the remaining servers act as backup).

  • active-active: Active-Active mode (one server operates as the master node that distributes traffic to all other nodes in the cluster).

session-sync

Configure user session synchronization in the cluster:

  • off: disable user session synchronization

  • on: enable user session synchronization

  • ha-cluster-id:

    • <num>: HA cluster multicast ID (can take values of 0 to 8). User session synchronization (except for sessions that use a proxy server, such as HTTP/S traffic) is enabled automatically.

virtual-router-id

Virtual Router ID (VRID).

nodes

Select configuration cluster nodes to combine them into an HA cluster.

virtual-ips

Set the virtual IP address for the cluster and select an interface for each node (the VRRP service should be enabled in the selected interface zone; for more details on how to configure zones using the CLI, see the Zones section).

To add a virtual IP address to the cluster, use the following command:

Admin@nodename# create settings device-mgmt ha-cluster virtual-ips <virtual-ips-filter> <virtual-ip-info>

Available parameters for <virtual-ips-filter>:

  • new: create a virtual IP address for the specific cluster.

  • <ip>: change data for the selected virtual address.

Available parameters for <virtual-ip-info>:

  • ip: set an IP address for the HA cluster (format: IP/mask).

  • ha-interfaces: set interfaces for the cluster nodes (format: node-name/interface).

session-sync-all

Enable/disable synchronizing all user sessions, including UDP/ICMP sessions. If this is disabled and session-sync enabled, only TCP sessions will be synchronized.

excluded-sync-ips

Specify the IP for which synchronization is disabled for all user sessions.

Example cluster creation command:

Admin@nodename# create settings device-mgmt ha-clusters nodes [ node_1 ] name "Test HA cluster" description "Test HA cluster description" mode active-passive enabled on virtual-ips new ha-interfaces [ node_1/port3 ] ip 192.168.1.5/24

To edit the cluster settings, use the following command:

Admin@nodename# set settings device-mgmt ha-cluster <cluster-name>

The following parameters are available:

Parameter

Description

enabled

Enable/disable the HA cluster:

  • on

  • off

name

HA cluster name.

description

HA cluster description.

mode

Select cluster operation mode:

  • active-passive: Active-Passive mode (one server operates as the master node that processes traffic while the remaining servers act as backup).

  • active-active: Active-Active mode (one server operates as the master node that distributes traffic to all other nodes in the cluster).

master-node

Assign the master node in the HA cluster.

session-sync

Configure session synchronization in the cluster:

  • off: disable user session synchronization

  • on: enable user session synchronization

  • ha-cluster-id:

    • <num>: HA cluster multicast ID (can take values of 0 to 8). User session synchronization (except for sessions that use a proxy server, such as HTTP/S traffic) is enabled automatically.

virtual-router-id

Virtual Router ID (VRID).

nodes

Select configuration cluster nodes to combine them into an HA cluster.

virtual-ips

Set the virtual IP address for the cluster and select an interface for each node (the VRRP service should be enabled in the selected interface zone; for more details on how to configure zones using the CLI, see the Zones section).

To add a virtual IP address to the cluster, use the following command:

Admin@nodename# create settings device-mgmt ha-cluster virtual-ips <virtual-ips-filter> <virtual-ip-info>

Available parameters for <virtual-ips-filter>:

  • new: create a virtual IP address for the specific cluster.

  • <ip>: change data for the selected virtual address.

Available parameters for <virtual-ip-info>:

  • ip: set an IP address for the HA cluster (format: IP/mask).

  • ha-interfaces: set interfaces for the cluster nodes (format: node-name/interface).

session-sync-all

Enable/disable synchronizing all user sessions, including UDP/ICMP sessions. If this is disabled and session-sync enabled, only TCP sessions will be synchronized.

excluded-sync-ips

Specify the IP for which synchronization is disabled for all user sessions.

Example commands for editing the cluster settings:

Admin@nodename# set settings device-mgmt ha-clusters "Test HA cluster" nodes [ node_1 node_2 ] virtual-ips 192.168.1.5/24 ha-interfaces [ node_1/port3 node_2/port3 ] ... Admin@nodename# set settings device-mgmt ha-clusters "Test HA cluster" master-node utmcore@iononsteswer

To delete a cluster, use the following command:

Admin@nodename# delete settings device-mgmt ha-clusters <cluster-name>

You can also delete individual parameters:

  • nodes

  • virtual-ips

To display information about all HA clusters, use the following command:

Admin@nodename# show settings device-mgmt ha-cluster

To display information about a specific HA cluster, use the following command:

Admin@nodename# show settings device-mgmt ha-cluster <cluster-name>