Configuring the TrueSight Server Automation connector

Note

The TrueSight Server Automation connector is required only for BMC Helix Automation Console (SaaS).

For TrueSight Automation Console (on-premises), integration with TrueSight Server Automation is configured during installation.

This topic provides an overview of and instructions to install and configure the TrueSight Server Automation connector. 

Overview

TrueSight Server Automation connector is used to establish connection between BMC Helix Automation Console with the TrueSight Server Automation Application Server. Automation Console sends notifications for jobs such as updating catalogs, and running patching jobs to the connector, which sends it to the TrueSight Server Automation. The connector ensures that even if the application server is in an air-gapped environment, communication between Automation Console and the application server is uninterrupted. 

By default, the connector establishes a connection over the HTTPS protocol using out-of-the-box self-signed certificates. To ensure seamless communication, you must provide the connector information in the hosts file on Server Automation. 

Before you begin

Before running the connector, ensure that the connector is installed and run on Windows and Linux operating systems that match the following criteria:

  • OpenJDK Runtime Environment 18.9 (build 11.0.2+9) is installed on the connector host
  • Port number 443 is open

    Port

    Protocol

    From

    To

    Notes

    443

    HTTPS

    Connector

    Application Server (web services port) and Internet

    Communication with Application Server and Internet

    443

    HTTPS

    Application Server (web services port)

    Connector

    Communication between Application Server and Connector

Installing the Server Automation connector

If there is no earlier instance of Server Automation connector in your environment, do these steps: 

  1. Download the connector file from the location provided in the email message when you complete the activation. 

  2. Extract the tssa_connector.zip file on an internet-enabled server (inbound and outbound). 
    The host where the connector is installed must be accessible to the Server Automation application server. 

  3. Go to /config/creds.json file and add the connector token provided by BMC.
    The workerId value in the creds.json file must match the workerId value in the /config/application.properties file. 

    "connectorToken":<connector-token-value>
    Sample creds.json file with connector token information
    {
          "user": "<worker-id-value>",
          "password": "",
          "deployment": "private",
          "connectorToken": "<connector-token-value>",
           "workerId": "<worker-id-value>",
           endpoints": {
                     "pls": "POLICY_ENDPOINT",
                     "ifi": "",
                     "ifm": "",
                     "wmw": "https://tenant-app-url.bmc.com"
            }
    }

      

  4. On the Server Automation application server, go to the hosts file and add the following:

    Hosts file location

    - Windows: C:\Windows\System32\drivers\etc\hosts

    - Linux: /etc/hosts

    <connector-ip>  tssa.connector.bmc.com

    Note

    If you choose to use DNS, you must register the connector server in the DNS as tssa.connector.bmc.com. No other name is currently supported.

  5. On the server where the connector file is extracted, go to the connector location, and run the following command to install  and start the connector: 
    • Windows: run.bat
    • Linux: run.sh

    The Server Automation connector starts running successfully. 

  6. (Optional) To configure the TrueSight Server Automation connector as a service, do these steps:
    1. Contact BMC Customer Support to obtain the TrueSight Server Automation connector XML file required for this step. 
      See Knowledge Article 000189930 .
    2. Replace the bsa-connector.xml file with the latest one. 
    3. Run the bsa-connector.exe install command.
      A new service is created on the host. 

Updating the TrueSight Server Automation connector

If you already have a running instance of TrueSight Server Automation connector, do these steps: 

  1. Download the connector file from the location provided in the email message. 

  2. Back up the directory where the existing connector is configured and extract the updated tssa_connector.zip file in a new directory on an internet-enabled server (inbound and outbound).
    The host where the connector is installed must be accessible to the TrueSight Server Automation application server. 
  3. From the existing connector /config directory, copy the creds.json and application.properties files to the /config directory where the updated connector file is extracted. 
    If you have received a connector token in the email message, update the connector token in the creds.json file.
  4. Verify whether the workerId value in the /config/creds.json file matches the workerId value in the /config/application.properties file. 
  5. On the server where the connector zip is extracted, go to the connector location, and run the following command to install  and start the connector: 
    • Windows: run.bat
    • Linux: run.sh

    The TrueSight Server Automation connector starts running successfully. 

Enabling debug mode

BMC recommends that you do not modify any other configuration files available in the /config directory. However, you can enable the debug mode on the connector to obtain detailed logging information.

Do this:

  1. Press CTRL+C twice to stop the connector.
  2. Go to <ConnectorLocation>/config, open the log4j.properties file, and change the logging option to debug.

    # Root logger option
    log4j.rootLogger=debug, file
  3. Start the connector.

Where to go next?

Log in to BMC Helix Automation Console with the appropriate credentials to successfully verify the connector installation. See Logging in

Was this page helpful? Yes No Submitting... Thank you

Comments