×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')

Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.
BMC Atrium Orchestrator Content 20.16.03 ... Application adapters NetApp Storage adapter NetApp Storage actor adapter requests and responses Job operations

Find Job Status operation

The Find Job Status operation finds the details of all the jobs that match the filter criteria specified.

The following table describes the elements for this request.

Adapter request elements for the Find Job Status operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: find-job-status

Yes

<arguments>

Specifies a list of arguments required for the operation

Yes

<targets>

Contains the parent XML element for the <target> element, which specifies the dynamic targets

Conditional; required if the adapter configuration is empty in Grid Manager

<target>

Contains the child XML <targets> element, which specifies the dynamic targets

Using dynamic targets, you can define connection information for a remote host in an adapter request. This capability enables you to configure an adapter in Grid Manager by specifying configuration information in an adapter request.

This XML element can have <host>, <user-name>, <password>, <protocol>, and <port> as its child elements.

Notes


  • An adapter configuration specified by using request-level dynamic targets takes precedence over Grid Manager level configuration information.
  • If you specify the request-level dynamic target by using <targets>, the request ignores the <targets> element that is a child of the <arguments> element.

Conditional; required if <targets> is present in the adapter request

<host>

Specifies the host name or IP address of the server on which NetApp DataFabric Manager is running

Conditional; required if <targets> is present in the adapter request

<user-name>

Specifies the user name required to log on to the NetApp DataFabric Manager

Conditional; required if <targets> is present in the adapter request

<password>

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

The <password> element can contain an encryption-type attribute. The encryption-type attribute indicates whether the password specified is encrypted.

Valid values for encryption-type attribute: Base64, Plain (default)

Conditional; required if <targets> is present in the adapter request

<protocol>

Specifies the communication protocol used by the adapter

Valid values: http (default), https

No

<port>

Specifies the port on which NetApp DataFabric Manager is enabled

Default values: 8088 (http), 8488 (https)

No

<target>

Specifies the child XML element of the <arguments> element

You can use this element to specify the connection information for a DFM server. You can use a comma-separated list of configuration names, which executes the request simultaneously on all DFM servers identified by the configuration names.

Valid values:

  • The values specified for the <target> XML element must be the same as the values that have been specified for the name attribute of the <config> element in the Grid Manager adapter configuration.
  • You can provide "ALL" as the value. In this case, the request is executed on all the DFM servers defined in the Grid Manager adapter configuration.
  • You can specify multiple comma-separated names to allow for simultaneous execution of requests across multiple DFM servers.
  • You can skip this element. In this case, the request is executed on the first defined Grid Manager adapter configuration.
  • You can leave this element empty. In this case, the request is executed on the first defined Grid Manager adapter configuration.

    Note

    If you specify a request-level dynamic target by using <targets>, the request ignores this element.

No

<job-id>

Specifies the identifier of a job to list

If unspecified, all jobs are listed.

Range: [1--2^31-1]

No

<job-state>

Specifies the state of the jobs to list

If specified, only the jobs which are in this state are listed.

No

<job-type>

Specifies the types of the jobs to list

If specified, only jobs of specified type are listed

No

<max-jobs>

If specified, this is the maximum number of jobs that the client wishes to receive at once.

If set to zero, return all jobs.

Default value: 50,000

Range: [0--2^31-1]

No

<object-name-or-id>

Specifies the name or ID of the dataset or a group

Range: [1--2^31-1] if ID is specified

No

A sample adapter request for this operation is given in the following figure.

Sample adapter request for the Find Job Status operation 

<netapp-storage-request>
    <operation-name>find-job-status</operation-name>
    <arguments>
      <targets>
        <target>
          <host>Server137</host>
          <user-name>username</user-name>
          <password encryption-type = "Base64">cGFzc3dvcmQ=</password>
          <protocol>http</protocol>
          <port>8088</port>
        </target>
      </targets>
      <target />
      <job-id>1371</job-id>
    </arguments>
</netapp-storage-request>


A sample adapter response for this operation is given in the following figure.

Sample adapter response for the Find Job Status operation 

<netapp-storage-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>Server137</target>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <dp-job-info>
          <job-id>1371</job-id>
          <job-type>provision_member</job-type>
          <started-timestamp>1263444675</started-timestamp>
          <completed-timestamp>1263444675</completed-timestamp>
          <job-description>Provision a storage container
'Storage 1263446241296' of size 16.0 MB.</job-description>
          <dataset-id>607</dataset-id>
          <dataset-name>QA-DataSetName1</dataset-name>
          <policy-name>QA-Test1</policy-name>
          <policy-id>299</policy-id>
          <object-id>607</object-id>
          <object-name>QA-DataSetName1</object-name>
          <object-type>dataset</object-type>
          <job-context-obj-id>607</job-context-obj-id>
          <job-context-obj-name>QA-DataSetName1</job-context-obj-name>
          <job-context-obj-type>dataset</job-context-obj-type>
          <submitted-by>domain-name\username</submitted-by>
          <job-progress>failure</job-progress>
          <job-state>completed</job-state>
          <job-overall-status>failed</job-overall-status>
<!--Please note that only the failed status is being captured
but not the actual error description-->
          <bytes-transferred>0</bytes-transferred>
          <source-node-name>Test1 $ Node Name</source-node-name>
          <source-node-id>1</source-node-id>
          <destination-node-name />
          <destination-node-id>0</destination-node-id>
          <provision-request-info>
            <provision-member-request-info>
              <name>Storage 1263446241296</name>
              <description>Provision a storage container
'Storage 1263446241296' of size 16.0 MB.</description>
              <size>16777216</size>
              <maximum-data-size>0</maximum-data-size>
              <initial-snapshot-space>0</initial-snapshot-space>
              <maximum-snapshot-space>0</maximum-snapshot-space>
              <provisioning-policy-id>289</provisioning-policy-id>
              <provisioning-policy-name>QA-JS1</provisioning-policy-name>
            </provision-member-request-info>
          </provision-request-info>
        </dp-job-info>
      </output>
    </response>
  </responses>
</netapp-storage-response>
Was this page helpful? Yes No Submitting... Thank you
Last modified by Deepa Bhat on May 05, 2016
job netapp_storage

Comments

Log in or register to comment.

Find Job Events operation
LUN operations
© Copyright 2024 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.