Configuring the NetApp RCU actor adapter

You can add an adapter in BMC Atrium Orchestrator Grid Manager by defining a configuration. This configuration provides information about how to interact with the NetApp Rapid Cloning Utility (RCU) application. You can add multiple adapters with the same adapter type to allow for different configuration properties. Each adapter must have a unique name.

Note

Before adding an adapter configuration, ensure that you have completed all the prerequisite tasks.

To configure the actor adapter

  1. Log on to Grid Manager.
  2. To access the adapters page, click the Manage tab, and then click the Adapters tab.
  3. On the Adapters in the Repository list, select the bmc-adapter-netapp-rcu-actor check box.
  4. To include the adapter in the Adapters on Grid list, click Add to Grid.
  5. Click Configure corresponding to the newly added adapter.
  6. On the Add an Adapter Configuration page, perform the following steps to specify the properties for the new adapter:
    1. Enter a name for the adapter.

      Tip

      Use NetAppRCUActor as the adapter name, which is the default adapter name used by the processes in the AO-AD-NetApp_Rapid_Cloning_Utility module.

    2. Enter a description for the adapter.
    3. Under Properties, enter the adapter configuration properties in an XML format, including all the required elements as indicated in the following table.
      The Properties text box must contain a valid XML configuration node for the adapter, as shown in Sample XML template for configuring the actor adapter using a plain password and Sample XML template for configuring the actor adapter using an encrypted Base64 password. These samples show all the possible elements. If the default value for a non-required element is acceptable, omit the element. Do not include any empty elements.
    4. Click OK.
      A confirmation message is displayed on the Adapters page when the changes are saved.

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

Node elements required to configure the actor adapter

Element

Description

Required

<vcenter-target>

Specifies the target server where the VMware VCenter server is running

Yes

<user-name>

Specifies the user name required to log on to the VCenter server

Yes

<password>

Specifies the password that corresponds to the user name

You can encrypt the password by specifying the encryption-type attribute.

For example: <password encryption-type = "Base64">cGFzc3dvcmQ=</password>

Yes

<rcu-service-target>

Specifies the server where the NetApp Rapid Cloning Utility or the Virtual Storage Console service is running

Default value: 'vcenter-target'

No; required when the NetApp Rapid Cloning Utility or the Virtual Storage Console service is running on a different server than the VCenter server

<rcu-service-port>

Specifies the port where the NetApp Rapid Cloning Utility or the Virtual Storage Console service is running

Default values:

  • 61921 for NetApp Rapid Cloning Utility version 3.0
  • 8143 for Virtual Storage Console version 2.0

No

<rcu-service-protocol>

Specifies the protocol used by the NetApp Rapid Cloning Utility or the Virtual Storage Console service.

Valid values: http (default), https

No

<version>

Specifies the version of the NetApp Rapid Cloning Utility or the Virtual Storage Console plug-in integrated with the VCenter server

Valid values: rcu 3.0 (default), vsc 2.0, vsc 2.1.1

No

<use-ssl-certificate>

Specifies whether SSL certification is required for authentication

Valid values: true, false (default)

Conditional. If the value of the <rcu-service-protocol> element is set to https, the value of <use-ssl-certificate> should be set to true.

<allow-unsigned-certificate>

Specifies whether unsigned certificates are permitted for SSL authentication

Valid values: true, false (default)

No

<install-certificate>

Specifies whether installation of certificates is required

Valid values: true, false (default)

No

<passphrase>

Specifies the password to authenticate the SSL certificate on the target server

Default value: changeit

No

<controller-connection-parameters>

Specifies the parent tag that contains the storage controller authentication information

Yes

<user-name>

Specifies the user name to authenticate a storage controller

Yes

<password>

Specifies the password that corresponds with the user name

You can encrypt the password by specifying the encryption type attribute.

For example: <password encryption-type = "Base64">cGFzc3dvcmQ=</password>

No

<ssl>

Specifies whether SSL is used for communication

If the storage controller uses SSL to communicate, set <ssl> to true.

Valid values: true, false (default)

No

Sample XML template for configuring the actor adapter using a plain password

<config>
<vcenter-target>d-13096.xyz.com</vcenter-target>
<user-name>username</user-name>
<password>password</password>
<rcu-service-target>172.11.11.111</rcu-service-target>
<rcu-service-port>61922</rcu-service-port>
<rcu-service-protocol>http</rcu-service-protocol>
<version>rcu 3.0</version>
<use-ssl-certificate>true</use-ssl-certificate>
<allow-unsigned-certificate>true</allow-unsigned-certificate>
<install-certificate>true</install-certificate>
<passphrase>changeit</passphrase>
<controller-connection-parameters>
<user-name>username</user-name>
<password>password</password>
<ssl>false</ssl>
</controller-connection-parameters>
</config>

Sample XML template for configuring the actor adapter using an encrypted Base64 password

<config>
<vcenter-target>d-13096.xyz.com</vcenter-target>
<user-name>username</user-name>
<password encryption-type="Base64">cGFzc3dvcmQ=</password>
<rcu-service-target>172.11.11.111</rcu-service-target>
<rcu-service-port>61922</rcu-service-port>
<rcu-service-protocol>http</rcu-service-protocol>
<version>rcu 3.0</version>
<use-ssl-certificate>true</use-ssl-certificate>
<allow-unsigned-certificate>true</allow-unsigned-certificate>
<install-certificate>true</install-certificate>
<passphrase>changeit</passphrase>
<controller-connection-parameters>
<user-name>username</user-name>
<password encryption-type="Base64">cGFzc3dvcmQ=</password>
<ssl>false</ssl>
</controller-connection-parameters>
</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 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

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

Comments