Skip to main content
ONTAP 9.10.1 ONTAPI-to-REST mapping
A newer release of this product is available.

snapmirror-policy

Contributors
Suggest changes

snapmirror-policy-add-rule

PATCH /api/snapmirror/policies/{uuid}

Note: A SnapMirror policy rule is referred to as SnapMirror policy retention object. To add a new retention object, use this REST API after appending the new retention object to the existing list of "retention" objects.

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

ONTAPI attribute REST attribute Comment

keep

retention.count

policy-name

name

prefix

retention.prefix

preserve

No REST Equivalent

schedule

retention.creation_schedule.uuid

snapmirror-label

retention.label

warn

No REST Equivalent

snapmirror-policy-create

POST /api/snapmirror/policies

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

ONTAPI attribute REST attribute Comment

archive-after-days

No REST Equivalent

are-data-ops-sequentially-split

No REST Equivalent

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.uuid

discard-configs

No REST Equivalent

ignore-atime

No REST Equivalent

is-network-compression-enabled

network_compression_enabled

keep

retention.count

owner

scope

policy-name

name

prefix

retention.prefix

preserve

No REST Equivalent

restart

No REST Equivalent

return-record

No REST Equivalent

schedule

retention.creation_schedule.uuid

snapmirror-label

retention.label

transfer-priority

No REST Equivalent

tries

No REST Equivalent

type

sync_type

warn

No REST Equivalent

window-size-for-tdp-mirror

No REST Equivalent

snapmirror-policy-delete

DELETE /api/snapmirror/policies/{uuid}

Note: The SnapMirror policy UUID uniquely identifies the policy that should be deleted.

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

ONTAPI attribute REST attribute Comment

policy-name

No REST Equivalent

snapmirror-policy-get

GET /api/snapmirror/policies

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

ONTAPI attribute REST attribute Comment

archive-after-days

No REST Equivalent

are-data-ops-sequentially-split

No REST Equivalent

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.uuid

create-snapshot

No REST Equivalent

discard-configs

No REST Equivalent

ignore-atime

No REST Equivalent

is-network-compression-enabled

network_compression_enabled

owner

scope

policy-name

name

restart

No REST Equivalent

snapmirror-policy-rules

retention

total-keep

No REST Equivalent

total-rules

No REST Equivalent

transfer-priority

No REST Equivalent

tries

No REST Equivalent

type

sync_type

vserver-name

svm.uuid

window-size-for-tdp-mirror

No REST Equivalent

policy-name

name

snapmirror-policy-get-iter

GET /api/snapmirror/policies

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

ONTAPI attribute REST attribute Comment

archive-after-days

No REST Equivalent

are-data-ops-sequentially-split

No REST Equivalent

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.uuid

create-snapshot

No REST Equivalent

discard-configs

No REST Equivalent

ignore-atime

No REST Equivalent

is-network-compression-enabled

network_compression_enabled

owner

scope

policy-name

name

restart

No REST Equivalent

snapmirror-policy-rules

retention

total-keep

No REST Equivalent

total-rules

No REST Equivalent

transfer-priority

No REST Equivalent

tries

No REST Equivalent

type

sync_type

vserver-name

svm.uuid

window-size-for-tdp-mirror

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-policy-modify

PATCH /api/snapmirror/policies/{uuid}

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

ONTAPI attribute REST attribute Comment

archive-after-days

No REST Equivalent

are-data-ops-sequentially-split

No REST Equivalent

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.uuid

discard-configs

No REST Equivalent

ignore-atime

No REST Equivalent

is-network-compression-enabled

network_compression_enabled

keep

retention.count

owner

No REST Equivalent

policy-name

name

prefix

retention.prefix

preserve

No REST Equivalent

restart

No REST Equivalent

schedule

retention.creation_schedule.uuid

snapmirror-label

retention.label

transfer-priority

No REST Equivalent

tries

No REST Equivalent

warn

No REST Equivalent

window-size-for-tdp-mirror

No REST Equivalent

snapmirror-policy-modify-rule

PATCH /api/snapmirror/policies/{uuid}

Note: A SnapMirror policy rule is referred to as a SnapMirror policy retention object. To modify a retention object, use this REST API by appending the modified retention object to the existing list of "retention" objects.

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

ONTAPI attribute REST attribute Comment

keep

retention.count

policy-name

name

prefix

retention.prefix

preserve

No REST Equivalent

schedule

retention.creation_schedule.uuid

snapmirror-label

retention.label

warn

No REST Equivalent

snapmirror-policy-remove-rule

PATCH /api/snapmirror/policies/{uuid}

Note: A SnapMirror policy rule is referred to as SnapMirror policy retention object. To delete a retention object, use this REST API by specifying the final list of "retention" objects excluding the retention object that must be deleted.

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

ONTAPI attribute REST attribute Comment

policy-name

No REST Equivalent

snapmirror-label

No REST Equivalent