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

snapmirror

Contributors
Suggest changes
PDFs

snapmirror-abort

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

Note: To abort an ongoing SnapMirror transfer, refer to snapmirror-abort-async.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

check-only

No REST Equivalent

clear-checkpoint

No REST Equivalent

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-abort-async

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

Note: To abort an ongoing SnapMirror transfer, set the tranfer state to "aborted".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

check-only

No REST Equivalent

clear-checkpoint

state

To clear the checkpoint in the REST API, set the state to "hard_aborted".

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-abort-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-add-exclude

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-off

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-on

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-remove-exclude

This ONTAPI call does not have an equivalent REST API call.

snapmirror-break

Note: To break a SnapMirror relationship, refer to snapmirror-break-async.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-break-async

PATCH /api/snapmirror/relationships/{uuid}

Note: To break a SnapMirror relationship, set the relationship state to "broken_off".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

recover

recover_after_break

restore-destination-to-snapshot

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-break-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cache-rebuild-relationship

This ONTAPI call does not have an equivalent REST API call.

snapmirror-capabilities-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-capabilities-get-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-check

This ONTAPI call does not have an equivalent REST API call.

snapmirror-check-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-config-replication-cluster-storage-configuration-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-config-replication-cluster-storage-configuration-modify

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-aggregate-eligibility-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-aggregate-eligibility-get-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-comm-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-comm-get-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-create

POST /api/snapmirror/relationships

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

cg-item-mappings

See comment column for details

Supply all of the following REST API properties:
destination.consistency_group_volumes.name
destination.consistency_group_volumes.uuid
source.consistency_group_volumes.name
source.consistency_group_volumes.uuid

destination-cluster

See comment column for details

Supply all of the following REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-endpoint-uuid

No REST Equivalent

destination-location

destination.path

destination-volume

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following REST API properties:
destination.svm.name
destination.svm.uuid

identity-preserve

No REST Equivalent

Identity preservation for an SVM DR relationship is part of the SnapMirror policy associated with the SnapMirror relationship.

is-auto-expand-enabled

No REST Equivalent

FlexGroup volume's automatic expand is set to "true" by default. This behavior cannot be altered through the REST API.

is-catalog-enabled

No REST Equivalent

max-transfer-rate

No REST Equivalent

Maximum transfer rate for a SnapMirror relationship is part of the SnapMirror policy associated with the relationship.

policy

See comment column for details

Supply all the following REST API properties:
policy.name
policy.uuid

relationship-type

No REST Equivalent

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

return-record

No REST Equivalent

schedule

No REST Equivalent

Schedule for a SnapMirror relationship is part of the SnapMirror policy associated with the relationship.

source-cluster

See comment column for details

Supply all the following REST API properties:
source.cluster.name
source.cluster.uuid

source-endpoint-uuid

No REST Equivalent

source-location

source.path

source-volume

No REST Equivalent

source-vserver

See comment column for details

Supply all the following REST API properties:
source.svm.name
source.svm.uuid

tries

No REST Equivalent

vserver

No REST Equivalent

snapmirror-destroy

DELETE /api/snapmirror/relationships/{uuid}

Note: To destroy a SnapMirror relationship, refer to snapmirror-destroy-async.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-destroy-async

DELETE /api/snapmirror/relationships/{uuid}

Note: When you do not specify a query, the SnapMirror relationship is deleted from the destination cluster and the relationship is also released from the source cluster. When you specify the query "destination_only=true", the SnapMirror relationship is deleted from the cluster that contains the destination endpoint and the relationship is not released from the source cluster.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-destroy-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-get

