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

volume

Contributors
Suggest changes
PDFs

volume-aggregate-vacate-async

Note: This is a deprecated zapi.

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

volume-autobalance-get

Note: This is a deprecated zapi.

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

volume-autobalance-get-iter

Note: This is a deprecated zapi.

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

volume-autobalance-start

Note: This is a deprecated zapi.

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

volume-autobalance-stop

Note: This is a deprecated zapi.

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

volume-autosize-get

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-autosize-set

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

grow-threshold-percent

autosize.grow_threshold

increment-size

No REST Equivalent

is-enabled

No REST Equivalent

maximum-size

autosize.maximum

minimum-size

autosize.minimum

mode

autosize.mode

reset

No REST Equivalent

shrink-threshold-percent

autosize.shrink_threshold

volume

name

volume-autosize-set-async

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

grow-threshold-percent

autosize.grow_threshold

maximum-size

autosize.maximum

minimum-size

autosize.minimum

mode

autosize.mode

reset

No REST Equivalent

shrink-threshold-percent

autosize.shrink_threshold

volume

name

volume-clone-create

POST /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

caching-policy

No REST Equivalent

comment

comment

force-worm-clone

No REST Equivalent

gid

nas.gid

junction-active

No REST Equivalent

junction-path

nas.path

parent-snapshot

clone.parent_snapshot.name

parent-volume

clone.parent_volume.name

parent-vserver

clone.parent_svm.name

qos-policy-group-name

qos.policy.name

space-reserve

No REST Equivalent

uid

nas.uid

use-snaprestore-license

No REST Equivalent

volume

name

Required attribute

volume-type

type

vserver

svm.name

Required attribute

vserver-dr-protection

No REST Equivalent

volume-clone-get

GET /api/storage/volumes/{uuid}

Note: The URL uses volume instance-uuid

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

ONTAPI attribute REST attribute Comment

aggregate

aggregates.name

block-percentage-complete

No REST Equivalent

blocks-scanned

No REST Equivalent

blocks-updated

No REST Equivalent

dsid

No REST Equivalent

flexclone-used-percent

No REST Equivalent

junction-active

No REST Equivalent

junction-path

No REST Equivalent

msid

No REST Equivalent

parent-snapshot

clone.parent_snapshot.name

There is an added cost to retrieving values for this property

parent-volume

clone.parent_volume.name

There is an added cost to retrieving values for this property

parent-vserver

clone.parent_svm.name

There is an added cost to retrieving values for this property

qos-adaptive-policy-group-name

No REST Equivalent

qos-policy-group-name

qos.policy.name

There is an added cost to retrieving values for this property

size

size

space-guarantee-enabled

guarantee.honored

space-reserve

No REST Equivalent

split-estimate

clone.split_estimate

state

state

used

No REST Equivalent

volume

name

volume-type

type

vserver

svm.name

vserver-dr-protection

No REST Equivalent

volume-clone-get-iter

GET /api/storage/volumes?clone.is_flexclone=true

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

ONTAPI attribute REST attribute Comment

aggregate

aggregates.name

Filter

block-percentage-complete

No REST Equivalent

blocks-scanned

No REST Equivalent

blocks-updated

No REST Equivalent

dsid

No REST Equivalent

flexclone-used-percent

No REST Equivalent

junction-active

No REST Equivalent

junction-path

No REST Equivalent

msid

No REST Equivalent

parent-snapshot

clone.parent_snapshot.name

Filter

parent-volume

clone.parent_volume.name

Filter

parent-vserver

clone.parent_svm.name

Filter

qos-adaptive-policy-group-name

No REST Equivalent

qos-policy-group-name

qos.policy.name

No REST Equivalent

size

size

Filter

space-guarantee-enabled

guarantee.honored

Filter

space-reserve

No REST Equivalent

split-estimate

clone.split_estimate

Filter

state

state

Filter

used

No REST Equivalent

volume

name

Filter

volume-type

type

Filter

vserver

svm.name

Filter

vserver-dr-protection

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-clone-split-estimate

GET /api/storage/volumes?clone.is_flexclone=true&fields=clone

Note: In the REST API, the result is mapped to clone.split_estimate in the response.

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

ONTAPI attribute REST attribute Comment

vserver

svm.name

Filter

flexclone

name

Filter

type

type

Filter

parent-vserver

clone.parent_svm.name

Filter

parent-volume

clone.parent_volume.name

Filter

state

state

Filter

junction-path

nas.path

Filter

junction-active

No REST Equivalent

space-guarantee

guarantee.type

Filter

aggregate

aggregates.name

Filter

dsid

No REST Equivalent

msid

No REST Equivalent

size

size

Filter

used

space.logical_space.used

Filter

split-estimate

clone.split_estimate

Filter

blocks-scanned

No REST Equivalent

blocks-updated

No REST Equivalent

comment

comment

Filter

qos-policy-group

qos.policy.name

Filter

qos-adaptive-policy-group

qos.policy.name

Filter

caching-policy

No REST Equivalent

junctionFileHandle

No REST Equivalent

parent-msid

No REST Equivalent

parent-snapshot-uuid

clone.parent_snapshot.uuid

Filter

parent-vol-type

No REST Equivalent

language

language

Filter

export-policy

nas.export_policy.name

Filter

snapshot-policy

No REST Equivalent

security-style

nas.security_style

Filter

flexclone-used-percent

space.percent_used

Filter

vserver-dr-protection

No REST Equivalent

block-percentage-complete

No REST Equivalent

uid

uuid

Filter

gid

nas.gid

Filter

is-constituent

is_constituent

Filter

is-flexgroup

No REST Equivalent

volume-style-extended

style

Filter

workflow

No REST Equivalent

volume-clone-split-start

PATCH /api/storage/volumes/{uuid}

Note: Set the "clone.split_initiated" field to "true" to start the volume clone split operation. The URL uses volume instance-uuid.

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

ONTAPI attribute REST attribute Comment

vserver

No REST Equivalent

flexclone

No REST Equivalent

foreground

No REST Equivalent

match-parent-storage-tier

clone.match_parent_storage_tier

volume-clone-split-status

GET /api/storage/volumes?clone.is_flexclone=true&fields=clone

Note: In the REST API, the result is mapped to clone.split_complete_percent in the response.

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

ONTAPI attribute REST attribute Comment

vserver

svm.name

Filter

