NetApp ONTAP Cluster icon

NetApp ONTAP Cluster

Manage NetApp ONTAP cluster, nodes, licenses, and jobs

Actions18

Cluster → Get

AI-generated

Summary

Retrieve information about a NetApp ONTAP cluster by querying its management API.

Inputs

  • Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF.
  • Port — HTTPS port number for the ONTAP REST API, defaulting to 443.
  • Options — Optional parameters including 'Fields' which is a comma-separated list of specific fields to include in the response; use '*' to include all fields.

Output shape

A JSON object containing detailed information about the ONTAP cluster, including only the requested fields if specified.

The operation performs a GET request to the '/cluster' endpoint of the ONTAP API. If 'fields' are specified in the options, the response is filtered to include only those fields. The response includes cluster-level metadata and settings retrieved synchronously. Errors during the request surface as operation failures.

Examples

Example 1: Get basic cluster information

Set 'Cluster Host' with the cluster's hostname or IP and leave 'Fields' empty to retrieve full details.

Example 2: Get specific cluster fields

Specify 'Fields' option with a comma-separated list of fields to narrow down the response data.

Links

Discussion