Retrieve ongoing SnapMirror transfers for a relationship

snapmirror show

Example

GET "/api/snapmirror/relationships/293baa53-e63d-11e8-bff1-005056a793dd/transfers"

Learn more

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

Parameters

Name	Type	In	Required	Description
relationship.uuid	string	path	True	Relationship UUID
relationship.uuid	string	query	False	Filter by relationship.uuid
relationship.restore	boolean	query	False	Filter by relationship.restore
relationship.destination.cluster.name	string	query	False	Filter by relationship.destination.cluster.name Introduced in: 9.7
relationship.destination.cluster.uuid	string	query	False	Filter by relationship.destination.cluster.uuid Introduced in: 9.7
relationship.destination.consistency_group_volumes.uuid	string	query	False	Filter by relationship.destination.consistency_group_volumes.uuid Introduced in: 9.8
relationship.destination.consistency_group_volumes.name	string	query	False	Filter by relationship.destination.consistency_group_volumes.name Introduced in: 9.8
relationship.destination.path	string	query	False	Filter by relationship.destination.path
relationship.destination.svm.uuid	string	query	False	Filter by relationship.destination.svm.uuid
relationship.destination.svm.name	string	query	False	Filter by relationship.destination.svm.name
state	string	query	False	Filter by state
snapshot	string	query	False	Filter by snapshot
uuid	string	query	False	Filter by uuid
checkpoint_size	integer	query	False	Filter by checkpoint_size
bytes_transferred	integer	query	False	Filter by bytes_transferred
fields	array[string]	query	False	Specify the fields to return.
max_records	integer	query	False	Limit the number of records returned.
return_records	boolean	query	False	The default is true for GET calls. When set to false, only the number of records is returned. Default value: 1
return_timeout	integer	query	False	The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached. Default value: 15 Max value: 120 Min value: 0
order_by	array[string]	query	False	Order results by specified fields and optional [asc

Name

Type

In

Required

Description

relationship.uuid

string

path

True

Relationship UUID

relationship.uuid

string

query

False

Filter by relationship.uuid

relationship.restore

boolean

query

False

Filter by relationship.restore

relationship.destination.cluster.name

string

query

False

Filter by relationship.destination.cluster.name

Introduced in: 9.7

relationship.destination.cluster.uuid

string

query

False

Filter by relationship.destination.cluster.uuid

Introduced in: 9.7

relationship.destination.consistency_group_volumes.uuid

string

query

False

Filter by relationship.destination.consistency_group_volumes.uuid

Introduced in: 9.8

relationship.destination.consistency_group_volumes.name

string

query

False

Filter by relationship.destination.consistency_group_volumes.name

Introduced in: 9.8

relationship.destination.path

string

query

False

Filter by relationship.destination.path

relationship.destination.svm.uuid

string

query

False

Filter by relationship.destination.svm.uuid

relationship.destination.svm.name

string

query

False

Filter by relationship.destination.svm.name

state

string

query

False

Filter by state

snapshot

string

query

False

Filter by snapshot

uuid

string

query

False

Filter by uuid

checkpoint_size

integer

query

False

Filter by checkpoint_size

bytes_transferred

integer

query

False

Filter by bytes_transferred

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

Default value: 15
Max value: 120
Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok

Name	Type	Description
_links	_links
num_records	integer	Number of records
records	array[snapmirror_transfer]

Name

Type

Description

_links

num_records

integer

Number of records

records

array[snapmirror_transfer]

Example response

{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "bytes_transferred": 0,
      "checkpoint_size": 0,
      "relationship": {
        "destination": {
          "cluster": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "cluster1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "consistency_group_volumes": [
            {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "name": "volume1",
              "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
            }
          ],
          "path": "svm1:volume1",
          "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"
    }
  ]
}

Error

Status: Default, Error

Name	Type	Description
error	error

Name

Type

Description

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

Name

Type

Description

href

string

_links

Name	Type	Description
next	href
self	href

Name

Type

Description

self

href

_links

Name	Type	Description
self	href

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

Name

Type

Description

destination_path

string

source_path

string

cluster

Name	Type	Description
_links	_links
name	string
uuid	string

Name

Type

Description

_links

name

string

uuid

string

consistency_group_volumes

Name	Type	Description
_links	_links
name	string	The name of the volume.
uuid	string	Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move. example: 028baa66-41bd-11e9-81d5-00a0986138f7

Name

Type

Description

_links

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

example: 028baa66-41bd-11e9-81d5-00a0986138f7

svm

Name	Type	Description
_links	_links
name	string	The name of the SVM.
uuid	string	The unique identifier of the SVM.

Name

Type

Description

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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, and Consistency Group 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
consistency_group_volumes	array[consistency_group_volumes]	Mandatory property for a Consistency Group endpoint. Specifies the list of FlexVol volumes for a Consistency Group.
path	string	ONTAP FlexVol/FlexGroup - svm1:volume1 ONTAP SVM - svm1: ONTAP Consistency Group - svm1:/cg/cg_name example: svm1:volume1 Introduced in: 9.6
svm	svm

Name

Type

Description

cluster

consistency_group_volumes

array[consistency_group_volumes]

Mandatory property for a Consistency Group endpoint. Specifies the list of FlexVol volumes for a Consistency Group.

path

string

ONTAP FlexVol/FlexGroup - svm1:volume1 ONTAP SVM - svm1: ONTAP Consistency Group - svm1:/cg/cg_name

example: svm1:volume1
Introduced in: 9.6

svm

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, and Consistency Group 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.
restore	boolean	Is the relationship for restore?
uuid	string

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, and Consistency Group 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.

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

Name

Type

Description

_links

bytes_transferred

integer

Bytes transferred

checkpoint_size

integer

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

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

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.

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.

Retrieve ongoing SnapMirror transfers for a relationship

Creating your file...

Related ONTAP commands

Example

Learn more

Parameters

Response

Error

Definitions