flexclone

name

Filter

block-percentage-complete

No REST Equivalent

blocks-scanned

No REST Equivalent

blocks-updated

No REST Equivalent

volume-clone-split-stop

PATCH /api/storage/volumes/{uuid}

Note: Set the "clone.split_initiated" field to "false" to stop the volume clone split operation. The URL uses volume instance-uuid.

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

ONTAPI attribute REST attribute Comment

vserver

No REST Equivalent

flexclone

No REST Equivalent

volume-container

GET /api/storage/volumes/{uuid}

Note: The response from this REST API call will contain information about the aggregate.

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

ONTAPI attribute REST attribute Comment

volume

name

volume-create

POST /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

antivirus-on-access-policy

No REST Equivalent

cache-retention-priority

No REST Equivalent

caching-policy

No REST Equivalent

cloud-retrieval-policy

cloud_retrieval_policy

constituent-role

No REST Equivalent

containing-aggr-name

aggregates.name

disk-count

No REST Equivalent

disk-size

No REST Equivalent

disk-size-with-unit

No REST Equivalent

disks

No REST Equivalent

efficiency-policy

efficiency.policy.name

application-io-size

efficiency.application_io_size

encrypt

encryption.enabled

anti-ransomware-state

anti_ransomware.state

excluded-from-autobalance

No REST Equivalent

export-policy

nas.export_policy.name

extent-size

No REST Equivalent

flexcache-cache-policy

No REST Equivalent

flexcache-fill-policy

No REST Equivalent

flexcache-origin-volume-name

No REST Equivalent

force

No REST Equivalent

group-id

nas.gid

is-junction-active

No REST Equivalent

is-mirrored

No REST Equivalent

is-nvfail-enabled

No REST Equivalent

is-snaplock

No REST Equivalent

is-space-enforcement-logical

space.logical_space.enforcement

is-space-reporting-logical

space.logical_space.reporting

is-vserver-root

is_svm_root

junction-path

nas.path

language-code

language

max-dir-size

No REST Equivalent

max-write-alloc-blocks

No REST Equivalent

mirror-disks

No REST Equivalent

percentage-snapshot-reserve

space.snapshot.reserve_percent

qos-adaptive-policy-group-name

qos.policy.name

qos-policy-group-name

qos.policy.name

raid-size

No REST Equivalent

remote-location

No REST Equivalent

size

size

snaplock-type

snaplock.type

snapshot-policy

snapshot_policy.name

space-reserve

guarantee.type

space-slo

No REST Equivalent

storage-service

No REST Equivalent

stripe-algorithm

No REST Equivalent

stripe-concurrency

No REST Equivalent

stripe-constituent-volume-count

No REST Equivalent

stripe-optimize

No REST Equivalent

stripe-width

No REST Equivalent

tiering-minimum-cooling-days

tiering.min_cooling_days

tiering-policy

tiering.policy

unix-permissions

nas.unix_permissions

user-id

nas.uid

vm-align-sector

No REST Equivalent

vm-align-suffix

No REST Equivalent

volume

name

volume-comment

comment

volume-raid-type

No REST Equivalent

volume-security-style

nas.security_style

volume-state

state

volume-type

type

vserver-dr-protection

No REST Equivalent

volume-create-async

POST /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

aggr-list

aggregates.name

aggr-list-multiplier

No REST Equivalent

auto-provision-as

No REST Equivalent

cache-retention-priority

No REST Equivalent

caching-policy

No REST Equivalent

cloud-retrieval-policy

cloud_retrieval_policy

containing-aggr-name

aggregates.name

data-aggr-list

No REST Equivalent

efficiency-policy

efficiency.policy.name

application-io-size

efficiency.application_io_size

enable-object-store

No REST Equivalent

enable-snapdiff

No REST Equivalent

encrypt

encryption.enabled

encryption-type

encryption.type

anti-ransomware-state

anti_ransomware.state

excluded-from-autobalance

No REST Equivalent

export-policy

nas.export_policy.name

flexcache-cache-policy

No REST Equivalent

flexcache-fill-policy

No REST Equivalent

flexcache-origin-volume-name

No REST Equivalent

group-id

nas.gid

is-junction-active

No REST Equivalent

is-managed-by-service

No REST Equivalent

is-nvfail-enabled

No REST Equivalent

is-space-enforcement-logical

space.logical_space.enforcement

is-space-reporting-logical

space.logical_space.reporting

is-vserver-root

is_svm_root

junction-path

nas.path

language-code

language

max-constituent-size

No REST Equivalent

max-data-constituent-size

No REST Equivalent

max-dir-size

No REST Equivalent

max-namespace-constituent-size

No REST Equivalent

namespace-aggregate

No REST Equivalent

namespace-mirror-aggr-list

No REST Equivalent

nodes

No REST Equivalent

object-write-sync-period

No REST Equivalent

ols-aggr-list

No REST Equivalent

ols-constituent-count

No REST Equivalent

ols-constituent-size

No REST Equivalent

percentage-snapshot-reserve

space.snapshot.reserve_percent

qos-adaptive-policy-group-name

qos.policy.name

qos-policy-group-name

qos.policy.name

size

size

snapshot-policy

snapshot_policy.name

space-guarantee

guarantee.type

space-reserve

guarantee.type

space-slo

No REST Equivalent

storage-service

No REST Equivalent

support-tiering

tiering.supported

tiering-minimum-cooling-days

tiering.min_cooling_days

tiering-policy

tiering.policy

unix-permissions

nas.unix_permissions

use-mirrored-aggregates

No REST Equivalent

user-id

nas.uid

vm-align-sector

No REST Equivalent

vm-align-suffix

No REST Equivalent

volume-comment

comment

volume-name

name

volume-security-style

nas.security_style

volume-state

state

volume-type

type

vserver-dr-protection

No REST Equivalent

volume-destroy

DELETE /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

name

name

unmount-and-offline

No REST Equivalent

volume-destroy-async

DELETE /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

unmount-and-offline

No REST Equivalent

volume-name

name

volume-encryption-conversion-get-iter

GET /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

percentage-completed

encryption.status.message

start-time

No REST Equivalent

status

encryption.status.message

volume

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-encryption-conversion-pause

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

volume-encryption-conversion-resume

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

volume-encryption-conversion-start

PATCH /api/storage/volumes/{uuid}

