Find Aggregate operation

The Find Aggregate operation lists all the aggregates contained in a Resource Group, Resource Pool, Dataset, Storage Set, Host, Aggregate, Volume, or Qtree.

The following table describes the elements for this request.

Adapter request elements for the Find Aggregate operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-aggregate`	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 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 using `<targets>`, the request ignores the `<targets>` element that is child of `<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 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: 8808 (http), 8488 (https)	No
`<target>`	Specifies the child element of the `<arguments>` element You can use this element to specify the connection information for a DFM server. For this, 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 `<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. If you specify ALL as the value, 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
`<aggregate-type>`	Specifies the filter by type of aggregate; if you do not specify the aggregate-type input, the response lists all aggregate types Valid values: traditional, aggregate	No
`<include-is-available>`	Specifies the is-available status for an aggregate Valid values: true, false (default) If true, the is-available status is calculated for each aggregate.	No
`<is-dp-ignored>`	Identifies the aggregates that are set to be ignored for the purposes of data protection Valid values: true, false If you do not specify this value, the response lists all aggregates regardless of whether they have been set to be ignored.	No
`<is-in-dataset>`	Identifies the aggregates that contain data protected by a dataset Valid values: true, false If you do not specify this value, the response lists all aggregates regardless of whether they contain data protected by a dataset	No
`<object-name-or-id>`	Specifies the name or identifier of an object to list the aggregates for The valid object types for this argument are Resource Group, Resource Pool, Dataset, Storage Set, Host, Aggregate, Volume, Qtree If the name or identifier resolves to a single aggregate, the request returns that aggregate. If the name or identifier resolves to more than one aggregate, the request returns all of them. If you omit this element, the response lists all aggregates	No
`<resourcepool-filter>`	Identifies aggregates that are in a resource pool or that are not in a resource pool Valid values: in_rpool, not_in_rpool, all (default) If set to `<in_rpool>`, lists aggregates that are in a resource pool. If set to not_in_rpool, lists aggregates that are not in a resource pool. If set to all, then lists all aggregates. An aggregate is said to be in a resource pool if either the aggregate or the storage system containing the aggregate is a member of the resource pool.	No

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

Sample adapter request for Find Aggregate operation

<netapp-storage-request>
    <operation-name>find-aggregate</operation-name>
    <arguments>
      <targets>
        <target>
          <host>172.11.11.111</host>
          <user-name>username</user-name>
          <password encryption-type = "Base64">cGFzc3dvcmQ=</password>
          <protocol>http</protocol>
          <port>8088</port>
        </target>
      </targets>
      <target />
      <aggregate-type>aggregate</aggregate-type>
      <include-is-available>true</include-is-available>
      <is-dp-ignored>false</is-dp-ignored>
      <is-in-dataset>false</is-in-dataset>
      <resourcepool-filter>all</resourcepool-filter>
    </arguments>
    <arguments>
      <target>Server134</target>
      <aggregate-type>aggregate</aggregate-type>
      <include-is-available>true</include-is-available>
      <is-dp-ignored>false</is-dp-ignored>
      <is-in-dataset>false</is-in-dataset>
      <resourcepool-filter>all</resourcepool-filter>
    </arguments>
</netapp-storage-request>

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

Sample adapter response for Find Aggregate operation

<netapp-storage-response>
  <metadata>
    <status>success</status>
    <response-count>2</response-count>
  <Indi/metadata>
  <responses>
    <response>
      <metadata>
        <status>success</status>
        <count>5</count>
      </metadata>
    <output>
        <aggregate-info>
          <aggregate-id>155</aggregate-id>
          <aggregate-name>netappsim4:aggr0</aggregate-name>
          <filer-name>netappsim4</filer-name>
          <aggregate-status>warning</aggregate-status>
          <aggregate-perf-status>unknown</aggregate-perf-status>
          <filer-id>153</filer-id>
          <is-available>true</is-available>
          <is-dp-ignored>false</is-dp-ignored>
          <is-in-dataset>false</is-in-dataset>
          <datasets />
          <aggregate-type>aggregate</aggregate-type>
          <block-type>32_bit</block-type>
          <aggregate-nearly-full-threshold />
          <aggregate-full-threshold />
          <time-to-full />
          <aggregate-space-status>ok</aggregate-space-status>
          <aggregate-nearly-overcommitted-threshold />
          <aggregate-overcommitted-threshold />
          <aggregate-size>
            <size-used>255713280</size-used>
            <size-available>461512704</size-available>
            <size-total>717225984</size-total>
            <space-total-committed>253607936</space-total-committed>
          </aggregate-size>
        </aggregate-info>
        <aggregate-info>...</aggregate-info>
        <aggregate-info>...</aggregate-info>
      </output>
    </response>
    <response>
      <metadata>
        <status>success</status>
        <count>5</count>
      </metadata>
      <output>
        <aggregate-info>...</aggregate-info>
        <aggregate-info>...</aggregate-info>
      </output>
    </response>
  </responses>
</netapp-storage-respons>

The following table describes the response elements.

Adapter response elements for find-aggregate operation

Element	Definition
`<aggregate-id>`	Specifies the identifier of the aggregate Range: [1--2^31-1^]
`<aggregate-name>`	Indicates a simple name of the aggregate The aggregate name is always present in the output. For example, any simple name such as myaggr
`<filer-name>`	Specifies the name of the controller when `<aggregate-type>` is traditional or aggregate Indicates the name of the cluster when aggregate-type is striped. The aggregate name is always present in the output. For example, any simple name such as myhost
`<aggregate-status>`	Indicates the current status of the aggregate based on all events Valid values: unknown, normal, information, unmanaged, warning, error, critical, and emergency
`<aggregate-perf-status>`	Indicates the current status of the aggregate based on performance event Valid values: unknown, normal, information, unmanaged, warning, error, critical, emergency
`<filer-id>`	Specifies the identifier of controller when aggregate-type is traditional or aggregate identifier of cluster when `<aggregate-type>` is striped The `<filer-id>` is always present in the output. Range: [1--2^31-1]
`<is-dp-ignored>`	Indicates whether an administrator wants to ignore this aggregate for purposes of data protection
`<is-in-dataset>`	Indicates whether this aggregate is a member of any data set
`<is-available>`	Indicates whether this object and all of its parents are up or online This element is available in output only if the call includes the "include-is-available" flag
`<resourcepool-name>`	Specifies the name of the resource pool of which the aggregate is a member This element is not present if the aggregate is not a member of a resource pool.
`<aggregate-type>`	Specifies the type of aggregate Valid values: traditional, aggregate, striped
`<block-type>`	Specifies the file system block type of the aggregate The volumes on both the source and destination sides of a SnapMirror relationship must be of the same block type. Valid values: 32_bit, 64_bit, unknown
`<aggregate-nearly-full-threshold>`	Specifies the value (as an integer percentage) of the fullness threshold used to generate an "aggregate nearly full" event for this aggregate If the value is empty, then the global setting for aggregate nearly full threshold is considered. Range: [0--1,000]
`<aggregate-full-threshold>`	Specifies the value (as an integer percentage) of the fullness threshold used to generate an "aggregate full" event for this aggregate If the value is empty, then the global setting for aggregate full threshold is considered. Range: [0--1,000]
`<time-to-full>`	Specifies the estimated amount of time left in seconds for the aggregate to become full This element is returned as empty when the estimated amount of time is more than a year. This can happen due to very low or negative rate of consumption of space in the aggregate. Range: [0--31,536,000]
`<aggregate-space-status>`	Indicates the space status 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 given in aggregate-nearly-full-threshold and `<aggregate-full-threshold>` Valid values: ok, nearly_full, full
`<aggregate-nearly-overcommitted-threshold>`	Specifies the value (as an integer percentage) that is used to generate "aggregate nearly overcommitted" event for this aggregate If the value is empty, then the global setting for `<aggregate-nearly-overcommitted-threshold>` is considered. Range: [0--65,535]
`<aggregate-overcommitted-threshold>`	Specifies the value (as an integer percentage) that is used to generate "aggregate overcommitted" event for this aggregate If the value is empty, then the global setting for `<aggregate-overcommitted-threshold>` is considered. Range: [0--65,535]
`<aggregate-size>`	Specifies the sizes of various parameters of the aggregate This element has following child elements: `<size-used>`: Aggregate bytes used. Range: [0--2^63-1] `<size-available>`: Available bytes in the aggregate Range: [0--2^63-1] `<size-total>`: Aggregate total size in bytes. Range: [0--2^63-1] `<space-total-committed` >: Total space committed in bytes. Range: [0--2^63-1]
`<datasets>`	Specifies the list of dataset IDs and names containing this volume If `<is-in-dataset>` is false, this list remains empty. This element has the following child elements: `<dataset-id>`: Identifier for the dataset. Range: [1--2^31-1] `<dataset-name>`: Name of the dataset
`<datasets-space-info>`	Specifies the space used by each dataset in the aggregate This element is returned only when the `<include-dataset-space-info> element` is set to true. This element has following child elements: `<dataset-id>`: Database identifier of the dataset `<dataset-name>`: Name of the dataset `<dp-node-id>`: Identifier of the node in the dataset that is consuming space from the aggregate. If there is no protection policy associated with the dataset, node-id is 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-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. `<is-dp-node-effective-primary>`: Specifies whether the node in the dataset that is consuming space from the aggregate is the effective primary node `<used-space>`: Space in bytes used by the dataset on the aggregate in bytes. Range: [0--2^64-1]

Find Aggregate operation

Comments