Cancel 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

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

Parameters

Name	Type	In	Required	Description
relationship.uuid	string	path	True	SnapMirror relationship UUID
uuid	string	path	True	SnapMirror transfer UUID

Name

Type

In

Required

Description

relationship.uuid

string

path

True

SnapMirror relationship UUID

uuid

string

path

True

SnapMirror transfer UUID

Request Body

Name	Type	Description
bytes_transferred	integer	Bytes transferred
checkpoint_size	integer	Amount of data transferred in bytes as recorded in the restart checkpoint.
end_time	string	End time of the transfer.
error_info	error_info	Error information for the transfer.
last_updated_time	string	Last updated time of the bytes transferred in an active transfer.
network_compression_ratio	string	Specifies the compression ratio achieved for the data sent over the wire with network compression enabled. This property is only valid for active transfers.
on_demand_attrs	string	Specifies whether or not an on-demand restore is being carried out. This is only supported for the transfer of restore relationships for entire volumes from the object store. A value for read_write_with_user_data_pull should be provided to start an on-demand restore. A file restore from the object store does not support this option.
relationship	relationship
snapshot	string	Name of snapshot 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. To find "queued" transfers refer to relationships GET API.
total_duration	string	Elapsed transfer time.
uuid	string	Unique identifier of the SnapMirror transfer.

Name

Type

Description

bytes_transferred

integer

Bytes transferred

checkpoint_size

integer

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

end_time

string

End time of the transfer.

error_info

Error information for the transfer.

last_updated_time

string

Last updated time of the bytes transferred in an active transfer.

network_compression_ratio

string

Specifies the compression ratio achieved for the data sent over the wire with network compression enabled. This property is only valid for active transfers.

on_demand_attrs

string

Specifies whether or not an on-demand restore is being carried out. This is only supported for the transfer of restore relationships for entire volumes from the object store. A value for read_write_with_user_data_pull should be provided to start an on-demand restore. A file restore from the object store does not support this option.

relationship

snapshot

string

Name of snapshot 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. To find "queued" transfers refer to relationships GET API.

total_duration

string

Elapsed transfer time.

uuid

string

Unique identifier of the SnapMirror transfer.

Example request

