ClusterXL Configuration Commands

Important:

Load Sharing modes are only supported with the required R80.20 Jumbo Hotfix Accumulator. For instructions, see sk162637.
To upgrade a ClusterXL that works in a Load Sharing mode from a lower version to R80.20, follow these steps in the same maintenance window:
1. Upgrade the ClusterXL to R80.20.
2. Install the required R80.20 Jumbo Hotfix Accumulator. For instructions, see sk162637.

Description

These commands let you configure internal behavior of the Clustering Mechanism.

	Important - We do not recommend that you run these commands. These commands must be run automatically only by the Security Gateway or the Check Point Support. The only exception to this rule is to changing the CCP mode, as described below.
	Important - You must configure all the Cluster Members in the same way.

Syntax

Notes:

In Gaia Clish:
Enter the set cluster<ESC><ESC> to see all the available commands.
In Expert mode:
Run the cphaconf command see all the available commands.

You can run the cphaconf commands only from the Expert mode.
Syntax legend:
1. Curly brackets or braces {}:
  Enclose a list of available commands or parameters, separated by the vertical bar |, from which user can enter only one.
2. Angle brackets <>:
  Enclose a variable - a supported value user needs to specify explicitly.
3. Square brackets or brackets []:
  Enclose an optional command or parameter, which user can also enter.

You can include these commands in scripts to run them automatically.

The meaning of each command is explained in the next sections.

Description of Command	Command in Gaia Clish	Command in Expert Mode
Configure how to show the Cluster Member in local ClusterXL logs - by its Member ID or its Member Name	set cluster member idmode id name	cphaconf mem_id_mode id name
Register a single Critical Device (Pnote) on the Cluster Member	N/A	`cphaconf set_pnote -d <`Name of Device`> -t <`Timeout in Sec`> -s {ok\|init\|problem} [-p] [-g] register`
Unregister a single Critical Device (Pnote) on the Cluster Member	N/A	cphaconf set_pnote -d <Name of Device> [-p] [-g] unregister
Report (change) a state in a single Critical Device (Pnote) on the Cluster Member	N/A	`cphaconf set_pnote -d <`Name of Device`> -s {ok\|init\|problem} [-g] report`
Register several Critical Devices (Pnotes) from a file on the Cluster Member	N/A	`cphaconf set_pnote -f <`Name of File`> [-g] register`
Unregister all Critical Devices (Pnotes) on the Cluster Member	N/A	`cphaconf set_pnote -a [-g] unregister`
Configure the Cluster Control Protocol (CCP) mode on the Cluster Member	set cluster member ccp auto broadcast multicast unicast	cphaconf set_ccp auto unicast multicast broadcast
Configure the Cluster Forwarding Layer on the Cluster Member (controls the forwarding of traffic between Cluster Members) Note - For Check Point use only.	set cluster member forwarding on off	cphaconf forward on off
Print the current cluster configuration as loaded in the kernel on the Cluster Member (for details, see sk93306)	N/A	`cphaconf debug_data`
Start internal failover between slave interfaces of specified bond interface - only in Bond High Availability mode (for details, see sk93306)	N/A	`cphaconf failover_bond <`bond_name`>`
Configure what happens during a failover after a Bond already failed over internally (for details, see sk93306)	N/A	`cphaconf enable_bond_failover <`bond_name`>`
Initiate manual cluster failover	set cluster member admin down up	clusterXL_admin down up

List of the Gaia Clish set cluster member commands

set cluster member

admin

down

ccp

auto

broadcast

multicast

unicast

forwarding

off

idmode

name

List of the cphaconf commands

Note - Some commands are not applicable to 3rd party clusters.

cphaconf [-D]

[-c <Cluster Size>]

[-i <Member ID>]

[-n <Cluster ID>]

[-p <Policy ID>]

[-m {1|service} | {2|balance} | {3|primary-up} | {4|active-up}]

[-R a | <Number of Required IF>]

[-t <Sync IF 1>...]

[-d <Non-Monitored IF 1>...]

[-M {0|multicast} | {1|pivot}]

[-l <Cluster Failover Track Mode 0-7>]

[-M multicast|pivot]

[-N <MAC Magic value>]

[-u <Member_Name1,Member_Name2,...>]

start

cphaconf stop

cphaconf [-t <Sync IF 1>...] [-d <Non-Monitored IF 1>...] add

cphaconf clear-secured

cphaconf clear-non-monitored

cphaconf set_ccp {auto|unicast|multicast|broadcast}

cphaconf debug_data

cphaconf delete_link_local [-vs <VSID>] <IF name>

cphaconf set_link_local [-vs <VSID>] <IF name> <Cluster IP>

cphaconf mem_id_mode {id | name}

cphaconf failover_bond <bond_name>

cphaconf [-s] {set|unset|get} var <Kernel Parameter Name> [<Value>]

cphaconf set_pnote -d <Device> -t <Timeout in sec> -s {ok|init|problem} [-p] [-g] register

cphaconf set_pnote -f <File> [-g] register

cphaconf set_pnote -d <Device> [-p] [-g] unregister

cphaconf set_pnote -a [-g] unregister

cphaconf set_pnote -d <Device> -s {ok|init|problem} [-g] report