Configuring the BMC Network Automation adapter

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the BMC Network Automation application. While each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.

The form view provides an easy-to-use interface for configuring adapters. The form view prevents human errors that might occur as a result of copying the configuration XML from the adapter user guide into the UI when configuring an adapter. You can switch to the XML view to configure those elements and attributes that are not available as fields or to configure all the elements and attributes using XML only. However, after you switch to the XML view, and save the configuration in the XML from that view, you cannot thereafter use the form view for modifying that configuration.

Note

The TrueSight Orchestration Application Adapter for BMC Network Automation contains an actor adapter only; it does not include a monitor adapter. The default name for the actor adapter is BCANActor.

To configure the adapter

  1. Log on to the TrueSight Orchestration Grid Manager.
  2. Access the adapters page by clicking the Manage tab; then click the Adapters tab.
  3. In the Adapters in Repository list, select the bmc-adapter-bmc-network-automation-actor versionNumber check box.
  4. Click Add to Grid to include the adapter in the Adapters on Grid list.
  5. Click Configure corresponding to the newly added adapter.
  6. On the Add an Adapter Configuration page, perform the following substeps to configure the adapter using the form view or skip to step 7 to configure the adapter using the XML view:
    1. Enter a name for the adapter.
    2. Enter a description for the adapter.
    3. Under Properties, enter or select values for the configuration elements.
      Include all required elements indicated with an asterisk (*).
  7. ( optional ) Configure the adapter in the XML view using the following substeps:
    1. Enter a name and a description for the adapter.
    2. Click Switch to XML View.
    3. In the Warning message, click Switch View.
    4. Copy the configuration elements and attributes from the adapter user guide into the Properties text box, and then click OK.

      Note

      If the default value for an optional element is acceptable, omit the element. Do not include empty elements.

    5. On the Warning message that appears, click Save.

      This saves the adapter configuration with settings in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.

      The following table describes the configuration elements for the actor adapter.

Node elements required to configure the actor adapter

UI label

Element

Definition

Required

Soap Url

<soap-url>

Specifies the URL for the remote SOAP service
The <soap-url> element has the following formats:

For insecure communication: <soap-url>http:// IPAddress : portNumber </soap-url>
For secure communication: <soap-url>https:// hostName : portNumber </soap-url>
where,

  • IPAddress is the IP address of the computer where the application server is installed.
  • hostName is the name of the computer where the application server is installed.
  • portNumber specifies the port on which the application server is running, even if it is the default (otherwise, the adapter fails to install the certificate and adapter requests fail).

    Default value (for secure communication): 443

Conditional; required if not specified in the request

User Name

<user-name>

Specifies the user name for the BMC Network Automation server authentication

Conditional; required if not specified in the request

Password

<password>

Specifies the password for the user name specified

Conditional; required if not specified in the request

Soap Version

<soap-version>

Specifies the SOAP version to use

Valid values: 1.1 (default), 1.2

Conditional; required if not specified in the request

Use ssl certificate

<use-ssl-certificate>

Specifies whether to use an SSL certificate to establish a secure connection

Set the value of this element to true when <soap-url> uses HTTPS.
Set the value of this element to false or leave it blank when <soap-url> uses HTTP.

Valid values: true, false (default)

No

Install Certificate

<install-certificate>

Specifies whether to install security certificates automatically

Note


Set the value of this element to true if you prefer to have security certificates installed automatically (a common practice).

Set the value of this element to false if you prefer to manually export the security certificate from the BMC Network Automation server and manually import it into the TrueSight Orchestration's local peer's cacerts file (a rare practice).



Valid values: true, false (default)

No

Allow Unsigned Certificate

<allow-unsigned-certificate>

Specifies whether to allow unsigned certificates from trusted zones

Valid values: true, false (default)

Set the value of this element to true if you are using self-signed SSL certificates (a common practice).

On ecommerce sites or military installations, if you need to use signed certificates such as Verisign or Thawte, set the value of this element to false (a rare practice).

No

Passphrase

<passphrase>

Specifies the password to the keystore file (cacerts) local to the TrueSight Orchestration peer

Default value: changeit

Warning

  • The value of the <passphrase> element is the passphrase for the cacerts certificate stored on the TrueSight Orchestration local peer (CDP or AP) and not the BMC Network Automation target host.
  • Changing the passphrase can be tricky and might destroy the cacerts security file integrity.



Verify the cacerts passphrase using the following command in UNIX or Linux:

$ /opt/bmc/ao/cdp/jvm/bin/keytool -list -keystore
/opt/bmc/ao/cdp/jvm/lib/security/cacerts

No

The following figure shows an XML sample to configure the adapter for insecure communication.

XML sample to configure the actor adapter for insecure communication

<config>
  <soap-url>http://10.10.75.126:8480</soap-url>
  <user-name>sysadmin</user-name>
  <password>abc123</password>
  <soap-version>1.1</soap-version>
</config>


The following figure shows an XML sample to configure the adapter for secure communication.

XML sample to configure the adapter for secure communication

<config>
  <soap-url>https://s-17157:9443</soap-url>
  <user-name>sysadmin</user-name>
  <password>admin</password>
  <soap-version>1.1</soap-version>
  <use-ssl-certificate>true</use-ssl-certificate>
  <install-certificate>true</install-certificate>
  <allow-unsigned-certificate>true</allow-unsigned-certificate>
  <passphrase>changeit</passphrase>
</config>

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

Note

You must be using TrueSight Orchestration version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of TrueSight Orchestration Platform.

These parameters are available with supported adapter versions. See TrueSight Orchestration Content documentation for details.

  • Log File Name: Provide a name for the log file.
    This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
  • Log File Size: Specify a size limit for the log file. 
    If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
  • Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
  • Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.
  • Log Level: Enter the logging level using one of the following choices:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

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

Comments