Installing the Event Orchestration runbook

This topic describes the process to install the runbook and lists the artifacts that get installed in your environment.

Preparing to install the runbook

  • Download the TrueSight Orchestration Content installation files.
    See, Downloading the installation files
  • Ensure that a compatible TrueSight Orchestration Platform is installed. 
    For instructions, see  Installing – Classic mode Open link .
  • Event Orchestration runbook is compatible with the following product versions:

    ProductSupported version
    TrueSight Presentation Server
    • 11.3.04
    • 11.3.03
    BMC Remedy AR System19.08
    BMC Helix IT Service ManagementLatest version
    TrueSight Orchestration Platform
    • 20.02
    • 8.2

Installing the runbook by using the wizard

You can provide configuration details for BMC Remedy AR System, TrueSight Operations Management, and TrueSight Orchestration platform and content during the installation or configure them later. This section describes the steps to configure the runbook during the installation. 

To install the runbook: 

  1. Navigate to the folder where you have downloaded the installation files and start the installation program.
    • Windows: setup.cmd
    • Linux or Solaris: setup.sh
  2. On the Welcome to TrueSight Orchestration panel, review the information, and on the next page, agree with the License Agreements, and click Next.
  3. On the Directory Selection panel, accept the default location, or click Browse to select a different location. 
  4. On the Repository Communications Settings panel, enter the repository settings:

    • Web Server Protocol: Select https or http 
    • Host Name or IP Address: Enter the fully qualified domain name of the repository server.
    • Web Server Port Number: Enter the port number where the repository is installed. 
    • Repository User: Enter the user name of the account created in Remedy Single Sign-On that you use to log on to the repository.

      Warning

      Ensure that the repository user is not the same as the default Remedy Single Sign-On user.

    • Repository Password: Enter the password that matches the specified user account.
  5. On the Installation Type panel, select BSM Solutions and click Next.
  6. On the Solution feature selection panel, select Event Orchestration and click Next.
  7. On the Adapter feature selection pane, the adapters required for the out-of-the-box use cases are already selected.
  8. (Optional) To configure and enable the adapters on the grid directly from the installer, select the Configure Adapters check box and click Next

    Note

    You can choose to not configure content from the installer, however, in that case, you must configure and enable the adapters after the installation is complete. If selected, the Solution Configuration panel is displayed in the installer where you can provide the configuration details.

  9. On the Module feature selection pane, the modules required for the out-of-the-box use cases are already selected. 
  10. (Optional) To activate and configure the modules on the grid directly from the installer, select the Configure Modules check box that ensures that the modules selected here are activated and on your grid and click Next.

    Note

    You can choose to not configure content from the installer, however, in that case, you must configure and enable the adapters after the installation is complete. If selected, the Solution Configuration panel is displayed in the installer where you can provide the configuration details.

  11. On the ITSM Type panel, select one of the IT Service Management system based on your requirement and click Next.

    • BMC Remedy AR Server

    • BMC Helix

      Note

      This panel appears only if you choose to configure content during the installation.


  12. On the Solution Configuration panel, provide the configuration details for the Event Orchestration runbook: 

    Note

    The Solution Configuration panel is displayed only if you select the Configure Adapters or Configure Modules check box in the previous panel.


    1. On the ITSM tab, provide the following details based on the ITSM system selected in the previous step:

      Field names if BMC Remedy AR System is selectedDescription and values
      AR Server host nameSpecify the name or the IP address where the BMC Remedy AR System server is running.
      AR Server port

      Select Port mapper or assign a specific port of the computer running the BMC Remedy AR System (if known).

      If the BMC Remedy AR System server is configured to use a port mapper, set the port number to 0.
      If the BMC Remedy AR System server is configured to use a specific port to receive requests, assign that specific port number. 

      User nameSpecify the user required to access the BMC Remedy AR Server.
      PasswordSpecify the password that matches the specified user name.
      Field names if BMC Helix is selectedDescription and values

      Jetty Server URL

      Specify the jetty server URL to your BMC Helix application.

      AR Server Host

      Specify the host name where BMC Remedy AR System server is running.
    2. Click the CDP tab and provide the following details: 

      Field nameDescription and values
      Web Server Protocol

      Select https

      Host Name or IP AddressSpecify the fully qualified domain name where the CDP is installed.
      Web Server Port Number

      Specify the port number of the CDP.

      Default value: 38080

      CDPUserSpecify the username required to log on to the grid.
      CDP PasswordSpecify the password that matches the specified user name.
    3. Click the Applications tab and provide the following details and click Next

      Field nameDescription and values
      Presentation Server URLSpecify the URL for the TrueSight Presentation Server
      Presentation Server username

      Specify the username required to log on to the TrueSight Presentation Server

      Note

      Use must have super admin privileges

      Mid-tier URLSpecify the URL required to log on to the BMC Remedy AR System mid-tier server
      Mid-tier userType the user name required to log on to the BMC Remedy AR System mid-tier server
  13. On the Installation preview panel, review the features to be installed, and then click Install.
  14. When the installation finishes, click Done.
    The Event Orchestration run book is installed successfully and you can view the install log at the location displayed on the installer.

