This section describes shell tools required for management of the system at the very system level. All these tools are shipped with the VCS distributive. You need to use SSH or direct access to the server in order to run any of these tools. Please notice that most of given tools require root access and show inline help when run without arguments.

Requirements Checker

The tool is aimed to check minimal requirements and security recommendations at your server before and after installation. 

<VCS_PATH>/bin/setup-checker

The tool should be run under root permissions without any arguments. When the tool is run, it will perform a list of checks and show results for each of them. Use it:

1. Before installation of the VCS to check minimal hardware and software requirements. At this stage you may download the tool separately from the VCS.
2. After installation of the VCS to check security recommendations. Usually you need to tune your firewall settings according to the VCS First Steps.

Services Manager

The tool is used for managing the VCS Services. It allows to correctly start, stop, get status of the VCS Services as RADIUS Server, SIP Server, Calculator, etc.

<VCS_PATH>/bin/service <service-name> <action> [<options>]

The tool should be run under root or vcs user. Service manager takes 2 arguments:

<service-name>

<action>

Additionally you may pass next options:

--path=<path>

--user=<user>

For your convenience there are some examples below:

<VCS_PATH>/bin/service bbradiusd restart

<VCS_PATH>/bin/service files_downloader start

<VCS_PATH>/bin/service bbsipd status

Cluster Manager

The tool is used to manage clusters. It allows to init the cluster, add and promote slave to master, etc. 

<VCS_PATH>/bin/cluster <command> [<options>]

The tool requires "root" permissions. Cluster Manager takes command as mandatory argument and additional options. Some of commands may be run only on Master and others only on Slave. There are two available types of Slave: redundancy and reporting. All extra options for the commands are explained below in the corresponding subsection.

Init Master

The command is run on Master and used for Master to configure its parameters.

<VCS_PATH>/bin/cluster init-master --ip=<IP-of-master> [<extra-options>]

This command may require additional options:

--ip=<ip>

none

--ssh-port=<port>

22

--data=<path>

autodetect

--vcs-path=<path>

<VCS_PATH>

Master: Add new Slave

The command is run on the Master and used for:

• first time initialization of the cluster;
• addition of the new slave node to the cluster;
• addition of the old master to work as slave after failover.

<VCS_PATH>/bin/cluster init-slave --ip=<IP-of-slave> [<extra-options>]

This command encapsulates 4 sub-commands:

• configuration of the Master to ship replication logs (init-master)
• configuration of the Master to accept connections from the Slave (init-master-access)
• configuration of the Slave to receive replication logs (init-slave)
• show status of the cluster (status).

Each of these commands may be performed separately if you know exactly what you need.

This command may require additional options:

--ip=<ip>

none

--ssh-port=<port>

22

--username=<login>

jerasupport

--data=<path>

--vcs-path=<path>

<VCS_PATH>

--role=<role>

redundancy

Slave: Promote to Master

The command is run on the Slave and used to promote current Slave to Master. 

<VCS_PATH>/bin/cluster promote

The command is used for failover. After you fix old Master, you may add it as new Slave using "init" command.

Slave: Sync Files

The command is run on the Slave and used to synchronize files from the Master. The command is mostly used in crontab for auto-sync.

<VCS_PATH>/bin/cluster sync-files

During initialization of the cluster tool adds this command to the crontab (/etc/cron.d/vcs-cluster) at the Slave node. 

Cluster Status

The command may be run on any node and used to get status of the cluster. 

<VCS_PATH>/bin/cluster status

When command is run on the Master, it shows type of the node and attached Slaves that are up to date:

[ NOTICE ] Cluster Status
  ifconfig  | grep 'inet addr:'| grep -v '127.0.0.1' | cut -d: -f2 | awk '{ print $1}'

Master (master ip): ACTIVE 
    Redundancy (slave ip): ACTIVE

When command is run on the Slave, it shows type of the node and synchronization delay.

[ NOTICE ] Cluster Status
  ifconfig  | grep 'inet addr:'| grep -v '127.0.0.1' | cut -d: -f2 | awk '{ print $1}'

Master (master ip): NOT AVAILABLE | Activity delay: -00:00:58.393423
    Redundancy (slave ip): ACTIVE

Please don't worry if you see the following:

the row: Master (master ip): NOT AVAILABLE 

It's a normal behavior. Instead, please pay attention to Activity delay parameter − it shows large values if replication is broken and servers are not in sync. 

In case when the Slave is not in synchronization (NOT-in-sync) with the Master, you need to re-initialize.