NetApp ONTAP SnapMirror icon

NetApp ONTAP SnapMirror

Manage NetApp ONTAP SnapMirror relationships and data protection

Policy → Get

AI-generated

Summary

Retrieve detailed information about a specific SnapMirror policy from a NetApp ONTAP cluster by specifying the cluster host and the UUID of the policy.

Inputs

  • Cluster Host (required) — Hostname or IP address of the ONTAP cluster management LIF where the SnapMirror policy resides.
  • Port — HTTPS port number for the ONTAP REST API, defaulting to 443.
  • Policy (required) — UUID identifier of the SnapMirror policy to retrieve.
  • Options — Optional parameters including a comma-separated list of fields to include in the response (supports '*' for all fields).

Output shape

a single record containing the detailed information of the specified SnapMirror policy

The response includes all policy details as returned by the ONTAP API. Users can limit the returned fields using the 'Fields' option. If the policy UUID is invalid or not found, an error is thrown.

Examples

Example 1: Retrieve a SnapMirror policy by specifying the ONTAP cluster host and policy UUID

Set 'Cluster Host' to your cluster's management LIF hostname or IP, set 'Policy' to the UUID of the desired policy, and optionally specify fields to include for response filtering.

Links

Discussion