Installing the runbook silently

In a silent installation, you run the installation program from a command line. To execute a silent installation, you specify an options file to feed the installation settings to the program. The options file is a text file that defines all the required installation properties.

To run the silent installation:

  1. On a computer that has network access to the repository, navigate to the directory that contains the installation program. 

  2. From the command line, execute the command in the following format to install the Event Orchestration runbook.

    Windows
    <ContentInstallerLocation>\Content\Disk1\setup.cmd -i silent -DOPTIONS_FILE="fullPathToOptionsFile/optionsFile"
    Linux
    <ContentInstallerLocation>\Content\Disk1\setup.sh -i silent -DOPTIONS_FILE="fullPathToOptionsFile/optionsFile"

    The following figure shows a sample options file for installing and configuring the runbook. Use the sample and replace the variable with values that match your environment.

    -P installLocation=C:\Program Files\BMC Software\AO\NewContent
    -J AO_INSTALLING_FEATURES=EventOrchestration
    -J AO_REPOSITORY_PROTOCOL=https
    -J AO_REPOSITORY_HOST=<hostname>
    -J AO_REPOSITORY_PORT=28080
    -J AO_REPOSITORY_USER_NAME=aoadmin
    -J AO_REPOSITORY_PASSWORD=<password>
    -J AO_CDP_HOST=<hostname>
    -J AO_CDP_PORT=38080
    -J AO_CDP_PROTOCOL=https
    -J AO_CDP_USER_NAME=aoadmin
    -J AO_CDP_PASSWORD=<password>
    -J AO_CONTENT_INSTALL_TYPE=INSTALL_TYPE_SOLUTIONS
    ###########################################Event Orchestration properties######################################
    -J CONFIGURE_ADAPTERS=true
    -J CONFIGURE_MODULES=true
    -J INSTALL_REMEDY_ITSM_INTEGRATIONS=false
    -J REMEDY_PORT_NUMBER=0
    -J REMEDY_USER_NAME=
    -J REMEDY_HOSTNAME=<hostname>
    -J REMEDY_PASSWORD=<password>
    -J ITSM_AUTHORING_COMPANY=
    -J ITSM_AUTHORING_ORGANIZATION=
    -J ITSM_AUTHORING_GROUP=
    -J TSPS_URL=<PROTOCOL://HOST:PORT>/tsws/10.0/api
    -J TSPS_USER_NAME=admin
    -J TSPS_TENANT=
    -J MIDTIER_URL=<PROTOCOL://HOST:PORT>//arsys/services/ARService?server=<AR_SERVER_HOST>
    -J MIDTIER_USER_NAME=Orchestrator
    -J ITSM_TYPE=HELIX
    -J JETTY_URL=

    The following table describes the silent installation properties for the options file.

    Property groupProperty nameDescriptionRequired
    Installer location
    -P installLocation
    Specify the directory where the content installer is located.Yes
    Repository communication settings
    -J AO_REPOSITORY_PROTOCOL=https
    -J AO_REPOSITORY_HOST=<hostname>
    -J AO_REPOSITORY_PORT=28080
    -J AO_REPOSITORY_USER_NAME=aoadmin
    -J AO_REPOSITORY_PASSWORD=<RepoPassword>
    Specify the communication settings for the repository where you want to install the runbook. Default port is 28080.Yes
    Content install type
    -J AO_CONTENT_INSTALL_TYPE=INSTALL_TYPE_SOLUTIONS
    Specify the content installation type. Do not change this value.Yes
    Remedy integration settings
    -J REMEDY_PORT_NUMBER=0
    -J REMEDY_USER_NAME=<username>
    -J REMEDY_HOSTNAME=<hostname>
    -J REMEDY_PASSWORD=password
    -J ITSM_AUTHORING_COMPANY=
    -J ITSM_AUTHORING_ORGANIZATION=
    -J ITSM_AUTHORING_GROUP=
    Specify the values that match your environment.No
    Configure content settings
    -J CONFIGURE_ADAPTERS=true
    -J CONFIGURE_MODULES=true
    Specify true if you want to configure and enable the adapters and modules included in the runbook.Conditional; required if you want to configure content from the installer
    BMC Remedy AR Server settings
    -J REMEDY_PORT_NUMBER=0
    -J REMEDY_USER_NAME=<RemedyARServerUser>
    -J REMEDY_HOSTNAME=<RemedyARServerHostname>
    -J REMEDY_PASSWORD=<password>
    If choosing to integrate with BMC Remedy AR System from the installer, specify the BMC Remedy AR Server values with encrypted password.Conditional; required if you want to configure content from the installer
    CDP connection settings
    -J AO_CDP_HOST=<CDPHostname>
    -J AO_CDP_PORT=38080
    -J AO_CDP_PROTOCOL=https
    -J AO_CDP_USER_NAME=aoadmin
    -J AO_CDP_PASSWORD=<password>
    Specify the connection settings for the CDP where the runbook is to be installed. Default port is 38080.Yes
    TrueSight Presentation Server settings
    -J TSPS_URL=<PROTOCOL://HOST:PORT>/tsws/10.0/api
    -J TSPS_USER_NAME=admin
    -J TSPS_TENANT=*
    Specify the connection settings to connect with TrueSight Presentation Server.

    -J TSPS_TENANT can be *

    Conditional; required if you want to configure content from the installer
    BMC Remedy AR System - Mid-tier Host settings
    -J MIDTIER_URL=<PROTOCOL://HOST:PORT>//
    arsys/services/ARService?server=<AR_SERVER_HOST>
    -J MIDTIER_USER_NAME=Username
    Specify the BMC Remedy AR System – mid-tier host connection settings.Conditional; required if you want to configure content from the installer

    BMC Helix settings

    -J MIDTIER_URL=<PROTOCOL://HOST:PORT>//
    arsys/services/ARService?server=<AR_SERVER_HOST>
    -J MIDTIER_USER_NAME=Username
    -J ITSM_TYPE=HELIX
    -J JETTY_URL=
    If choosing to integrate with BMC Helix, specify the ITSM type and the jetty server URL to the BMC Helix application.Conditional; required if you want to configure content from the installer

    The Event Orchestration run book is installed successfully and you can view the install log at the location displayed on the installer.

  3. You can now verify whether the artifacts are installed and then complete the post-installation tasks.

