Managing Orchestration policies

When you create a custom use case on TrueSight Orchestration, associated custom Orchestration actions are enabled on all the events (irrespective of context) on the TrueSight console. If you run such an Orchestration action from a relevant event, it works as needed. However, you need to be careful about running such custom Orchestration actions. For example, you cannot run a custom Orchestration action for upgrading the RAM of a server from a critical event indicating insufficient disk space. 

To avoid analyzing events every time before running a custom Orchestration action, you can create an Orchestration policy and configure the event selection criteria. The event selection criteria determines the type of events on which an Orchestration action must be enabled. Also, in the policy, you can enable the Orchestration action to run automatically when a relevant event occurs and perform triage and remediation actions. 

Use the Configuration > Orchestration Policies page to view and manage a policy. By default, Solution Administrators have full access to all policies in all realms (tenants). Tenant Administrators have full access to all policies in their realm (tenant). 

Before you begin

Ensure that you have already added the custom use case for the custom Orchestration action. For more information, see  Add a custom use case to enable Orchestration actions

Out-of-the-box Orchestration policies

The following table lists the supported out-of-the-box Orchestration policies. You can use these policies to initiate Orchestration actions for different types of use cases.

These policies are editable and can be customized as per your needs.

For more information about each of the use cases, see  Orchestration actions.

Note

The out-of-the-box Orchestration actions are enabled for Windows and Linux operating systems only.

Also, these actions are supported in English locale settings only.

Orchestration PolicyOrchestration actionDescriptionSupported with Presentation Server

BMC_TrueSight-ServiceDown-1_policy

Restart Service (in 11.3.02)

Start Service (in 11.3.03)

Initiate this Orchestration action to triage and remediate service down problems.

Note: The associated Orchestration action is renamed from Restart Service to Start Service in version 11.3.03 of Presentation Server and 20.19.02 of the Event Orchestration runbook.

11.3.02, 11.3.03
BMC_TrueSight-HostDown-1_policyCheck Host ConnectionInitiate this Orchestration action to triage host down problems.11.3.02, 11.3.03
Apache Web Server Service DownStart Apache Web Server Initiate this action to triage and start the Apache Web Server service.11.3.03
Microsoft Exchange Service Down

Start Microsoft Exchange service 

Initiate this action to triage and start the Microsoft Exchange service.11.3.03
Microsoft SQL Service Down

Start Microsoft SQL service

Initiate this action to triage and start the Microsoft SQL service.11.3.03
Oracle Service Down

Start Oracle service

Initiate this action to triage and start the Oracle database service.11.3.03
Disk Space Full

Free up disk space

Initiate this action to triage and clean free up disk space.

Note: You need to configure this Orchestration action to delete the specific files that are not required.

11.3.03
PATROL Agent Service Down

Start PATROL Agent 

Initiate this action to triage and start the PATROL Agent service.11.3.03
Print Spooler Service Down

Start Print Spooler

Initiate this action to triage and start the Print Spooler service.11.3.03
Remedy Service Down

Start BMC Remedy AR System Server service

Initiate this action to triage and start the BMC Remedy AR System server service.11.3.03
RSCD Agent Service Down

Start RSCD agent

Initiate this action to triage and start the RSCD Agent service.11.3.03
Microsoft Skype Service Down

Start Microsoft Skype service

Initiate this action to triage and start the Microsoft Skype service.11.3.03
SNMP Service DownStart SNMP serviceInitiate this action to triage and start the SNMP service.11.3.03
TrueSight Server Automation Service Down

Start TrueSight Server Automation service

Initiate this action to triage and start the TrueSight Server Automation service.11.3.03

