Skip to Content

Configuring the monitor adapter for VMware vCloud

You can use the form view for configuring the monitor adapter. Use rules to specify the action to be taken when the response is received.

To configure the monitor adapter

  1. Log on to 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-vmware-vcloud-monitor 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, configure the adapter by using the form view as follows, or skip to step 7 to configure the adapter by 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 as follows:
    1. Enter a name and a description for the adapter.
    2. Click Switch to XML View.
    3. On the Warning message that appears, click Switch View.
    4. Copy the configuration elements and attributes from the XML sample into the Properties text box, and then click OK.
    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.
Warning

Note

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

The following figure shows the configuration elements for the monitor adapter:

Node elements required for configuring the monitor adapter

UI label

Element

Description

Required

Vcloud Api Url

<vcloud-api-url>

Specifies the URL for the VMware vCloud Director
Valid values:

 http://hostName, https://hostName 

Yes

Vcloud Organization

<vcloud-organization>

Specifies the name of the vCloud organization

Yes

User Name

<user-name>

Specifies the user name required for basic HTTP authentication on vCloud

Yes

Password

<password>

Contains the password corresponding to the specified user name

Yes

Use Ssl Certificate

<use-ssl-certificate>

Specifies whether to establish a secure connection
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)

No

Install Certificate

<install-certificate>

Specifies whether to install certificates
Valid values: true, false (default)

No

Passphrase

<passphrase>

Specifies the Java Standard Trust Keystore passphrase
Default value: changeit

No

Poll Interval

<poll-interval>

Specifies the poll interval (in seconds) for fetching new monitor events
Default value: 60 seconds

No

Return History

<return-history>

Specifies whether the history of events should be returned when the adapter is enabled for the first time
Valid values: true, false (default)

No

Number Of Retries

<number-of-retries>

Specifies the number of retries allowed if the adapter is in a fault state
Default value: 3

No

Retry Wait

<retry-wait>

Specifies the retry interval (in seconds) for recovering the adapter from the fault state
Default value: 60 seconds

No

The following figure shows an XML sample for configuring the monitor adapter:

XML sample for configuring the monitor adapter

<config>
   <vcloud-api-url>https://10.128.248.112</vcloud-api-url>
   <vcloud-organization>BMCDevOrg</vcloud-organization>
   <user-name>user1</user-name>
   <password>k*ngo*eew</password>
   <use-ssl-certificate>true</use-ssl-certificate>
   <allow-unsigned-certificate>true</allow-unsigned-certificate>
   <install-certificate>true</install-certificate>
   <passphrase>changeit</passphrase>
   <poll-interval>30</poll-interval>
   <return-history>true</return-history>
   <number-of-retries>3</number-of-retries>
   <retry-wait>60</retry-wait>
</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.

Warning

Note

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

These parameters are available with supported adapter versions. See your adapter 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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 24.3