Note: Set the "encryption.enabled" field to "true" to start the encryption conversion operation.

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

ONTAPI attribute REST attribute Comment

volume

No REST Equivalent

volume-encryption-rekey-get-iter

GET /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

percentage-completed

encryption.status.message

start-time

No REST Equivalent

status

encryption.status.message

volume

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-encryption-rekey-pause

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

volume-encryption-rekey-resume

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

volume-encryption-rekey-start

PATCH /api/storage/volumes/{uuid}

Note: Set the "encryption.rekey" field to "true" to start the encryption rekey operation.

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

ONTAPI attribute REST attribute Comment

volume

No REST Equivalent

volume-expand-async

PATCH /api/storage/volumes/{uuid}

Note: For you to modify the size of the FlexGroup, the sizing_method query parameter must be set to "add_new_resources".

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

ONTAPI attribute REST attribute Comment

aggr-list

aggregates.name

aggr-list-multiplier

No REST Equivalent

aggr-list-multiplier → constituents_per_aggregate

volume-name

name

volume-flexgroup-capacity-tier-footprint-get-iter

GET /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

volume-capacity-tier-footprint

space.capacity_tier_footprint

volume-name

name

vserver-name

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-flexgroup-deploy-async

POST /api/storage/volumes

Note: Specify the "style" field as "flexgroup" to create a FlexGroup volume that automatically provisions aggregates if there are no specified aggregates. If you do not specify "style", the volume type is determined based on the specified aggregates. Specifying multiple aggregates, or a single aggregate with "constituents_per_aggregate", creates a FlexGroup.

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

ONTAPI attribute REST attribute Comment

size

size

space-reserve

guarantee.type

volume-name

name

volume-type

type

vserver

svm.name

volume-flexgroup-deploy-simulate-aggr-layout

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

volume-flexgroup-get-create-limits

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

volume-flexgroup-get-expand-limits

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

volume-flexgroup-get-resize-limits

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

volume-footprint-get-iter

GET /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

dedupe-metafiles-footprint

space.dedupe_metafiles_footprint

dedupe-metafiles-footprint-percent

No REST Equivalent

dedupe-metafiles-temporary-footprint

space.dedupe_metafiles_temporary_footprint

dedupe-metafiles-temporary-footprint-percent

No REST Equivalent

delayed-free-footprint

space.delayed_free_footprint

delayed-free-footprint-percent

No REST Equivalent

file-operation-metadata

space.file_operation_metadata

file-operation-metadata-percent

No REST Equivalent

flexvol-metadata-footprint

space.metadata

flexvol-metadata-footprint-percent

No REST Equivalent

snapmirror-destination-footprint

space.snapmirror_destination_footprint

snapmirror-destination-footprint-percent

No REST Equivalent

tape-backup-metafiles-footprint

No REST Equivalent

tape-backup-metafiles-footprint-percent

No REST Equivalent

total-footprint

space.total_footprint

total-footprint-percent

No REST Equivalent

volume

name

volume-blocks-footprint

space.footprint

volume-blocks-footprint-bin0

space.performance_tier_footprint

volume-blocks-footprint-bin0-percent

No REST Equivalent

volume-blocks-footprint-bin1

space.capacity_tier_footprint

volume-blocks-footprint-bin1-percent

No REST Equivalent

volume-blocks-footprint-percent

No REST Equivalent

volume-guarantee-footprint

space.volume_guarantee_footprint

volume-guarantee-footprint-percent

No REST Equivalent

cross-volume-dedupe-metafiles-footprint

space.cross_volume_dedupe_metafiles_footprint

cross-volume-dedupe-metafiles-temporary-footprint

space.cross_volume_dedupe_metafiles_temporary_footprint

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-get-iter

GET /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

encrypt

encryption.enabled

encryption-state

encryption.state

encryption-type

encryption.type

key-id

encryption.key_id

anti-ransomware-state

anti_ransomware.state

volume-antivirus-attributes

No REST Equivalent

volume-autobalance-attributes

No REST Equivalent

volume-autosize-attributes

autosize

grow-threshold-percent → autosize.grow_threshold
is-enabled → autosize.mode
is-enabled is deduced from autosize.mode value. is-enabled is "false" if the autosize.mode is "off", otherwise "true".
reset → NA
maximum-size → autosize.maximum
minimum-size → autosize.minimum
mode → autosize.mode
shrink-threshold-percent → autosize.shrink_threshold

volume-clone-attributes

clone

clone-child-count → NA
The following attributes are from volume-clone-parent-attributes.
dsid → NA
msid → NA
volume-name → clone.parent_volume.name
uuid → clone.parent_volume.uuid
vserver-name → clone.parent_svm.name
snapshot-name → clone.parent_snapshot.name
snapshot-id → NA
name → clone.parent_volume.name

volume-comp-aggr-attributes

tiering

cloud-retrieval-policy → cloud_retrieval_policy
tiering-minimum-cooling-days → tiering.min_cooling_days
tiering-policy → tiering.policy
tiering-object-tags → tiering.object_tags
needs-object-retagging → NA

volume-directory-attributes

No REST Equivalent

volume-export-attributes

nas.export_policy.name

volume-flexcache-attributes

See comment column for details

cache-policy → NA
fill-policy → NA
min-reserve → NA
The following flexcache attributes are mapped to flexcache. The respective URL is api/storage/flexcache/flexcaches/{uuid}.
origin → origins.volume.name

volume-hybrid-cache-attributes

See comment column for details

caching-policy → flash_pool.caching_policy
cache-retention-priority → flash_pool.cache_retention_priority
hybrid-cache-eligibility → flash_pool.cache_eligibility

volume-id-attributes

See comment column for details

comment → comment
containing-aggregate-name → aggregates.name
containing-aggregate-uuid → aggregates.uuid
node → NA
aggr-list → aggregates.name
nodes → NA
creation-time → create_time
dsid → NA
fsid → NA
instance-uuid → uuid (Only for FlexVols)
junction-parent-name → nas.junction_parent.name
junction-parent-uuid → nas.junction_parent.uuid
junction-path → nas.path
msid → msid
name → name
name-ordinal → NA
owning-vserver-name → svm.name
owning-vserver-uuid → svm.uuid
provenance-uuid → NA
style → NA
style is deprecated, style can deduced from style-extended attribute
style-extended → style
type → type
uuid → NA
flexcache-endpoint-type → flexcache_endpoint_type
flexgroup-msid → NA
flexgroup-index → NA
flexgroup-uuid → uuid (Only for FlexGroup volumes)
flexgroup-uuid → flexgroup.uuid (Only for FlexGroup constituents)
flexgroup-name → flexgroup.name (Only for FlexGroup constituents)
application → application.name
application-uuid → application.uuid
extent-size → NA
qos-policy-group-name → qos.policy.name

