Configuring the NetApp Storage monitor adapter

The monitor adapter receives SNMP traps sent by the NetApp DataFabric Manager application when events occur in the application. On receiving the traps, the adapter creates corresponding events in BMC Atrium Orchestrator that are then used by workflows. If these events correspond to successful provisioning actions, the monitor adapter retrieves details of the provisioned storage and sends this data to the BMC Atrium Orchestrator events.

You configure an adapter in BMC Atrium Orchestrator Grid Manager. The configuration provides information about how the adapter interacts with CA Service Desk. Although 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 errors that might occur when you copy the configuration XML from the adapter documentation to the UI during configuration. 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 XML from that view, you cannot thereafter use the form view to modify that configuration.

Note

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

This topic describes the properties to configure the NetApp Storage monitor adapter:


To configure the monitor adapter

  1. Log on to BMC Atrium Orchestrator Grid Manager.
  2. To access the adapters page, click the Manage tab, and then click the Adapters tab.
  3. In the Adapters in Repository list, select the bmc-adapter-netapp-storage-monitor 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 configure the adapter by using the form view, 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, which are indicated with an asterisk (*).
    4. Click OK.
      The newly configured adapter is now listed in the Adapters on Grid list.
  7. (Optional) Configure the adapter in the XML view by performing the following steps:

    Note

    If you switch to the XML view, you cannot thereafter use the form view to modify the configuration.

    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. In the Properties text box, use XML format to enter the configuration elements and attributes, 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.
      The adapter configuration with settings is saved 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 monitor adapter. You cannot use the form view to configure elements and attributes that do not have an entry in the UI label column.

Node elements required for configuring the monitor adapter

UI label

Element

Description

Required

None

<config>

Specifies a container element for all other elements.

Yes

Target

<target>

Specifies the target server on which the Data Fabric Manager (DFM) server is running

Yes

User Name

<user-name>

Specifies the user name to be used for server authentication

Yes

Password

<password>

Specifies the password that corresponds to the <user-name>

The password element can contain an encryption-type attribute.

Yes

Encryption Type

<encryption-type>

Indicates whether the password specified is encrypted; is an attribute of the < password > element, not an element itself

Valid values: Base64, Plain (default)

No

Protocol

<protocol>

Specifies the protocol which the adapter uses to contact the DFM server

Valid values: http (default), https.

No

Netapp Server Port

<netapp-server-port>

Specifies the port on which the adapter will contact the DFM server

The value depends upon the protocol selected.

Default value: 8088(for "http" protocol), 8488(for "https" protocol).

No

Port

<port>

Specifies the port on which to listen for SNMP traps

Note

(UNIX only) If the SNMP-based monitor adapter for NetApp Storage is configured with a port number less than 1024, you must ensure that the peer is configured with administrator or root privileges.

Yes

Version

<version>

Specifies the SNMP version Default value: 1

Yes

Mibs Directory

<mibs-directory>

Specifies the directory location for SNMP MIBS

Note

This directory should include the following mib files:

  • NETWORK-APPLIANCE-MIB.mib: Available on internet as a generic download.
  • dfm.mib: Can be downloaded from NetApp community sites.

Yes








Note

UNIX Only: If the SNMP-based monitor adapter for NetApp Storage is configured with a port number less than 1024, you must ensure that the peer is configured with administrator or root privileges.

XML sample for Base64 configuration

<config>
  <target>172.11.11.111</target>
  <user-name>username</user-name>
  <password encryption-type="Base64">cGFzc3dvcmQ=</password>
  <protocol>http</protocol>
  <netapp-server-port>8088</netapp-server-port>
  <port>1620</port>
  <version>1</version>
  <mibs-directory>C:netapp-mibs</mibs-directory>
</config>

Adapter configuration properties

This section describes some common configuration properties than you can add Properties section of the Adapter Configuration page.

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.

Note

You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use this encryption attribute.

For example, to encrypt the port number used by the adapter, the XML would look similar to the following:

<port secure="true">8088</port>

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