GET /api/snapmirror/relationships/{uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

break-failed-count

No REST Equivalent

break-successful-count

No REST Equivalent

catalog-status

No REST Equivalent

catalog-total-progress

No REST Equivalent

catalog-transfer-snapshot

No REST Equivalent

cg-item-mappings

See comment column for details

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
destination.consistency_group_volumes.uuid
source.consistency_group_volumes.name
source.consistency_group_volumes.uuid

current-max-transfer-rate

No REST Equivalent

current-operation-id

No REST Equivalent

current-transfer-error

No REST Equivalent

current-transfer-priority

No REST Equivalent

current-transfer-type

No REST Equivalent

destination-cluster

See comment column for details

Supply all the following the REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-endpoint-uuid

No REST Equivalent

destination-location

destination.path

destination-volume

No REST Equivalent

destination-volume-node

No REST Equivalent

destination-vserver

destination.svm.name

destination-vserver-uuid

destination.svm.uuid

exported-snapshot

exported_snapshot

exported-snapshot-timestamp

No REST Equivalent

file-restore-file-count

No REST Equivalent

file-restore-file-list

No REST Equivalent

identity-preserve

No REST Equivalent

is-auto-expand-enabled

No REST Equivalent

is-catalog-enabled

No REST Equivalent

is-constituent

No REST Equivalent

is-healthy

healthy

lag-time

lag_time

last-transfer-duration

transfer.total_duration

last-transfer-end-timestamp

transfer.end_time

last-transfer-error

unhealthy_reason.message

last-transfer-error-codes

unhealthy_reason.code

last-transfer-from

No REST Equivalent

last-transfer-network-compression-ratio

No REST Equivalent

last-transfer-size

transfer.bytes_transferred

last-transfer-type

No REST Equivalent

max-transfer-rate

No REST Equivalent

mirror-state

state

network-compression-ratio

No REST Equivalent

newest-snapshot

No REST Equivalent

newest-snapshot-timestamp

No REST Equivalent

opmask

No REST Equivalent

policy

See comment column for details

Supply all the following the REST API properties:
policy.name
policy.uuid

policy-type

policy.type

progress-last-updated

No REST Equivalent

relationship-control-plane

No REST Equivalent

relationship-group-type

No REST Equivalent

relationship-id

uuid

relationship-progress

transfer.bytes_transferred

relationship-status

state

relationship-type

No REST Equivalent

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

resync-failed-count

No REST Equivalent

resync-successful-count

No REST Equivalent

schedule

No REST Equivalent

snapshot-checkpoint

No REST Equivalent

snapshot-progress

No REST Equivalent

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-endpoint-uuid

No REST Equivalent

source-location

source.path

source-volume

No REST Equivalent

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

source-vserver-uuid

source.svm.uuid

total-transfer-bytes

transfer.bytes_transferred

total-transfer-time-secs

No REST Equivalent

transfer-snapshot

No REST Equivalent

tries

No REST Equivalent

unhealthy-reason

See comment column for details

Supply all the following the REST API properties:
unhealthy_reason.message
unhealthy_reason.code

update-failed-count

No REST Equivalent

update-successful-count

No REST Equivalent

vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

destination-cluster

See comment column for details

Supply all the following the REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-location

destination.path

destination-volume

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-location

source.path

source-volume

No REST Equivalent

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

snapmirror-get-destination

GET /api/snapmirror/relationships/{uuid}

Note: Use the query "list_destinations_only=true" to list the source side SnapMirror relationships.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

cg-item-mappings

See comment column for details

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
destination.consistency_group_volumes.uuid
source.consistency_group_volumes.name
source.consistency_group_volumes.uuid

destination-location

destination.path

destination-volume

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

is-constituent

No REST Equivalent

policy-type

policy.type

progress-last-updated

No REST Equivalent

relationship-group-type

No REST Equivalent

relationship-id

uuid

relationship-status

state

relationship-type

No REST Equivalent

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

source-location

source.path

source-volume

No REST Equivalent

source-volume-node

No REST Equivalent

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

transfer-progress

transfer.state

destination-location

destination.path

destination-volume

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

source-location

source.path

source-volume

No REST Equivalent

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

snapmirror-get-destination-iter

GET /api/snapmirror/relationships

Note: Use the query "list_destinations_only=true" to list the source side SnapMirror relationships.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

cg-item-mappings

See comment column for details

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
destination.consistency_group_volumes.uuid
source.consistency_group_volumes.name
source.consistency_group_volumes.uuid

destination-location

destination.path

destination-volume

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

is-constituent

No REST Equivalent

policy-type

policy.type

progress-last-updated

No REST Equivalent

relationship-group-type

No REST Equivalent

relationship-id

uuid

relationship-status

state

relationship-type

No REST Equivalent

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

source-location

source.path

source-volume

No REST Equivalent

source-volume-node

No REST Equivalent

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

transfer-progress

transfer.bytes_transferred

expand

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-get-dp-personality

Note: This feature is obsolete and deprecated. Not implemented in REST API.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-get-iter

GET /api/snapmirror/relationships

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

break-failed-count

No REST Equivalent

break-successful-count

No REST Equivalent

catalog-status

No REST Equivalent

catalog-total-progress

No REST Equivalent

catalog-transfer-snapshot

No REST Equivalent

cg-item-mappings

See comment column for details

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
destination.consistency_group_volumes.uuid
source.consistency_group_volumes.name
source.consistency_group_volumes.uuid

current-max-transfer-rate

No REST Equivalent

current-operation-id

No REST Equivalent

current-transfer-error

No REST Equivalent

current-transfer-priority

No REST Equivalent

current-transfer-type

No REST Equivalent

destination-cluster

See comment column for details

Supply all the following the REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-endpoint-uuid

No REST Equivalent

destination-location

destination.path

destination-volume

No REST Equivalent

destination-volume-node

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

destination-vserver-uuid

destination.svm.uuid

exported-snapshot

exported_snapshot

exported-snapshot-timestamp

No REST Equivalent

file-restore-file-count

No REST Equivalent

file-restore-file-list

No REST Equivalent

identity-preserve

No REST Equivalent

is-auto-expand-enabled

No REST Equivalent

is-catalog-enabled

No REST Equivalent

is-constituent

No REST Equivalent

is-healthy

No REST Equivalent

lag-time

lag_time

last-transfer-duration

transfer.total_duration

last-transfer-end-timestamp

transfer.end_time

last-transfer-error

unhealthy_reason.message

last-transfer-error-codes

unhealthy_reason.code

last-transfer-from

No REST Equivalent

last-transfer-network-compression-ratio

No REST Equivalent

last-transfer-size

transfer.bytes_transferred

last-transfer-type

No REST Equivalent

max-transfer-rate

No REST Equivalent

mirror-state

state

network-compression-ratio

No REST Equivalent

newest-snapshot

No REST Equivalent

newest-snapshot-timestamp

No REST Equivalent

opmask

No REST Equivalent

policy

policy.name

policy-type

policy.type

progress-last-updated

No REST Equivalent

relationship-control-plane

No REST Equivalent

relationship-group-type

No REST Equivalent

relationship-id

uuid

relationship-progress

No REST Equivalent

relationship-status

state

relationship-type

No REST Equivalent

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API

resync-failed-count

No REST Equivalent

resync-successful-count

No REST Equivalent

schedule

No REST Equivalent

snapshot-checkpoint

No REST Equivalent

snapshot-progress

No REST Equivalent

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-endpoint-uuid

No REST Equivalent

source-location

source.path

source-volume

No REST Equivalent

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

source-vserver-uuid

source.svm.uuid

total-transfer-bytes

transfer.bytes_transferred

total-transfer-time-secs

No REST Equivalent

transfer-snapshot

No REST Equivalent

tries

No REST Equivalent

unhealthy-reason

unhealthy_reason.message

update-failed-count

No REST Equivalent

update-successful-count

No REST Equivalent

vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

expand

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-get-total-records

This ONTAPI call does not have an equivalent REST API call.

snapmirror-get-volume-status

This ONTAPI call does not have an equivalent REST API call.

snapmirror-history-get

GET /api/snapmirror/relationships/{relationship.uuid}/transfers/{uuid}

Note: Use the GET /api/snapmirror/relationships/{relationship.uuid}/transfers/{uuid} REST API to retrieve the status of an on-going transfer or completed transfer within the last 24 hours. Refer to audit.log for information on other operations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

additional-info

error_info.message

destination-location

relationship.destination.path

destination-volume

No REST Equivalent

destination-vserver

relationship.destination.svm.name

end-time

end_time

operation-id

uuid

operation-type

No REST Equivalent

relationship-group-type

No REST Equivalent

relationship-id

relationship.uuid

result

state

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

start-time

No REST Equivalent

transfer-size

bytes_transferred

destination-location

irelationship.destination.path`

destination-volume

No REST Equivalent

destination-vserver

relationship.destination.svm

operation-id

uuid

snapmirror-history-get-iter

GET /api/snapmirror/relationships/{relationship.uuid}/transfers

Note: Use the GET /api/snapirror/relationships/{relationship.uuid}/transfers REST API to obtain all transfer information for a SnapMirror relationship within the last 24 hours. Refer to audit.log for information on other operations.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

additional-info

error_info.message

destination-location

relationship.destination.path

destination-volume

No REST Equivalent

destination-vserver

relationship.destination.svm

end-time

end_time

operation-id

uuid

operation-type

No REST Equivalent

relationship-group-type

No REST Equivalent

relationship-id

relationship.uuid

result

state

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

start-time

No REST Equivalent

transfer-size

bytes_transferred

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-initialize

PATCH /api/snapmirror/relationships/{uuid}

Note: To initialize the SnapMirror relationship, set the "state" property to "snapmirrored".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-snapshot

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

is-adaptive

No REST Equivalent

is-auto-expand-enabled

No REST Equivalent

is-catalog-enabled

No REST Equivalent

max-transfer-rate

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-snapshot

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

transfer-priority

No REST Equivalent

snapmirror-initialize-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-initialize-ls-set

Note: This feature is deprecated. Not implemented in REST API.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-list-unprotected

GET /api/storage/volumes

Note: To list the unprotected volumes, set the query on the property "snapmirror.is_protected" to "false".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

snapmirror-modify

PATCH /api/snapmirror/relationships/{uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

destination.path

destination-volume

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

is-auto-expand-enabled

No REST Equivalent

is-catalog-enabled

No REST Equivalent

max-transfer-rate

No REST Equivalent

policy

See comment column for details

Supply all the following the REST API properties:
policy.name
policy.uuid

schedule

No REST Equivalent

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-location

source.path

source-volume

No REST Equivalent

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

tries

No REST Equivalent

vserver

destination.svm.name

snapmirror-modify-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-promote

This ONTAPI call does not have an equivalent REST API call.

snapmirror-promote-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-protect

POST /api/snapmirror/relationships

Note: Use the "create_destination" object to provision the destination endpoint when establishing a SnapMirror relationship for a FlexVol volume, FlexGroup volume, SVM, or Consistency Group. Given a source endpoint, the destination endpoint is provisioned in the SVM specified in the "destination.path" property. While protecting an SVM, the SVM destination endpoint can only be provisioned on the local cluster. Note that the snapmirror-protect ONTAPI generates the name for the destination endpoint, but the REST API requires that you specify the name of the destination endpoint in the "destination path" property.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

auto-initialize

state

When you specify the "create_destination.enabled" option while making a POST for a SnapMirror relationship, the relationship can be automatically initialized by setting the "state" either to "snapmirrored" when the policy is of type "async" or to "in_sync" when the policy is of type "sync"

destination-object-store

No REST Equivalent

destination-volume-prefix

No REST Equivalent

destination-volume-suffix

No REST Equivalent

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

destination-vserver-ipspace

destination.ipspace

is-catalog-enabled

No REST Equivalent

path-list

source.path

Can protect one source endpoint at a time.

policy

See comment column for details

Supply all the following the REST API properties:
policy.name
policy.uuid

schedule

No REST Equivalent

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

A POST request to create the destination FlexVol volume, FlexGroup volume, and Consistency Group endpoints can optionally specify this 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 this property for the remote endpoint. A POST request to create the destination SVM endpoint or to establish an SVM DR relationship must populate this property with the remote source cluster details.

support-tiering

create_destination.tiering.supported

tiering-policy

create_destination.tiering.policy

snapmirror-quiesce

PATCH /api/snapmirror/relationships/{uuid}

Note: To quiesce the relationship, suspending further transfers, PATCH the "state" to "paused" for relationships with a policy of type "async" or "sync". SnapMirror relationships with the policy type as "sync" and "sync_type" as "automated_failover" cannot be "paused".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-quiesce-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-release

DELETE /api/snapmirror/relationships/{uuid}

Note: Use the query "source_only=true" to release the SnapMirror relationship and delete the Snapshot copies from the cluster that contains the source endpoint. Use the query "source_info_only=true" to release the SnapMirror relationship information from the cluster that contains the source endpoint.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-endpoint-uuid

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

relationship-id

No REST Equivalent

relationship-info-only

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-release-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-restore

POST /api/snapmirror/relationships

Note: Use the POST /api/snapmirror/relationships REST API call with the property "restore=true" to create the SnapMirror restore relationship. Use the POST /api/snapmirror/relationships/\{relationship.uuid\}/transfers REST API call to start the restore transfer on the SnapMirror relationship.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

archive-retrieval-priority

No REST Equivalent

cg-item-mappings

No REST Equivalent

clean-up-failure

No REST Equivalent

Use the DELETE /api/snapmirror/relationships/{uuid} REST API call to delete a SnapMirror restore relationship.

create-check-snapshot

No REST Equivalent

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

Use the POST /api/snapmirror/relationships REST API call to specify the "destination.path" property and create the SnapMirror restore relationship.

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

disable-storage-efficiency

storage_efficiency_enabled

Use the POST /api/snapmirror/relationships/\{relationship.uuid\}/transfers REST API call to set this property to "false" to turn off storage efficiency for data transferred over the wire and written to the destination.

max-transfer-rate

throttle

Use the POST /api/snapmirror/relationships/\{relationship.uuid\}/transfers REST API call to set the transfer rate to restrict the speed of the transfer to the maximum KB/s.

on-demand

No REST Equivalent

on-demand-attrs

No REST Equivalent

restore-file-list

See comment column for details

Supply all the following the REST API properties:
files.source_path
files.destination_path

Use the POST /api/snapmirror/relationships/\{relationship.uuid\}/transfers REST API endpoint to specify the list of files or LUNs to be restored. The list can contain up to eight files or LUNs.

restore-object-expiry

No REST Equivalent

source-cluster

No REST Equivalent

source-endpoint-uuid

No REST Equivalent

source-location

No REST Equivalent

Use the POST /api/snapmirror/relationships REST API call to specify the "source.path" property and create the SnapMirror restore relationship.

source-snapshot

source_snapshot

Use the POST /api/snapmirror/relationships/\{relationship.uuid\}/transfers REST API call to specify the Snapshot copy on the source to be transferred to the destination.

source-snapshot-uuid

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

transfer-priority

No REST Equivalent

tries

No REST Equivalent

use-network-compression

No REST Equivalent

snapmirror-resume

PATCH /api/snapmirror/relationships/{uuid}

Note: In the REST API, to resume transfers for a paused SnapMirror relationship, PATCH the "state" property to "snapmirrored" for relationships with a policy of type "async" or "in_sync" for relationships with a policy of type "sync".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

snapmirror-resume-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-resync

PATCH /api/snapmirror/relationships/{uuid}

Note: In the REST API, to resync the broken SnapMirror relationship, PATCH the "state" to "snapmirrored" for relationships with a policy of type "async" or "in_sync" for relationships with a policy of type "sync".

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-endpoint-uuid

No REST Equivalent

destination-location

No REST Equivalent

destination-snapshot

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

is-adaptive

No REST Equivalent

is-auto-expand-enabled

No REST Equivalent

is-catalog-enabled

No REST Equivalent

max-transfer-rate

No REST Equivalent

preserve

No REST Equivalent

quick-resync

No REST Equivalent

remove-catalog-base-owners

No REST Equivalent

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-snapshot

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

transfer-priority

No REST Equivalent

snapmirror-resync-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-create

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-destroy

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-get-snapshots

This ONTAPI call does not have an equivalent REST API call.

snapmirror-update

POST /api/snapmirror/relationships/{relationship.uuid}/transfers

Note: Use the REST API POST method with an empty JSON body to start the SnapMirror update transfer on the relationship.

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

destination-cluster

No REST Equivalent

destination-location

No REST Equivalent

destination-snapshot

No REST Equivalent

destination-volume

No REST Equivalent

destination-vserver

No REST Equivalent

enable-storage-efficiency

No REST Equivalent

max-transfer-rate

throttle

Use the POST /api/snapmirror/relationships/\{relationship.uuid\}/transfers REST API call to set the transfer rate to restrict the speed of the transfer to the maximum KB/s.

source-cluster

No REST Equivalent

source-location

No REST Equivalent

source-snapshot

No REST Equivalent

source-volume

No REST Equivalent

source-vserver

No REST Equivalent

transfer-priority

No REST Equivalent

snapmirror-update-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-update-ls-set

Note: This feature is deprecated. Not implemented in REST API.

This ONTAPI call does not have an equivalent REST API call.