Find Volume operation

The Find Volume operation finds the list of all the volumes contained inside a Resource Group, Data Set, Storage Set, Host, Aggregate, Volume, Qtree.

The following table describes the elements for this request.

Adapter request elements for the Find Volume operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-volume`	Yes
`<arguments>`	Specifies a list of arguments that is required for this 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
`<include-is-available>`	Specifies whether the `<is-available>` status is calculated for each volume. Valid values: true, false (default)	No
`<is-dp-ignored>`	Lists only those volumes that have been set to be ignored for data protection If FALSE, lists only those volumes that have not been set to be ignored for data protection. If not specified, lists all volumes without taking into account whether they have been ignored or not.	No
`<is-in-dataset>`	Specifies whether to list volumes that contain data protected by a data set If FALSE, only list volumes containing data which is not protected by a dataset. If not specified, list all volumes whether they are in a dataset or not.	No
`<object-name-or-id>`	Specifies the name or identifier of an object to list volumes for The allowed object types for this argument are: Resource Group, Data Set, Storage Set, Host, Aggregate, Volume, Qtree If the `<object-name-or-id>` element identifies a volume, that single volume is returned. If `<object-name-or-id>` resolves to more than one volume, all of them are returned. If the `<object-name-or-id>` element is not provided, then all the volumes are listed.	No
`<is-snapmirror-primary-capable>`	Specifies whether to list volumes capable of being a primary for a SnapMirror relationship If present and TRUE, only list volumes capable of being a primary for a SnapMirror relationship. This indicates that the storage system is licensed for the SnapMirror. The `<is-snapmirror-primary-capable>` element is meaningless if present and FALSE.	No
`<is-snapmirror-secondary-capable>`	Specifies whether to list volumes capable of being a secondary for a SnapMirror relationship If present and TRUE, only list volumes capable of being a secondary for a SnapMirror relationship. This indicates that the storage system is licensed for the SnapMirror and the volume is not already a SnapMirror or SnapVault secondary. The `<is-snapmirror-secondary-capable>` element is meaningless if present and FALSE.	No
`<is-snapvault-primary-capable>`	Indicates a boolean field If present and TRUE, only list volumes capable of being the source of a SnapVault transfer. This means the storage system is licensed to be a SnapVault primary. Meaningless if present and FALSE.	No
`<is-snapvault-secondary-capable>`	Specifies whether to list volumes capable of being the destination of the SnapVault transfers If present and TRUE, only list volumes capable of being the destination of SnapVault transfers. This indicates that the storage system is licensed as a SnapVault secondary and the volume is not a SnapMirror destination. The `<is-snapvault-secondary-capable>` element is not useful if it is present but FALSE.	No
`<snapvault-secondary-schedule-name>`	Specifies the name of a SnapVault backup schedule If the `<snapvault-secondary-schedule-name>` element is specified, the SnapVault secondary volumes that use the specified backup schedule are listed.	No
`<volume-type>`	Specifies the filter based on the type of the volume Valid values: traditional, flexible, striped	No

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

Sample adapter request for the Find Volume operation

<netapp-storage-request>
    <operation-name>find-volume</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 />
      <object-name-or-id>test1:/test</object-name-or-id>
      <include-is-available>true</include-is-available>
      <is-dp-ignored>false</is-dp-ignored>
      <is-in-dataset>false</is-in-dataset>
      <volume-type>flexible</volume-type>
      <is-snapmirror-primary-capable>false</is-snapmirror-primary-capable>
      <is-snapmirror-secondary-capable>false</is-snapmirror-secondary-capable>
      <is-snapvault-primary-capable>false</is-snapvault-primary-capable>
      <is-snapvault-secondary-capable>false</is-snapvault-secondary-capable>
    </arguments>
</netapp-storage-request>

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

Sample adapter response for the Find Volume 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>
        <volume-info>
          <volume-id>563</volume-id>
          <volume-name>test1:/test</volume-name>
          <host-id>74</host-id>
          <host-name>test1</host-name>
          <aggregate-id>75</aggregate-id>
          <aggregate-name>test1:aggr0</aggregate-name>
          <volume-type>flexible</volume-type>
          <block-type>32_bit</block-type>
          <volume-state>online</volume-state>
          <volume-status>normal</volume-status>
          <volume-perf-status>unknown</volume-perf-status>
          <is-available>true</is-available>
          <is-dp-ignored>false</is-dp-ignored>
          <is-in-dataset>false</is-in-dataset>
          <datasets />
          <dataset-nodes />
          <is-snapvault-primary-volume>false</is-snapvault-primary-volume>
          <is-snapvault-secondary-volume>false</is-snapvault-secondary-volume>
          <is-snapmirror-primary-volume>false</is-snapmirror-primary-volume>
          <is-snapmirror-secondary-volume>false</is-snapmirror-secondary-volume>
          <is-vsm-secondary-volume>false</is-vsm-secondary-volume>
          <is-readonly-volume>false</is-readonly-volume>
          <is-snapvault-primary-capable>true</is-snapvault-primary-capable>
          <is-snapvault-secondary-capable>true</is-snapvault-secondary-capable>
          <is-snapmirror-primary-capable>true</is-snapmirror-primary-capable>
          <is-snapmirror-secondary-capable>true</is-snapmirror-secondary-capable>
          <volume-nearly-full-threshold />
          <volume-full-threshold />
          <volume-space-status>ok</volume-space-status>
          <space-guarantee>volume</space-guarantee>
          <snapshot-volume-id>564</snapshot-volume-id>
          <snapshot-volume-name>test1:/test.snapshot</snapshot-volume-name>
          <volume-size>
            <snapshot-reserve-total>10485760</snapshot-reserve-total>
            <snapshot-reserve-used>114688</snapshot-reserve-used>
            <snapshot-reserve-avail>10371072</snapshot-reserve-avail>
            <afs-total>41943040</afs-total>
            <afs-used>299008</afs-used>
            <afs-data>299008</afs-data>
            <afs-used-per-day>6144</afs-used-per-day>
            <afs-avail>41644032</afs-avail>
            <total>52428800</total>
            <space-allocated-from-aggr>52690944</space-allocated-from-aggr>
            <overwrite-reserve-total>0</overwrite-reserve-total>
            <overwrite-reserve-used>0</overwrite-reserve-used>
            <overwrite-reserve-avail>0</overwrite-reserve-avail>
            <hole-reserve>0</hole-reserve>
            <is-autosize-enabled>false</is-autosize-enabled>
            <actual-volume-size>52428800</actual-volume-size>
          </volume-size>
          <volume-qtree>
            <total-qtree-count>1</total-qtree-count>
            <protected-qtree-count>0</protected-qtree-count>
            <unprotected-qtree-count>1</unprotected-qtree-count>
            <protected-data-size>0</protected-data-size>
            <unprotected-data-size>0</unprotected-data-size>
          </volume-qtree>
        </volume-info>
      </output>
    </response>
  </responses>
</netapp-storage-response>

Find Volume operation

Comments