NetApp ONTAP Storage icon

NetApp ONTAP Storage

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

Snapshot → Get

AI-generated

Summary

Retrieve detailed information about a specific snapshot of a volume in a NetApp ONTAP storage cluster using the snapshot's UUID or name.

Inputs

  • Cluster Host (required) — Hostname or IP address of the ONTAP cluster management LIF to connect to.
  • Port — HTTPS port number for the ONTAP REST API (defaults to 443).
  • Volume (required) — UUID of the volume containing the snapshot.
  • Snapshot (required) — Identifier for the snapshot to retrieve, selectable by UUID or name.
  • Options — Optional parameters including a comma-separated list of specific fields to include in the response (use '*' to include all fields).

Output shape

a single JSON object representing the snapshot details

If the snapshot is specified by name, the node resolves it to the UUID internally. The returned data contains snapshot attributes as per ONTAP API, filtered by optional 'Fields' parameter if provided. Errors are thrown if the volume or snapshot is not found.

Examples

Example 1: Retrieve details of a snapshot by UUID

Specify the cluster host, optional port, the volume UUID, and the snapshot UUID.

Example 2: Retrieve details of a snapshot by name

Provide cluster host, port, the volume UUID, and snapshot specified by name; the node resolves the name to UUID internally.

Links

Discussion