rp_rcm_startup

Description

Starts an RCM using the specified path and configuration file.

Syntax

rp_rcm_startup [rcm_path, rcm_cfg, rcm_log, rcm_retries, rcm_redundant]

Parameters

rcm_path

Path to the RCM binary.

  • If not provided (NULL), the RCM binary is executed using the value of the RCM_PATH parameter set in the OpenSwitch configuration file. If RCM_PATH is not set, the RCM binary is executed from $OPENSWITCH/bin/rcm on UNIX and from %OPENSWITCH%\bin\rcm on Windows.

  • When you provide rcm_path, the RCM executable is invoked from the specified location. You must have execution permission on the RCM binary.

rcm_cfg

Absolute path to the RCM configuration file. If not provided, the value specified by the RCM_CFG_FILE parameter in the OpenSwitch configuration file is used. You must have read access on this file.

rcm_log

Absolute path to the RCM log. If not provided, the value specified by the RCM_LOG_FILE parameter in the OpenSwitch configuration file is used.

rcm_retries

An integer value to specify the number of times OpenSwitch restarts the RCM if it fails. If NULL, the value specified by RCM_RETRIES parameter in the OpenSwitch configuration file is used.

rcm_redundant

An Boolean value (1 is “true” and zero (0) is “false”) to specify whether or not the RCM being started is a redundant RCM. If 1, the RCM binary is executed with the “-R” option. If zero (0), the RCM binary is not executed with the “-R” option.

Examples

Example 1

Starts the RCM with the default RCM binary, trying twice, with no redundancy.

1> rp_rcm_startup NULL, /scratch/15.0_bld2/OpenSwitch-15_1/config/rcm.cfg,
   /scratch/15.0_bld2/OpenSwitch-15_1/logs/rcm.log, 2, 0
2> go

Returns:

Msg 20107, Level 16, State 0:
Server 'monsoon_OSW':rp_rcm_startup: 
The RCM has been started.
(return status = 0)

Usage

See also

rp_rcm_shutdown, rp_rcm_list