Actions23
Relationship → Get
AI-generatedSummary
Retrieve detailed information about a specific SnapMirror relationship from a NetApp ONTAP cluster by specifying its UUID.
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 retrieve details for.
- Options — Optional parameters including 'Fields' as a comma-separated list specifying which fields to include in the response (use * to include all fields).
Output shape
A single record object containing detailed information about the specified SnapMirror relationship.
The operation requires the Relationship parameter to be specified as a UUID, and returns one SnapMirror relationship's details. If the 'Fields' option is provided, only those fields are included in the response.
Examples
Example 1: Retrieve details for a SnapMirror relationship with UUID 'abc123-uuid-xyz'.
Set 'Cluster Host' to the cluster's management LIF hostname or IP; set 'Relationship' to 'abc123-uuid-xyz'; optionally specify 'Fields' to limit returned data.