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

sis

Contributors
Suggest changes
PDFs

sis-check

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

sis-disable

PATCH /api/storage/volumes/{uuid}

Note: Setting all efficiencies to "none" disables the sis operation.

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

ONTAPI attribute REST attribute Comment

path

No REST Equivalent

API uses volume.uuid from URL

sis-disable-async

PATCH /api/storage/volumes/{uuid}

Note: Setting all efficiencies to "none" for the FlexGroup parent volume disables the sis operation.

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

ONTAPI attribute REST attribute Comment

volume-name

No REST Equivalent

The REST API uses volume.uuid from the URL.

sis-enable

PATCH /api/storage/volumes/{uuid}

Note: Setting any efficiency enables the sis operation.

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

ONTAPI attribute REST attribute Comment

path

No REST Equivalent

The REST API uses volume.uuid from the URL.

sis-enable-async

PATCH /api/storage/volumes/{uuid}

Note: Setting any efficiency for the FlexGroup parent volume enables the sis operation.

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

ONTAPI attribute REST attribute Comment

volume-name

No REST Equivalent

API uses volume.uuid from URL

sis-get

GET /api/storage/volumes/{uuid}

Note: There are two types of efficiencies: inline and background. This is mapped in the REST API to enum inline, background, both, mixed (for FlexGroup), and none.

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

ONTAPI attribute REST attribute Comment

application-io-size

No REST Equivalent

blocks-skipped-sharing

No REST Equivalent

changelog-size

No REST Equivalent

changelog-used-percent

No REST Equivalent

checkpoint-op-type

No REST Equivalent

checkpoint-progress

No REST Equivalent

checkpoint-stage

No REST Equivalent

checkpoint-sub-stage

No REST Equivalent

checkpoint-time

No REST Equivalent

compression-algorithm

No REST Equivalent

compression-changelog-size

No REST Equivalent

compression-type

No REST Equivalent

has-extended-compressed-data

No REST Equivalent

is-compression-enabled

efficiency.compression

In the REST API, if efficiency.compression is "background" or "both", then is-compression-enabled is "true". If efficiency.compression is "none", then is-compression-enabled is "false".

is-constituent

No REST Equivalent

is-content-available

No REST Equivalent

is-cross-volume-background-dedupe-enabled

efficiency.cross_volume_dedupe

In the REST API, if efficiency.cross_volume_dedupe is "background" or "both", then is-cross-volume-background-dedupe-enabled is "true".
If efficiency.cross_volume_dedupe is "none", then is-cross-volume-background-dedupe-enabled is "false".

is-cross-volume-inline-dedupe-enabled

efficiency.cross_volume_dedupe

In the REST API, if efficiency.cross_volume_dedupe is "inline" or "both", then is-cross-volume-inline-dedupe-enabled is "true".
If efficiency.cross_volume_dedupe is "none", then is-cross-volume-inline-dedupe-enabled is "false".

is-data-compaction-enabled

efficiency.compaction

In the REST API, if efficiency.compaction is "inline", then is-data-compaction-enabled is "true".
If efficiency.compaction is "none", then is-data-compaction-enabled is "false".

is-idd-enabled

No REST Equivalent

is-inline-compression-enabled

efficiency.compression

In the REST API, if efficiency.compression is "inline" or "both", then is-inline-compression-enabled is "true".
If efficiency.compression is "none", then is-inline-compression-enabled is "false".

is-inline-dedupe-enabled

efficiency.dedupe

In the REST API, if efficiency.dedupe is "inline" or "both", then is-inline-dedupe-enabled is "true".
If efficiency.dedupe is "none", then is-inline-dedupe-enabled is "false".

last-op-begin-timestamp

efficiency.last_op_begin

last-op-begin-timestamp in ZAPI is mapped to efficiency.last_op_begin in REST for better readability.

last-op-end-timestamp

efficiency.last_op_end

last-op-end-timestamp in ZAPI is mapped to efficiency.last_op_end in REST for better readability.

last-op-error

efficiency.last_op_error

last-op-size

efficiency.last_op_size

last-op-state

efficiency.last_op_state

last-success-op-begin-timestamp

No REST Equivalent

last-success-op-end-timestamp

No REST Equivalent

logical-data-limit

No REST Equivalent

logical-data-size

No REST Equivalent

minimum-blocks-shared

No REST Equivalent

path

efficiency.volume_path

policy

efficiency.policy.name

progress

efficiency.progress

queued-job-type

No REST Equivalent

quick-check-fsize

No REST Equivalent

schedule

efficiency.schedule

stale-fingerprint-percentage

No REST Equivalent

state

efficiency.state

status

efficiency.status

type

efficiency.type

vault-transfer-log-size

No REST Equivalent

vserver

svm.name

path

No REST Equivalent