To create an Orchestration policy

  1. Go to Configuration > Orchestration Policies and click Create Policy.
  2. In the Create Orchestration Policy page, specify the following details and click Save.

    FieldDescription
    NameUnique name to identify the policy.
    Enable Policy(Optional) Indicates whether the policy is enabled or disabled. By default, the policy is disabled. 
    Automate Orchestration Action(Optional) Indicates whether the Orchestration action will run automatically. If you enable automation, when relevant events occur (determined by the event selection criteria), the selected Orchestration action is automatically run for triage and remediation purposes.

    Note: In the following scenarios, the actions will not be run automatically. In such scenarios, you can manually run the Orchestration action from the relevant events.
    • If the Orchestration policy is disabled
    • If the TrueSight Orchestration component is down 
    • If a bulk of events are received at the same time
    Orchestration ActionSelect the Orchestration action for which you want to configure event selection.
    Event Selection CriteriaConditions to select events on which the policy is applied. To create conditions, you need to first select an appropriate class. The selection criteria consists of opening parenthesis, followed by the slot name, the operator, the slot value (which can be a string based on the type of slot selected), and the closing parenthesis. You can optionally select the logical operator AND or OR to add additional conditions.

To edit an Orchestration policy

  1. On the Configuration > Orchestration Policies page, select a policy. 
  2. From the policy action menu, select Edit.
  3. Change the configuration details provided while creating the policy and click Save.

To view an Orchestration policy

On the Configuration > Orchestration Policies page, click the policy name.

Alternatively, select a policy. From the policy action menu, select View.

To enable or disable an Orchestration policy

  1. On the Configuration > Orchestration Policies page, select one or more policies.
  2. Do one of the following:
    • To enable a policy: From the policy action menu or from the common action menu, select Enable or Disable as required.
    • To enable multiple policies: From the common action menu, select Enable or Disable as required.

To delete an Orchestration policy

  1. On the Configuration > Orchestration Policies page, select one or more policies.
  2. Do one of the following:
    • To delete a policy: From the policy action menu or from the common action menu, select Delete and click Yes.
    • To delete multiple policies: From the common action menu, select Delete and click Yes.

To enable or disable automation of the Orchestration action in the policy

  1. On the Configuration > Orchestration Policies page, select one or more policies.
  2. Do one of the following:
    • To enable automation for a policy: From the policy action menu or from the common action menu, select Enable Automation or Disable Automation as required.
    • To enable automation for multiple policies: From the common action menu, select Enable Automation or Disable Automation as required.

Fields and options on the Orchestration Policies page

The following figure highlights the various fields and options that are available on the Orchestration Policies page.

#Field / OptionDescription
1Main action menuEnables you to create a new policy.
2Policies table

Displays the list of policies created.

The table columns display the following information:

  • Name of the policy
  • The selected Orchestration action
  • The selected class
  • Orchestration action automation status - whether the action will run automatically
3Common action menu

Allows you to perform operations such as viewing, copying, enabling, enabling automation (for Orchestration actions), editing, and deleting multiple policies.

Note: You can delete disabled policies only. You cannot edit or view multiple policies.

4Policy action menu

Displays options depending on the policy status:

Menu optionAllows you to...
Enable Automation / Disable Automation

Enable or disable automation of the Orchestration action selected in the policy.

When you enable automation, the Orchestration action is automatically run for triage and remediation purposes.

EditEdit and change details of an Orchestration policy.
Enable / DisableEnable an Orchestration policy.
CopyCreate a copy of an Orchestration policy. You can later modify it as per your needs.
Delete

Delete an Orchestration policy.

Note: You can delete disabled policies only.

View

View details of an Orchestration policy.

Alternatively, you can view policy details by clicking the policy name.

5Create policy buttonA quick access button that enables you to create a policy.
6Policy search iconEnables you to find a policy by performing a search on its properties that are shown as columns in the Policies table. 
The search is case insensitive.
7Refresh pageEnables you to manually refresh the page

Where to go from here

After verifying that the custom Orchestration action is getting displayed correctly, you can directly initiate the Orchestration action to perform triage or remediation based on your use case. For more information about initiating Orchestration actions, see  Using Orchestration actions to enable triage and remediation of events.

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

Comments

  1. Sharad Srivastava

    Team,

    Can we perform the CRUD operation through Web Service call for Orchestration policies.

    Thanks Sharad

    Jan 06, 2020 01:21
    1. Priyanka Nanwani

      Hi Sharad,

      We are not supporting any external web services for Orchestration policies.

      Priyanka

      Jan 14, 2020 05:56