volume-infinitevol-attributes

No REST Equivalent

volume-inode-attributes

files

files-total → files.maximum
files-used → files.used
block-type → NA
files-private-used → NA
inofile-version → NA
inodefile-private-capacity → NA
inodefile-public-capacity → NA

volume-language-attributes

language

is-convert-ucode-enabled → NA
is-create-ucode-enabled → NA
language → NA
language-code → language
nfs-character-set → NA
oem-character-set → NA

volume-mirror-attributes

No REST Equivalent

volume-performance-attributes

No REST Equivalent

volume-qos-attributes

qos

policy-group-name → qos.policy.name
adaptive-policy-group-name → qos.policy.name

volume-security-attributes

nas

style → nas.security_style
group-id → nas.gid
permissions → nas.unix_permissions
user-id → nas.uid

volume-sis-attributes

No REST Equivalent

volume-snaplock-attributes

snaplock.type

volume-snapshot-attributes

See comment column for details

auto-snapshots-enabled → NA
snapdir-access-enabled → snapshot_directory_access_enabled
snapshot-clone-dependency-enabled → NA
snapshot-policy → snapshot_policy
snapshot-count → snapshot_count

volume-snapshot-autodelete-attributes

space

is-autodelete-enabled → space.snapshot.autodelete_enabled
commitment → NA
defer-delete → NA
delete-order → NA
destroy-list → NA
prefix → NA
target-free-space → NA
trigger → NA

volume-space-attributes

space

expected-available → space.expected_available
filesystem-size → space.filesystem_size
is-filesys-size-fixed → NA
is-space-enforcement-logical → space.logical_space.enforcement
is-space-reporting-logical → space.logical_space.reporting
is-space-slo-enabled → NA
logical-used → space.logical_space.used
logical-used-by-afs → space.logical_space.used_by_afs
logical-used-by-snapshots → space.logical_space.used_by_snapshots
logical-used-percent → space.logical_space.used_percent
logical-available → space.logical_space.available
over-provisioned → space.over_provisioned
overwrite-reserve → space.overwrite_reserve
overwrite-reserve-required → NA
overwrite-reserve-used → space.overwrite_reserve_used
overwrite-reserve-used-actual → NA
percentage-fractional-reserve → space.fractional_reserve
percentage-size-used → space.percent_used
percentage-snapshot-reserve → space.snapshot.reserve_percent
percentage-snapshot-reserve-used → space.snapshot.space_used_percent
physical-used → space.physical_used
physical-used-percent → space.physical_used_percent
size → space.size
size-available → space.available
size-available-for-snapshots → space.size_available_for_snapshots
size-used-by-snapshots → space.snapshot.used
size-total → space.afs_total
size-used → space.used
snapshot-reserve-available → space.snapshot.reserve_available
snapshot-reserve-size→ space.snapshot.reserve_size
space-full-threshold-percent→ space.full_threshold_percent
space-mgmt-option-try-first→ NA
space-nearly-full-threshold-percent→ space.nearly_full_threshold_percent
space-slo→ NA
is-space-slo-enabled→ NA
space-mgmt-option-try-first→ NA
max-constituent-size→ NA
performance-tier-inactive-user-data→ space.block_storage_inactive_user_data
performance-tier-inactive-user-data-percent→ space.block_storage_inactive_user_data_percent
flexvol-metadata-footprint→ space.metadata
total-footprint→ space.total_footprint
volume-blocks-footprint→ space.footprint
volume-blocks-footprint-bin0→ space.performance_tier_footprint
volume-blocks-footprint-bin1→ space.capacity_tier_footprint
The following ONTAPI space attributes are now members of the REST API guarantee property.
is-space-guarantee-enabled → guarantee.honored
space-guarantee → guarantee.type

volume-state-attributes

See comment column for details

become-node-root-after-reboot → NA
ignore-inconsistent → NA
in-nvfailed-state → NA
is-cluster-volume → NA
is-inconsistent → NA
is-invalid → NA
is-junction-active → NA
is-moving → NA
is-volume-in-cutover → NA
is-node-root → NA
is-nvfail-enabled → NA
is-quiesced-in-memory → NA
is-quiesced-on-disk → NA
is-unrecoverable → NA
is-vserver-root → is_svm_root
is-constituent → constituents
size → constituents.space.size
size-available → constituents.space.available
size-used → constituents.space.used
performance-tier-inactive-user-data→ constituents.space.block_storage_inactive_user_data
volume-blocks-footprint-bin1→ constituents.space.capacity_tier_footprint
volume-blocks-footprint-bin0→ constituents.space.performance_tier_footprint
volume-blocks-footprint→ constituents.space.footprint
over-provisioned → constituents.space.over_provisioned
flexvol-metadata-footprint→ constituents.space.metadata
total-footprint→ constituents.space.total_footprint
is-space-reporting-logical → constituents.space.logical_space.reporting
is-space-enforcement-logical → constituents.space.logical_space.enforcement
logical-used-by-afs → constituents.space.logical_space.used_by_afs
logical-available → constituents.space.logical_space.available
size-used-by-snapshots → constituents.space.snapshot.used
percentage-snapshot-reserve → constituents.space.snapshot.reserve_percent
is-autodelete-enabled → constituents.space.snapshot.autodelete_enabled
containing-aggregate-name → constituents.aggregates.name
containing-aggregate-uuid → constituents.aggregates.uuid
constituent-count → NA
state → state
force-nvfail-on-dr → NA
is-flexgroup → NA
is-flexgroup-qtree-enabled → NA
is-move-destination-in-cutover → NA
is-protocol-access-fenced → NA
protocol-access-fenced-by → NA
status → status

volume-transition-attributes

No REST Equivalent

volume-vm-align-attributes

No REST Equivalent

volume-vserver-dr-protection-attributes

No REST Equivalent

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-get-language

GET /api/storage/volumes/{uuid}

Note: The response from this REST API call will contain information about the language attribute.

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

