file
Suggest changes
PDFs
file-assign-qos
PATCH /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call cannot be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
caching-policy |
No REST Equivalent |
|
file |
path |
|
qos-adaptive-policy-group-name |
qos_policy.name |
|
qos-policy-group-name |
qos_policy.name |
|
volume |
volume.uuid |
|
vserver |
No REST Equivalent |
file-compact-data
This ONTAPI call does not have an equivalent REST API call.
file-copy-destroy
This ONTAPI call does not have an equivalent REST API call.
file-copy-get-iter
This ONTAPI call does not have an equivalent REST API call.
file-copy-start
POST /api/storage/file/copy
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cutover-time |
cutover_time |
|
destination-paths |
files_to_copy.destination.path |
|
hold-quiescence |
hold_quiescence |
|
max-throughput |
max_throughput |
|
reference-cutover-time |
reference_cutover_time |
|
reference-path |
reference_file.path |
|
source-paths |
files_to_copy.source.path |
file-create-directory
POST /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
path |
|
perm |
unix_permissions |
file-create-symlink
POST /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
path |
|
symlink |
target |
file-delete-directory
DELETE /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
path |
file-delete-file
DELETE /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-clone-file |
No REST Equivalent |
|
path |
path |
file-fingerprint-abort
DELETE /api/storage/snaplock/file-fingerprints/{id}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
session-id |
id |
file-fingerprint-dump
GET /api/storage/snaplock/file-fingerprints/{id}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
aggregate-uuid |
No REST Equivalent |
|
file-metadata |
metadata_fingerprint |
|
filer-id |
No REST Equivalent |
|
filer-name |
No REST Equivalent |
|
fingerprint-algorithm |
algorithm |
|
fingerprint-end-time |
No REST Equivalent |
|
fingerprint-input-path |
path |
|
fingerprint-scope |
scope |
|
fingerprint-start-time |
No REST Equivalent |
|
fingerprint-version |
No REST Equivalent |
|
formatted-fingerprint-end-time |
No REST Equivalent |
|
formatted-fingerprint-start-time |
No REST Equivalent |
|
formatted-snaplock-system-compliance-clock |
No REST Equivalent |
|
formatted-snaplock-volume-compliance-clock |
No REST Equivalent |
|
formatted-volume-expiry-date |
No REST Equivalent |
|
is-volume-expiry-date-wraparound |
No REST Equivalent |
|
session-id |
id |
|
snaplock-license |
No REST Equivalent |
|
snaplock-system-compliance-clock |
No REST Equivalent |
|
snaplock-volume-compliance-clock |
No REST Equivalent |
|
volume-containing-aggregate |
No REST Equivalent |
|
volume-dsid |
No REST Equivalent |
|
volume-expiry-date |
No REST Equivalent |
|
volume-msid |
No REST Equivalent |
|
volume-name |
volume.name |
|
volume-snaplock-type |
No REST Equivalent |
|
vserver-id |
svm.uuid |
|
vserver-name |
svm.name |
|
session-id |
id |
file-fingerprint-get-iter
GET /api/storage/snaplock/file-fingerprints
Note: In the REST API, you must pass svm.uuid and volume.uuid in the query.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
file |
No REST Equivalent |
|
operation-status |
No REST Equivalent |
|
progress-percentage |
No REST Equivalent |
|
session-id |
id |
|
volume |
volume.name |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
file-fingerprint-start
POST /api/storage/snaplock/file-fingerprints
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
algorithm |
algorithm |
|
file |
path |
|
scope |
scope |
file-get-file-info
GET /api/storage/volumes/{volume.uuid}/files/{path}?return_metadata=true
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
path |
Relative path of a file or directory in the volume. The path field requires using "%2E" to represent "." and "%2F" to represent "/" for the path provided in REST. |
file-get-space-reservation-info
GET /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
path |
|
volume-id |
volume.uuid |
|
is-fill-enabled |
fill_enabled |
|
is-overwrite-enabled |
overwrite_enabled |
file-hole-range-query-iter
This ONTAPI call does not have an equivalent REST API call.
file-inode-info-get-iter
This ONTAPI call does not have an equivalent REST API call.
file-list-directory-iter
GET /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
accessed-timestamp |
accessed_time |
|
acl-type |
No REST Equivalent |
|
bytes-used |
bytes_used |
|
changed-timestamp |
changed_time |
|
creation-timestamp |
creation_time |
|
dsid |
No REST Equivalent |
|
file-size |
size |
|
file-type |
type |
|
group-id |
group_id |
|
hard-links-count |
hard_links_count |
|
inode-gen-number |
inode_generation |
|
inode-number |
inode_number |
|
is-empty |
is_empty |
|
is-junction |
is_junction |
|
is-snapshot |
is_snapshot |
|
is-vm-aligned |
is_vm_aligned |
|
modified-timestamp |
modified_time |
|
msid |
No REST Equivalent |
|
name |
name |
|
owner-id |
owner_id |
|
perm |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
path |
path |
file-move-destroy
This ONTAPI call does not have an equivalent REST API call.
file-move-get-iter
GET /api/storage/file/moves
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
destination-file-generation-id |
No REST Equivalent |
|
destination-file-path |
destination.path |
|
destination-fileid |
No REST Equivalent |
|
destination-path |
No REST Equivalent |
|
destination-volume-dsid |
No REST Equivalent |
|
file-index |
index |
|
is-destination-ready |
is_destination_ready |
|
is-scanner-paused |
No REST Equivalent |
|
is-snapshot-fenced |
is_snapshot_fenced |
|
job-uuid |
uuid |
|
last-failure-code |
failure |
|
last-failure-reason |
failure |
|
node |
node.name |
|
scanner-progress-bytes |
scanner.progress |
|
scanner-progress-percentage |
scanner.percent |
|
scanner-status |
scanner.state |
|
scanner-total-size |
scanner.total |
|
source-file-generation-id |
No REST Equivalent |
|
source-file-path |
source.path |
|
source-fileid |
No REST Equivalent |
|
source-volume-dsid |
No REST Equivalent |
|
source-volume-msid |
No REST Equivalent |
|
source-vserver |
source.svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
file-move-start
POST /api/storage/file/moves
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cutover-time |
max_cutover_time |
|
destination-paths |
files_to_move.destinations.path |
|
max-throughput |
max_throughput |
|
reference-cutover-time |
reference.max_cutover_time |
|
reference-path |
reference.path |
|
source-paths |
files_to_move.sources.path |
file-punch-hole-iter
This ONTAPI call does not have an equivalent REST API call.
file-read-file
GET /api/storage/volumes/{volume.uuid}/files/{path}
Note: You MUST include \{ "Accept" : "multipart/form-data" \} in the header. The contents of the file will be stored in the variable "response_files" in the return object.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
length |
No REST Equivalent |
|
offset |
byte_offset |
|
path |
path |
|
stream-name |
stream_name |
file-read-symlink
GET /api/storage/volumes/{volume.uuid}/files/{path}?return_metadata=true
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
path |
file-rename-file
PATCH /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
from-path |
path |
This is the path in path parameter. |
to-path |
path |
This is the path in request body parameter. |
file-set-space-reservation-info
PATCH /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
is-fill-enabled |
fill_enabled |
|
is-overwrite-enabled |
overwrite_enabled |
|
path |
path |
|
volume-id |
volume.uuid |
file-truncate-file
PATCH /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
path |
path |
|
size |
size |
file-usage-get
GET /api/storage/volumes/{volume.uuid}/files/{path}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
length |
No REST Equivalent |
|
path |
path |
|
start-offset |
byte_offset |
file-usage-result-get
Note: The REST API endpoint does not exist for this ONTAPI
This ONTAPI call does not have an equivalent REST API call.
file-usage-start
Note: The REST API endpoint does not exist for this ONTAPI
This ONTAPI call does not have an equivalent REST API call.
file-write-file
PATCH /api/storage/volumes/{volume.uuid}/files/{path}
Note: You MUST include \{ "Accept" : "multipart/form-data" \} in the header.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
data |
data |
|
offset |
byte_offset |
|
overwrite |
overwrite |
|
path |
path |
|
stream-name |
stream_name |