Configuring the NetApp Storage polling monitor adapter

The polling monitor adapter polls the NetApp DataFabric Manager application for events after a preconfigured interval. Based on the search criteria defined in the monitor configuration, it generates events for the BMC Atrium Orchestrator adapter manager, which are then used by workflows.

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.

To configure the polling 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-polling-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 polling 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 polling monitor adapter 

UI label

Element

Description

Required

None

<config>

Specifies the container element for all other elements

Yes

Target

<target>

Specifies the target server on which the 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 <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 that 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 on the protocol selected

Default value: 8088 (HTTP), 8488 (HTTPS)

No

Job State

<job-state>

Specifies the state of the jobs to list

If specified, only the jobs that are in the specified state are listed.

Valid values:

  • Queued
  • Running
  • Completed
  • Aborting
  • Aborted

No

Job Overall Status

<job-overall-status>

Specifies the overall status of job based on job-progress and job-state

Valid values:

  • Queued
  • Canceling
  • canceled
  • running
  • running_with_failures
  • partially_failed
  • succeeded
  • failed

No

Max Jobs

<max-jobs>

The maximum number of jobs that the client wants to receive at one time; if set to 0, lists all jobs

Default value: 50,000

Range: 0 to 2 31 - 1

No

Polling Interval

<polling-interval>

Specifies the time, in seconds, between polls by the monitor

Default value: 5 seconds

No

Event Duration

<event-duration>

Specifies the period for which the events are retrieved from the past

Provide the value in x d y h z m format. For example, 2d14h33m represents 2 days, 14 hours, and 33 minutes.

Yes

Object Name Or ID

<object-name-or-id>

Specifies the name or ID of a dataset, a resource group, or a vFiler unit

For datasets or vFiler units, jobs carried out on them are listed. In case of resource groups, jobs carried out on datasets or vFiler units that are members of the resource group are listed.

No

None

<job-types>

Identifies the container element for all <job-type> elements

Conditional; required if <job-type> is specified

Job Types

<job-type>

Lists jobs of the specified type

Note

If you do not specify a value for <job-type>, the request retrieves all job types. If too many records of different job types are returned, you might receive an unexpected response.

Valid values:

  • For data protection jobs:
    • local_backup
    • local_backup_confirmation
    • remote_backup
    • mirror
    • restore
    • create_relationship
    • destroy_relationship
    • on_demand_backup
    • failover
  • For provisioning jobs:
    • provision_member
    • resize_member
    • destroy_member
    • delete_snapshots
    • dedupe_member
    • undedupe_member
    • dedupe_volume
    • pm_re_export
  • For space management jobs:
    • dedupe_volume
    • migrate_volume
    • resize_volume
    • delete_snapshot
    • delete_backup
  • For migration jobs:
    • migrate_start
    • migrate_complete
    • migrate_cancel
    • migrate_cleanup
    • migrate_update

No



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>
<job-state>completed</job-state>
<job-overall-status>succeeded</job-overall-status>
<job-types>
<job-type>provision_member</job-type>
<job-type>destroy_member</job-type>
</job-types>
<max-jobs>10</max-jobs>
<polling-interval>1</polling-interval>
<event-duration>30m</event-duration>
</config>
Was this page helpful? Yes No Submitting... Thank you

Comments