ONTAPI attribute REST attribute Comment

volume

name

volume-get-root-name

GET /api/storage/volumes/{uuid}

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

There are no attributes defined for this ONTAPI call.

volume-get-volume-path

GET /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

is-style-cifs

No REST Equivalent

volume

name

volume-modify-iter

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

encrypt

encryption.enabled

encryption-state

encryption.state

encryption-type

encryption.type

key-id

encryption.key_id

anti-ransomware-state

anti_ransomware.state

volume-antivirus-attributes

No REST Equivalent

volume-autobalance-attributes

No REST Equivalent

volume-autosize-attributes

autosize

grow-threshold-percent → autosize.grow_threshold
is-enabled → autosize.mode
is-enabled is deduced from autosize.mode value. is-enabled is "false" if the autosize.mode is "off", otherwise "true".
reset → NA
reset → NA
maximum-size → autosize.maximum
minimum-size → autosize.minimum
mode → autosize.mode
shrink-threshold-percent → autosize.shrink_threshold

volume-clone-attributes

clone

clone-child-count → NA
The following attributes are from volume-clone-parent-attributes.
dsid → NA
msid → NA
volume-name → clone.parent_volume.name
uuid → clone.parent_volume.uuid
vserver-name → clone.parent_svm.name
snapshot-name → clone.parent_snapshot.name
snapshot-id → NA

volume-comp-aggr-attributes

tiering

cloud-retrieval-policy → cloud_retrieval_policy
tiering-minimum-cooling-days → tiering.min_cooling_days
tiering-policy → tiering.policy
tiering-object-tags → tiering.object_tags
needs-object-retagging → NA

volume-directory-attributes

No REST Equivalent

volume-export-attributes

nas.export_policy.name

volume-flexcache-attributes

See comment column for details

cache-policy → NA
fill-policy → NA
min-reserve → NA
The following flexcache attributes are mapped to flexcache. The respective URL is /api/storage/flexcache/flexcaches/{uuid}.
origin → origins.volume.name

volume-hybrid-cache-attributes

No REST Equivalent

volume-id-attributes

See comment column for details

comment → comment
containing-aggregate-name → aggregates.name
containing-aggregate-uuid → aggregates.uuid
node → NA
aggr-list → aggregates.name
nodes → NA
creation-time → create_time
dsid → NA
fsid → NA
instance-uuid → uuid (Only for FlexVols)
junction-parent-name → nas.junction_parent.name
junction-parent-uuid → nas.junction_parent.uuid
junction-path → nas.path
msid → msid
name → name
name-ordinal → NA
owning-vserver-name → svm.name
owning-vserver-uuid → svm.uuid
provenance-uuid → NA
style → NA
style-extended → style
type → type
uuid → NA
flexcache-endpoint-type → flexcache_endpoint_type
flexgroup-msid → NA
flexgroup-index → NA
flexgroup-uuid → uuid (Only for FlexGroup volumes)
application → application.name
application-uuid → application.uuid
extent-size → NA

volume-infinitevol-attributes

No REST Equivalent

volume-inode-attributes

files

files-total → files.maximum
files-used → files.used
block-type → NA
files-private-used → NA
inofile-version → NA
inodefile-private-capacity → NA
inodefile-public-capacity → NA

volume-language-attributes

language

is-convert-ucode-enabled → NA
is-create-ucode-enabled → NA
language-str → NA
language-code → language
nfs-character-set → NA
oem-character-set → NA +

volume-mirror-attributes

No REST Equivalent

volume-performance-attributes

No REST Equivalent

volume-qos-attributes

qos

policy-group-name → qos.policy.name
adaptive-policy-group-name → qos.policy.name

volume-security-attributes

nas

style → nas.security_style
group-id → nas.gid
permissions → nas.unix_permissions
user-id → nas.uid

volume-sis-attributes

No REST Equivalent

volume-snaplock-attributes

snaplock.type

volume-snapshot-attributes

See comment column for details

auto-snapshots-enabled → NA
snapdir-access-enabled → NA
snapshot-clone-dependency-enabled → NA
snapshot-policy → snapshot_policy
snapshot-count → NA

volume-snapshot-autodelete-attributes

space

is-autodelete-enabled → space.snapshot.autodelete_enabled
commitment → NA
defer-delete → NA
delete-order → NA
destroy-list → NA
prefix → NA
target-free-space → NA
trigger → NA

volume-space-attributes

space

expected-available → NA
filesystem-size → NA
is-filesys-size-fixed → NA
is-space-enforcement-logical → space.logical_space.enforcement
is-space-reporting-logical → space.logical_space.reporting
is-space-slo-enabled → NA
logical-used → NA
logical-used-by-afs → space.logical_space.used_by_afs
logical-used-by-snapshots → NA
logical-used-percent → NA
logical-available → space.logical_space.available
over-provisioned → space.over_provisioned
overwrite-reserve → NA
overwrite-reserve-required → NA
overwrite-reserve-used → NA
overwrite-reserve-used-actual → NA
percentage-fractional-reserve → NA
percentage-size-used → NA
percentage-snapshot-reserve → space.snapshot.reserve_percent
physical-used → NA
physical-used-percent → NA
size → space.size
size-available → space.available
size-available-for-snapshots → NA
size-used-by-snapshots → size-used-by-snapshots
size-total → NA
size-used → space.used
snapshot-reserve-available → NA
snapshot-reserve-size→ NA
space-full-threshold-percent→ NA
space-mgmt-option-try-first→ NA
space-nearly-full-threshold-percent→ NA
space-slo→ NA
is-space-slo-enabled→ NA
space-mgmt-option-try-first→ NA
space-nearly-full-threshold-percent→ NA
space-full-threshold-percent→ NA
max-constituent-size→ NA
performance-tier-inactive-user-data→ space.block_storage_inactive_user_data
performance-tier-inactive-user-data-percent→ NA
flexvol-metadata-footprint→ space.metadata
total-footprint→ space.total_footprint
volume-blocks-footprint→ space.footprint
volume-blocks-footprint-bin0→ space.performance_tier_footprint
volume-blocks-footprint-bin1→ space.capacity_tier_footprint
The following ONTAPI space attributes are now members of the REST API guarantee property.
is-space-guarantee-enabled → guarantee.honored
space-guarantee → guarantee.type

volume-state-attributes

