Log Forwarder Control Script

The cluster_logforwarderctrl.sh script, in the <installation_directory>/peptrino/scripts/cluster_utils/ directory, manages the Log Forwarder services on all the nodes in the cluster that are listed in the hosts file.

The utility provides the following options:

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

Note: When you run the Log Forwarder 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 Log Forwarder

To check the status of the log forwarder on all the nodes:

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_logforwarderctrl.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 log forwarder 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 Logforwarder on current node...
    
    Checking status of Logforwarder on all nodes...
    
    The script's logs and operation results are logged in /opt/protegrity/logs/cluster_logforwarderctrl.log
    

Stopping the Log Forwarder on all the Nodes

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_logforwarderctrl.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 log forwarder 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 Logforwarder on current node...
    
    Logforwarder stopped on current node
    
    Stopping Logforwarder on all nodes...
    
    Logforwarder stopped on all nodes
    
    The script's logs and operation results are logged in /opt/protegrity/logs/cluster_logforwarderctrl.log
    

Starting the Log Forwarder on all the Nodes

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_logforwarderctrl.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 log forwarder 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 Logforwarder on current node...
    
    Logforwarder started on current node
    
    Starting Logforwarder on all nodes...
    
    Logforwarder started on all nodes
    
    The script's logs and operation results are logged in /opt/protegrity/logs/cluster_logforwarderctrl.log
    

Restarting the Log Forwarder on all the Nodes

  1. Log in to the co-ordinator node.
  2. Run the following command:
    ./cluster_logforwarderctrl.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 log forwarder 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 Logforwarder on current node...
    
    Logforwarder stopped on current node
    
    Starting Logforwarder on current node...
    
    Logforwarder started on current node
    
    Stopping Logforwarder on all nodes...
    
    Logforwarder stopped on all nodes
    
    Starting Logforwarder on all nodes...
    
    Logforwarder started on all nodes
    
    The script's logs and operation results are logged in /opt/protegrity/logs/cluster_logforwarderctrl.log
    

Last modified : February 20, 2026