Skip to Content

Configuring the VIS actor adapter

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the VMware Infrastructure 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

Warning

Note

Before creating an adapter configuration, ensure that you have completed all the pre-requisite tasks.

To configure the actor adapter

  1. Log on to BMC Atrium Orchestrator Grid Manager.
  2. To access the adapters page, click the Manage tab, and click the Adapters tab.
  3. On the Adapters in Repository page, select the check box corresponding to the version.
  4. Click Add to Grid.
     The adapter is now listed under Adapters on Grid.

  5. Click Configure corresponding to the newly added adapter. 

    Warning

    Note

    The actor adapter does not support setting up of multiple configurations with a single adapter instance.

  6. On the Add an Adapter Configuration page, perform the following substeps to configure the adapter using the form view or jump to Step 7 to configure the adapter using the XML view:
    1. Specify a name for the adapter.
    2. Specify 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. Specify a name for the adapter. 

      Warning

      Note

      The default adapter name is VMwareInfrastructure.

    2. Specify a description for the adapter.

    3. Click Switch to XML View.  

      Warning

      Note

      Switching to the XML view to specify configuration elements means that you cannot thereafter use the form for modifying the adapter configuration.

    4. Click OK.
    5. On the Warning message that appears, click Switch View.
    6. Warning

      The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

      The Properties text box must contain a valid XML configuration node for the adapter, as shown in the following code sample. This sample shows all possible elements. If the default value for a non-required element is acceptable, omit the element. Do not include empty elements.

      Warning

      The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

    7. Click OK.
    8. 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 adapter configuration elements and attributes for the adapter that you can specify using the form view, XML view, or both.

Node elements required to configure the actor adapter

UI Label

Element

Description

Required

Soap URL

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Default format for HTTPS: https://<hostName>:<port>/sdk/vim

Default format for HTTP: http://<hostName>:<port>/sdk/vim

Warning

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

No

Transport

<transport>

Specifies the transport protocol for the message

If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration.

Valid values: https-rpc (default), http-rpc

Warning

Note

If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.

Yes

User Name

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center

Conditional: required if not specified in the request

Password

<password>

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

Return Mob Ref

<return-mob-ref>

Specifies the format of the adapter response

Valid values: true, false (default)

If <return-mob-ref> is set to true, all the adapter responses contain Managed Object IDs.
If <return-mob-ref> is set to false, all the adapter responses contain display names.

No

Use SSL Certificate

<use-ssl-certificate>

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

Valid values: true, false (default)

Conditional:

  • 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.

Install Certificate

<install-certificate>

Specifies whether to install security certificates automatically

Warning

Note

Set the value of this element to true if you prefer to have security certificates installed automatically (common).
Set the value of this element to false if you prefer to manually export the security certificate from the VirtualCenter server and manually import it into the BMC Atrium Orchestrator's local peer's cacerts file (rare).


Valid values: true, false (default)

No

Passphrase

<passphrase>

Specifies the password to the keystore file (cacerts) local to the BMC Atrium Orchestrator peer

Default value: changeit

Error
Warning
  • The value of the <passphrase> element is the passphrase for the cacerts certificate stored on the BMC Atrium Orchestrator 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

Allow Unsigned Certificate

<allow-unsigned-certificate>

Specifies whether to allow unsigned certificates from trusted zones

Valid values: true, false (default)

Commonly, set the value of this element to true if you are using self-signed SSL certificates.

Rarely, 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.

No

Warning

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

 

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

BMC Atrium Orchestrator Content 20.14.01