Configuring the BMC Atrium CMDB adapter

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

This topic describes the properties to configure the BMC Atrium CMDB adapter:


Before you begin

To obtain the Web Service URL for the adapter configuration, perform the following steps:

  1. Go to http://host:port/cmdbws/services/listServices to open the list of services for the Atrium Web Service.
  2. Verify that the list of services contains "cmdbws" and that the Service Status is Active.
  3. Copy the Web Service URL specified under the Service EPR heading.

    Examples

    For BMC Atrium CMDB 2.0: http://host:port/cmdbws/server/cmdbws
    For BMC Atrium CMDB 7.5 and later: http://host:port

  4. Paste the URL into the Soap Url configuration element of your adapter configuration.

    Note

    You must only use the procedure when you want to use the CMDB Web Service version 2.0 to configure the BMC Atrium CMDB version 7.6.03.00 with a CMDB adapter.

    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 XML sample 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 BMC Atrium Orchestrator Application Adapter for BMC Atrium CMDB contains an actor adapter only; it does not include a monitor adapter. The default name for the actor adapter is BMCAtriumCMDBActorAdapter.

To configure the actor adapter

  1. Log on to the BMC Atrium Orchestrator 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 ro-adapter-bmc-atrium-cmdb-actor 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 jump 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.
      The configuration elements for each adapter are described in that adapter's section. Include all required elements indicated with an asterisk (*).
    4. ( optional ) Click Switch to XML Viewand use the following steps to specify elements and attributes that are not in the form view.

      Note

      Switching to the XML view to specify those elements and attributes not included in the form means that you cannot thereafter use the form for modifying that configuration.

  7. On the Warning message that appears, click Switch View.
  8. In the Properties text box, use XML format to enter the configuration elements and attributes not available as fields in the form view.
  9. Click OK.
  10. (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. On the Warning message that appears, click Switch View.
    4. Copy the configuration elements from the XML sample 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 node elements required to configure 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.

Valid format for CMDB applications 7.5 and 7.6: http://<host>:<port>

For more information about obtaining the Webservice URL, see the Before you begin section.

Yes

Version

<version>

Specifies the version of the CMDB application with which the adapter communicates

Valid values: v2.0 (default), v7.5, v7.6, v8.0, v8.1, v9.0, v9.1

No

Patch

<patch>

Specifies the patch number of the BMC Atrium CMDB application to which the adapter communicates

The patch number can be specified if the CMDB application uses out-of-box keystores for encryption and digital signature

Valid values: 001 and 003

No

Install Certificate

<install-certificate>

Indicates whether to install the SSL certificates

Valid values: true, false (default)

No

Passphrase

<passphrase>

Specifies the Java standard Trust Key Store Pass Phrase Default value: changeit

No

Nonce Validation

<nonce-validation>

Indicates whether to include the wsse:Nonce (a randomly generated unique number) element in the wsse:UsernameToken

Valid values: true, false (default)

No

Created Validation

<created-validation>

Indicates whether to include the wsse:Created element in the wsse:UsernameToken

Valid values: true, false (default)

No

Sign Request

<sign-request>

Indicates whether a SOAP request should include a digital signature

Valid values: true, false (default)

No

Encrypt Request

<encrypt-request>

Indicates whether a SOAP request should be encrypted

Valid values: true, false (default)

No

Verify Reponse Signature

<verify-response-signature>

Decides whether to verify the XML digital signature of the received SOAP response

Valid values: true, false (default)

No

Decrypt Response

<decrypt-response>

Decides whether to decrypt the SOAP response

Valid values: true, false (default)

No

None

<signature-properties>

Contains the nodes to specify the information about keystore, used for XML digital signature and decryption

No

None

<keystore-type>

Specifies the type of keystore

Valid values: JKS(default), JCEKS, PCKS12

No

None

<keystore-file>

Configures the adapter to use the keystore specified by the keystore file name

The <keystore-file> element must contain the absolute path of the keystore file.

No

None

<keystore-password>

Specifies the password of the keystore

No

None

<alias>

Specifies the name of the asynchronous private key used by the adapter to sign its outgoing SOAP messages

No

None

<password>

Specifies the password for the specified <alias>

No

None

<encryption-properties>

Contains the nodes used to specify information about the keystore, used for encryption and digital signature verification

No

None

<encryption-user>

Specifies the name of the asynchronous public key used by the adapter to encrypt the SOAP requests

No

Atrium Instances URL

<atrium-instances-url >

Specifies the URL for the Atrium Instances Service

Conditional; required with CMDB version 7.6.03 and later

Atrium Instances WSDL

<atrium-instances-wsdl>

Specifies the WSDL location for the Atrium Instances Service

Conditional; required with CMDB version 7.6.03 and later

Atrium Versions URL

<atrium-versions-url>

Specifies the URL for the Atrium Versions Service

Conditional; required with CMDB version 7.6.03 and later

Atrium Versions WSDL

<atrium-versions-wsdl>

Specifies the WSDL location for the Atrium Versions Service

Conditional; required with CMDB version 7.6.03 and later

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

The following figure shows an XML sample for configuring the adapter using the BMC Atrium CMDB 7.5 application with out-of-box keystores:


XML template for configuring the actor adapter

<config>
<soap-url></soap-url>
<atrium-instances-url></atrium-instances-url>
<atrium-instances-wsdl></atrium-instances-wsdl>
<atrium-versions-url></atrium-versions-url>
<atrium-versions-wsdl></atrium-versions-wsdl>
<version></version>
<patch></patch>
<install-certificate></install-certificate>
<passphrase></passphrase>
<nonce-validation></nonce-validation>
<created-validation></created-validation>
<sign-request></sign-request>
<encrypt-request></encrypt-request>
<verify-reponse-signature></verify-reponse-signature>
<decrypt-response></decrypt-response>
<signature-properties>
  <keystore-type></keystore-type>
  <keystore-file></keystore-file>
  <keystore-password></keystore-password>
  <alias></alias>
  <password></password>
</signature-properties>
<encryption-properties>
  <keystore-type></keystore-type>
  <keystore-file></keystore-file>
  <keystore-password></keystore-password>
  <encryption-user></encryption-user>
</encryption-properties>
</config>


The following figure shows an XML sample for configuring the actor adapter using the BMC Atrium CMDB 7.5 application with out-of-box keystores:

XML sample for configuring the actor adapter with out-of-box keystores

<config>
  <soap-url>http://abc-lt-01:9090</soap-url>
  <version>v7.5</version>
  <nonce-validation>true</nonce-validation>
  <created-validation>true</created-validation>
  <sign-request>true</sign-request>
  <encrypt-request>true</encrypt-request>
  <verify-reponse-signature>true</verify-reponse-signature>
  <decrypt-response>true</decrypt-response>
</config>

The following figure shows an XML sample for configuring the adapter using the BMC Atrium CMDB 7.5 application (patch 001) with custom keystores:

XML sample for configuring the adapter with custom keystores

<config>
  <soap-url>https://abc-lt-01:9090</soap-url>
  <version>v7.5</version>
  <patch>001</patch>
  <install-certificate>true</install-certificate>
  <passphrase>changeit</passphrase>
  <nonce-validation>true</nonce-validation>
  <created-validation>true</created-validation>
  <sign-request>true</sign-request>
  <encrypt-request>true</encrypt-request>
  <verify-reponse-signature>true</verify-reponse-signature>
  <decrypt-response>true</decrypt-response>
<signature-properties>
    <keystore-type>jks</keystore-type>
    <keystore-file>D:\CMDB 7.5\security\cmdbwsclient.jks</keystore-file>
    <keystore-password>password</keystore-password>
    <alias>cmdb</alias>
    <password>mycmdb</password>
  </signature-properties>
  <encryption-properties>
    <keystore-type>jks</keystore-type>
    <keystore-file>D:\CMDB 7.5\security\cmdbwsserver.jks</keystore-file>
    <keystore-password>password</keystore-password>
    <encryption-user>cmdbserver</encryption-user>
  </encryption-properties>
</config>

The following figure shows an XML sample for configuring the actor adapter for CMDB version 7.6.03 with default security settings:

XML sample for configuring the actor adapter for CMDB version 7.6.03 with default security settings

<config>
  <soap-url>http://vm-xxx-abcd:1296</soap-url>
  <atrium-instances-url>https://vm-xxx-abcd:1297/atriumws7603/services
/atrium_instances</atrium-instances-url>
  <atrium-instances-wsdl>http://vm-xxx-abcd:1296/atriumws7603/services
/atrium_instances.wsdl</atrium-instances-  wsdl>
  <atrium-versions-url>https://vm-xxx-abcd:1297/atriumws7603/services
/atrium_versions</atrium-versions-url>
  <atrium-versions-wsdl>http://vm-xxx-abcd:1296/atriumws7603/services
/atrium_versions.wsdl</atrium-versions-wsdl>
  <version>v7.6.03</version>
  <install-certificate>true</install-certificate>
  <passphrase>changeit</passphrase>
</config>


The following figure shows an XML sample for configuring the actor adapter for CMDB version 7.6.03 with all security policies turned on:

XML sample for configuring the actor adapter for CMDB version 7.6.03 with all security policies turned on

<config>
  <soap-url>http://vm-xxx-abcd:1296</soap-url>
  <atrium-instances-url>https://vm-xxx- abcd:1297/atriumws7603/services
/atrium_instances</atrium-instances-url>
  <atrium-instances-wsdl>http://vm-xxx- abcd:1296/atriumws7603/services
/atrium_instances.wsdl</atrium-instances-wsdl>
  <atrium-versions-url>https://vm-xxx- abcd:1297/atriumws7603/services
/atrium_versions</atrium-versions-url>
  <atrium-versions-wsdl>http://vm-xxx- abcd:1296/atriumws7603/services
/atrium_versions.wsdl</atrium-versions-wsdl>
  <version>v7.6.03</version>
  <install-certificate>true</install-certificate>
  <passphrase>changeit</passphrase>
  <nonce-validation>true</nonce-validation>
  <created-validation>true</created-validation>
  <sign-request>true</sign-request>
  <encrypt-request>true</encrypt-request>
  <verify-reponse-signature>true</verify-reponse-signature>
  <decrypt-response>true</decrypt-response>
</config>

The following figure shows an XML sample for configuring the actor adapter using the BMC Atrium CMDB 2.0 application:

XML sample for configuring the actor adapter using BMC Atrium CMDB 2.0

<config>
  <soap-url>http://vm3-xxx-abcd:9090/cmdbws</soap-url>
  <version>v2.0</version>
</config>

The following figure shows an XML sample for configuring the actor adapter using the BMC Atrium CMDB 8.1 application:

XML sample for configuring the actor adapter using BMC Atrium CMDB 8.1

<config> 
  <soap-url>http://vm-xxx-abcd:34560</soap-url> 
  <atrium-instances-url>https://vm-xxx-abcd34561/atriumws81/services/atrium_instances</atrium-instances-url> 
  <atrium-instances-wsdl>http://vm-xxx-abcd:34560/atriumws81/services/atrium_instances.wsdl</atrium-instances-wsdl> 
  <atrium-versions-url>https://vm-xxx-abcd:34561/atriumws81/services/atrium_versions</atrium-versions-url> 
  <atrium-versions-wsdl>http://vm-xxx-abcd:34560/atriumws81/services/atrium_versions.wsdl</atrium-versions-wsdl> 
  <version>v8.1</version> 
  <install-certificate>true</install-certificate> 
  <passphrase>changeit</passphrase> 
  <nonce-validation>false</nonce-validation> 
  <created-validation>false</created-validation> 
  <sign-request>false</sign-request> 
  <encrypt-request>false</encrypt-request> 
  <verify-reponse-signature>false</verify-reponse-signature> 
  <decrypt-response>false</decrypt-response> 
</config>
Was this page helpful? Yes No Submitting... Thank you

Comments