NetApp ONTAP SnapMirror icon

NetApp ONTAP SnapMirror

Manage NetApp ONTAP SnapMirror relationships and data protection

Actions23

Transfer → Start

AI-generated

Summary

Start a new SnapMirror transfer for a specified SnapMirror relationship on a NetApp ONTAP cluster using the ONTAP REST API.

Inputs

  • Cluster Host (required) — The hostname or IP address of the ONTAP cluster management LIF where the API request will be sent.
  • Port — HTTPS port for the ONTAP REST API, defaulting to 443.
  • Relationship (required) — The UUID identifying the SnapMirror relationship for which to start a transfer.
  • Transfer Options — Optional parameters to customize the transfer, including specifying a specific source snapshot to transfer and throttling the transfer rate in KB/s.
  • Options — Additional options such as specifying a comma-separated list of fields to include in the response (use '*' for all fields).

Output shape

a single JSON object containing the started transfer details, including job metadata if the operation is asynchronous

The operation initiates the transfer via a POST request to /snapmirror/relationships/{relationshipUUID}/transfers with optional body parameters. If the ONTAP API response includes a job, the node polls until the job completes and returns full job details. Errors during the start process will be thrown unless 'Continue On Fail' is enabled.

Examples

Example 1: Starting a transfer for a SnapMirror relationship with the default settings and no throttling

Provide the ONTAP cluster host, port (optional), and the UUID of the SnapMirror relationship. Leave Transfer Options empty to start the transfer of the latest snapshot at unlimited speed.

Example 2: Starting a transfer specifying a particular source snapshot and limiting the transfer speed

Provide the relationship UUID and set Transfer Options with 'Source Snapshot' to the snapshot name and 'Throttle' to the maximum KB/s transfer rate desired.

Links

Discussion