Installing Resilient Package (RP) Agent on Linux or Unix and Windows

The following section describes the steps to install the RP Agent on Linux or Unix and Windows.

Installing RP Agent on Linux or Unix

The following section describes the steps to install the RP Agent on a Linux or Unix platform using the Interactive or Silent mode of installation.

By default, the RP Agent is installed in the /opt/protegrity directory. You can choose to install the RP Agent in a different directory by specifying the -d or --dir argument in the installation command. If you change the base installation directory, then the installation path will also change accordingly.

Use the --help argument if you need any help with installing the RP Agent, as shown in the following command.

./RPAgentSetup_Linux_x64_<version>.sh --help

The following snippet displays the output.

Install:
./RPAgentSetup_Linux_x64_<version>.sh -e <host[:port]...> [-d <dir>]
 
Options:
 -h, --host      Host or IP of the upstream
 -u, --user      ESA username. Must be a user with the Export Certificates role.
 -p, --password  ESA password. Must be a user with the Export Certificates role.
 -t, --token     ESA token. Must be a token with the Export Certificates role.
     --port      Port to connect to on the upstream (default: 25400)
 -d, --dir       Path to base directory for installation (default: /opt/protegrity)
   , --nocert    Disable certificates

Important: The -t or --token parameter is currently not applicable.

Installing RP Agent on Linux or Unix using Interactive Mode

To install the RP Agent on a Linux or Unix platform using the Interactive mode:

1. Run the RP Agent installer using the following command.

   ./RPAgentSetup_Linux_x64_<version>.sh
   

   The prompt to enter the upstream hostname or IP address appears.

   Please enter upstream host name or IP address
   []:
   

2. Enter the ESA Host Name or IP Address.

3. Press ENTER.

   The prompt to enter the username for downloading certificates appears.

   Please enter the user name for downloading certificates
   []:
   

4. Enter the username for downloading the certificates.

5. Press ENTER.

   The prompt to enter the password for downloading the certificates appears.

   Please enter the password for downloading certificates
   []:
   

6. Press ENTER to install into the destination directory.

   Directories are created under /opt/protegrity/rpagent by default, and the required installation files are installed in these directories.

   Ensure that the ESA is up and running with the HubController service in running status to enable automatic downloading of certificates.

7. If you have installed the RP Agent using the --nocert parameter, then the ESA certificates are not downloaded during the installation. To manually install the certificates to the /opt/protegrity/rpagent/data directory of the RP Agent, perform the following steps.

   i. Navigate to the /opt/protegrity/rpagent/bin directory and run the following command.

   ./GetCertificates -u <ESA User with the Export Certificates role> [-h <ESA host name or IP address>] [-p portno] [-d directory]
   

   This initiates a secure communication between the RP Agent and the ESA.

   ii. Enter the password for the ESA user.

   iii. Verify that the following files have been copied to the /opt/protegrity/rpagent/data directory:

   • CA.pem
   • cert.key
   • cert.pem
   • rpagent.cfg
   • secret.txt

8. Start the RP Agent by using the following command.

   /opt/protegrity/rpagent/bin/rpagentctrl start
   

   The RP Agent is successfully installed.

Installing RP Agent on Linux or Unix using Silent Mode

You can also execute the RP Agent installer without any manual intervention, which is also known as the Silent mode of installation. The following parameters must be provided to execute the installer in the Silent mode.

Important: The -t or --token parameter is currently not applicable.

At the command prompt, type the following command from the installer directory.

./RPAgentSetup_Linux_x64_<version>.sh (-u <user> -p <password>) [-h <host>] [--port <port>] 

If you want to install the RP Agent in a directory other than the default directory, then you can add the -d parameter to the command to specify the directory. The following command displays a sample snippet.

./RPAgentSetup_Linux_x64_<version>.sh (-u <user> -p <password>) [-h <host>] [--port <port>] [-d <dir>]

Uninstalling the RP Agent on Linux or Unix

1. Navigate to the /opt/protegrity/rpagent/bin directory.

2. Stop the RP Agent by using the following command.

   ./rpagentctrl stop
   

3. Delete the rpagent directory.

   The RP Agent and all its components are uninstalled.

Installing RP Agent on Windows

The following section describes the steps to install the RP Agent on a Windows platform using the Windows wizard or through silent installation.

When you install the RP Agent, the system automatically sets up a directory structure with the required files in the ..\Protegrity\rpagent directory.

Installing RP Agent on Windows using the Windows Wizard

To install the RP Agent on a Windows platform using the Windows wizard:

1. Double-click or run the RPAgentSetup_<OS>_<version>.exe file.

   The Setup Wizard appears.

2. Click Next.

   The Upstream Connectivity Information screen appears.

3. Specify the following details.

   Parameter	Description
   Address	Host name or IP address of the upstream server that is providing the resilient packages.
   Port	Port number of the upstream server that is providing the resilient packages. The default value is 25400.
   Certificate download user	Name of the ESA user for downloading the certificates from the ESA. This is an optional parameter.
   Certificate download password	Password of the ESA user required for downloading the certificates from the ESA. This is an optional parameter.

   Note: Ensure that the ESA is up and running with the HubController service in running status to enable automatic downloading of certificates.

4. Click Next.

   The screen to specify the RP Agent location appears.

5. Browse to the directory in which you want to install the RP Agent, or retain the default location.

   It is recommended to retain the default location.

6. Click Next.

   The Ready to Install screen appears.

7. Click Install.

   The Windows wizard installs the RP Agent on your machine.

8. Click Finish to close the Resilient Package Agent Setup Wizard and complete the installation.

   The directories are created under the installation directory that was defined and the installation files are installed in these directories.

9. If you have not specified the Certificate download user name and password in the Upstream Connectivity Information screen, then the ESA certificates are not downloaded during the installation. To manually install the certificates to the \Protegrity\rpagent\data directory of the RP Agent, perform the following steps.

   i. Navigate to the \Protegrity\rpagent\bin directory and run the following command.

   .\GetCertificates.bat -u <ESA User with the Export Certificates role> -p <Password of the ESA user> [-h <ESA host name or IP address>] [--port portno] [-d directory]
   

   This initiates a secure communication between the RP Agent and the ESA.

   ii. Verify that the following files have been copied to the \Protegrity\rpagent\data directory:

   • CA.pem
   • cert.key
   • cert.pem
   • rpagent.cfg
   • secret.txt

   iii. Restart the rpagent service from the Windows Task Manager after editing the file.

Installing RP Agent on Windows using Silent Mode

You can also execute the RP Agent installer without any manual intervention, which is also known as the Silent mode of installation. The following parameters must be provided to execute the installer in the Silent Mode.

Important: The --token parameter is currently not applicable.

At the command prompt, type the following command from the installation directory.

.\RPAgentSetup_<OS>_<version>.exe --host <ip address> --port <port number> --user <ESA user name> --password <ESA user password>

To install the RP Agent in a directory other than the default directory, add the --dir parameter to the command to specify the RP Agent installation directory. The following snippet displays a sample command.

.\RPAgentSetup_<OS>_<version>.exe --host <ip address> --port <port number> --user <ESA user name> --password <ESA user password> --dir <RP Agent installation directory>

Uninstalling the RP Agent on Windows

1. Navigate to the \Protegrity\rpagent directory.

2. Double-click the unins000.exe file.

   The Resilient Package Agent Uninstall dialog box appears. A message appears asking you to confirm whether you want to uninstall the RP Agent.

3. Click Yes. The RP Agent and all its components are uninstalled.