Content artifacts installed with the runbook

When you install the runbook, the adapters, modules, and workflows that constitute the runbook framework and logic for the out-of-the-box use cases are installed in the repository and available in the Grid Manager. These adapters and modules are configured with basic configuration and enabled on the grid. 

The following table lists the adapters and modules installed with the runbook. 

Content typeNameTypeAdapter name on the grid
Adapters

BMC Remedy AR System

ro-adapter-remedy-actor

ARSAdapter_EO

Command Line

ro-adapter-command-line

Command Line_EO

PowerShell

bmc-adapter-microsoft-windows-powershell-actorWindowsPowerShellAdapter_EO
SSH

ro-adapter-ssh

SSHAdapter_EO

REST

ro-adapter-rest

RESTAdapter_EO

Web Services

ro-adapter-ws

SOAPAdapter_EO

Windows Command

ro-adapter-windows-command

WindowsCommandAdapter_EO
Modules
  • AMP-AD-BMC-Remedy-ARS
  • AutoPilot-AD-Utilities
  • AutoPilot-OA-Applications_Utilities
  • AutoPilot-OA-BAOGridManagement
  • AutoPilot-OA-Common_Utilities
  • AutoPilot-OA-Credentials_Store
  • AutoPilot-OA-Errors
  • AutoPilot-OA-Event_Orchestration
  • AutoPilot-OA-File_Utilities
  • AutoPilot-OA-ITSM_Automation
  • AutoPilot-OA-Network_Utilities
  • BMC-AD-Remedy_REST
  • BMC-SA-Event_Orchestration
  • BMC-SA-Event_Orchestration_Configuration
  • BMC-SA-Event_Orchestration_Host_Down
  • BMC-SA-Event_Orchestration_Service_Down
  • BMC-SA-Event_Orchestration_Disk_Space_Full
  • BMC-SA-Event_Orchestration_MSExchange_Down
  • BMC-SA-Event_Orchestration_MSSQL_Service_Down
  • BMC-SA-Event_Orchestration_Oracle_Down
  • BMC-SA-Event_Orchestration_PatrolAgent_Down
  • BMC-SA-Event_Orchestration_Remedy_Down
