Installing the client using the command line interface (CLI)
Learn how to install IBM RPA on Red Hat® OpenShift® Container Platform client by using the command line interface in Windows™ command prompt.
Before you begin
- Install and configure the IBM RPA server. The IBM RPA client relies on it to work. For more information, see Installing the server.
- You don't need an internet connection to proceed with the installation. You can use a local network connection.
- Make sure you meet the prerequisites described in Prerequisites to install the client.
- Download the installer. For more information about how to download it, see Downloading the client installer.
- The IBM Robotic Process Automation default installation directory is
C:\Program Files. You cannot change the installation directory.
Procedure
Before 23.0.2
Open the Windows™ command prompt and enter the installer parameters. The parameters include the installer name and extension.
| Installer parameters | Description | Required |
|---|---|---|
/exenoui |
It disables the graphical user interface. | Required |
/qn |
It enables silent mode. | Required |
installlevel |
The type of installation by using numbers: - 1: Typical installation- 4: Complete installation |
Required |
licenseapiaddress |
The API endpoint for the IBM RPA on Red Hat® OpenShift® Container Platform server. | Required |
tenantcode |
The tenant code. | Optional |
proxyaddress |
The proxy server address. | Only if your network has a proxy server. |
proxyusername |
The proxy server username. | Only if your network has a proxy server. |
proxypassword |
The proxy server password. | Only if your network has a proxy server. |
The following code snippet shows the installer parameters in the command line:
Setup.exe /exenoui /qn installlevel=1 [tenantcode=<TENANT_CODE>] licenseapiaddress=<API_ADDRESS> [proxyaddress=<ADDRESS> proxyusername=<USERNAME> proxypassword=<PASSWORD>]
Where:
<TENANT_CODE>
The tenant code. This code refers to the environment that you use to debug and deploy bots on IBM RPA.
<API_ADDRESS>
The API endpoint for the IBM RPA on Red Hat® OpenShift® Container Platform server. This endpoint refers to either the IP address to the IBM RPA server or the server's domain name. See Accessing the IBM RPA UI within the Platform UI for more information.
Starting from 23.0.2
Open the Windows™ command prompt and enter the installer parameters. The parameters includes the installer name and extension.
Example:
Setup.exe [options]
| Installer parameters | Description | Required |
|---|---|---|
/exenoui |
It disables the graphical user interface. | Required |
/qn |
It enables silent mode. | Required |
installlevel |
The type of installation by using numbers: - 1: Typical installation- 4: Complete installation |
Required |
installkey |
The installation key. | Required |
licenseapiaddress |
The API endpoint for the IBM RPA on premises server. Important:Starting from version 23.0.6, you no longer need to enter the API address when you install the client. The API address comes from the installation key.
|
Required |
proxyaddress |
The proxy server address. | Only if your network has a proxy server. |
proxyusername |
The proxy server username. | Only if your network has a proxy server. |
proxypassword |
The proxy server password. | Only if your network has a proxy server. |
USEMSMQ |
Enable or disable Microsoft™ Message Queue (MSMQ) support. MSMQ is enabled by default. | Optional |
Example:
Setup.exe /exenoui /qn installlevel=<LEVEL> installkey=<INSTALL_KEY> licenseapiaddress=<API_ADDRESS> [proxyaddress=<ADDRESS> proxyusername=<USERNAME> proxypassword=<PASSWORD>] [USEMSMQ=<true or false>]
For more information about how to get the installation key, see Getting the installation key.