Skip to main content
REST API reference
A newer release of this product is available.

Cancel an ongoing SnapMirror transfer

PDFs

PATCH /snapmirror/relationships/{relationship.uuid}/transfers/{uuid}

Aborts an ongoing SnapMirror transfer.

  • snapmirror abort

Example

PATCH "/api/snapmirror/relationships/293baa53-e63d-11e8-bff1-005056a793dd/transfers/293baa53-e63d-11e8-bff1-005056a793dd" '{"state":"aborted"}'

Learn more

Parameters

Name Type In Required Description

relationship.uuid

string

path

True

Relationship UUID

uuid

string

path

True

Transfer UUID

Request Body

Name Type Description

_links

_links

bytes_transferred

integer

Bytes transferred

checkpoint_size

integer

Amount of data transferred in bytes as recorded in the restart checkpoint.

relationship

relationship

snapshot

string

Name of Snapshot copy being transferred.

state

string

Status of the transfer. Set PATCH state to "aborted" to abort the transfer. Set PATCH state to "hard_aborted" to abort the transfer and discard the restart checkpoint.

uuid

string
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "bytes_transferred": 0,
  "checkpoint_size": 0,
  "relationship": {
    "destination": {
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    },
    "uuid": "d2d7ceea-ab52-11e8-855e-00505682a4c7"
  },
  "snapshot": "string",
  "state": "string",
  "storage_efficiency_enabled": null,
  "uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response codes

Error code Description

13303848

Abort of sync SnapMirror is not allowed

13303849

SnapMirror transfer state is invalid
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

files

Specifies a file or LUN consisting of a source_path and an optional destination_path. If not specified, the destination_path is the same as the source_path.

Name Type Description

destination_path

string

source_path

string

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

snapmirror_endpoint

Endpoint of a SnapMirror relationship.

Name Type Description

svm

svm

relationship

Name Type Description

destination

snapmirror_endpoint

Endpoint of a SnapMirror relationship.

restore

boolean

Is the relationship for restore?

uuid

string

snapmirror_transfer

Snapmirror transfer information

Name Type Description

_links

_links

bytes_transferred

integer

Bytes transferred

checkpoint_size

integer

Amount of data transferred in bytes as recorded in the restart checkpoint.

relationship

relationship

snapshot

string

Name of Snapshot copy being transferred.

state

string

Status of the transfer. Set PATCH state to "aborted" to abort the transfer. Set PATCH state to "hard_aborted" to abort the transfer and discard the restart checkpoint.

uuid

string

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.