{
  "bytes_transferred": 0,
  "checkpoint_size": 0,
  "end_time": "2020-12-02 21:36:19 -0500",
  "error_info": {
    "code": 6620046,
    "message": "Transfer aborted"
  },
  "last_updated_time": "2023-09-15 19:58:39 -0400",
  "network_compression_ratio": 61,
  "on_demand_attrs": "read_write_with_user_data_pull",
  "relationship": {
    "destination": {
      "cluster": {
        "name": "cluster1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "luns": {
        "name": "/vol/volume1/lun1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "path": "svm1:volume1",
      "svm": {
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    },
    "uuid": "d2d7ceea-ab52-11e8-855e-00505682a4c7"
  },
  "snapshot": "string",
  "state": "string",
  "storage_efficiency_enabled": true,
  "total_duration": "PT28M41S",
  "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

Error code

Description

13303848

Abort of sync SnapMirror is not allowed

13303849

SnapMirror transfer state is invalid

Definitions

See Definitions

href

Name	Type	Description
href	string

Name

Type

Description

href

string

_links

error_info

Error information for the transfer.

Name	Type	Description
code	integer	Error code
message	string	Error message

Name

Type

Description

code

integer

Error code

message

string

Error message

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. File restore is not supported if the source_path or destination_path contains commas in its directory or file name.

Name	Type	Description
destination_path	string
source_path	string

Name

Type

Description

destination_path

string

source_path

string

options

cluster

Name	Type	Description
name	string
uuid	string

Name

Type

Description

name

string

uuid

string

consistency_group_volumes

Name	Type	Description
name	string	The name of the volume.

Name

Type

Description

name

string

The name of the volume.

luns

Optional property for a SnapMirror endpoint. Specifies the list of source LUNs and optionally list of destination LUNs during SnapMirror Consistency Group LUN restore operation.

Name	Type	Description
name	string	The name of a LUN. A LUN is located within a volume. Optionally, it can be located within a qtree in a volume. LUN names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.
uuid	string	The unique identifier of the LUN.

Name

Type

Description

name

string

The name of a LUN. A LUN is located within a volume. Optionally, it can be located within a qtree in a volume.

LUN names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

uuid

string

The unique identifier of the LUN.

svm

SVM, applies only to SVM-scoped objects.

Name	Type	Description
name	string	The name of the SVM. This field cannot be specified in a PATCH method.
uuid	string	The unique identifier of the SVM. This field cannot be specified in a PATCH method.

Name

Type

Description

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

snapmirror_endpoint

Endpoint of a SnapMirror relationship. For a GET request, the property "cluster" is populated when the endpoint is on a remote cluster. A POST request to create the destination SVM endpoint or to establish an SVM DR relationship must have the property "cluster" populated with the remote cluster details. A POST request to create the destination FlexVol volume, FlexGroup volume, Consistency Group, ONTAP S3 bucket and NON-ONTAP object-store endpoints can optionally specify the "cluster" property when the source SVM and the destination SVM are peered. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify the "cluster" property for the remote endpoint.

Name	Type	Description
cluster	cluster
luns	luns	Optional property for a SnapMirror endpoint. Specifies the list of source LUNs and optionally list of destination LUNs during SnapMirror Consistency Group LUN restore operation.
path	string	ONTAP FlexVol/FlexGroup - svm1:volume1 ONTAP SVM - svm1: ONTAP Consistency Group - svm1:/cg/cg_name ONTAP S3 - svm1:/bucket/bucket1 NON-ONTAP - objstore1:/objstore example: svm1:volume1 Introduced in: 9.6 x-nullable: true
svm	svm	SVM, applies only to SVM-scoped objects.

Name

Type

Description

cluster

luns

Optional property for a SnapMirror endpoint. Specifies the list of source LUNs and optionally list of destination LUNs during SnapMirror Consistency Group LUN restore operation.

path

string

ONTAP FlexVol/FlexGroup - svm1:volume1 ONTAP SVM - svm1: ONTAP Consistency Group - svm1:/cg/cg_name ONTAP S3 - svm1:/bucket/bucket1 NON-ONTAP - objstore1:/objstore

example: svm1:volume1
Introduced in: 9.6
x-nullable: true

svm

SVM, applies only to SVM-scoped objects.

relationship

Name	Type	Description
destination	snapmirror_endpoint	Endpoint of a SnapMirror relationship. For a GET request, the property "cluster" is populated when the endpoint is on a remote cluster. A POST request to create the destination SVM endpoint or to establish an SVM DR relationship must have the property "cluster" populated with the remote cluster details. A POST request to create the destination FlexVol volume, FlexGroup volume, Consistency Group, ONTAP S3 bucket and NON-ONTAP object-store endpoints can optionally specify the "cluster" property when the source SVM and the destination SVM are peered. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify the "cluster" property for the remote endpoint. Introduced in: 9.6
restore	boolean	Is the relationship for restore?
uuid	string	Unique identifier of the SnapMirror relationship.

Name

Type

Description

destination

snapmirror_endpoint

Endpoint of a SnapMirror relationship. For a GET request, the property "cluster" is populated when the endpoint is on a remote cluster. A POST request to create the destination SVM endpoint or to establish an SVM DR relationship must have the property "cluster" populated with the remote cluster details. A POST request to create the destination FlexVol volume, FlexGroup volume, Consistency Group, ONTAP S3 bucket and NON-ONTAP object-store endpoints can optionally specify the "cluster" property when the source SVM and the destination SVM are peered. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify the "cluster" property for the remote endpoint.

Introduced in: 9.6

restore

boolean

Is the relationship for restore?

uuid

string

Unique identifier of the SnapMirror relationship.

snapmirror_transfer

SnapMirror transfer information

Name	Type	Description
bytes_transferred	integer	Bytes transferred
checkpoint_size	integer	Amount of data transferred in bytes as recorded in the restart checkpoint.
end_time	string	End time of the transfer.
error_info	error_info	Error information for the transfer.
last_updated_time	string	Last updated time of the bytes transferred in an active transfer.
network_compression_ratio	string	Specifies the compression ratio achieved for the data sent over the wire with network compression enabled. This property is only valid for active transfers.
on_demand_attrs	string	Specifies whether or not an on-demand restore is being carried out. This is only supported for the transfer of restore relationships for entire volumes from the object store. A value for read_write_with_user_data_pull should be provided to start an on-demand restore. A file restore from the object store does not support this option.
relationship	relationship
snapshot	string	Name of snapshot 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. To find "queued" transfers refer to relationships GET API.
total_duration	string	Elapsed transfer time.
uuid	string	Unique identifier of the SnapMirror transfer.

Name

Type

Description

bytes_transferred

integer

Bytes transferred

checkpoint_size

integer

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

end_time

string

End time of the transfer.

error_info

Error information for the transfer.

last_updated_time

string

Last updated time of the bytes transferred in an active transfer.

network_compression_ratio

string

Specifies the compression ratio achieved for the data sent over the wire with network compression enabled. This property is only valid for active transfers.

on_demand_attrs

string

Specifies whether or not an on-demand restore is being carried out. This is only supported for the transfer of restore relationships for entire volumes from the object store. A value for read_write_with_user_data_pull should be provided to start an on-demand restore. A file restore from the object store does not support this option.

relationship

snapshot

string

Name of snapshot 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. To find "queued" transfers refer to relationships GET API.

total_duration

string

Elapsed transfer time.

uuid

string

Unique identifier of the SnapMirror transfer.

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

returned_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.

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.

Cancel an ongoing SnapMirror transfer

Creating your file...

Related ONTAP commands

Example

Learn more

Parameters

Request Body

Response

Error

Definitions