See comment column for details

become-node-root-after-reboot → NA
ignore-inconsistent → NA
in-nvfailed-state → NA
is-cluster-volume → NA
is-inconsistent → NA
is-invalid → NA
is-junction-active → NA
is-moving → NA
is-volume-in-cutover → NA
is-node-root → NA
is-nvfail-enabled → NA
is-quiesced-in-memory → NA
is-quiesced-on-disk → NA
is-unrecoverable → NA
is-vserver-root → is_svm_root
is-constituent → constituents
size → constituents.space.size
size-available → constituents.space.available
size-used → constituents.space.used
performance-tier-inactive-user-data→ constituents.space.block_storage_inactive_user_data
volume-blocks-footprint-bin1→ constituents.space.capacity_tier_footprint
volume-blocks-footprint-bin0→ constituents.space.performance_tier_footprint
volume-blocks-footprint→ constituents.space.footprint
over-provisioned → constituents.space.over_provisioned
flexvol-metadata-footprint→ constituents.space.metadata
total-footprint→ constituents.space.total_footprint
is-space-reporting-logical → constituents.space.logical_space.reporting
is-space-enforcement-logical → constituents.space.logical_space.enforcement
logical-used-by-afs → constituents.space.logical_space.used_by_afs
logical-available → constituents.space.logical_space.available
size-used-by-snapshots → constituents.space.snapshot.used
percentage-snapshot-reserve → constituents.space.snapshot.reserve_percent
is-autodelete-enabled → constituents.space.snapshot.autodelete_enabled
containing-aggregate-name → constituents.aggregates.name
containing-aggregate-uuid → constituents.aggregates.uuid
constituent-count → NA
state → state
force-nvfail-on-dr → NA
is-flexgroup → NA
is-flexgroup-qtree-enabled → NA
is-move-destination-in-cutover → NA
is-protocol-access-fenced → NA
protocol-access-fenced-by → NA
status → status

volume-transition-attributes

No REST Equivalent

volume-vm-align-attributes

No REST Equivalent

volume-vserver-dr-protection-attributes

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

volume-modify-iter-async

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

encrypt

encryption.enabled

encryption-state

encryption.state

encryption-type

encryption.type

key-id

encryption.key_id

anti-ransomware-state

anti_ransomware.state

volume-antivirus-attributes

No REST Equivalent

volume-autobalance-attributes

No REST Equivalent

volume-autosize-attributes

autosize

grow-threshold-percent → autosize.grow_threshold
is-enabled → autosize.mode
is-enabled is deduced from autosize.mode value. is-enabled is "false" if the autosize.mode is "off", otherwise "true".
reset → NA
reset → NA
maximum-size → autosize.maximum
minimum-size → autosize.minimum
mode → autosize.mode
shrink-threshold-percent → autosize.shrink_threshold

volume-clone-attributes

clone

clone-child-count → NA
The following attributes are from volume-clone-parent-attributes.
dsid → NA
msid → NA
volume-name → clone.parent_volume.name
uuid → clone.parent_volume.uuid
vserver-name → clone.parent_svm.name
snapshot-name → clone.parent_snapshot.name
snapshot-id → NA

volume-comp-aggr-attributes

tiering

cloud-retrieval-policy → cloud_retrieval_policy
tiering-minimum-cooling-days → tiering.min_cooling_days
tiering-policy → tiering.policy
tiering-object-tags → tiering.object_tags
needs-object-retagging → NA

volume-directory-attributes

No REST Equivalent

volume-export-attributes

nas.export_policy.name

volume-flexcache-attributes

See comment column for details

cache-policy → NA
fill-policy → NA
min-reserve → NA
The following flexcache attributes are mapped to flexcache. The respective URL is /api/storage/flexcache/flexcaches/{uuid}.
origin → origins.volume.name

volume-hybrid-cache-attributes

No REST Equivalent

volume-id-attributes

See comment column for details

comment → comment
containing-aggregate-name → aggregates.name
containing-aggregate-uuid → aggregates.uuid
node → NA
aggr-list → aggregates.name
nodes → NA
creation-time → create_time
dsid → NA
fsid → NA
instance-uuid → uuid (Only for FlexVols)
junction-parent-name → nas.junction_parent.name
junction-parent-uuid → nas.junction_parent.uuid
junction-path → nas.path
msid → NA
name → name
name-ordinal → NA
owning-vserver-name → svm.name
owning-vserver-uuid → svm.uuid
provenance-uuid → NA
style → NA
style-extended → style
type → type
uuid → NA
flexcache-endpoint-type → flexcache_endpoint_type
flexgroup-msid → NA
flexgroup-index → NA
flexgroup-uuid → uuid (Only for FlexGroup volumes)
application → application.name
application-uuid → application.uuid
extent-size → NA

volume-infinitevol-attributes

No REST Equivalent

volume-inode-attributes

files

files-total → files.maximum
files-used → files.used
block-type → NA
files-private-used → NA
inofile-version → NA
inodefile-private-capacity → NA
inodefile-public-capacity → NA

volume-language-attributes

language

is-convert-ucode-enabled → NA
is-create-ucode-enabled → NA
language-str → NA
language-code → language
nfs-character-set → NA
oem-character-set → NA

volume-mirror-attributes

No REST Equivalent

volume-performance-attributes

No REST Equivalent

volume-qos-attributes

qos

policy-group-name → qos.policy.name
adaptive-policy-group-name → qos.policy.name

volume-security-attributes

nas

style → nas.security_style
group-id → nas.gid
permissions → nas.unix_permissions
user-id → nas.uid

volume-sis-attributes

No REST Equivalent

volume-snaplock-attributes

snaplock.type

volume-snapshot-attributes

See comment column for details

auto-snapshots-enabled → NA
snapdir-access-enabled → NA
snapshot-clone-dependency-enabled → NA
snapshot-policy → snapshot_policy
snapshot-count → NA

volume-snapshot-autodelete-attributes

space

is-autodelete-enabled → space.snapshot.autodelete_enabled
commitment → NA
defer-delete → NA
delete-order → NA
destroy-list → NA
prefix → NA
target-free-space → NA
trigger → NA

volume-space-attributes

space

