Find Dataset Members operation

The Find Dataset Members operation finds details of members of specified dataset.

The following table describes the elements for this request.

Adapter request elements for the Find Dataset Members operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-dataset-members`	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
`<dataset-name-or-id>`	Specifies the name or identifier of the data set whose members are listed	Yes
`<dp-node-name>`	Lists only the members in this policy node If NONE is specified, then list members in all policy nodes. If both `<dp-node-name>` and `<storageset-name-or-id>` are specified, then the value of `<dp-node-name>` is ignored.	No
`<include-deleted>`	Specifies whether to include members that are marked as deleted in the database If false, deleted members are not returned. Valid values: true, false	No
`<include-exports-info>`	Specifies whether the information about the export of members is included in the output If the member is exported over NFS, the NFS export name is retuned in the `<nfs-export-name>` element in the `<dataset-member-info>`. If the member is exported over CIFS, the shared names are returned in the `<cifs-share-names>` array in the `<dataset-member-info>`. In case the members are accessed using both NFS and CIFS, (i.e Mixed mode) then both NFS export name and CIFS share names are returned. Valid values: true, false (default)	No
`<include-indirect>`	Specifies whether to include indirect data set members By default, the indirect members are not included. An example of an indirect member is a qtree in a volume, which is a direct member of the data set.	No
`<include-is-available>`	Specifies whether to calculate the is-available status for each data set member, which may make the call to this operation much longer Valid values: true, false (default)	No
`<include-space-info>`	Specifies whether to compute the space status for all members of the data set The space status and detailed space conditions of every data set member is returned if the space status of the member is WARNING or ERROR. Valid values: true, false (default)	No
`<storageset-name-or-id>`	Lists the members only in this storage set If NONE is specified, then the request lists members in all storagesets mapped to the current data set's nodes. If both `<dp-node-name>` and `<storageset-name-or-id>` are specified, then the value of `<dp-node-name>` is ignored.	No
`<suppress-status-refresh>`	Specifies whether to refresh the status of the data set member If TRUE, the request does not refresh the member status. If FALSE or omitted, the status of all members is refreshed before being returned.	No
`<member-name-or-id>`	Specifies the name or ID in the DFM database, of a specific member of the dataset If specified, details of only this object are returned.	No

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

Sample adapter request for Find Dataset Members operation

<netapp-storage-request>
    <operation-name>find-dataset-members</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 />
      <dataset-name-or-id>testnew</dataset-name-or-id>
      <include-deleted>true</include-deleted>
      <include-exports-info>true</include-exports-info>
      <include-indirect>true</include-indirect>
      <include-is-available>true</include-is-available>
      <include-space-info>true</include-space-info>
      <suppress-status-refresh>false</suppress-status-refresh>
      <dp-node-name>Primary data</dp-node-name>
      <member-name-or-id>test1:/demo1</member-name-or-id>
      <storageset-name-or-id>testnew:username</storageset-name-or-id>
    </arguments>
</netapp-storage-request>

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

Sample adapter response for Find Dataset Members operation

<netapp-storage-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <dataset-member-info>
          <member-id>332</member-id>
          <member-type>qtree</member-type>
          <member-name>test1:/demo1</member-name>
          <member-status>normal</member-status>
          <member-perf-status>unknown</member-perf-status>
          <storageset-id>285</storageset-id>
          <storageset-name>testnew:username</storageset-name>
          <dp-node-name>Primary data</dp-node-name>
          <is-available>true</is-available>
          <space-info>
            <total-space>20971520</total-space>
            <used-space>0</used-space>
            <available-space>20971520</available-space>
            <space-status>ok</space-status>
          </space-info>
        </dataset-member-info>
      </output>
    </response>
  </responses>
</netapp-storage-response>

The following table describes the response elements.

Adapter response elements for the find-dataset-members operation

Element	Definition
`<member-id>`	Specifies the identifier of the member
`<member-type>`	Specifies the type of the member Valid values for direct members: volume, qtree, or ossv_directory. When `<include-exports-info>` is true in the `<dataset-member-list-info-iter-start>`, this can also be "lun_path"
`<member-name>`	Specifies the name of the member
`<member-status>`	Specifies the current status of the member Valid values: normal, information, unknown, warning, error, critical, or emergency
`<member-perf-status>`	Specifies the current status of the member based on the worst performance event Valid values: unknown, normal, information, unmanaged, warning, error, critical, and emergency
`<storageset-id>`	Specifies the identifier of the storage set to which the data set member belongs
`<storageset-name>`	Specifies the name of the storage set to which the data set member belongs
`<dp-node-name>`	Specifies the name of the policy node to which the data set member is attached The `<dp-node-name>` element is included only if a data protection policy is associated with the dataset.
`<is-available>`	True, if this object and all of its parents are up or online Only valid for members of the following types: ossv-host ossv-dir filer vfiler aggregate volume qtree
`<space-info>`	Specifies the space related information of a dataset member The `<space-info>` is included in the output only if the `<include-space-info>` element is true in the call to `<dataset-member-list-info-iter-start>`. Note that some members do not have space related information. Those type of members are: Non qtree data Qtrees without hard disk quota limit. In these cases, it is considered that the space status of such members is unknown. This XML element has following sub elements: `<total-space>` : Specifies the total capacity of the dataset member, in bytes Range: 1 to 2^63-1 `<used-space>` : Specifies the capacity used in the dataset member, in bytes Range: 1 to 2^63-1 `available-space>` : Specifies the space available in the dataset member, in bytes Range: 1 to ^63-1 `space-status` : Space status of the member Valid values: unknown, ok, warning, and error

Find Dataset Members operation

Comments