Actions23
Relationship → Create
AI-generatedSummary
Create a new SnapMirror relationship between specified source and destination SVMs and paths on a NetApp ONTAP cluster via the ONTAP REST API.
Inputs
- Cluster Host (required) — Hostname or IP address of the ONTAP cluster management interface.
- Port — HTTPS port to use for the ONTAP REST API (default 443).
- Source SVM (required) — Source Storage Virtual Machine identified by name for the SnapMirror relationship.
- Source Path (required) — Source path in format svm:volume or svm:volume/qtree for SVM-DR; if just volume or volume/qtree is provided, it is prefixed by the source SVM name.
- Destination SVM (required) — Destination Storage Virtual Machine identified by name for the SnapMirror relationship.
- Destination Path (required) — Destination path in format svm:volume; if just volume is provided, it is prefixed by the destination SVM name.
- Additional Options — Optional settings including whether to create the destination volume automatically (with optional aggregate name), identity preservation mode for SVM-DR, whether to initialize the relationship on creation (starting the initial transfer), policy and schedule to assign to the relationship.
- Options.Fields — Comma-separated list of fields to include in the API response (use '*' for all fields).
Output shape
a single JSON object representing the created SnapMirror relationship, potentially including polling results if the creation is asynchronous; follow-up requests may be needed to fully track status.
The operation constructs a JSON body with source and destination paths and optional features, then sends a POST request to /snapmirror/relationships. If initialization on creation is enabled (default true), it automatically starts the initial data transfer. The response may indicate an asynchronous job which is polled until completion before returning.