expected-available → NA
filesystem-size → NA
is-filesys-size-fixed → NA
is-space-enforcement-logical → space.logical_space.enforcement
is-space-reporting-logical → space.logical_space.reporting
is-space-slo-enabled → NA
logical-used → NA
logical-used-by-afs → space.logical_space.used_by_afs
logical-used-by-snapshots → NA
logical-used-percent → NA
logical-available → space.logical_space.available
over-provisioned → space.over_provisioned
overwrite-reserve → NA
overwrite-reserve-required → NA
overwrite-reserve-used → NA
overwrite-reserve-used-actual → NA
percentage-fractional-reserve → NA
percentage-size-used → NA
percentage-snapshot-reserve → space.snapshot.reserve_percent
physical-used → NA
physical-used-percent → NA
size → space.size
size-available → space.available
size-available-for-snapshots → NA
size-used-by-snapshots → size-used-by-snapshots
size-total → NA
size-used → space.used
snapshot-reserve-available → NA
snapshot-reserve-size→ NA
space-full-threshold-percent→ NA
space-mgmt-option-try-first→ NA
space-nearly-full-threshold-percent→ NA
space-slo→ NA
is-space-slo-enabled→ NA
space-mgmt-option-try-first→ NA
space-nearly-full-threshold-percent→ NA
space-full-threshold-percent→ NA
max-constituent-size→ NA
performance-tier-inactive-user-data→ space.block_storage_inactive_user_data
performance-tier-inactive-user-data-percent→ NA
flexvol-metadata-footprint→ space.metadata
total-footprint→ space.total_footprint
volume-blocks-footprint→ space.footprint
volume-blocks-footprint-bin0→ space.performance_tier_footprint
volume-blocks-footprint-bin1→ space.capacity_tier_footprint
The following ONTAPI space attributes are now members of the REST API guarantee property.
is-space-guarantee-enabled → guarantee.honored
space-guarantee → guarantee.type

volume-state-attributes

See comment column for details

become-node-root-after-reboot → NA
ignore-inconsistent → NA
in-nvfailed-state → NA
is-cluster-volume → NA
is-inconsistent → NA
is-invalid → NA
is-junction-active → NA
is-moving → NA
is-volume-in-cutover → NA
is-node-root → NA
is-nvfail-enabled → NA
is-quiesced-in-memory → NA
is-quiesced-on-disk → NA
is-unrecoverable → NA
is-vserver-root → is_svm_root
is-constituent → constituents
size → constituents.space.size
size-available → constituents.space.available
size-used → constituents.space.used
performance-tier-inactive-user-data→ constituents.space.block_storage_inactive_user_data
volume-blocks-footprint-bin1→ constituents.space.capacity_tier_footprint
volume-blocks-footprint-bin0→ constituents.space.performance_tier_footprint
volume-blocks-footprint→ constituents.space.footprint
over-provisioned → constituents.space.over_provisioned
flexvol-metadata-footprint→ constituents.space.metadata
total-footprint→ constituents.space.total_footprint
is-space-reporting-logical → constituents.space.logical_space.reporting
is-space-enforcement-logical → constituents.space.logical_space.enforcement
logical-used-by-afs → constituents.space.logical_space.used_by_afs
logical-available → constituents.space.logical_space.available
size-used-by-snapshots → constituents.space.snapshot.used
percentage-snapshot-reserve → constituents.space.snapshot.reserve_percent
is-autodelete-enabled → constituents.space.snapshot.autodelete_enabled
containing-aggregate-name → constituents.aggregates.name
containing-aggregate-uuid → constituents.aggregates.uuid
constituent-count → NA
state → state
force-nvfail-on-dr → NA
is-flexgroup → NA
is-flexgroup-qtree-enabled → NA
is-move-destination-in-cutover → NA
is-protocol-access-fenced → NA
protocol-access-fenced-by → NA
status → status

volume-transition-attributes

No REST Equivalent

volume-vm-align-attributes

No REST Equivalent

volume-vserver-dr-protection-attributes

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

volume-mount

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

activate-junction

No REST Equivalent

export-policy-override

No REST Equivalent

junction-path

nas.path

volume-name

name

volume-move-get-iter

GET /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

actual-completion-timestamp

No REST Equivalent

actual-duration

No REST Equivalent

bypass-throttling

No REST Equivalent

bytes-remaining

No REST Equivalent

bytes-sent

No REST Equivalent

completion-code

No REST Equivalent

completion-status

No REST Equivalent

cutover-action

No REST Equivalent

cutover-attempted-count

No REST Equivalent

cutover-attempts

No REST Equivalent

cutover-hard-deferred-count

No REST Equivalent

cutover-trigger-timestamp

No REST Equivalent

cutover-window

movement.cutover_window

cutovers-soft-deferred-count

No REST Equivalent

destination-aggregate

See comment column for details

This ONTAPI attribute requires that the following REST API properties are supplied.
movement.destination_aggregate.name
movement.destination_aggregate.uuid

destination-key-id

No REST Equivalent

destination-node

No REST Equivalent

details

No REST Equivalent

estimated-completion-time

No REST Equivalent

estimated-remaining-duration

No REST Equivalent

execution-progress

No REST Equivalent

internal-state

No REST Equivalent

is-destination-encrypted

No REST Equivalent

is-source-encrypted

No REST Equivalent

job-id

No REST Equivalent

job-uuid

No REST Equivalent

last-cutover-trigger-timestamp

No REST Equivalent

managing-node

No REST Equivalent

moved-by-autobalance

No REST Equivalent

original-job-id

No REST Equivalent

percent-complete

movement.percent_complete

phase

movement.state

prior-issues

No REST Equivalent

replication-throughput

No REST Equivalent

skip-delta-calculation

No REST Equivalent

source-aggregate

See comment column for details

This ONTAPI attribute requires that the following REST API properties are supplied.
aggregates.name
aggregates.uuid

source-key-id

No REST Equivalent

source-node

No REST Equivalent

start-timestamp

movement.start_time

state

movement.state

volume

name

volume-instance-uuid

uuid

vserver

See comment column for details

This ONTAPI attribute requires that the following REST API properties are supplied.
svm.name
svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-move-pause

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can PATCH the "movement.state" property to "paused" to pause the volume move operation in progress.

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

ONTAPI attribute REST attribute Comment

volume

No REST Equivalent

vserver

No REST Equivalent

volume-move-resume

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can PATCH the "movement.state" property to "replicating" to resume the paused volume move operation.

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

ONTAPI attribute REST attribute Comment

