Upgrading on-premises connectors

As an automation engineer, you use the remote-restapi-plugin utility to configure a connector. The latest remote-restapi-plugin utility is included in each version of BMC Helix Intelligent Automation. When there's an update or a change in the on-premises connectors, we recommend you upgrade to the latest version of the on-premises connector to make sure that you benefit from the latest updates.

The process to upgrade any of the supported on-premises connectors is the same. 



Related topics

Connecting-with-automation-tools

Getting-started

System-requirements

Video

The following video by BMC Support team describes the steps to upgrade the remote-restapi-plugin version to be able to upgrade to the latest version of any on-premises connector:

Before you begin

Before upgrading any on-premises connector, navigate to the location where any on-premises connector is installed and running and back up the following files: 

  • creds.json
  • plugin.properties
    By default, these files are located at the remote-restapi-plugin\config location. 
  • The server-side certificate located at the remote-restapi-plugin\server-certs location. 
  • Uninstall the remote restapi plugin service:
    • Navigate to the location where the remote restapi plugin service is running.
    • Run the (Mircosoft Windows) install.bat uninstall or (Linux) install.sh uninstall command. 
      Uninstalling a service does not affect your credentials. 


To upgrade on-premises connectors

  1. Log on to the BMC Helix Intelligent Automation console and navigate to Connectors > Available Connectors. 
  2. Click Configure against any of the available connectors. 
  3. On the Configure On-premises Connector page, click Download Plugin.
    The remote-restapi-plugin.zip file is downloaded.
  4. Copy and extract the downloaded ZIP file.
  5. Verify whether you have downloaded the latest file by opening the remote-restapi-plugin\version.txt file.
  6. Navigate to the remote-restapi-plugin\config location and replace the following files with the files copied before downloading the latest utility:
    • creds.json
    • plugin.properties
  7. Navigate to the remote-restapi-plugin\server-certs location and replace the .PEM certificate file. 
  8. Run the following command to install and run the plugin as a service:
    • Microsoft Windows: install.bat 
    • Linux: ./install.sh 

  9. To verify whether the service is started, run the following command: 

    • Microsoft Windows: install.bat status
    • Linux: ./install.sh status

    If a service is installed successfully, the remote restapi plugin service is displayed in the list of services available in the Microsoft Windows Service Manager. On Linux servers, a system process with the name BMC remote-restapi-plugin is displayed.


Where to go from here

Connecting-with-automation-tools

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*