NetApp ONTAP Storage icon

NetApp ONTAP Storage

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

Aggregate → Get Many

AI-generated

Summary

Retrieve multiple aggregates from a NetApp ONTAP cluster with optional filtering and result limiting.

Inputs

  • Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF to connect to.
  • Port — The HTTPS port number for the ONTAP REST API (default 443).
  • Filters — Optional API filter expression to restrict results, using field=value syntax supporting operators like =, !=, <, >, <=, >=, *, |.
  • Return All — Boolean to indicate if all matching aggregates should be returned or limited to a maximum number.
  • Limit — Maximum number of aggregate records to return if Return All is false.
  • Fields — Comma-separated list of aggregate fields to include in the response (use * for all).

Output shape

a list of aggregate objects as returned by the ONTAP REST API

If Return All is true (default), all aggregates matching optional filters are returned, with automatic pagination handled. If Return All is false, at most Limit aggregates are returned. The returned objects include the fields requested if specified, otherwise default fields, or all fields if '*' is used. Errors during retrieval are thrown unless 'Continue On Fail' is enabled.

Examples

Example 1: Fetch all aggregates from a cluster

Set Cluster Host and optionally Port. Leave filters empty and Return All true to get all aggregates.

Example 2: Fetch up to 10 aggregates with a specific name filter

Set Cluster Host, add API Filters 'name=aggr1', set Return All to false, and Limit to 10.

Links

Discussion