RPAgent Control Script

The cluster_rpagentctrl.sh script, in the <installation_directory>/peptrino/scripts/cluster_utils/ directory, manages the RPAgent services on all the nodes in the cluster that are listed in the 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 connect to the cluster nodes.

Reporting the Status of the RPAgent

To check the status of the RPAgent on all the nodes:

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_rpagentctrl.sh \
     --hostsfile=<path_of_the_hosts_file> \
     --ssh-auth-type=publickey \
     --private-key-path=<key_file_path>/<name_of_the_private_key_file> \
     status
    
  3. Press ENTER. The script reports the status of the RPAgent in a log file.
    ==========================================================================
    
    Hosts file set to '<path_of_the_hosts_file>'
    
    SSH Authentication Type is set to 'Public Key Authentication'
    
    SSH Private Key file path is set to '<key_file_path>/<name_of_the_private_key_file>'
    
    Checking connectivity of cluster nodes...
    
    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
    

Stopping the RPAgent on all the Nodes

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_rpagentctrl.sh \
     --hostsfile=<path_of_the_hosts_file> \
     --ssh-auth-type=publickey \
     --private-key-path=<key_file_path>/<name_of_the_private_key_file> \
     stop
    
  3. Press ENTER. The script stops the RPAgent and generates the log in a file.
    ==========================================================================
    
    Hosts file set to '<path_of_the_hosts_file>'
    
    SSH Authentication Type is set to 'Public Key Authentication'
    
    SSH Private Key file path is set to '<key_file_path>/<name_of_the_private_key_file>'
    
    Checking connectivity of cluster nodes...
    
    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
    

Starting the RPAgent on all the Nodes

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_rpagentctrl.sh \
     --hostsfile=<path_of_the_hosts_file> \
     --ssh-auth-type=publickey \
     --private-key-path=<key_file_path>/<name_of_the_private_key_file> \
     start
    
  3. Press ENTER. The script starts the RPAgent and generates the log in a file.
    ==========================================================================
    
    Hosts file set to '<path_of_the_hosts_file>'
    
    SSH Authentication Type is set to 'Public Key Authentication'
    
    SSH Private Key file path is set to '<key_file_path>/<name_of_the_private_key_file>'
    
    Checking connectivity of cluster nodes...
    
    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
    

Restarting the RPAgent on all the Nodes

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_rpagentctrl.sh \
     --hostsfile=<path_of_the_hosts_file> \
     --ssh-auth-type=publickey \
     --private-key-path=<key_file_path>/<name_of_the_private_key_file> \
     restart
    
  3. Press ENTER. The script restarts the RPAgent and generates the log in a file.
    ==========================================================================
    
    Hosts file set to '<path_of_the_hosts_file>'
    
    SSH Authentication Type is set to 'Public Key Authentication'
    
    SSH Private Key file path is set to '<key_file_path>/<name_of_the_private_key_file>'
    
    Checking connectivity of cluster nodes...
    
    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 : February 20, 2026