snapshot
Suggest changes
PDFs
snapshot-add-test-owners
This ONTAPI call does not have an equivalent REST API call.
snapshot-autodelete-list-info
GET /api/storage/volumes/{uuid}
Note: The REST API field name is "space.snapshot.autodelete_enabled".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-autodelete-set-option
PATCH /api/storage/volumes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
option-name |
space.snapshot.autodelete_enabled |
|
option-value |
No REST Equivalent |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL |
snapshot-create
POST /api/storage/volumes/{volume.uuid}/snapshots
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
async |
No REST Equivalent |
All REST API POST endpoints are async. |
comment |
comment |
|
expiry-time |
expiry_time |
|
is-valid-lun-clone-snapshot |
No REST Equivalent |
|
snapmirror-label |
snapmirror_label |
|
snapshot |
name |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-create-async
This ONTAPI call does not have an equivalent REST API call.
snapshot-delete
DELETE /api/storage/volumes/{volume.uuid}/snapshots/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ignore-owners |
No REST Equivalent |
|
snapshot |
No REST Equivalent |
The REST API uses snapshot.uuid from the URL. |
snapshot-instance-uuid |
No REST Equivalent |
Field is present in the URL as "snapshot.uuid". |
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-delete-async
This ONTAPI call does not have an equivalent REST API call.
snapshot-delta-info
GET /api/storage/volumes/{volume.uuid}/snapshots?fields=delta&name=snapshot1,snapshot2
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
snapshot1 |
name |
|
snapshot2 |
name |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-get-iter
GET /api/storage/volumes/{volume.uuid}/snapshots/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
access-time |
create_time |
|
afs-used |
No REST Equivalent |
|
busy |
owners |
Snapshot copies which have owners are busy. |
comment |
comment |
Optional parameter. Must be part of query only. |
compress-savings |
No REST Equivalent |
|
compression-type |
No REST Equivalent |
|
contains-lun-clones |
No REST Equivalent |
|
convert-recovery |
No REST Equivalent |
|
cumulative-percentage-of-total-blocks |
No REST Equivalent |
|
cumulative-percentage-of-used-blocks |
No REST Equivalent |
|
cumulative-total |
No REST Equivalent |
|
dedup-savings |
No REST Equivalent |
|
dependency |
owners |
Dependencies are denoted by the "dependent" suffix. |
expiry-time |
expiry_time |
Optional parameter. Must be part of query only. |
infinite-snaplock-expiry-time |
No REST Equivalent |
|
inofile-version |
No REST Equivalent |
|
is-7-mode-snapshot |
No REST Equivalent |
|
is-constituent-snapshot |
No REST Equivalent |
|
name |
name |
Optional parameter. Must be part of query only. |
percentage-of-total-blocks |
No REST Equivalent |
|
percentage-of-used-blocks |
No REST Equivalent |
|
performance-metadata |
No REST Equivalent |
|
snaplock-expiry-time |
snaplock_expiry_time |
Optional parameter. Must be part of query only. |
snapmirror-label |
snapmirror_label |
Optional parameter. Must be part of query only. |
snapshot-instance-uuid |
uuid |
Optional parameter. Must be part of query only. |
snapshot-owners-list |
owners |
Optional parameter. Must be part of query only. |
snapshot-version-uuid |
version_uuid |
|
state |
state |
Optional parameter. Must be part of query only. |
total |
size |
Optional parameter. Used only as part of a query. The value of size is in bytes. |
vbn0-savings |
No REST Equivalent |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
volume-provenance-uuid |
provenance_volume.uuid |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
snapshot-get-reserve
GET /api/storage/volumes/{uuid}
Note: The REST API field name is "space.snapshot.reserve_percent".
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
volume |
No REST Equivalent |
API uses volume uuid from URL |
snapshot-get-schedule
GET /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules
Note: The REST API field name is "schedule.uuid". You can retrieve The REST API field snapshot_policy.uuid by using the GET /api/storage/volumes endpoint.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
volume |
No REST Equivalent |
snapshot-list-info
GET /api/storage/volumes/{volume.uuid}/snapshots
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-7-mode-snapshot |
No REST Equivalent |
|
lun-clone-snapshot |
No REST Equivalent |
|
snapowners |
owners |
|
target-name |
No REST Equivalent |
|
target-type |
No REST Equivalent |
|
terse |
No REST Equivalent |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-modify-iter
PATCH /api/storage/volumes/{volume.uuid}/snapshots/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
access-time |
No REST Equivalent |
|
afs-used |
No REST Equivalent |
|
busy |
No REST Equivalent |
|
comment |
comment |
|
compress-savings |
No REST Equivalent |
|
compression-type |
No REST Equivalent |
|
contains-lun-clones |
No REST Equivalent |
|
convert-recovery |
No REST Equivalent |
|
cumulative-percentage-of-total-blocks |
No REST Equivalent |
|
cumulative-percentage-of-used-blocks |
No REST Equivalent |
|
cumulative-total |
No REST Equivalent |
|
dedup-savings |
No REST Equivalent |
|
dependency |
No REST Equivalent |
|
expiry-time |
expiry_time |
|
infinite-snaplock-expiry-time |
No REST Equivalent |
|
inofile-version |
No REST Equivalent |
|
is-7-mode-snapshot |
No REST Equivalent |
|
is-constituent-snapshot |
No REST Equivalent |
|
name |
name |
|
percentage-of-total-blocks |
No REST Equivalent |
|
percentage-of-used-blocks |
No REST Equivalent |
|
performance-metadata |
No REST Equivalent |
|
snaplock-expiry-time |
No REST Equivalent |
In the REST API, "snaplock-expiry-time" is a read-only field. |
snapmirror-label |
snapmirror_label |
|
snapshot-instance-uuid |
No REST Equivalent |
|
snapshot-owners-list |
No REST Equivalent |
In the REST API, "owners" is a read-only field. |
snapshot-version-uuid |
No REST Equivalent |
|
state |
No REST Equivalent |
In the REST API, "state" is a read-only field. |
total |
No REST Equivalent |
|
vbn0-savings |
No REST Equivalent |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
volume-provenance-uuid |
No REST Equivalent |
|
vserver |
No REST Equivalent |
|
continue-on-failure |
No REST Equivalent |
|
max-failure-count |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
return-failure-list |
No REST Equivalent |
|
return-success-list |
No REST Equivalent |
snapshot-modify-snaplock-expiry-time
PATCH /api/storage/volumes/{volume.uuid}/snapshots/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
expiry-time |
snaplock_expiry_time |
|
infinite-expiry-time |
No REST Equivalent |
|
snapshot |
No REST Equivalent |
The REST API uses snapshot uuid from the URL |
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-multicreate
POST /api/storage/volumes/*/snapshots
Note: All attributes are part of the records array.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cleanup |
No REST Equivalent |
|
snapmirror-label |
snapmirror_label |
|
snapshot |
name |
|
volume-names |
volume.name |
|
wait-for-sync |
No REST Equivalent |
snapshot-multicreate-validate
This ONTAPI call does not have an equivalent REST API call.
snapshot-multidelete
DELETE /api/storage/volumes/*/snapshots
Note: All attributes are part of the records array.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
reverting |
No REST Equivalent |
|
reverting-fg |
No REST Equivalent |
|
snapshot |
name |
|
snapshot-tags |
No REST Equivalent |
|
use-snapshot-as-prefix |
No REST Equivalent |
|
volume-names |
volume.name |
|
volume-uuids |
volume.uuid |
snapshot-multirename
PATCH /api/storage/volumes/*/snapshots
Note: All attributes are part of the records array.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
new-snapshot-name |
name |
|
snapshot-name |
uuid |
|
volume-names |
volume.name |
snapshot-partial-restore-file
PATCH /api/storage/volumes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
byte-count |
restore_to.byte_count |
|
path |
restore_to.path |
|
snapshot |
restore_to.snapshot.name |
|
snapshot-instance-uuid |
restore_to.snapshot.uuid |
|
start-byte |
restore_to.start_byte |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
volume-dsid |
No REST Equivalent |
snapshot-partial-restore-file-list-info
This ONTAPI call does not have an equivalent REST API call.
snapshot-policy-add-schedule
POST /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
count |
count |
|
policy |
No REST Equivalent |
The REST API uses snapshot_policy.uuid from the URL. |
prefix |
prefix |
|
schedule |
schedule.name |
|
snapmirror-label |
snapmirror_label |
snapshot-policy-create
POST /api/storage/snapshot-policies
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
|
count1 |
copies.count |
|
count2 |
copies.count |
|
count3 |
copies.count |
|
count4 |
copies.count |
|
count5 |
copies.count |
|
enabled |
enabled |
|
policy |
name |
|
prefix1 |
copies.prefix |
|
prefix2 |
copies.prefix |
|
prefix3 |
copies.prefix |
|
prefix4 |
copies.prefix |
|
prefix5 |
copies.prefix |
|
schedule1 |
copies.schedule.name |
|
schedule2 |
copies.schedule.name |
|
schedule3 |
copies.schedule.name |
|
schedule4 |
copies.schedule.name |
|
schedule5 |
copies.schedule.name |
|
snapmirror-label1 |
copies.snapmirror_label |
|
snapmirror-label2 |
copies.snapmirror_label |
|
snapmirror-label3 |
copies.snapmirror_label |
|
snapmirror-label4 |
copies.snapmirror_label |
|
snapmirror-label5 |
copies.snapmirror_label |
snapshot-policy-delete
DELETE /api/storage/snapshot-policies/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
policy |
No REST Equivalent |
API uses snapshot_policy.uuid from URL |
snapshot-policy-get
GET /api/storage/snapshot-policies/{uuid}
Note: "snapshot_policy.uuid" is an optional parameter.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
Optional parameter. Must be part of query only. |
enabled |
enabled |
Optional parameter. Must be part of query only. |
policy |
name |
Optional parameter. Must be part of query only. |
policy-owner |
No REST Equivalent |
|
snapshot-policy-schedules |
copies.schedule.name |
Optional parameter. Must be part of query only. |
total-schedules |
copies.count |
Optional parameter. Must be part of query only. |
vserver-name |
svm.name |
Optional parameter. Must be part of query only. You can also use "svm.uuid". |
snapshot-policy-get-iter
GET /api/storage/snapshot-policies
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
Optional parameter. Must be part of query only. |
enabled |
enabled |
Optional parameter. Must be part of query only. |
policy |
name |
Optional parameter. Must be part of query only. |
policy-owner |
No REST Equivalent |
|
snapshot-policy-schedules |
copies.schedule.name |
Optional parameter. Must be part of query only. |
total-schedules |
No REST Equivalent |
|
vserver-name |
svm.name |
Optional parameter. Must be part of query only. |
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
snapshot-policy-modify
PATCH /api/storage/snapshot-policies/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
comment |
comment |
|
enabled |
enabled |
|
policy |
name |
snapshot-policy-modify-schedule
PATCH /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules/{schedule.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
new-count |
count |
|
new-snapmirror-label |
snapmirror_label |
|
policy |
No REST Equivalent |
The REST API uses snapshot_policy.uuid from the URL. |
schedule |
No REST Equivalent |
The REST API uses schedule.uuid from the URL. |
snapshot-policy-remove-schedule
DELETE /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules/{schedule.uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
policy |
No REST Equivalent |
The REST API uses snapshot_policy.uuid from the URL. |
schedule |
No REST Equivalent |
snapshot-reclaimable-info
GET /api/storage/volumes/{volume.uuid}/snapshots?fields=reclaimable_space
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
snapshots |
name |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-remove-owner
This ONTAPI call does not have an equivalent REST API call.
snapshot-rename
PATCH /api/storage/volumes/{volume.uuid}/snapshots/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
current-name |
No REST Equivalent |
The REST API uses snapshot uuid from the URL |
new-name |
name |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-reserve-list-info
GET /api/storage/volumes/{uuid}
Note: The REST API field name is space.snapshot.reserve_percent
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-restore-file
PATCH /api/storage/volumes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ignore-streams |
No REST Equivalent |
|
path |
restore_to.path |
|
restore-path |
restore_to.restore_path |
|
snapshot |
restore_to.snapshot.name |
|
snapshot-instance-uuid |
restore_to.snapshot.uuid |
|
space-efficient-split-disabled |
No REST Equivalent |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
volume-dsid |
No REST Equivalent |
snapshot-restore-file-info
This ONTAPI call does not have an equivalent REST API call.
snapshot-restore-volume
PATCH /api/storage/volumes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
force |
No REST Equivalent |
|
preserve-lun-ids |
preserve_lun_ids |
|
sched-snap-name |
scheduled_snapshot_naming_scheme |
|
snapshot |
restore_to.snapshot.name |
|
snapshot-instance-uuid |
restore_to.snapshot.uuid |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-restore-volume-async
This ONTAPI call does not have an equivalent REST API call.
snapshot-set-reserve
PATCH /api/storage/volumes/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
percentage |
space.snapshot.reserve_percent |
|
volume |
No REST Equivalent |
The REST API uses volume.uuid from the URL. |
snapshot-volume-info
This ONTAPI call does not have an equivalent REST API call.