snaplock

Contributors

snaplock-archive-vserver-log

PATCH /api/storage/snaplock/audit-logs/{svm.uuid}

Note: You must pass the field "log_archive.archive" as "true" in the body.

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

ONTAPI attribute REST attribute Comment

base-name

log_archive.base_name

snaplock-create-vserver-log

POST /api/storage/snaplock/audit-logs

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

ONTAPI attribute REST attribute Comment

default-retention-period

log_volume.retention_period

max-log-size

log_volume.max_log_size

volume

log_volume.volume.name

With the REST API, you can also use "log_volume.volume.uuid".

snaplock-destroy-vserver-log

DELETE /api/storage/snaplock/audit-logs/{svm.uuid}

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

There are no attributes defined for this ONTAPI call.

snaplock-event-retention-abort

DELETE /api/storage/snaplock/event-retention/operations/{id}

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

ONTAPI attribute REST attribute Comment

operation-id

id

snaplock-event-retention-apply-start

POST /api/storage/snaplock/event-retention/operations

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

ONTAPI attribute REST attribute Comment

path

path

policy-name

policy.name

volume

volume.name

With the REST API, you can also use "volume.uuid".

snaplock-event-retention-get-iter

GET /api/storage/snaplock/event-retention/operations

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

ONTAPI attribute REST attribute Comment

num-files-failed

num_files_failed

num-files-processed

num_files_processed

num-files-skipped

num_files_skipped

num-inodes-ignored

num_inodes_ignored

operation-id

id

operation-status

state

path

path

policy-name

policy.name

retention-period

policy.retention_period

status-details

No REST Equivalent

volume

volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

snaplock-event-retention-policy-create

POST /api/storage/snaplock/event-retention/policies

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

ONTAPI attribute REST attribute Comment

name

name

retention-period

retention_period

return-record

return_records

snaplock-event-retention-policy-destroy

DELETE /api/storage/snaplock/event-retention/policies/{policy.name}

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

ONTAPI attribute REST attribute Comment

name

policy.name

snaplock-event-retention-policy-get-iter

GET /api/storage/snaplock/event-retention/policies

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

ONTAPI attribute REST attribute Comment

name

name

retention-period

retention_period

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

snaplock-event-retention-policy-modify

PATCH /api/storage/snaplock/event-retention/policies/{policy.name}

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

ONTAPI attribute REST attribute Comment

name

name

retention-period

retention_period

snaplock-file-privileged-delete

DELETE /api/storage/snaplock/file/{volume.uuid}/{path}

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

ONTAPI attribute REST attribute Comment

file

path

snaplock-get-clock-ntp-sync

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

snaplock-get-file-retention

GET /api/storage/snaplock/file/{volume.uuid}/{path}

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

ONTAPI attribute REST attribute Comment

file

file_path

formatted-retention-time

expiry_time

is-wraparound

No REST Equivalent

retention-time

No REST Equivalent

vserver

svm.name

file

No REST Equivalent

snaplock-get-node-compliance-clock

GET /api/storage/snaplock/compliance-clocks/{node.uuid}

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

ONTAPI attribute REST attribute Comment

node

node.uuid

snaplock-get-vserver-active-log-files-iter

GET /api/storage/snaplock/audit-logs

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

ONTAPI attribute REST attribute Comment

base-name

log_files.base_name

expiry-time

log_files.expiry_time

file-path

log_files.path

file-size

log_files.size

volume

log_volume.volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

snaplock-get-vserver-log-iter

GET /api/storage/snaplock/audit-logs

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

ONTAPI attribute REST attribute Comment

default-retention-period

log_volume.retention_period

max-log-size

log_volume.max_log_size

volume

log_volume.volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

DELETE /api/storage/snaplock/litigations/{litigation.id}/operations/{id}

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

ONTAPI attribute REST attribute Comment

operation-id

id

POST /api/storage/snaplock/litigations

Note: Can also use POST on /api/storage/snaplock/litigations/\{litigation.id\}/operations

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

ONTAPI attribute REST attribute Comment

litigation-name

name

path

path

volume

volume.name

Can also use volume.uuid

GET /api/storage/snaplock/litigations/{litigation.id}/files

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

ONTAPI attribute REST attribute Comment

litigation-name

No REST Equivalent

output-directory-path

No REST Equivalent

The REST API call displays the list of files in the console.

output-volume

No REST Equivalent

volume

No REST Equivalent

GET /api/storage/snaplock/litigations

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

ONTAPI attribute REST attribute Comment

output-directory-path

No REST Equivalent

The REST API call displays the list of litigations in the console.

output-volume

No REST Equivalent

volume

No REST Equivalent

POST /api/storage/snaplock/litigations/{litigation.id}/operations

Note: You can use DELETE on the API /api/storage/snaplock/litigations/{id} to end all the litigations for a litigation ID.

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

ONTAPI attribute REST attribute Comment

litigation-name

No REST Equivalent

path

path

volume

No REST Equivalent

GET /api/storage/snaplock/litigations

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

ONTAPI attribute REST attribute Comment

litigation-name

name

num-files-failed

operations.num_files_failed

num-files-processed

operations.num_files_processed

num-files-skipped

operations.num_files_skipped

num-inodes-ignored

operations.num_inodes_ignored

operation-id

operations.id

operation-status

operations.state

operation-type

operations.type

path

path

status-details

No REST Equivalent

volume

volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

snaplock-modify-clock-ntp-sync

Note: The REST API does not support this functionality.

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

snaplock-modify-vserver-log

PATCH /api/storage/snaplock/audit-logs/{svm.uuid}

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

ONTAPI attribute REST attribute Comment

default-retention-period

log_volume.retention_period

max-log-size

log_volume.max_log_size

volume

log_volume.volume.name

snaplock-set-file-retention

PATCH /api/storage/snaplock/file/{volume.uuid}/{path}

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

ONTAPI attribute REST attribute Comment

file

path

retention-time

expiry_time

set-infinite-retention

No REST Equivalent

To set infinite retention time, pass the value of expiry_time as "infinite".

set-unspecified-retention

No REST Equivalent

To set unspecified retention time, pass the value of expiry_time as "unspecified".

snaplock-set-node-compliance-clock

POST /api/storage/snaplock/compliance-clocks

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

ONTAPI attribute REST attribute Comment

node

node.uuid

node.name can also be used.

snaplock-volume-set-privileged-delete

PATCH /api/storage/volumes/{uuid}

Note: Pass the "snaplock.privileged_delete" field as "enabled" in the REST API body.

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

ONTAPI attribute REST attribute Comment

state

No REST Equivalent

volume

uuid

volume-get-snaplock-attrs

GET /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

volume

name

volume-set-snaplock-attrs

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

autocommit-period

snaplock.autocommit_period

default-retention-period

snaplock.retention.default

is-volume-append-mode-enabled

snaplock.append_mode_enabled

maximum-retention-period

snaplock.retention.maximum

minimum-retention-period

snaplock.retention.minimum

volume

uuid