NetApp ONTAP SnapMirror icon

NetApp ONTAP SnapMirror

Manage NetApp ONTAP SnapMirror relationships and data protection

Actions23

Relationship → Break

AI-generated

Summary

Break a SnapMirror relationship by setting its state to 'broken_off' in the specified NetApp ONTAP cluster.

Inputs

  • Cluster Host (required) — Hostname or IP address of the ONTAP cluster management LIF.
  • Port — HTTPS port for the ONTAP REST API (default 443).
  • Relationship (required) — The UUID of the SnapMirror relationship to break.
  • Options — Optional parameters, including a 'fields' string to specify which fields to include in the response.

Output shape

a single JSON object representing the updated SnapMirror relationship or job status after setting its state to 'broken_off'.

The operation sends a PATCH request to update the SnapMirror relationship's state to 'broken_off' and waits for any asynchronous job to complete before returning. If 'fields' option is provided, it controls which properties are included in the response.

Examples

Example 1: Break a SnapMirror relationship by UUID

Specify the cluster host and (optionally) port, provide the UUID of the SnapMirror relationship, and execute the break operation to set its state as broken off.

Links

Discussion