Find Resource Pool Members operation

The Find Resource Pool Members operation finds details of members of a resource pool.

The following table describes the elements for this request.

Adapter request elements for the Find Resource Pool Members operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-resource-pool-members`	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
`<resourcepool-name-or-id>`	Specifies the name or identifier of the resource pool to query It should be a valid DFM object name or object id and contain at least one non-numeric character. Range: [1--2^31-1]	No
`<include-indirect>`	Specifies whether to include indirect members By default, the indirect members are not included.	No
`<include-dataset-space-info>`	Specifies whether the space utilized by datasets on each aggregate is returned. Valid values: true, false (default) This input is ignored when the `<run-provisioning-checks>` element is TRUE.	No
`<member-type>`	Specifies the type of object to be returned Valid values: filer, aggregate	No

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

Sample adapter request for the Find Resource Pool Members operation

<netapp-storage-request>
    <operation-name>find-resource-pool-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 />
      <resourcepool-name-or-id>GL_Gold</resourcepool-name-or-id>
      <include-indirect>true</include-indirect>
      <include-dataset-space-info>true</include-dataset-space-info>
      <member-type>aggregate</member-type>
    </arguments>
  </netapp-storage-request>

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

Sample adapter response for the Find Resource Pool 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>
        <resourcepool-member-info>
          <member-id>75</member-id>
          <member-type>aggregate</member-type>
          <member-name>test1:aggr0</member-name>
          <resource-tag />
          <member-status>normal</member-status>
          <member-perf-status>unknown</member-perf-status>
          <member-used-space>249932</member-used-space>
          <member-committed-space>270316</member-committed-space>
          <member-size>1050624</member-size>
          <member-space-status>ok</member-space-status>
          <datasets-space-info>
            <dataset-space-info>
              <dataset-name>test1 nas sla Dataset</dataset-name>
              <dataset-id>244</dataset-id>
              <used-space>98304</used-space>
              <dp-node-id>1</dp-node-id>
              <dp-node-name>Primary data</dp-node-name>
              <is-dp-node-effective-primary>true</is-dp-node-effective-primary>
              <is-capable-of-migration>false</is-capable-of-migration>
            </dataset-space-info>
          </datasets-space-info>
        </resourcepool-member-info>
      </output>
    </response>
  </responses>
</netapp-storage-response>

The following table describes the response elements.

Adapter response elements for the Find Resource Pool Members operation

Element	Definition
`<member-id>`	Specifies the identifier of the member in the range of [1--2^31-1].
`<member-type>`	Specifies the type of the member Valid values: filer, aggregate
`<member-name>`	Specifies the display name of the member
`<resource-tag>`	Specifies a label for a resource pool member
`<member-status>`	Specifies the current status of the member Valid values: normal, information, unknown, warning, error, critical, 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, emergency
`<member-used-space>`	Specifies the used space of the member
`<member-committed-space>`	Specifies the committed space of the member
`<member-size>`	Specifies the total size of the member
`<member-space-status>`	Space status of the resource pool member This indicates the fullness of the aggregate in terms of whether the percentage of used space with respect to total size of the aggregate has reached or crossed the fullness thresholds. This value is returned only when member-type is 'aggregate'. Valid values: ok, nearly_full, full
`<provisioning-checks-passed>`	Set to true, if all the member passes all the provisioning related checks for the given provisioning policy and provisioning request. The `<provisioning-checks-passed>` is applicable only when `<run-provisioning-checks>` is set to true.
`<datasets-space-info>`	Specifies the space used by each dataset in the aggregate Returned only when member-type is 'aggregate' and if `<include-dataset-space-info>` is set to true.
`<dataset-space-info>`	Specifies the details of space used by one dataset in the aggregate This XML element has following sub elements: `<dataset-name>` : Name of the dataset `<dataset-id>`: Database identifier of the dataset `<used-space>`: Space used by the dataset on the aggregate in bytes Range: [0--2^64-1] `<dp-node-id>`: Identifier of the node in the dataset that is consuming space from the aggregate If no protection policy is associated with the dataset, the `node-id` will be 1. Range: [1--2^32-1] `<dp-node-name>`: Name of the node in the dataset that is consuming space from the aggregate. If there is no protection policy associated with the dataset, this would return the name of the dataset. `<is-dp-node-effective-primary>`: Specifies whether the node in the dataset that is consuming space from the aggregate is the effective primary node or not. `<is-capable-of-migration>`: Indicates whether the dataset is capable of migration This is returned true only if the dataset can be migrated in a transparent way using vFiler migration.

Find Resource Pool Members operation

Comments