NetApp ONTAP SnapMirror icon

NetApp ONTAP SnapMirror

Manage NetApp ONTAP SnapMirror relationships and data protection

Actions23

Policy → Update

AI-generated

Summary

Update a SnapMirror policy's properties in a NetApp ONTAP cluster by specifying its UUID and the fields to modify.

Inputs

  • Cluster Host (required) — Hostname or IP address of the ONTAP cluster management LIF to connect to.
  • Port — HTTPS port for the ONTAP REST API; defaults to 443.
  • Policy (required) — The UUID identifier of the SnapMirror policy to update.
  • Update Fields — Fields to update on the policy including 'Comment' (string), 'Network Compression Enabled' (boolean), and 'Throttle (KB/s)' (number).
  • Options — Additional request options such as 'Fields' to specify which response fields to include (comma-separated or '*' for all).

Output shape

a single record representing the updated SnapMirror policy, including any asynchronous job status if applicable

The operation sends a PATCH request to update the specified fields of the policy. If the API response includes a job UUID, the operation will poll until the asynchronous update completes, returning the final job result nested inside the response.

Links

Discussion