NetApp ONTAP Storage icon

NetApp ONTAP Storage

Manage NetApp ONTAP volumes, aggregates, snapshots, qtrees, and quotas

Actions36

Aggregate → Get

AI-generated

Summary

Retrieve detailed information about a specific NetApp ONTAP aggregate by its UUID or name.

Inputs

  • Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF.
  • Port — HTTPS port for the ONTAP REST API, defaulting to 443.
  • Aggregate (required) — The aggregate to retrieve, specified either by UUID or by name.
  • Options — Additional options for the request, including a comma-separated list of specific fields to include in the response (use '*' for all fields).

Output shape

a single aggregate record as a JSON object containing the aggregate's detailed properties as returned by the ONTAP API

The operation returns the full details of the specified aggregate. If the aggregate is specified by name and not found, an error will be thrown. The 'fields' option can limit which properties are included in the response.

Examples

Example 1: Get aggregate details by UUID

Set Cluster Host and Port; specify the aggregate by UUID; optionally set fields to '*' to get all fields.

Example 2: Get aggregate details by name

Set Cluster Host and Port; choose aggregate mode 'By Name' and input the aggregate name; optionally specify fields to restrict returned data.

Links

Discussion