sis-get-iter

GET /api/storage/volumes

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

ONTAPI attribute REST attribute Comment

application-io-size

No REST Equivalent

blocks-skipped-sharing

No REST Equivalent

changelog-size

No REST Equivalent

changelog-used-percent

No REST Equivalent

checkpoint-op-type

No REST Equivalent

checkpoint-progress

No REST Equivalent

checkpoint-stage

No REST Equivalent

checkpoint-sub-stage

No REST Equivalent

checkpoint-time

No REST Equivalent

compression-algorithm

No REST Equivalent

compression-changelog-size

No REST Equivalent

compression-type

No REST Equivalent

has-extended-compressed-data

No REST Equivalent

is-compression-enabled

efficiency.compression

In the REST API, if efficiency.compression is "background" or "both", then is-compression-enabled is "true".
If efficiency.compression is "none", then is-compression-enabled is "false".

is-constituent

No REST Equivalent

is-content-available

No REST Equivalent

is-cross-volume-background-dedupe-enabled

efficiency.cross_volume_dedupe

In the REST API, if efficiency.cross_volume_dedupe is "background" or "both", then is-cross-volume-background-dedupe-enabled is "true".
If efficiency.cross_volume_dedupe is "none" then is-cross-volume-background-dedupe-enabled is "false".

is-cross-volume-inline-dedupe-enabled

efficiency.cross_volume_dedupe

In the REST API, if efficiency.cross_volume_dedupe is "inline" or "both", then is-cross-volume-inline-dedupe-enabled is "true".
If efficiency.cross_volume_dedupe is "none", then is-cross-volume-inline-dedupe-enabled is "false".

is-data-compaction-enabled

efficiency.compaction

In the REST API, if efficiency.compaction is "inline", then is-data-compaction-enabled is "true".
If efficiency.compaction is "none", then is-data-compaction-enabled is "false".

is-idd-enabled

No REST Equivalent

is-inline-compression-enabled

efficiency.compression

In the REST API, if efficiency.compression is "inline" or "both", then is-inline-compression-enabled is "true".
If efficiency.compression is "none", then is-inline-compression-enabled is "false".

is-inline-dedupe-enabled

efficiency.dedupe

In the REST API, if efficiency.dedupe is "inline" or "both", then is-inline-dedupe-enabled is "true".
If efficiency.dedupe is "none", then is-inline-dedupe-enabled is "false".

last-op-begin-timestamp

efficiency.last_op_begin

last-op-begin-timestamp in ZAPI is mapped to efficiency.last_op_begin in REST for better readability.

last-op-end-timestamp

efficiency.last_op_end_

last-op-end-timestamp in ZAPI is mapped to efficiency.last_op_end in REST for better readability.

last-op-error

efficiency.last_op_error

last-op-size

efficiency.last_op_size

last-op-state

efficiency.last_op_state

last-success-op-begin-timestamp

No REST Equivalent

last-success-op-end-timestamp

No REST Equivalent

logical-data-limit

No REST Equivalent

logical-data-size

No REST Equivalent

minimum-blocks-shared

No REST Equivalent

path

efficiency.volume_path

policy

efficiency.policy.name

progress

efficiency.progress

queued-job-type

No REST Equivalent

quick-check-fsize

No REST Equivalent

schedule

efficiency.schedule

stale-fingerprint-percentage

No REST Equivalent

state

efficiency.state

status

efficiency.status

type

efficiency.type

vault-transfer-log-size

No REST Equivalent

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

sis-policy-create

POST /api/storage/volume-efficiency-policies

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

ONTAPI attribute REST attribute Comment

changelog-threshold-percent

start_threshold_percent

comment

comment

duration

duration

enabled

enabled

policy-name

name

policy-type

type

qos-policy

qos_policy

schedule

schedule

sis-policy-delete

DELETE /api/storage/volume-efficiency-policies/{uuid}

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

ONTAPI attribute REST attribute Comment

policy-name

No REST Equivalent

The REST API uses volume_efficiency_policy.uuid from the URL.

sis-policy-get

GET /api/storage/volume-efficiency-policies/{uuid}

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

ONTAPI attribute REST attribute Comment

changelog-threshold-percent

start_threshold_percent

comment

comment

duration

duration

enabled

enabled

policy-name

name

policy-owner

No REST Equivalent

policy-type

type

qos-policy

qos_policy

schedule

schedule

vserver

svm.name

sis-policy-get-iter

GET /api/storage/volume-efficiency-policies

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

ONTAPI attribute REST attribute Comment

changelog-threshold-percent

start_threshold_percent

comment

comment

duration

duration

enabled

enabled

policy-name

name

policy-owner

No REST Equivalent

policy-type

type

qos-policy

qos_policy

schedule

schedule

vserver

svm.name

