Module for the BMC Server Automation adapter

Each command supported by the application adapter has a corresponding process in the adapter module. Top-level processes perform high-level functions and call specialized processes in subdirectories. Each subdirectory contains process directories that correspond to the namespace for that command.

Setup Validation directory

The processes in the Setup Validation directory are examples of operations. A process is provided to test each supported method of executing commands in BMC Server Automation.

The processes in the Setup Validation directory contain sample values for request elements. You can change these sample values to reflect the values in your environment.

Version directories

The adapter module contains the following version-specific directories:

• v7.42
• v7.43
• v7.5
• v7.6
• v8.0
• v8.1

These directories contain subdirectories, organized by namespace, that contain processes to execute BLCLI commands supported by BMC Server Automation.

Utilities directory

The Utilities directory contains general processes that perform validation, error checking, and the low-level actions that are used by processes in the top-level and version directories.

Working with the module

This section is an introduction for building workflows using your knowledge of the BMC Server Automation and TrueSight Orchestration. It guides you through the steps for creating a new process. The process incorporates multiple called processes and uses the Context Item mapping. Details are provided to assist you with determining input parameters and Context Item mapping.

To successfully create a workflow, you must:

• Have a working knowledge of BMC Server Automation
• Have work experience with the BladeLogic Command Line Interface (BLCLI)
• Have successfully completed training for TrueSight Orchestration
• Have successfully completed training for using the TrueSight Orchestration Development Studio or have relevant work experience

To create a Deploy Job, see Creating-a-BMC-BladeLogic-Deploy-Job-to-deploy-a-BMC-BladeLogic-Package.

Executing NSH commands and scripts using the adapter

The BMC Server Automation adapter can execute NSH commands and NSH scripts using the following mechanisms:

• NSH command using the adapter module
• NSH scripts using the <script-directory> element specified in the adapter configuration
• NSH scripts using the <script-directory> element specified in the adapter request, that overrides the value of the <script-directory> element in the adapter configuration

Executing NSH commands using the adapter module

For executing NSH commands using the adapter module, you must specify the connection details for the adapter without including a value for the <script-directory> element.

The following code snippet illustrates the <connection-details> element without a value for the <script-directory> element.

Executing NSH scripts using the <script-directory> element in the configuration

For executing NSH scripts with the value of the <script-directory> element specified in the adapter configuration, you must set the value of <script-directory> to USE_ADAPTER_CONFIG in the connection details for the adapter.

The following code snippet illustrates the <connection-details> element that uses the value of the <script-directory> element in the adapter configuration.

Executing NSH scripts using the <script-directory> element in the adapter request or connection details for the adapter module

For executing NSH scripts with the <script-directory> element specified in the adapter request, you must specify the <script-directory> element in connection details for the adapter.

The following code snippet illustrates the <connection-details> element containing the value of the <script-directory> element.

For more details about using NSH scripts and NSH commands with the BMC Server Automation adapter, see Actor adapter requests and responses for executing scripts and commands on NSH. 

Modifying the command timeout for the adapter

The adapter module deals with command timeout in the following ways:

1. If a value for timeout is not specified in the connection details of a workflow, a default timeout value of 300 seconds is inserted in the adapter request.
2. If a value for timeout is specified in the connection details, the specified value is used for the timeout of the given commands.

You can modify the timeout for commands by adding the <BladeLogicConnectionDetail> element in the workflow. The following code snippet shows an XML sample with the connection details element.