Configuring RCM autostart

The parameters in Table 4-2, which are also located in the [CONFIG] section of the OpenSwitch configuration file, are used to configure an RCM to automatically start and stop when OpenSwitch starts and stops.

The description in Table 4-2 also indicates whether an option is configured dynamically or statically. A dynamic option indicates a newly configured value that takes effect immediately and affects all future connections; existing connections are not affected. Dynamically configured options usually affect individual connections. Static options cannot be changed by the user while OpenSwitch is running. You must stop and restart OpenSwitch before the changes take effect. Static options usually define the overall characteristics of the OpenSwitch server and its start-up options.

See “Starting and stopping the RCM automatically from OpenSwitch” and the OpenSwitch Administration Guide, Chapter 4, “Starting and Stopping OpenSwitch and RCMs,” for complete instructions on configuring this functionality.

**Table 4-2: RCM autostart configuration parameters**
Parameter	Description	Value
RCM_AUTOSTART	Instruct OpenSwitch whether to start the replication coordination module (RCM). This option is configured dynamically.	Enter: 0 – to not automatically start the RCM when OpenSwitch starts. This is the default value. 1 – to automatically start the RCM when you start OpenSwitch.
RCM_RETRIES	The number of times OpenSwitch should retry starting the RCM. If the RCM fails for reasons other than the user requesting that the RCM be shutdown, OpenSwitch attempts to restart the RCM. If an unrequested shut down of the RCM occurs within one minute of starting, OpenSwitch logs an error and does not attempt to restart the RCM. This option is configured statically.	Enter: 0 – OpenSwitch does not attempt to restart the RCM. Any numeric value – enter the number of times OpenSwitch should retry to start the RCM.
RCM_PATH	The path where OpenSwitch should look for the RCM executable. If you do not enter this path, and are using and RCM, OpenSwitch runs the RCM located in $OPENSWITCH/bin on UNIX systems or in %OPENSWITCH%\bin on Windows systems; where OPENSWITCH is the installation directory. This parameter has a NULL value if you do not specify a path, and is configured statically.	RCM executable file path
RCM_CFG_FILE	The path where the RCM configuration file is located. This parameter has a NULL value if you do not specify a path, and is configured statically.	RCM configuration file path
RCM_LOG_FILE	The path where the RCM log file should be created. This parameter has a NULL value if you do not specify a path, and is configured statically.	RCM log file path
RCM_SECONDARY	Indicate to OpenSwitch whether the RCM it is launching is a primary or a secondary RCM. The default is “1”. This parameter is configured dynamically.	Enter: 0 – the primary RCM. 1 – secondary RCM.

Table 4-2: RCM autostart configuration parameters

Parameter

Description

Value

RCM_AUTOSTART

Instruct OpenSwitch whether to start the replication coordination module (RCM).

This option is configured dynamically.

Enter:

0 – to not automatically start the RCM when OpenSwitch starts. This is the default value.
1 – to automatically start the RCM when you start OpenSwitch.

RCM_RETRIES

The number of times OpenSwitch should retry starting the RCM.

If the RCM fails for reasons other than the user requesting that the RCM be shutdown, OpenSwitch attempts to restart the RCM. If an unrequested shut down of the RCM occurs within one minute of starting, OpenSwitch logs an error and does not attempt to restart the RCM.

This option is configured statically.

Enter:

0 – OpenSwitch does not attempt to restart the RCM.
Any numeric value – enter the number of times OpenSwitch should retry to start the RCM.

RCM_PATH

The path where OpenSwitch should look for the RCM executable.

If you do not enter this path, and are using and RCM, OpenSwitch runs the RCM located in $OPENSWITCH/bin on UNIX systems or in %OPENSWITCH%\bin on Windows systems; where OPENSWITCH is the installation directory.

This parameter has a NULL value if you do not specify a path, and is configured statically.

RCM executable file path

RCM_CFG_FILE

The path where the RCM configuration file is located. This parameter has a NULL value if you do not specify a path, and is configured statically.

RCM configuration file path

RCM_LOG_FILE

The path where the RCM log file should be created. This parameter has a NULL value if you do not specify a path, and is configured statically.

RCM log file path

RCM_SECONDARY

Indicate to OpenSwitch whether the RCM it is launching is a primary or a secondary RCM. The default is “1”.

This parameter is configured dynamically.

Enter:

0 – the primary RCM.
1 – secondary RCM.