Can also use svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

sis-policy-modify

PATCH /api/storage/volume-efficiency-policies/{uuid}

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

ONTAPI attribute REST attribute Comment

changelog-threshold-percent

start_threshold_percent

comment

comment

duration

duration

enabled

enabled

policy-name

name

policy-type

type

qos-policy

qos_policy

schedule

schedule

sis-prepare-to-downgrade

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

sis-promote

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

sis-revert-to

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

sis-set-config

PATCH /api/storage/volumes/{uuid}

Note: There are two type of efficiencies: inline and background. This is mapped to enum inline, background, both, mixed (for FlexGroup) and none in the REST API.

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

ONTAPI attribute REST attribute Comment

application-io-size

No REST Equivalent

compression-algorithm

No REST Equivalent

compression-type

No REST Equivalent

enable-compression

efficiency.compression

In the REST API, if you need to enable enable-compression (background), then \{efficiency.compression:background\} is the equivalent option.
If you use \{efficiency.compression:both\}, it will enable background and inline compression.

enable-cross-volume-background-dedupe

efficiency.cross_volume_dedupe

In the REST API, if you need to enable enable-cross-volume-background-dedupe, then \{efficiency.cross_volume_dedupe:background\} is the equivalent option.
If you use \{efficiency.cross_volume_dedupe:both\}, it will enable background and inline cross volume dedupe.

enable-cross-volume-inline-dedupe

efficiency.cross_volume_dedupe

In the REST API, if you need to enable enable-cross-volume-inline-dedupe, then \{efficiency.cross_volume_dedupe:inline\} is the equivalent option.
If you use \{efficiency.cross_volume_dedupe:both\}, it will enable background and inline cross volume dedupe.

enable-data-compaction

efficiency.compaction

In the REST API, if you need to enable enable-data-compaction, then \{efficiency.compaction:inline\} is the equivalent option.

enable-idd

No REST Equivalent

enable-inline-compression

efficiency.compression

In the REST API, if you need to enable enable-inline-compression, then \{efficiency.compression:inline\} is the equivalent option.
If you use \{efficiency.compression:both\}, it will enable background and inline compression.

enable-inline-dedupe

efficiency.dedupe

In the REST API, if you need to enable enable-inline-dedupe, then \{efficiency.dedupe:inline\} is the equivalent option
If you use \{efficiency.dedupe:both\}, t it will enable background and inline dedupe.

path

No REST Equivalent

policy-name

efficiency.policy.name

storage-efficiency-mode

efficiency.storage_efficiency_mode

quick-check-fsize

No REST Equivalent

schedule

efficiency.schedule

sis-set-config-async

PATCH /api/storage/volumes/{uuid}

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

ONTAPI attribute REST attribute Comment

application-io-size

No REST Equivalent

compression-algorithm

No REST Equivalent

compression-type

No REST Equivalent

enable-compression

efficiency.compression

In the REST API, if you need to enable enable-compression (background), then \{efficiency.compression:background\} is the equivalent option.
If you use \{efficiency.compression:both\}, it will enable background and inline compression.

enable-cross-volume-background-dedupe

efficiency.cross_volume_dedupe

In the REST API, if you need to enable enable-cross-volume-background-dedupe, then \{efficiency.cross_volume_dedupe:background\} is the equivalent option.
If you use \{efficiency.cross_volume_dedupe:both\}, it will enable background and inline cross volume deduplication.

enable-cross-volume-inline-dedupe

efficiency.cross_volume_dedupe

In the REST API, if you need to enable enable-cross-volume-inline-dedupe, then \{efficiency.cross_volume_dedupe:inline\} is the equivalent option.
If you use \{efficiency.cross_volume_dedupe:both\}, it will enable background and inline cross volume deduplication.

enable-data-compaction

efficiency.compaction

In the REST API, if you need to enable enable-data-compaction, then \{efficiency.compaction:inline\} is the equivalent option.

enable-idd

No REST Equivalent

enable-inline-compression

efficiency.compression

In the REST API, if you need to enable enable-inline-compression needs, then \{efficiency.compression:inline\} is the equivalent option.
If you use \{efficiency.compression:both\}, then it will enable background and inline compression.

enable-inline-dedupe

efficiency.dedupe

In the REST API, if you need to enable enable-inline-dedupe, then \{efficiency.dedupe:inline\} is the equivalent option.
If you use \{efficiency.dedupe:both\}, then it will enable background and inline deduplication.

policy-name

efficiency.policy.name

storage-efficiency-mode

efficiency.storage_efficiency_mode

quick-check-fsize

No REST Equivalent

schedule

efficiency.schedule

volume-name

name

sis-start

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

sis-start-async

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

sis-status

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

sis-stop

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

sis-stop-async

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

sis-undo

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