Find Aggregate Details operation

The Find Aggregate Details operation finds the details of either the specified aggregate or all the aggregates in the Storage System.

The following table describes the elements for this request.

Adapter request elements for the Find Aggregate Details operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-aggregate-details`	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 `<target>` element, which specifies a dynamic target Using dynamic targets, you can define connection information for a remote host in an adapter request, which 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 `<target>` element that is a child of `<arguments>` is ignored.	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 that 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>`	Contains the child XML element of the `<arguments>` XML element You can use this element to specify the connection information for a DFM server: The values specified for `<target>` must be the same as the values specified for the `name` attribute of `<config>` in the Grid Manager adapter configuration. You can specify ALL as the value. If you specify All, the request is executed on all the DFM servers defined in the Grid Manager adapter configuration. You can specify multiple comma-separated names 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 response ignores this element.	No
`<target-host>`	Specifies the host name or IP address of the target storage/filer	Yes
`<aggregate>`	Specifies the aggregate for which details must be retrieved If you do not specify the aggregate, the details of all aggregates in the storage system are retrieved.	No
`<verbose>`	Specifies whether detailed volume and complex information (including all the RAID group and disk information)is retrieved Valid values: true, false	No

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

Sample adapter request for Find Aggregate Details operation

<netapp-storage-request>
    <operation-name>find-aggregate-details</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 />
      <target-host>Filer1</target-host>
      <aggregate>aggr0</aggregate>
      <verbose>true</verbose>
    </arguments>
  </netapp-storage-request>

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

Sample adapter response for Find Aggregate Details 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>
        <aggregates>
          <aggr-info>
            <name>aggr0</name>
            <uuid>0d525362-632e-11df-952a-0050561ba0f6</uuid>
            <type>aggr</type>
            <state>online</state>
            <mirror-status>unmirrored</mirror-status>
            <size-total>4751622144</size-total>
            <size-used>3239636992</size-used>
            <size-percentage-used>68</size-percentage-used>
            <size-available>1511985152</size-available>
            <files-total>31142</files-total>
            <files-used>108</files-used>
            <checksum-style>zoned</checksum-style>
            <raid-size>8</raid-size>
            <raid-status>raid0</raid-status>
            <is-checksum-enabled>true</is-checksum-enabled>
            <checksum-status>upgrading_phase2</checksum-status>
            <has-local-root>true</has-local-root>
            <has-partner-root>false</has-partner-root>
            <is-inconsistent>false</is-inconsistent>
            <is-snaplock>false</is-snaplock>
            <disk-count>13</disk-count>
            <volume-count>1</volume-count>
            <plex-count>1</plex-count>
            <plexes>
              <plex-info>
                <name>/aggr0/plex0</name>
                <is-online>true</is-online>
                <is-resyncing>false</is-resyncing>
                <raid-groups>
                  <raid-group-info>
                    <name>/aggr0/plex0/rg0</name>
                    <is-reconstructing>false</is-reconstructing>
                    <disks>
                      <disk-info>
                        <name>v4.16</name>
                      </disk-info>
                      ...
                    </disks>
                  </raid-group-info>
                  <raid-group-info>
                    <name>/aggr0/plex0/rg1</name>
                    <is-reconstructing>false</is-reconstructing>
                    <disks>
                      <disk-info>
                        <name>v4.34</name>
                      </disk-info>
                      ...
                    </disks>
                  </raid-group-info>
                </raid-groups>
              </plex-info>
            </plexes>
            <volumes>
              <contained-volume-info>
                <name>vol0</name>
              </contained-volume-info>
            </volumes>
          </aggr-info>
        </aggregates>
      </output>
    </response>
  </responses>
</netapp-storage-response>

Find Aggregate Details operation

Comments