Configuring the TrueSight Orchestration connector

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

Overview

As an administrator, you configure a connector to enable integration with TrueSight Orchestration for change management. For a vulnerability operation, you can now create a change ticket with an approval process in BMC Remedy IT Service Management. TrueSight Orchestration connector establishes a connection and enables communication between TrueSight Orchestration and BMC Helix Automation Console (SaaS) and TrueSight Automation Console (on-premises). For more details, see Change automation

In version 20.02, you can configure the connector using REST APIs only. 

This topic describes the URL, method, and sample configuration for only configuring the connector. For more information about the supported connector API calls see, Using REST API

Configuring connector for TrueSight Automation Console

For TrueSight Automation Console (on-premises), the connector is available as a container after the installation is complete. 

To use this REST API, you must first create an authorized session with administrator credentials. For more information, see, Using REST API.

POST/api/v1/connectors

Request body parameters

NameDescriptionRequired
nameSpecifies the name of the connector.Yes
descriptionSpecifies the optional description for the connector.No
type

Specifies the type of the connector.

Valid value: TSO

Yes
host

Specifies the host where TrueSight Orchestration server is installed.

Yes
port

Specifies the port number on which the TrueSight Orchestration – Grid Manager component is running.

Default value: 38080

Yes
protocolSpecifies the Grid Manager protocol.Yes
properties

Contains the properties to connect to the TrueSight Orchestration Grid Manager.

Yes
username

Specifies the username required to login to the Grid Manager.

Default value: aoadmin

Yes
password

Specifies the password that matches the username.

Yes
gridSpecifies the name of the grid.Yes
change_approval_required

Specifies whether to enable change approval.

Valid values: true, false.

If true, change request creation and approval is mandatory when you create a vulnerability remediation operation in Automation Console.

If false, you can skip change creation and approval while creating a vulnerability operation.

Yes

Sample request JSON

{
    "name": "TSO CONF",
    "description": "TSAC AO configuration",
    "type": "TSO",
    "admin_role": "",
    "host": "<hostname>",
    "port": 38080,
    "protocol": "https",
    "properties": {
        "username": "aoadmin",
        "password": "<password>",
        "grid": "MyGrid",
        "change_approval_required": "false"
    }
}

Sample response JSON

{
    "connector_id": "fe11975a-08b8-4184-b497-391f136aa746",
    "name": "TSO CONF",
    "description": "TSAC AO configuration",
    "admin_role": "",
    "host": "tso.bmc.com",
    "port": 38080,
    "protocol": "https",
    "type": "TSO",
    "properties": {
        "username": "aoadmin",
        "password": "RKy3Q6NHz05RFC7CCzzKRQ==",
        "grid": "MyGrid",
        "change_approval_required": "false"
    },
    "worker_id": "tso-connector"
} 

Responses

CodeDescription
200OK

401

Unauthorized

500

Internal Server Error

Configuring connector for BMC Helix Automation Console

In a BMC Helix Automation Console environment, you must first configure the connector, then download the connector file, and run it in your environment. 

  1. Create an authorized session with administrator credentials by using the POST /api/v1/sessions API call.
    See Using REST API.

  2. Configure the connector by using the POST /api/v1/connectors REST API call. 
    See Configuring TrueSight Orchestration connector.
  3. Download the connector file using the REST API call: https://<serverName>/api/v1/connectors/download/{type}
  4. Extract the tso_connector.zip file on an internet-enabled server (inbound and outbound). 
    The host where the connector is installed must be accessible to TrueSight Orchestration.

  5. On TrueSight Orchestration, go to the hosts file and add the following:

    Hosts file location

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

    - Linux: /etc/hosts

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

    Note

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

  6. 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

    TrueSight Orchestration connector starts running successfully. 

Where to go next?

After successfully configuring the connector, you can now complete the tasks required to enable change automation. See Enabling change automation.


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

Comments