Actions23
Relationship → Quiesce
AI-generatedSummary
Quiesce a SnapMirror relationship to pause data transfer by setting its state to 'paused'.
Inputs
- Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF.
- Port — HTTPS port for the ONTAP REST API; defaults to 443.
- Relationship (required) — The UUID of the SnapMirror relationship to quiesce.
- Options — Optional parameters including a comma-separated list of fields to include in the response.
Output shape
a JSON object representing the updated SnapMirror relationship and job details if applicable.
The operation returns the API response after setting the relationship state to 'paused'. If an asynchronous job is triggered, it polls until completion and includes job details in the output.
Examples
Example 1: Pause data transfer for a specific SnapMirror relationship to perform maintenance or prevent replication temporarily.
Provide the ONTAP cluster host, optional port (default 443), and specify the SnapMirror relationship UUID to quiesce. Optionally select which fields to return in the response.