volume

No REST Equivalent

vserver

No REST Equivalent

volume-move-start

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, to start the volume move operation, PATCH the volume endpoint with the "movement" sub-object.

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

ONTAPI attribute REST attribute Comment

allow-mixed-aggr-types

No REST Equivalent

cutover-action

No REST Equivalent

cutover-attempts

No REST Equivalent

cutover-window

movement.cutover_window

dest-aggr

movement.destination_aggregate.name

encrypt-destination

No REST Equivalent

encrypt-with-aggr-key

No REST Equivalent

generate-destination-key

No REST Equivalent

perform-validation-only

validate_only

In the REST API, to perform validation only, set the query "validate_only" to "true".

source-volume

No REST Equivalent

tiering-policy

movement.tiering_policy

vserver

No REST Equivalent

volume-move-target-aggr-get-iter

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

volume-move-trigger-abort

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can PATCH the "movement.state" property to "aborted" to abort the ongoing volume move operation.

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

ONTAPI attribute REST attribute Comment

source-volume

No REST Equivalent

vserver

No REST Equivalent

volume-move-trigger-cutover

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can PATCH the "movement.state" property to "cutover" to trigger cutover.

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

ONTAPI attribute REST attribute Comment

force

No REST Equivalent

source-volume

No REST Equivalent

vserver

No REST Equivalent

volume-offline

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can update the state attribute to "state:offline" to set the volume state to "offline".

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

ONTAPI attribute REST attribute Comment

cifs-delay

No REST Equivalent

name

name

volume-offline-async

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can update the state attribute to "state:offline" to set the volume state to "offline".

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

ONTAPI attribute REST attribute Comment

volume-name

name

volume-online

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can update the state attribute to "state:online" to set the volume state to "online".

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

ONTAPI attribute REST attribute Comment

name

name

volume-online-async

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can update the state attribute to "state:online" to set the volume state to "online".

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

ONTAPI attribute REST attribute Comment

volume-name

name

volume-options-list-info

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

volume-prepare-for-revert

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

volume-recovery-queue-get

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

volume-recovery-queue-get-iter

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

volume-recovery-queue-modify-retention

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

volume-recovery-queue-purge

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

volume-recovery-queue-recover

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

volume-rehost

POST /api/private/cli/volume/rehost

Note: Available through the REST API by using the CLI passthrough.

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

ONTAPI attribute REST attribute Comment

auto-remap-luns

No REST Equivalent

destination-vserver

No REST Equivalent

force-unmap-luns

No REST Equivalent

volume

No REST Equivalent

vserver

No REST Equivalent

volume-rename

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

new-volume-name

name

volume

No REST Equivalent

In PATCH, you can identify the volume by "uuid" in the /api/storage/volumes/{uuid} REST API endpoint

volume-rename-async

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

new-volume-name

name

volume-name

No REST Equivalent

In PATCH, you can identify the volume by "uuid" in the /api/storage/volumes/{uuid} REST API endpoint

volume-restrict

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can update the state attribute to "state:restricted" to set the volume state to "restricted".

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

ONTAPI attribute REST attribute Comment

cifs-delay

No REST Equivalent

name

name

volume-restrict-async

PATCH /api/storage/volumes/{uuid}

Note: In the REST API, you can update the state attribute to "state:restricted" to set the volume state to "restricted".

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

ONTAPI attribute REST attribute Comment

volume-name

name

volume-set-msid

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

volume-set-option

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

volume-set-total-files

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

requested-total-files

files.maximum

volume

name

volume-size

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

new-size

size

volume

name

volume-size-async

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

new-size

size

volume-name

name

volume-space-get-iter

GET /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

dedupe-metafiles

No REST Equivalent

dedupe-metafiles-percent

No REST Equivalent

dedupe-metafiles-temporary

No REST Equivalent

dedupe-metafiles-temporary-percent

No REST Equivalent

filesystem-metadata

No REST Equivalent

filesystem-metadata-percent

No REST Equivalent

inodes

No REST Equivalent

inodes-percent

No REST Equivalent

inodes-upgrade

No REST Equivalent

inodes-upgrade-percent

No REST Equivalent

logical-available

space.logical_space.available

logical-used

space.logical_space.used

logical-used-percent

space.logical_space.used_percent

performance-metadata

No REST Equivalent

performance-metadata-percent

No REST Equivalent

physical-used

No REST Equivalent

physical-used-percent

No REST Equivalent

quota-metafiles

No REST Equivalent

quota-metafiles-percent

No REST Equivalent

snapmirror-metadata

No REST Equivalent

snapmirror-metadata-percent

No REST Equivalent

snapshot-reserve-size

space.snapshot.reserve_size

snapshot-reserve-percent

space.snapshot.reserve_percent

snapshot-reserve-unusable

space.snapshot_reserve_unusable

snapshot-reserve-unusable-percent

No REST Equivalent

snapshot-spill

space.snapshot_spill

snapshot-spill-percent

No REST Equivalent

tape-backup-metadata

No REST Equivalent

tape-backup-metadata-percent

No REST Equivalent

total-used

space.used

total-used-percent

No REST Equivalent

user-data

space.user_data

user-data-percent

No REST Equivalent

volume

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

volume-storage-service-get-iter

Note: This is a deprecated zapi.

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

volume-storage-service-rename

Note: This is a deprecated zapi.

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

volume-tiering-policies-list

GET /api/storage/volumes/{uuid}

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

There are no attributes defined for this ONTAPI call.

volume-transition-check

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

volume-transition-prepare-to-downgrade

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

volume-transition-protect

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

volume-unmount

PATCH /api/storage/volumes/{uuid}

Note: "nas.path" is an empty path in the REST API PATCH method which deactivates and unmounts the volume.

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

ONTAPI attribute REST attribute Comment

force

No REST Equivalent

volume-name

name

volume-transition

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

volume-clone-create-async

POST /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

vserver

svm.name

volume

name

parent-vserver

clone.parent_svm.name

parent-volume

clone.parent_volume.name

parent-snapshot

clone.parent_snapshot.name

space-reserve

No REST Equivalent

junction-path

No REST Equivalent

junction-active

No REST Equivalent

use-snaprestore-license

No REST Equivalent

vserver-dr-protection

No REST Equivalent

uid

nas.uid

gid

nas.gid

volume-get-limits

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

volume-vbncheck

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