RPAgent Control Script

Perform operations on the cluster using the RPAgent Control Script

The cluster_rpagentctrl.sh script, in the <installation_directory>/cluster_utils directory, manages the RPAgent services on all the nodes in the cluster that are listed in the BDP hosts file.

The utility provides the following options:

  • Start – Starts the RPAgent on all the nodes in the cluster.
  • Stop – Stops the RPAgent on all the nodes in the cluster.
  • Restart – Restarts the RPAgent on all the nodes in the cluster.
  • Status – Reports the status of the RPAgent on all the nodes in the cluster.

Note: When you run the RPAgent Control utility, the script will prompt to enter the path of the SSH private key file to securely login into the cluster nodes.

Verifying the Status of RPAgent

To verify the status of the RPAgent on all the nodes in the cluster:

  1. Log in to the lead or Primary node.

  2. Navigate to the <installation_directory>/cluster_utils directory.

  3. Run the following command:

    ./cluster_rpagentctrl.sh

  4. Press ENTER.

    The prompt to enter the path of the private key file appears.

    Enter the path of the Private Key (.PEM) file:

  5. Enter the location of the Private Key (.PEM) file.

  6. Press ENTER.

    The script verifies the connectivity on the cluster nodes and the options appear.

    Checking connectivity of cluster nodes...

Select option:
    1) Start
    2) Stop
    3) Restart
    4) Status
Option(1-4):

  7. To verify the status of the RPAgent on all the nodes, type 4.

  8. Press ENTER.

    The script checks the status of the RPAgent on all the nodes and appends the event details to a log file.

    Checking status of RPAgent on current node...

Checking status of RPAgent on all nodes...

The script's logs and operation results are logged in /opt/protegrity/logs/cluster_rpagentctrl.log

Starting the RPAgent

To start the RPAgent on all the nodes in the cluster:

  1. Log in to the lead or Primary node.

  2. Navigate to the <installation_directory>/cluster_utils directory.

  3. Run the following command:

    ./cluster_rpagentctrl.sh

  4. Press ENTER.

    The prompt to enter the path of the private key file appears.

    Enter the path of the Private Key (.PEM) file:

  5. Enter the location of the Private Key (.PEM) file.

  6. Press ENTER.

    The script verifies the connectivity on the cluster nodes and the options appear.

    Checking connectivity of cluster nodes...

Select option:
    1) Start
    2) Stop
    3) Restart
    4) Status
Option(1-4):

  7. To start the RPAgent on all the nodes, type 1.

  8. Press ENTER.

    The script starts the RPAgent on all the nodes and appends the event details to a log file.

    Starting RPAgent on current node...

RPAgent started on current node

Starting RPAgent on all nodes...

RPAgent started on all nodes

The script's logs and operation results are logged in /opt/protegrity/logs/cluster_rpagentctrl.log

Stopping the RPAgent

To stop the RPAgent on all the nodes in the cluster:

  1. Log in to the lead or Primary node.

  2. Navigate to the <installation_directory>/cluster_utils directory.

  3. Run the following command:

    ./cluster_rpagentctrl.sh

  4. Press ENTER.

    The prompt to enter the path of the private key file appears.

    Enter the path of the Private Key (.PEM) file:

  5. Enter the location of the Private Key (.PEM) file.

  6. Press ENTER.

    The script verifies the connectivity on the cluster nodes and the options appear.

    Checking connectivity of cluster nodes...

Select option:
    1) Start
    2) Stop
    3) Restart
    4) Status
Option(1-4):

  7. To stop the RPAgent on all the nodes, type 2.

  8. Press ENTER.

    The script stops the RPAgent on all the nodes and appends the event details to a log file.

    Stopping RPAgent on current node...

RPAgent stopped on current node

Stopping RPAgent on all nodes...

RPAgent stopped on all nodes


The script's logs and operation results are logged in /opt/protegrity/logs/cluster_rpagentctrl.log

Restarting the RPAgent

To restart the RPAgent on all the nodes in the cluster:

  1. Log in to the lead or Primary node.

  2. Navigate to the <installation_directory>/cluster_utils directory.

  3. Run the following command:

    ./cluster_rpagentctrl.sh

  4. Press ENTER.

    The prompt to enter the path of the private key file appears.

    Enter the path of the Private Key (.PEM) file:

  5. Enter the location of the Private Key (.PEM) file.

  6. Press ENTER.

    The script verifies the connectivity on the cluster nodes and the options appear.

    Checking connectivity of cluster nodes...

Select option:
    1) Start
    2) Stop
    3) Restart
    4) Status
Option(1-4):

  7. To restart the RPAgent on all the nodes, type 3.

  8. Press ENTER.

    The script restarts the RPAgent on all the nodes and appends the event details to a log file.

    Stopping RPAgent on current node...

RPAgent stopped on current node

Starting RPAgent on current node...

RPAgent started on current node

Stopping RPAgent on all nodes...

RPAgent stopped on all nodes

Starting RPAgent on all nodes...

RPAgent started on all nodes

The script's logs and operation results are logged in /opt/protegrity/logs/cluster_rpagentctrl.log

Last modified : October 03, 2025