NANA

Complete the post-installation tasks

The steps in this section are required if you have chosen to configure and activate the adapters and modules from the installer. 

Note

If you have just installed the runbook without configuring and enabling content from the installer, you must perform additional configuration steps before you can start using/implementing the solution. For more information, see the Where to go from here section in this topic.

Configure the SSH adapter

SSH adapter is used to run commands on a remote host using the SSH protocol. SSH adapter is enabled on your grid, but you must provide the remote host details in the adapter configuration. 

  1. On the Grid Manager, click the Manage tab and then click the Adapters tab.
  2. From the Adapters on Grid list, click the SSHAdapter_EO adapter.
  3. On the Edit an Adapter Configuration page, provide the following details:

    ElementDescriptionRequired
    TargetSpecifies the host name or the IP address of the remote host computerYes
    PortSpecifies the port on which the remote host listens.  Default value: 22No
    UsernameSpecifies the user name required for remote host authenticationYes
    Password

    Specifies the password corresponding to the specified user name 

    The <private-key-file> element is used if you do not provide the <password> element. 

    The <password> element can contain an encryption-type attribute.

    If you provide the <password> and <private-key-file>elements in the grid configuration, the <private-key-file> approach is used and the <password> element is ignored.

    Yes
    Encryption TypeIndicates whether the password specified is encrypted; is an attribute of the <password> element, not an element itself 

    Valid values: Base64, Plain (default)
    No
  4. Click Save and enable the adapter on the grid.

Update BMC-SA-Event_Orchestration_Configuration module configuration 

When you configure content from the installer, modules with connection details for BMC Remedy ITSM and TrueSight Presentation Server are configured and activated on the grid. Installer does not provide the option to specify passwords for the target connections. You must specify the password for connecting to BMC Remedy ITSM and TrueSight Presentation Server environments. 

  1. On the Grid Manager, click the Manage tab and then click the Modules tab.
  2. From the Activated On Grid list, click the BMC-SA-Event_Orchestration_Configuration module.
  3. To specify the CDP connection details used for the runbook, on the Edit Module Configuration page, go to Specifics > BAO and provide the TrueSight Orchestration URL, username, and password required to log on to the CDP.
  4. To specify password for the BMC Remedy mid-tier host, on the Edit Module Configuration page, go to Specifics > BMC_AR_System > WebServiceConnectionData and provide the password for the mid-tier host specified in the URL field.
  5. To specify password for the TrueSight Presentation Server host, go to Specifics > BMC_TrueSight > WebServiceConnectionData and provide the password for the host specified in the BASE_URL field.
  6. Save changes.

Update Credentials Store module configuration 

The Credentials Store module contains encrypted passwords for all target servers. Credentials for TrueSight Orchestration, TrueSight Presentation Server, and BMC Remedy IT Service Management are stored in the BMC-SA-Event_Orchestration_Configuration module. Assuming that in an organization, each component type (OS type) can have its own set of credentials, definitions for storing UNIX and Windows Credentials are provided in the module out-of-the-box.

MultiExcerpt named ConfigureCredentialsStore was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro

Where to go next?

Choose one of the following options:

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

Comments