This page contains a categorized list of ONTAPI calls that require one or more input parameters, along with a mapping of those calls to their equivalent REST API calls. Each ONTAPI call entry also includes a list of applicable ONTAPI input parameters mapped to the corresponding REST attributes.

NetApp strives for an ONTAP REST API that enables you to successfully modernize your automated processes as you transition from ONTAPI to REST. If you identify ONTAPI calls or parameters required by your automation processes that are not currently supported by the ONTAP REST API, we want to hear from you.

vicon.png : This icon signifies the following, "This ONTAPI call can be issued against Storage VM (SVM) management LIFs. If you are transitioning the call from an SVM management LIF to a cluster management LIF, make sure to specify the SVM name or UUID using the SVM-related properties of the REST endpoint."

ONTAPI features that have REST equivalents are listed below. If there is no direct REST equivalent but there is a CLI equivalent, you may use REST’s CLI passthrough feature to access it.

Category: ACTIVE-DIRECTORY

active-directory-account-create

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

active-directory-account-delete

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

active-directory-account-get-iter

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

active-directory-account-modify

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

active-directory-account-password-change

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

active-directory-account-password-reset

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

Category: AGGR

aggr-add

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

actual-disk-type

NO REST EQUIVALENT

aggregate

name

allocation-units

block_storage.hybrid_cache.storage_pools.allocation_units_count

allow-mixed-rpm

NO REST EQUIVALENT

allow-same-carrier

NO REST EQUIVALENT

cache-raid-group-size

NO REST EQUIVALENT

cache-raid-type

block_storage.hybrid_cache.raid_type

checksum-style

NO REST EQUIVALENT

disk-class

NO REST EQUIVALENT

disk-count

block_storage.primary.disk_count

disk-size

disk_size

This is only used as a query parameter.

disk-size-with-unit

NO REST EQUIVALENT

disk-type

NO REST EQUIVALENT

disks

NO REST EQUIVALENT

force-cache-size

NO REST EQUIVALENT

force-spare-pool

NO REST EQUIVALENT

group-selection-mode

NO REST EQUIVALENT

ignore-pool-checks

NO REST EQUIVALENT

mirror-disks

NO REST EQUIVALENT

pre-check

NO REST EQUIVALENT

Invoking the REST API PATCH method with the simulate parameter returns pre-check warnings.

raid-group

NO REST EQUIVALENT

simulate

simulate

so-aggr

NO REST EQUIVALENT

storage-pool

block_storage.hybrid_cache.storage_pools.name

upgrade-64bit-mode

NO REST EQUIVALENT

aggr-autobalance-aggregate-state-get-iter

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

aggr-autobalance-config-get

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

aggr-autobalance-config-modify

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

aggr-autobalance-notification-get-iter

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

aggr-autobalance-volume-state-get-iter

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

aggr-check-spare-low

GET /api/cluster/nodes?fields=is_spares_low

ONTAPI attribute

REST attribute

Comment

node-name

name

This is only used as a query parameter. Ex: /api/cluster/nodes?fields=is_spares_low&name=[node-name]

aggr-cluster-space-details-get

GET /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

cluster-space-info

See comment column for details

performance-tier-used → NA
performance-tier-total→ NA
performance-tier-available → NA
local-tier-used → NA
local-tier-total → NA
local-tier-available→ NA
capacity-tier-total-licensed→ licenses.capacity.maximum_size
licensed-object-store-type → NA
licensed-object-store-used → NA
unlicensed-object-store-type → NA
unlicensed-object-store-used → NA
local-tier-inactive-user-data → NA
local-tier-inactive-user-data-percent → NA

aggr-create

POST /api/storage/aggregates

ONTAPI attribute

REST attribute

Comment

actual-disk-type

NO REST EQUIVALENT

aggregate

name

allow-mixed-rpm

NO REST EQUIVALENT

allow-same-carrier

NO REST EQUIVALENT

auto-provision-target-size

NO REST EQUIVALENT

autobalance-state

NO REST EQUIVALENT

block-type

NO REST EQUIVALENT

checksum-style

block_storage.primary.checksum_style

disk-class

block_storage.primary.disk_class

disk-count

block_storage.primary.disk_count

disk-size

disk_size

This is only used as a query parameter.

disk-size-with-unit

NO REST EQUIVALENT

disk-type

NO REST EQUIVALENT

disks

NO REST EQUIVALENT

encrypt

NO REST EQUIVALENT

encrypt-with-aggr-key

data_encryption.software_encryption_enabled

force-small-aggregate

NO REST EQUIVALENT

force-spare-pool

NO REST EQUIVALENT

force-zcs

NO REST EQUIVALENT

ha-policy

NO REST EQUIVALENT

ignore-pool-checks

NO REST EQUIVALENT

is-autobalance-eligible

NO REST EQUIVALENT

is-mirrored

block_storage.mirror.enabled

is-snaplock

NO REST EQUIVALENT

language-code

NO REST EQUIVALENT

mirror-disks

NO REST EQUIVALENT

nodes

node.name

pre-check

NO REST EQUIVALENT

raid-size

block_storage.primary.raid_size

raid-type

block_storage.primary.raid_type

requested-uuid

uuid

rpm

NO REST EQUIVALENT

simulate

NO REST EQUIVALENT

snaplock-type

snaplock_type

so-aggr

NO REST EQUIVALENT

spare-pool

NO REST EQUIVALENT

striping

NO REST EQUIVALENT

type

NO REST EQUIVALENT

aggr-destroy

DELETE /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

plex

NO REST EQUIVALENT

The REST API does not support plex deletion.

aggr-efficiency-cumulated-get

GET /api/storage/cluster

ONTAPI attribute

REST attribute

Comment

aggregates

NO REST EQUIVALENT

Key to retrieve cumulative efficiency details of aggregates (list of aggregates).

nodes

NO REST EQUIVALENT

Key to retrieve cumulative efficiency details of nodes (list of nodes).

aggr-efficiency-get-iter

GET /api/storage/aggregates

ONTAPI attribute

REST attribute

Comment

aggr-efficiency-additional-details-info

NO REST EQUIVALENT

aggr-efficiency-aggr-info

NO REST EQUIVALENT

aggr-efficiency-cumulative-info

space.efficiency

Attribute also maps to properties ofspace.efficiency_without_snapshots attributes. aggr-efficiency-total-cumulated-info is the list of attributes. You can perform one-to-one mapping by pairing: ONTAPI attribute → REST API attribute:
total-data-reduction-logical-used → space.efficiency_without_snapshots.logical_used
total-data-reduction-efficiency-ratio → space.efficiency_without_snapshots.ratio
total-logical-used → space.efficiency.logical_used
total-storage-efficiency-ratio → space.efficiency.ratio
total-data-reduction-physical-used → (space.efficiency_without_snapshots.logical_used - space.efficiency_without_snapshots.savings)
total-physical-used → (space.efficiency.logical_used - space.efficiency.savings)

aggr-efficiency-snapshot-and-flexclone-volume-info

NO REST EQUIVALENT

aggr-efficiency-volume-info

NO REST EQUIVALENT

aggregate

name

node

node

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-get-filer-info

GET /api/storage/aggregates?show_spares=true

ONTAPI attribute

REST attribute

Comment

filer-info-version

NO REST EQUIVALENT

node-name

spares.node.name

This attribute is an input query in ZAPI and is an output field in REST.

root-volume

NO REST EQUIVALENT

disk-types

NO REST EQUIVALENT

checksum-types

spares.checksum_style

snapshots-max

NO REST EQUIVALENT

default-raidtype

NO REST EQUIVALENT

allowed-raidtypes

NO REST EQUIVALENT

raidgroup-size

See comment column for details

raidgroup-size-info → spares.layout_requirements
default-size → spares.layout_requirements.raid_group.default
disktype → spares.disk_type
maximum-size → spares.layout_requirements.raid_group.max
minimum-size → spares.layout_requirements.raid_group.min
raidtype → spares.layout_requirements.raid_type
minimum-disk-capacity → NA
maximum-disk-capacity → NA

max-named-disks-per-request

NO REST EQUIVALENT

min-aggr-disk-count

See comment column for details

min-aggr-disk-count-info → spares.layout_requirements
raid-type → spares.layout_requirements.raid_type
minimum-disk-count → spares.layout_requirements.aggregate_min_disks

default-raidtype-config

See comment column for details

default-raidtype-config-info → spares.layout_requirements
default-raid-type → spares.layout_requirements.default
disk-type → spares.disk_type

aggr-get-iter

GET /api/storage/aggregates

ONTAPI attribute

REST attribute

Comment

aggr-64bit-upgrade-attributes

NO REST EQUIVALENT

aggr-fs-attributes

NO REST EQUIVALENT

aggr-inode-attributes

See comment column for details

files-total → inode_attributes.files_total
files-used → inode_attributes.files_used
inofile-version → inode_attributes.version
fs-files-private-used → inode_attributes.files_private_used
fs-inodefile-private-capacity → inode_attributes.file_private_capacity
fs-inodefile-public-capacity → inode_attributes.file_public_capacity
fs-maxfiles-available → inode_attributes.max_files_available
fs-maxfiles-possible → inode_attributes.max_files_possible
fs-maxfiles-used → inode_attributes.max_files_used
fs-percent-inode-used-capacity → inode_attributes.used_percent

aggr-ownership-attributes

See comment column for details

cluster → NA
dr-home-id → NA
dr-home-name → dr_home_node.name
home-id → NA
home-name → home_node.name
owner-id → NA
owner-name → node.name
Each of the node fields is a reference to a node object. The NVRAM IDs are available as an attribute for these objects, by using a separate GET call.

aggr-performance-attributes

See comment column for details

free-space-realloc → NA
max-write-alloc-blocks → NA
single-instance-data-logging → sidl_enabled

aggr-raid-attributes

See comment column for details

aggregate-type → block_storage.storage_type
cache-raid-group-size → NA
checksum-status → NA
checksum-style → block_storage.primary.checksum_style
disk-count → block_storage.[primary|hybrid_cache].diskcount
encrypt-with-aggr-key → block_storage.data_encryption.software_encryption_enabled
ha-policy → NA
has-local-root → NA
has-partner-root → NA
is-checksum-enabled → NA
is-composite → NA
is-encrypted → block_storage.data_encryption.software_encryption_enabled
comment: is-encrypted has been deprecated since ONTAP 9.6.
is-fabricpool-mirrored → NA
is-hybrid → NA
is-hybrid-enabled → NA
is-inconsistent → NA
is-mirrored → block_storage.mirror.enabled
is-nve-capable → NA
is-root-aggregate → NA
mirror-status → block_storage.mirror.state
mount-state → NA
plex-count → NA
plexes → block_storage.plexes
plexes.is-online → online
plexes.is-resyncing → resync.active
plexes.plex-name → name
plexes.plex-resync-pct-with-precision → NA
plexes.plex-status → state
plexes.pool → pool
plexes.raidgroups plexes.raidgroups.checksum-style → NA
plexes.raidgroups.is-cache-tier → raidgroups.cache_tier
plexes.raidgroups.is-recomputing-parity → raidgroups.recomputing_parity.active
plexes.raidgroups.is-reconstructing → raidgroups.reconstruct.active
plexes.raidgroups.raidgroup-name → raidgroups.name
plexes.raidgroups.recomputing-parity-percentage → raidgroups.recomputing_parity.percent
plexes.raidgroups.reconstruction-percentage → raidgroups.reconstruct.percent
plexes.resync-level → resync.level
plexes.resyncing-percentage → resync.percent
raid-lost-write-state → NA
raid-size → block_storage.primary.raid_size
raid-status → NA
raid-type → block_storage.primary.raid_type
state → state
uses-shared-disks → block_storage.uses_partitions

aggr-snaplock-attributes

See comment column for details

is-snaplock → {snaplock-type == non_snaplock? false: true}
snaplock-type → snaplock-type

aggr-snapmirror-attributes

See comment column for details

dp-snapmirror-destinations → NA
ls-snapmirror-destinations → NA
mv-snapmirror-destinations → NA

aggr-snapshot-attributes

See comment column for details

files-total → snapshot.files-total
files-used → snapshot.files-used
inofile-version → NA
is-snapshot-auto-create-enabled → NA
is-snapshot-auto-delete-enabled → NA
maxfiles-available → snapshot.max-files-available
maxfiles-possible → NA
maxfiles-used → snapshot.max-files-used
percent-inode-used-capacity → NA
percent-used-capacity → space.snapshot.used-percent
size-available → space.snapshot.available
size-total → space.snapshot.total
size-used → space.snapshot.used
snapshot-reserve-percent → space.snapshot.reserve-percent

aggr-space-attributes

space

aggregate-metadata → space.block_storage.aggregate_metadata
capacity-tier-used → space.cloud_storage.used
data-compacted-count → space.block_storage.data_compacted_count
data-compaction-space-saved → space.block_storage.data_compaction_space_saved
data-compaction-space-saved-percent → space.block_storage.data_compaction_space_saved_percent
hybrid-cache-size-total → NA
percent-used-capacity → 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
physical-used → space.block_storage.physical_used
physical-used-percent → space.block_storage.physical_used_percent
sis-shared-count → space.block_storage.volume_deduplication_shared_count
sis-space-saved → space.block_storage.volume_deduplication_space_saved
sis-space-saved-percent → space.block_storage.volume_deduplication_space_saved_percent
size-available → space.block_storage.available
size-total → space.block_storage.size
size-used → space.block_storage.used
total-reserved-space → NA
used-including-snapshot-reserve → space.block_storage.used_including_snapshot_reserve
volume-footprints → space.footprint
aggregate-size → space.block_storage.size
snapshot-reserve-unusable-percent → NA
tier-name → NA
used-including-snapshot-reserve-percent → space.block_storage.used_including_snapshot_reserve_percent
volume-footprints-percent → space.footprint_percent
aggregate-metadata-percent → space.block_storage.aggregate_metadata_percent
object-store-metadata → NA
object-store-metadata-percent → NA
object-store-physical-used → NA
object-store-physical-used-percent → NA
object-store-referenced-capacity → NA
object-store-referenced-capacity-percent → NA
object-store-sis-space-saved → NA
object-store-sis-space-saved-percent → NA
object-store-size → NA
object-store-unreclaimed-space → NA
object-store-unreclaimed-space-percent → NA
percent-snapshot-space → space.block_storage.percent_snapshot_space
snap-size-total → NA
snapshot-reserve-unusable → NA

aggr-striping-attributes

See comment column for details

member-count→NA

aggr-volume-count-attributes

See comment column for details

flexvol-count → volume_count
flexvol-count-collective → NA
flexvol-count-not-online → NA
flexvol-count-quiesced → NA
flexvol-count-striped → NA

aggr-wafliron-attributes

See comment column for details

last-start-errno → NA
last-start-error-info → NA
scan-percentage → NA
state → NA
summary-scan-percentage→NA

aggregate-name

name

aggregate-uuid

uuid

autobalance-available-threshold-percent

NO REST EQUIVALENT

autobalance-state

NO REST EQUIVALENT

autobalance-state-change-counter

NO REST EQUIVALENT

autobalance-unbalanced-threshold-percent

NO REST EQUIVALENT

inactive-data-reporting-start-timestamp

inactive_data_reporting.start_time

is-autobalance-eligible

NO REST EQUIVALENT

is-cft-precommit

NO REST EQUIVALENT

is-inactive-data-reporting-enabled

inactive_data_reporting.enabled

is-object-store-attach-eligible

cloud_storage.attach_eligible

is-transition-out-of-space

NO REST EQUIVALENT

nodes

node.name

striping-type

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-mirror

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

allow-mixed-rpm

NO REST EQUIVALENT

allow-same-carrier

NO REST EQUIVALENT

force

NO REST EQUIVALENT

ignore-pool-checks

NO REST EQUIVALENT

mirror-disks

NO REST EQUIVALENT

override-vfiler-ownership

NO REST EQUIVALENT

pre-check

NO REST EQUIVALENT

simulate

NO REST EQUIVALENT

Calling OPTIONS on an aggregate instance will show you the possible values of a modifiable field.
If a mirror simulate would have resulted in a success, the OPTIONS output for block_storage.mirror.enabled will include "true" as an allowed value.

victim-aggregate

NO REST EQUIVALENT

aggr-modify-raid-type

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

disk-type

NO REST EQUIVALENT

raid-type

block_storage.primary.raid_type

simulate

NO REST EQUIVALENT

Calling OPTIONS on an aggregate instance will show you the possible values of a modifiable field.
If a raidtype change is supported, the OPTIONS output for block_storage.primary.raid_type will include the new raidtype.

aggr-object-store-attach

POST /api/storage/aggregates/{aggregate.uuid}/cloud-stores

ONTAPI attribute

REST attribute

Comment

aggregate

NO REST EQUIVALENT

allow-flexgroup

allow_flexgroups

check-only

check_only

object-store-name

target.name

With the REST API, you can also use target.uuid

aggr-object-store-config-create

POST /api/cloud/targets

ONTAPI attribute

REST attribute

Comment

access-key

access_key

auth-type

authentication_type

azure-account

azure_account

azure-private-key

azure_private_key

cap-url

cap_url

check-only

NO REST EQUIVALENT

ignore-warning-codes

NO REST EQUIVALENT

ipspace

ipspace.name

With the REST API, you can also use ispace.uuid

is-certificate-validation-enabled

certificate_validation_enabled

object-store-name

name

port

port

provider-type

provider_type

s3-name

container

secret-password

secret_password

server

server

ssl-enabled

ssl_enabled

url-style

url_style

aggr-object-store-config-delete

DELETE /api/cloud/targets/{uuid}

ONTAPI attribute

REST attribute

Comment

object-store-name

NO REST EQUIVALENT

aggr-object-store-config-get

GET /api/cloud/targets/{uuid}

ONTAPI attribute

REST attribute

Comment

access-key

access_key

auth-type

authentication_type

azure-account

azure_account

cap-url

cap_url

ipspace

ipspace.name

is-certificate-validation-enabled

certificate_validation_enabled

license-used-percent

NO REST EQUIVALENT

object-store-name

name

object-store-uuid

uuid

port

port

provider-type

provider_type

s3-name

container

server

server

ssl-enabled

ssl_enabled

used-space

used

aggr-object-store-config-get-iter

GET /api/cloud/targets

ONTAPI attribute

REST attribute

Comment

access-key

access_key

auth-type

authentication_type

azure-account

azure_account

cap-url

cap_url

ipspace

ipspace.name

is-certificate-validation-enabled

certificate_validation_enabled

license-used-percent

NO REST EQUIVALENT

object-store-name

name

object-store-uuid

uuid

port

port

provider-type

provider_type

s3-name

container

server

server

ssl-enabled

ssl_enabled

used-space

used

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-object-store-config-modify

PATCH /api/cloud/targets/{uuid}

ONTAPI attribute

REST attribute

Comment

access-key

access_key

auth-type

authentication_type

azure-account

azure_account

azure-private-key

azure_private_key

cap-url

cap_url

check-only

NO REST EQUIVALENT

ignore-warning-codes

NO REST EQUIVALENT

ipspace

ipspace.name

With the REST API, you can also use ispace.uuid

is-certificate-validation-enabled

certificate_validation_enabled

new-object-store-name

name

object-store-name

NO REST EQUIVALENT

port

port

secret-password

secret_password

server

server

ssl-enabled

ssl_enabled

url-style

url_style

use-iam-role

NO REST EQUIVALENT

Deprecated. Use authentication_type instead.

aggr-object-store-config-provider-list

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

aggr-object-store-get-iter

GET /api/storage/aggregates/{aggregate.uuid}/cloud-stores

ONTAPI attribute

REST attribute

Comment

aggregate

NO REST EQUIVALENT

aggregate-uuid

NO REST EQUIVALENT

bin-uuid

NO REST EQUIVALENT

force-tiering-on-metrocluster

NO REST EQUIVALENT

is-mirror-degraded

mirror_degraded

license-used-percent

NO REST EQUIVALENT

mirror-type

primary

object-store-availability

availability

object-store-name

target.name

object-store-uuid

NO REST EQUIVALENT

provider-type

NO REST EQUIVALENT

size-limit

NO REST EQUIVALENT

tiering-fullness-threshold

NO REST EQUIVALENT

used-space

used

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-object-store-get-resync-status-iter

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

aggr-object-store-licenses-paygo-add

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

aggr-object-store-licenses-paygo-agent-ping

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

aggr-object-store-licenses-paygo-get-iter

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

aggr-object-store-licenses-paygo-remove

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

aggr-object-store-mirror

POST /api/storage/aggregates/{aggregate.uuid}/cloud-stores/{target.uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

NO REST EQUIVALENT

object-store-name

target.name

With the REST API, you can also use target.uuid

aggr-object-store-modify

PATCH /api/storage/aggregates/{aggregate.uuid}/cloud-stores/{target.uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

NO REST EQUIVALENT

force-tiering-on-metrocluster

NO REST EQUIVALENT

mirror-type

primary

object-store-name

target.name

With the REST API, you can also use target.uuid

aggr-object-store-profiler-abort

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

aggr-object-store-profiler-get-iter

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

aggr-object-store-profiler-start

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

aggr-object-store-tiering-get

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

aggr-object-store-tiering-modify

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

aggr-object-store-unmirror

DELETE /api/storage/aggregates/{aggregate.uuid}/cloud-stores/{target.uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

NO REST EQUIVALENT

aggr-object-store-vol-btuuids-get-iter

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

aggr-offline

Set field "state" to the value "offline" to unmount volumes and offline the aggregate.

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

cifs-delay-seconds

NO REST EQUIVALENT

force-offline

NO REST EQUIVALENT

plex

NO REST EQUIVALENT

unmount-volumes

NO REST EQUIVALENT

Unmount-volumes is set to true.

aggr-online

Set field "state" to the value "online" to online the aggregate.

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

force-online

NO REST EQUIVALENT

keep-same-uuid

NO REST EQUIVALENT

plex

NO REST EQUIVALENT

aggr-options-list-info

This returns options and values for a given aggregate, and the possible option names are documented in aggr-set-option mapping.

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

aggr-recommendation-assign-disks

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

aggr-recommendation-configure-progress-get

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

aggr-recommendation-configure-start

POST /api/storage/aggregates

ONTAPI attribute

REST attribute

Comment

uuid

NO REST EQUIVALENT

aggr-recommendation-create

GET /api/storage/aggregates?recommend=true

ONTAPI attribute

REST attribute

Comment

nodes

NO REST EQUIVALENT

aggr-recommendation-details-get

GET /api/storage/aggregates

ONTAPI attribute

REST attribute

Comment

nodes

NO REST EQUIVALENT

aggr-recommendation-get

GET /api/storage/aggregates?recommend=true

ONTAPI attribute

REST attribute

Comment

uuid

NO REST EQUIVALENT

aggr-recommendation-verify

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

aggr-relocation

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate-list

name

destination-node-name

node.name

is-ndo-controller-upgrade

NO REST EQUIVALENT

is-override-destination-checks

NO REST EQUIVALENT

is-override-vetoes

NO REST EQUIVALENT

is-relocate-to-higher-version

NO REST EQUIVALENT

source-node-name

node.name

aggr-relocation-status

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

aggr-remove-stale-record

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

aggr-rename

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

new-aggregate-name

name

aggr-restrict

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

aggr-resync-options-get

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

aggr-resync-options-get-iter

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

aggr-resync-options-set

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

aggr-scrub-list-info

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

aggr-scrub-resume

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

aggr-scrub-start

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

aggr-scrub-stop

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

aggr-scrub-suspend

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

aggr-set-option

The options that you can modify in the REST API are block_storage.primary.raidtype, block_storage.primary.raidsize and inactive_data_reporting.enabled

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

option-name

NO REST EQUIVALENT

option-value

NO REST EQUIVALENT

aggr-space-get-iter

GET /api/storage/aggregates/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate

name

aggregate-metadata

space.block_storage.aggregate_metadata

aggregate-metadata-percent

space.block_storage.aggregate_metadata_percent

aggregate-size

space.block_storage.size

object-store-metadata

NO REST EQUIVALENT

object-store-metadata-percent

NO REST EQUIVALENT

object-store-physical-used

NO REST EQUIVALENT

object-store-physical-used-percent

NO REST EQUIVALENT

object-store-referenced-capacity

NO REST EQUIVALENT

object-store-referenced-capacity-percent

NO REST EQUIVALENT

object-store-sis-space-saved

NO REST EQUIVALENT

object-store-sis-space-saved-percent

NO REST EQUIVALENT

object-store-size

NO REST EQUIVALENT

object-store-unreclaimed-space

NO REST EQUIVALENT

object-store-unreclaimed-space-percent

NO REST EQUIVALENT

percent-snapshot-space

space.block_storage.percent_snapshot_space

physical-used

space.block_storage.physical_used

physical-used-percent

space.block_storage.physical_used_percent

snap-size-total

NO REST EQUIVALENT

snapshot-reserve-unusable

NO REST EQUIVALENT

snapshot-reserve-unusable-percent

NO REST EQUIVALENT

tier-name

NO REST EQUIVALENT

used-including-snapshot-reserve

space.block_storage.used_including_snapshot_reserve

used-including-snapshot-reserve-percent

space.block_storage.used_including_snapshot_reserve_percent

volume-footprints

space.footprint

volume-footprints-percent

space.footprint_percent

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-spare-get-iter

The REST API does not iterate and list individual spares but groups similar spares together

GET /api/storage/aggregates?show_spares=true

ONTAPI attribute

REST attribute

Comment

checksum-style

spares.checksum_style

disk

NO REST EQUIVALENT

disk-class

spares.disk_class

disk-rpm

NO REST EQUIVALENT

disk-type

NO REST EQUIVALENT

effective-disk-rpm

NO REST EQUIVALENT

effective-disk-type

spares.disk_type

is-disk-left-behind

NO REST EQUIVALENT

is-disk-shared

spares.is_partition

is-disk-zeroed

NO REST EQUIVALENT

is-disk-zeroing

NO REST EQUIVALENT

is-sparecore

NO REST EQUIVALENT

local-usable-data-size

NO REST EQUIVALENT

local-usable-data-size-blks

NO REST EQUIVALENT

local-usable-data1-size

NO REST EQUIVALENT

local-usable-data1-size-blks

NO REST EQUIVALENT

local-usable-data2-size

NO REST EQUIVALENT

local-usable-data2-size-blks

NO REST EQUIVALENT

local-usable-root-size

NO REST EQUIVALENT

local-usable-root-size-blks

NO REST EQUIVALENT

original-owner

NO REST EQUIVALENT

standard-disk-type

NO REST EQUIVALENT

syncmirror-pool

spares.syncmirror_pool

total-size

NO REST EQUIVALENT

usable-size

spares.size

usable-size-blks

NO REST EQUIVALENT

zeroing-percent

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-spare-requirements-get-iter

GET /api/storage/aggregates?show_spares=true

ONTAPI attribute

REST attribute

Comment

spare-req-allowed-raid-type-info

spares.layout_requirements

spare-req-available-count

spares.usable

spare-req-checksum-style

spares.checksum_style

spare-req-default-raid-type

spares.layout_requirements.raid_type

In the REST API, default raidtype is the entry in layout_requirements that has the default attribute set to "true".

spare-req-disk-or-partition-style

NO REST EQUIVALENT

spare-req-disk-rpms

NO REST EQUIVALENT

spare-req-disk-storage-class

spares.disk_class

spare-req-disk-types

NO REST EQUIVALENT

spare-req-effective-disk-rpm

NO REST EQUIVALENT

spare-req-effective-disk-type

NO REST EQUIVALENT

spare-req-minimum-required-count

NO REST EQUIVALENT

spare-req-node

spares.node.name

spare-req-non-zeroed-count

NO REST EQUIVALENT

spare-req-optimized-recommended-count

NO REST EQUIVALENT

spare-req-physical-disk-usable-size-bytes

NO REST EQUIVALENT

spare-req-pool

spares.syncmirror_pool

spare-req-recommended-count

NO REST EQUIVALENT

spare-req-required-count

NO REST EQUIVALENT

spare-req-standard-disk-types

NO REST EQUIVALENT

spare-req-usable-size-bytes

spares.size

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-status-get-iter

To retrieve all plexes specify "*" for aggregate uuid

GET /api/storage/aggregates/{aggregate.uuid}/plexes

ONTAPI attribute

REST attribute

Comment

aggr-cksumstyle

NO REST EQUIVALENT

aggr-plex-list

See comment column for details

plex-name → name
plex-is-online → online
plex-is-resyncing → resync.active
plex-resync-percent → resync.percent
plex-resync-pct-with-precision → NA
plex-resync-level → resync.level
plex-status → NA
aggr-raidgroup-list → raid_groups
storage-pool → NA
aggr-raidgroup-entity-list → NA
raidgroup → raid_groups.name
is-rg-reconstructing → raid_groups.reconstruct.active
rg-recons-percent → raid_groups.reconstruct.percent
is-rg-recomputing-parity → raid_groups.recomputing_parity.active
rg-reparity-percent → raid_groups.recomputing_parity.percent
scrub-percent-complete → NA
is-scrub-active → NA
rg-cksumstyle → NA
rg-raidtype → raid_groups.raid_type
rg-status → NA aggr-disk-list → raid_groups.disks
disk → raid_groups.disks.disk
position → raid_groups.disks.position
syncmirror-pool → pool
disk-type → raid_groups.disks.type
standard-disk-type → NA
disk-rpm → NA
usable-size → raid_groups.disks.usable_size
physical-size → NA
reconstruction-percent → NA
copy-percent → NA
is-sick → NA
is-recons-active → NA
is-offline → NA
is-replacing → NA
is-evacuating → NA
is-sdc-active → NA
effective-disk-type → NA
effective-disk-rpm → NA
is-cache → cache_tier

aggr-raid-status

NO REST EQUIVALENT

aggr-raid-type

NO REST EQUIVALENT

aggr-wafl-status

NO REST EQUIVALENT

aggregate

aggregate.name

aggregate-uuid

aggregate.uuid

is-mirror-verifying

NO REST EQUIVALENT

mirror-verification-pct-with-precision

NO REST EQUIVALENT

mirror-verification-percent

NO REST EQUIVALENT

node

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

aggr-verify-list-info

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

aggr-verify-resume

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

aggr-verify-start

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

aggr-verify-stop

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

aggr-verify-suspend

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

raidgroup-get-iter

You can find this information from the nested raidgroups array in the /api/storage/aggregates/{uuid}/plexes/{name} REST API endpoint.

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

aggr-wafliron-start

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

aggr-wafliron-stop

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

aggr-wafliron-commit

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

aggr-wafliron-reject

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

aggr-wafliron-review

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

Category: ANTIVIRUS

antivirus-modify

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-get-engine-info

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-get-engine-options

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-get-log

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-get-remedy-info

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-get-version-info

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-log-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-access-policy-create

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-access-policy-delete

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-access-policy-get

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-access-policy-get-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-access-policy-modify

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-abort

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-run

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-cluster-create

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-cluster-delete

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-cluster-get

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-cluster-get-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-cluster-modify

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-dir-create

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-dir-delete

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-dir-get

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-dir-get-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-dir-modify

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-file-create

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-file-delete

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-file-get

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-file-get-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-file-modify

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-vserver-create

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-vserver-delete

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-vserver-get

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-vserver-get-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-scan-vserver-modify

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-schedule

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-command-unschedule

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-job-get-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-report-get-iter

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-report-print

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-on-demand-report-upload

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-set-engine-info

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-set-engine-options

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-set-log

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-set-remedy-info

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-set-version-info

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

av-start-update

This ONTAPI is related to the onboard antivirus scanner, which is obsolete and not implemented in the REST API.

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

Category: APPLICATION

application-cluster-supported

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

application-create-async

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

application-delete-async

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

application-details-get-iter

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

application-get-iter

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

application-lun-get-iter

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

application-provisioning-aggr-get-iter

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

application-provisioning-config-get

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

application-provisioning-config-modify

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

application-provisioning-job-get-iter

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

application-provisioning-lun-results-get

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

application-provisioning-lun-start

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

application-provisioning-set-version

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

application-provisioning-volume-get-iter

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

application-provisioning-volume-results-get

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

application-provisioning-volume-start

POST /api/storage/volumes vicon.png

ONTAPI attribute

REST attribute

Comment

application-name

NO REST EQUIVALENT

dry-run

NO REST EQUIVALENT

fabricpool-policy

NO REST EQUIVALENT

protection-service

NO REST EQUIVALENT

provision-restraints

NO REST EQUIVALENT

volume-groups

NO REST EQUIVALENT

application-rename

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

application-snapshot-create

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

application-snapshot-delete

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

application-snapshot-get-iter

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

application-snapshot-restore

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

application-stats-get-iter

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

application-supported-aggr-by-restraint-get-iter

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

application-template-get-iter

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

application-test-vvolengine-can-change-performance

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

application-test-vvolengine-place

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

application-volume-get-iter

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

application-vserver-supported

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

application-vserver-supported-get-iter

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

Category: AUDIT

audit-log-config-get

GET /api/security/audit

ONTAPI attribute

REST attribute

Comment

cli-get

cli

http-get

http

ontapi-get

ontapi

snmp-get

NO REST EQUIVALENT

audit-log-config-modify

PATCH /api/security/audit

ONTAPI attribute

REST attribute

Comment

cli-get

cli

http-get

http

ontapi-get

ontapi

snmp-get

NO REST EQUIVALENT

audit-log-get

GET /api/security/audit/messages

ONTAPI attribute

REST attribute

Comment

entry

See comment column for details

This ONTAPI property maps to the following REST API properties:
application
location
user
scope
input
state
message

node

node

seq

index

timestamp

timestamp

audit-log-get-iter

GET /api/security/audit/messages

ONTAPI attribute

REST attribute

Comment

entry

See comment column for details

This ONTAPI property maps to the following REST API properties:
application
location
user
scope
input
state
message

node

node

seq

index

timestamp

timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: AUTOSUPPORT

autosupport-budget-get

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

autosupport-budget-get-iter

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

autosupport-budget-get-total-records

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

autosupport-budget-modify

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

autosupport-check-iter

GET /api/support/autosupport?fields=issues

ONTAPI attribute

REST attribute

Comment

check-category

NO REST EQUIVALENT

check-type

NO REST EQUIVALENT

corrective-action

issues.corrective_action

error-detail

issues.issue.message

node-name

issues.node.name

status

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

autosupport-compliant-get

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

autosupport-compliant-get-iter

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

autosupport-compliant-get-total-records

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

autosupport-config-get

AutoSupport configuration is cluster-scoped and cannot be targeted at the node level.

GET /api/support/autosupport

ONTAPI attribute

REST attribute

Comment

from

from

is-enabled

enabled

is-local-collection-enabled

NO REST EQUIVALENT

is-nht-data-enabled

NO REST EQUIVALENT

is-node-in-subject

NO REST EQUIVALENT

is-ondemand-download-enabled

NO REST EQUIVALENT

is-ondemand-enabled

NO REST EQUIVALENT

is-ondemand-remote-diag-enabled

NO REST EQUIVALENT

is-perf-data-enabled

NO REST EQUIVALENT

is-private-data-removed

is_minimal

is-reminder-enabled

NO REST EQUIVALENT

is-support-enabled

contact_support

is-throttle-enabled

NO REST EQUIVALENT

last-subject

NO REST EQUIVALENT

last-timestamp

NO REST EQUIVALENT

mail-hosts

mail_hosts

max-download-rate

NO REST EQUIVALENT

max-http-size

NO REST EQUIVALENT

max-smtp-size

NO REST EQUIVALENT

max-upload-rate

NO REST EQUIVALENT

minimum-private-data-length

NO REST EQUIVALENT

node-name

NO REST EQUIVALENT

node-specific-from

NO REST EQUIVALENT

noteto

NO REST EQUIVALENT

ondemand-polling-interval

NO REST EQUIVALENT

ondemand-server-url

NO REST EQUIVALENT

partner-address

partner_addresses

payload-format

NO REST EQUIVALENT

periodic-tx-window

NO REST EQUIVALENT

post-url

NO REST EQUIVALENT

proxy-url

proxy_url

put-url

NO REST EQUIVALENT

retry-count

NO REST EQUIVALENT

retry-interval

NO REST EQUIVALENT

support-address

NO REST EQUIVALENT

to

to

transport

transport

validate-digital-certificate

NO REST EQUIVALENT

node-name

NO REST EQUIVALENT

autosupport-config-get-iter

AutoSupport configuration is cluster-scoped and cannot be targeted at the node level.

GET /api/support/autosupport

ONTAPI attribute

REST attribute

Comment

from

from

is-enabled

enabled

is-local-collection-enabled

NO REST EQUIVALENT

is-nht-data-enabled

NO REST EQUIVALENT

is-node-in-subject

NO REST EQUIVALENT

is-ondemand-download-enabled

NO REST EQUIVALENT

is-ondemand-enabled

NO REST EQUIVALENT

is-ondemand-remote-diag-enabled

NO REST EQUIVALENT

is-perf-data-enabled

NO REST EQUIVALENT

is-private-data-removed

is_minimal

is-reminder-enabled

NO REST EQUIVALENT

is-support-enabled

contact_support

is-throttle-enabled

NO REST EQUIVALENT

last-subject

NO REST EQUIVALENT

last-timestamp

NO REST EQUIVALENT

mail-hosts

mail_hosts

max-download-rate

NO REST EQUIVALENT

max-http-size

NO REST EQUIVALENT

max-smtp-size

NO REST EQUIVALENT

max-upload-rate

NO REST EQUIVALENT

minimum-private-data-length

NO REST EQUIVALENT

node-name

NO REST EQUIVALENT

node-specific-from

NO REST EQUIVALENT

noteto

NO REST EQUIVALENT

ondemand-polling-interval

NO REST EQUIVALENT

ondemand-server-url

NO REST EQUIVALENT

partner-address

partner_addresses

payload-format

NO REST EQUIVALENT

periodic-tx-window

NO REST EQUIVALENT

post-url

NO REST EQUIVALENT

proxy-url

proxy_url

put-url

NO REST EQUIVALENT

retry-count

NO REST EQUIVALENT

retry-interval

NO REST EQUIVALENT

support-address

NO REST EQUIVALENT

to

to

transport

transport

validate-digital-certificate

NO REST EQUIVALENT

node-name

NO REST EQUIVALENT

autosupport-config-get-total-records

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

autosupport-config-modify

PATCH /api/support/autosupport

ONTAPI attribute

REST attribute

Comment

from

from

is-enabled

enabled

is-local-collection-enabled

NO REST EQUIVALENT

is-nht-data-enabled

NO REST EQUIVALENT

is-node-in-subject

NO REST EQUIVALENT

is-ondemand-download-enabled

NO REST EQUIVALENT

is-ondemand-enabled

NO REST EQUIVALENT

is-ondemand-remote-diag-enabled

NO REST EQUIVALENT

is-perf-data-enabled

NO REST EQUIVALENT

is-private-data-removed

is_minimal

is-reminder-enabled

NO REST EQUIVALENT

is-support-enabled

contact_support

is-throttle-enabled

NO REST EQUIVALENT

mail-hosts

mail_hosts

max-download-rate

NO REST EQUIVALENT

max-http-size

NO REST EQUIVALENT

max-smtp-size

NO REST EQUIVALENT

max-upload-rate

NO REST EQUIVALENT

minimum-private-data-length

NO REST EQUIVALENT

node-name

NO REST EQUIVALENT

AutoSupport configuration is cluster-scoped and cannot be targeted at the node level.

node-specific-from

NO REST EQUIVALENT

noteto

NO REST EQUIVALENT

ondemand-polling-interval

NO REST EQUIVALENT

ondemand-server-url

NO REST EQUIVALENT

partner-address

partner_addresses

payload-format

NO REST EQUIVALENT

periodic-tx-window

NO REST EQUIVALENT

post-url

NO REST EQUIVALENT

proxy-url

proxy_url

put-url

NO REST EQUIVALENT

retry-count

NO REST EQUIVALENT

retry-interval

NO REST EQUIVALENT

support-address

NO REST EQUIVALENT

to

to

transport

transport

validate-digital-certificate

NO REST EQUIVALENT

autosupport-config-reset-destinations

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

autosupport-destinations-get

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

autosupport-destinations-get-iter

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

autosupport-destinations-get-total-records

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

autosupport-download-get

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

autosupport-download-get-iter

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

autosupport-history-cancel

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

autosupport-history-get

GET /api/support/autosupport/messages?node.name={node-name}

ONTAPI attribute

REST attribute

Comment

attempt-count

NO REST EQUIVALENT

decompressed-size

NO REST EQUIVALENT

destination

NO REST EQUIVALENT

generation-timestamp

generated_on

last-modification-timestamp

NO REST EQUIVALENT

node-name

node.name

percent-complete

NO REST EQUIVALENT

seq-num

index

size

NO REST EQUIVALENT

status

state

subject

subject

time-remaining

NO REST EQUIVALENT

total-time

NO REST EQUIVALENT

trigger

NO REST EQUIVALENT

upload-rate

NO REST EQUIVALENT

uri

NO REST EQUIVALENT

destination

destination

autosupport-history-get-iter

GET /api/support/autosupport/messages

ONTAPI attribute

REST attribute

Comment

attempt-count

NO REST EQUIVALENT

decompressed-size

NO REST EQUIVALENT

destination

destination

generation-timestamp

generated_on

last-modification-timestamp

NO REST EQUIVALENT

node-name

node.name

percent-complete

NO REST EQUIVALENT

seq-num

index

size

NO REST EQUIVALENT

status

state

subject

subject

time-remaining

NO REST EQUIVALENT

total-time

NO REST EQUIVALENT

trigger

NO REST EQUIVALENT

upload-rate

NO REST EQUIVALENT

uri

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

autosupport-history-get-total-records

GET /api/support/autosupport/messages?return_records=false

There are no attributes defined for this ONTAPI call.

autosupport-history-retransmit

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

autosupport-invoke

POST /api/support/autosupport/messages

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

message

message

node-name

node.name

type

type

uri

uri

autosupport-invoke-core-upload

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

autosupport-invoke-diagnostic

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

autosupport-invoke-diagnostic-iter

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

autosupport-invoke-iter

To invoke an ASUP on all nodes in the cluster, omit the "node" attribute.

POST /api/support/autosupport/messages

ONTAPI attribute

REST attribute

Comment

continue-on-failure

NO REST EQUIVALENT

force

NO REST EQUIVALENT

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

message

message

from

NO REST EQUIVALENT

is-enabled

NO REST EQUIVALENT

is-local-collection-enabled

NO REST EQUIVALENT

is-nht-data-enabled

NO REST EQUIVALENT

is-node-in-subject

NO REST EQUIVALENT

is-ondemand-download-enabled

NO REST EQUIVALENT

is-ondemand-enabled

NO REST EQUIVALENT

is-ondemand-remote-diag-enabled

NO REST EQUIVALENT

is-perf-data-enabled

NO REST EQUIVALENT

is-private-data-removed

NO REST EQUIVALENT

is-reminder-enabled

NO REST EQUIVALENT

is-support-enabled

NO REST EQUIVALENT

is-throttle-enabled

NO REST EQUIVALENT

last-subject

NO REST EQUIVALENT

last-timestamp

NO REST EQUIVALENT

mail-hosts

NO REST EQUIVALENT

max-download-rate

NO REST EQUIVALENT

max-http-size

NO REST EQUIVALENT

max-smtp-size

NO REST EQUIVALENT

max-upload-rate

NO REST EQUIVALENT

minimum-private-data-length

NO REST EQUIVALENT

node-name

node.name

node-specific-from

NO REST EQUIVALENT

noteto

NO REST EQUIVALENT

ondemand-polling-interval

NO REST EQUIVALENT

ondemand-server-url

NO REST EQUIVALENT

partner-address

NO REST EQUIVALENT

payload-format

NO REST EQUIVALENT

periodic-tx-window

NO REST EQUIVALENT

post-url

NO REST EQUIVALENT

proxy-url

NO REST EQUIVALENT

put-url

NO REST EQUIVALENT

retry-count

NO REST EQUIVALENT

retry-interval

NO REST EQUIVALENT

support-address

NO REST EQUIVALENT

to

NO REST EQUIVALENT

transport

NO REST EQUIVALENT

validate-digital-certificate

NO REST EQUIVALENT

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

type

type

uri

uri

autosupport-invoke-performance-archive

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

autosupport-invoke-performance-archive-iter

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

autosupport-invoke-splog

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

autosupport-manifest-get-iter

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

autosupport-manifest-get-total-records

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

autosupport-trigger-get

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

autosupport-trigger-get-iter

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

autosupport-trigger-get-total-records

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

autosupport-trigger-modify

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

Category: CAPABILITY

capability-get

This ONTAPI is published as an unsupported ONTAPI. It is available through the REST API by using the CLI passthrough /api/private/cli/system/capability.

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

capability-get-iter

This ONTAPI is published as an unsupported ONTAPI. It is available through the REST API by using the CLI passthrough /api/private/cli/system/capability.

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

Category: CF

cf-aggregate-giveback-status

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

aggr-giveback-error

ha.giveback.status.error

aggr-giveback-module

NO REST EQUIVALENT

aggr-giveback-state

ha.giveback.status.state

aggregate

ha.giveback.status.aggregate

destination-node

NO REST EQUIVALENT

node

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

cf-force-takeover

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

cf-get-iter

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

giveback-state

ha.giveback.state

sfo-interconnect-info

ha.interconnect

sfo-node-info

NO REST EQUIVALENT

auto-giveback-enabled

ha.auto_giveback

sfo-storage-info

NO REST EQUIVALENT

takeover-state

ha.takeover.state

max-records

max_records

Specifies the maximum number of records to return before paging.

cf-get-partner

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

node

name

cf-giveback

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

node

NO REST EQUIVALENT

only-cfo-aggregates

NO REST EQUIVALENT

override-vetoes

NO REST EQUIVALENT

require-partner-waiting

NO REST EQUIVALENT

cf-hwassist-stats

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

cf-hwassist-stats-clear

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

cf-hwassist-status

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

node

NO REST EQUIVALENT

cf-hwassist-test

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

cf-mode-set

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

cf-modify-iter

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

auto-giveback-enabled

ha.auto_giveback

failover-enabled

ha.enabled

ha-mode

NO REST EQUIVALENT

node

NO REST EQUIVALENT

sfo-advanced-options-info-modify

NO REST EQUIVALENT

sfo-giveback-options-info-modify

NO REST EQUIVALENT

sfo-takeover-options-info-modify

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

cf-service-disable

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

cf-service-enable

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

node

NO REST EQUIVALENT

cf-status

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

interconnect-type

ha.interconnect.adapter

cf-takeover

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

allow-disk-inventory-mismatch

NO REST EQUIVALENT

bypass-optimization

NO REST EQUIVALENT

force

NO REST EQUIVALENT

halt

action

ignore-quorum-warnings

NO REST EQUIVALENT

immediate

NO REST EQUIVALENT

node

NO REST EQUIVALENT

override-vetoes

NO REST EQUIVALENT

skip-lif-migration

NO REST EQUIVALENT

version-mismatch-ok

NO REST EQUIVALENT

cf-takeover-status

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

aggregate-takeover-status

NO REST EQUIVALENT

node

NO REST EQUIVALENT

node-takeover-status

ha.takeover.state

taken-over-aggregate

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: CG

cg-commit

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

cg-start

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

Category: CIFS

cifs-branchcache-create

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

cifs-branchcache-flush

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

cifs-branchcache-get

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

cifs-branchcache-get-iter

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

cifs-branchcache-hash

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

cifs-branchcache-modify

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

cifs-branchcache-remove

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

cifs-cache-settings-get

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

cifs-cache-settings-modify

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

cifs-character-mapping-create

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

cifs-character-mapping-destroy

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

cifs-character-mapping-get-iter

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

cifs-character-mapping-modify

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

cifs-check-server-get-iter

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

cifs-connection-get-iter

GET /api/protocols/cifs/connections vicon.png

ONTAPI attribute

REST attribute

Comment

connection-id

identifier

lif-ip

server_ip

network-context-id

network_context_id

node

node.name

session-id

sessions.identifier

vserver

svm.name

workstation-ip

client_ip

workstation-port

client_port

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-discovered-servers-get-iter

CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

GET /api/protocols/cifs/domains vicon.png

ONTAPI attribute

REST attribute

Comment

address

server_ip

dc-functional-level

NO REST EQUIVALENT

domain

domain

is-dc-read-only

NO REST EQUIVALENT

name

server_name

node

node

prefer-type

preference

server-type

server_type

status

state

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-discovered-servers-reset

Merged with CIFS domains GET endpoint. It triggers asynchronous rediscovery of servers and returns current CIFS domains information.

GET /api/protocols/cifs/domains/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

NA

reset_discovered_servers

"reset_discovered_servers" query parameter value needs to be passed as true for servers rediscovery. The default value is false.

cifs-domain-name-mapping-search-add

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

cifs-domain-name-mapping-search-get-iter

CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

GET /api/protocols/cifs/domains vicon.png

ONTAPI attribute

REST attribute

Comment

trusted-domains

trusted_domains

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-name-mapping-search-modify

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

cifs-domain-name-mapping-search-remove

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

cifs-domain-password-schedule-get-iter

CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

GET /api/protocols/cifs/domains vicon.png

ONTAPI attribute

REST attribute

Comment

is-schedule-enabled

schedule_enabled

schedule-day-of-week

NO REST EQUIVALENT

schedule-randomized-minute

schedule_randomized_minute

schedule-time-of-day

NO REST EQUIVALENT

schedule-weekly-interval

schedule_weekly_interval

schedule-last-changed

schedule_last_changed_time

schedule-description

schedule_description

schedule-warn-msg

schedule_warn_message

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-password-schedule-modify

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

cifs-domain-preferred-dc-add

POST /api/protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers vicon.png

ONTAPI attribute

REST attribute

Comment

domain

fqdn

preferred-dc

server_ip

In ZAPI, preferred-dc is a list of IP addresses. In REST APIs, a single IP address input is taken, not a list of IP addresses. In case mulitiple IPs are to be added to a given vserver and domain bulk POST is also supported.

vserver

svm.uuid

skip-config-validation

skip_config_validation

cifs-domain-preferred-dc-get-iter

GET /api/protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers vicon.png

ONTAPI attribute

REST attribute

Comment

domain

fqdn

preferred-dc

server_ip

In ZAPI, preferred-dc is a list of IP addresses. In REST APIs, a single IP address input is taken, not a list of IP addresses.

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-preferred-dc-remove

DELETE /api/protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers/{fqdn}/{server_ip} vicon.png

ONTAPI attribute

REST attribute

Comment

domain

fqdn

preferred-dc

server_ip

In ZAPI, preferred-dc is a list of IP addresses. In REST API, a single IP address input is taken, not a list of IP addresses. In case mulitiple IPs are to be removed from a given domain or vserver query based bulk DELETE is also supported.

vserver

svm.uuid

cifs-domain-server-discovery-mode-get

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

cifs-domain-server-discovery-mode-get-iter

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

cifs-domain-server-discovery-mode-modify

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

cifs-domain-trusts-get-iter

CIFS domains endpoint returns name mapping, trusted relationships, preferred domain controllers, discovered servers, and password schedule information. You can also retrieve the same information for a specific SVM based on its SVM UUID.

GET /api/protocols/cifs/domains vicon.png

ONTAPI attribute

REST attribute

Comment

home-domain

home_domain

node

node

trusted-domain

trusted_domains

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-domain-trusts-rediscover

Merged with the CIFS domains GET endpoint. It triggers asynchronous trusted servers rediscovery and returns current CIFS domains information.

GET /api/protocols/cifs/domains/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

NA

rediscover_trusts

"rediscover_trusts" query parameter value needs to be passed as true for trusts rediscovery. The default value is false.

cifs-home-directory-get-iter

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

cifs-home-directory-modify

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

cifs-home-directory-search-path-add

POST /api/protocols/cifs/home-directory/search-paths vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

cifs-home-directory-search-path-delete

In the REST API, you need the index to delete the home directory search-path.

DELETE /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

path

NO REST EQUIVALENT

cifs-home-directory-search-path-get-iter

GET /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

position

index

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-home-directory-search-path-remove

In the REST API, you need the index to remove the home directory search-path.

DELETE /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

path

NO REST EQUIVALENT

cifs-home-directory-search-path-reorder

PATCH /api/protocols/cifs/home-directory/search-paths/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

path

NO REST EQUIVALENT

to-position

new_index

cifs-local-group-create

POST /api/protocols/cifs/local-groups vicon.png

ONTAPI attribute

REST attribute

Comment

description

description

group-name

name

return-record

return_records

cifs-local-group-delete

DELETE /api/protocols/cifs/local-groups/{svm.uuid}/{sid} vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

NO REST EQUIVALENT

The local group is identified using the SID attribute. This field is not required in REST API.

cifs-local-group-get-iter

GET /api/protocols/cifs/local-groups vicon.png

ONTAPI attribute

REST attribute

Comment

description

description

group-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-group-members-add-members

POST /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

NO REST EQUIVALENT

The local group is identified using the SID attribute. This field is not required in REST API.

member-names

name

The name parameter is used to add a single member while records parameter is used to add multiple members.

cifs-local-group-members-get-iter

The local group members can also be retrieved using REST API: /api/protocols/cifs/local-groups.

GET /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

NO REST EQUIVALENT

The local group is identified using the SID attribute. This field is not required in REST API.

member

records.name

This is an advanced privilege field in REST API: /api/protocols/cifs/local-groups.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-group-members-remove-members

DELETE /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

NO REST EQUIVALENT

The local group is identified using the SID attribute. This field is not required in REST API.

member-names

name

The name parameter is used to delete a single member while records parameter is used to delete multiple members.

cifs-local-group-modify

PATCH /api/protocols/cifs/local-groups/{svm.uuid}/{sid} vicon.png

ONTAPI attribute

REST attribute

Comment

description

description

group-name

NO REST EQUIVALENT

The local group is identified using the SID attribute. This field is not required in REST API.

cifs-local-group-rename

This API is merged with cifs-local-group-modify in REST API.

PATCH /api/protocols/cifs/local-groups/{svm.uuid}/{sid} vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

NO REST EQUIVALENT

The local group is identified using the SID attribute. This field is not required in REST API.

new-group-name

name

cifs-local-user-create

POST /api/protocols/cifs/local-users vicon.png

ONTAPI attribute

REST attribute

Comment

description

description

full-name

full_name

is-account-disabled

account_disabled

user-name

name

user-password

password

cifs-local-user-delete

DELETE /api/protocols/cifs/local-users/{svm.uuid}/{sid} vicon.png

ONTAPI attribute

REST attribute

Comment

user-name

NO REST EQUIVALENT

The local user is identified using the SID attribute. This field is not required in REST API.

cifs-local-user-get-iter

GET /api/protocols/cifs/local-users vicon.png

ONTAPI attribute

REST attribute

Comment

description

description

full-name

full_name

is-account-disabled

account_disabled

user-name

name

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-user-membership-get-iter

This API is merged with cifs-local-user-get-iter in REST API.

GET /api/protocols/cifs/local-users vicon.png

ONTAPI attribute

REST attribute

Comment

membership

membership

This is an advanced privilege field in the REST API.

user-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-local-user-modify

PATCH /api/protocols/cifs/local-users/{svm.uuid}/{sid} vicon.png

ONTAPI attribute

REST attribute

Comment

description

description

full-name

full_name

is-account-disabled

account_disabled

user-name

name

cifs-local-user-rename

This API is merged with cifs-local-user-modify in REST API.

PATCH /api/protocols/cifs/local-users/{svm.uuid}/{sid} vicon.png

ONTAPI attribute

REST attribute

Comment

new-user-name

name

user-name

NO REST EQUIVALENT

The local user is identified using the SID attribute. This field is not required in REST API.

cifs-local-user-set-password

This API is merged with cifs-local-user-modify in REST API.

PATCH /api/protocols/cifs/local-users/{svm.uuid}/{sid} vicon.png

ONTAPI attribute

REST attribute

Comment

user-name

NO REST EQUIVALENT

The local user is identified using the SID attribute. This field is not required in REST API.

user-password

password

cifs-nbtstat-get-iter

GET /api/protocols/cifs/netbios vicon.png

ONTAPI attribute

REST attribute

Comment

nbt-mode

mode

nbt-name-state

state

nbt-scope

scope

netbios-name

name

netbios-suffix

suffix

node

node.name

registered-addresses

interfaces

registered-type

name_registration_type

registration-time-left-minutes

time_left

vserver

svm.name

wins-entries

wins_servers

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-options-get-iter

GET /api/protocols/cifs/services vicon.png

ONTAPI attribute

REST attribute

Comment

client-session-timeout

NO REST EQUIVALENT

default-unix-group

NO REST EQUIVALENT

default-unix-user

default_unix_user

file-system-sector-size

NO REST EQUIVALENT

grant-unix-group-perms-to-others

NO REST EQUIVALENT

guest-unix-user

NO REST EQUIVALENT

is-admin-users-mapped-to-root-enabled

admin_to_root_mapping

is-advanced-sparse-file-support-enabled

advanced_sparse_file

is-advertise-dfs-enabled

NO REST EQUIVALENT

is-client-dup-detection-enabled

NO REST EQUIVALENT

is-client-version-reporting-enabled

NO REST EQUIVALENT

is-copy-offload-direct-copy-enabled

NO REST EQUIVALENT

is-copy-offload-enabled

copy_offload

is-dac-enabled

NO REST EQUIVALENT

is-exportpolicy-enabled

NO REST EQUIVALENT

is-fake-open-enabled

fake_open

is-fsctl-file-level-trim-enabled

fsctl_trim

is-hide-dotfiles-enabled

NO REST EQUIVALENT

is-inherit-modebits-with-nfsv4acl-enabled

NO REST EQUIVALENT

is-large-mtu-enabled

large_mtu

is-local-auth-enabled

NO REST EQUIVALENT

is-local-users-and-groups-enabled

NO REST EQUIVALENT

is-multichannel-enabled

multichannel

is-nbns-enabled

NO REST EQUIVALENT

is-netbios-over-tcp-enabled

NO REST EQUIVALENT

is-path-component-cache-enabled

path_component_cache

is-path-component-cache-symlink-enabled

NO REST EQUIVALENT

is-read-only-delete-enabled

NO REST EQUIVALENT

is-referral-enabled

referral

is-search-short-names-enabled

NO REST EQUIVALENT

is-shadowcopy-enabled

NO REST EQUIVALENT

is-smb1-enabled

NO REST EQUIVALENT

is-smb2-enabled

NO REST EQUIVALENT

is-smb3-enabled

NO REST EQUIVALENT

is-smb31-enabled

NO REST EQUIVALENT

is-trusted-domain-enum-search-enabled

NO REST EQUIVALENT

is-unix-extensions-enabled

NO REST EQUIVALENT

is-unix-nt-acl-enabled

NO REST EQUIVALENT

is-use-junctions-as-reparse-points-enabled

junction_reparse

map-sid-to-uid-on-set-owner

NO REST EQUIVALENT

max-connections-per-session

NO REST EQUIVALENT

max-credits

smb_credits

max-file-write-zero-length

NO REST EQUIVALENT

max-lifs-per-session

NO REST EQUIVALENT

max-mpx

NO REST EQUIVALENT

max-opens-same-file-per-tree

NO REST EQUIVALENT

max-same-tree-connect-per-session

NO REST EQUIVALENT

max-same-user-sessions-per-connection

NO REST EQUIVALENT

max-watches-set-per-tree

NO REST EQUIVALENT

path-component-cache-entry-exp-time

NO REST EQUIVALENT

path-component-cache-max-entries

NO REST EQUIVALENT

path-component-cache-max-session-token-size

NO REST EQUIVALENT

path-component-cache-symlink-exp-time

NO REST EQUIVALENT

read-grants-execute

NO REST EQUIVALENT

restrict-anonymous

security.restrict_anonymous

shadowcopy-dir-depth

NO REST EQUIVALENT

smb1-max-buffer-size

NO REST EQUIVALENT

vserver

svm.name

widelink-as-reparse-point-versions

widelink_reparse_versions

win-name-for-null-user

null_user_windows_name

wins-servers

netbios.wins_servers

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-options-modify

PATCH /api/protocols/cifs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

client-session-timeout

NO REST EQUIVALENT

default-unix-group

NO REST EQUIVALENT

default-unix-user

default_unix_user

file-system-sector-size

NO REST EQUIVALENT

grant-unix-group-perms-to-others

NO REST EQUIVALENT

guest-unix-user

NO REST EQUIVALENT

is-admin-users-mapped-to-root-enabled

admin_to_root_mapping

is-advanced-sparse-file-support-enabled

advanced_sparse_file

is-advertise-dfs-enabled

NO REST EQUIVALENT

is-client-dup-detection-enabled

NO REST EQUIVALENT

is-client-version-reporting-enabled

NO REST EQUIVALENT

is-copy-offload-direct-copy-enabled

NO REST EQUIVALENT

is-copy-offload-enabled

copy_offload

is-dac-enabled

NO REST EQUIVALENT

is-exportpolicy-enabled

NO REST EQUIVALENT

is-fake-open-enabled

fake_open

is-fsctl-file-level-trim-enabled

fsctl_trim

is-hide-dotfiles-enabled

NO REST EQUIVALENT

is-inherit-modebits-with-nfsv4acl-enabled

NO REST EQUIVALENT

is-large-mtu-enabled

large_mtu

is-local-auth-enabled

NO REST EQUIVALENT

is-local-users-and-groups-enabled

NO REST EQUIVALENT

is-multichannel-enabled

multichannel

is-nbns-enabled

NO REST EQUIVALENT

is-netbios-over-tcp-enabled

NO REST EQUIVALENT

is-path-component-cache-enabled

path_component_cache

is-path-component-cache-symlink-enabled

NO REST EQUIVALENT

is-read-only-delete-enabled

NO REST EQUIVALENT

is-referral-enabled

referral

is-search-short-names-enabled

NO REST EQUIVALENT

is-shadowcopy-enabled

NO REST EQUIVALENT

is-smb1-enabled

NO REST EQUIVALENT

is-smb2-enabled

NO REST EQUIVALENT

is-smb3-enabled

NO REST EQUIVALENT

is-smb31-enabled

NO REST EQUIVALENT

is-trusted-domain-enum-search-enabled

NO REST EQUIVALENT

is-unix-extensions-enabled

NO REST EQUIVALENT

is-unix-nt-acl-enabled

NO REST EQUIVALENT

is-use-junctions-as-reparse-points-enabled

junction_reparse

map-sid-to-uid-on-set-owner

NO REST EQUIVALENT

max-connections-per-session

NO REST EQUIVALENT

max-credits

smb_credits

max-file-write-zero-length

NO REST EQUIVALENT

max-lifs-per-session

NO REST EQUIVALENT

max-mpx

NO REST EQUIVALENT

max-opens-same-file-per-tree

NO REST EQUIVALENT

max-same-tree-connect-per-session

NO REST EQUIVALENT

max-same-user-sessions-per-connection

NO REST EQUIVALENT

max-watches-set-per-tree

NO REST EQUIVALENT

path-component-cache-entry-exp-time

NO REST EQUIVALENT

path-component-cache-max-entries

NO REST EQUIVALENT

path-component-cache-max-session-token-size

NO REST EQUIVALENT

path-component-cache-symlink-exp-time

NO REST EQUIVALENT

read-grants-execute

NO REST EQUIVALENT

restrict-anonymous

security.restrict_anonymous

shadowcopy-dir-depth

NO REST EQUIVALENT

smb1-max-buffer-size

NO REST EQUIVALENT

widelink-as-reparse-point-versions

widelink_reparse_versions

win-name-for-null-user

null_user_windows_name

wins-servers

netbios.wins_servers

cifs-password-change

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

cifs-password-reset

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

cifs-preferred-dc-check-get-iter

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

cifs-privilege-add-privilege

POST /api/protocols/cifs/users-and-groups/privileges vicon.png

ONTAPI attribute

REST attribute

Comment

privileges

privileges

user-or-group-name

name

cifs-privilege-get-iter

GET /api/protocols/cifs/users-and-groups/privileges vicon.png

ONTAPI attribute

REST attribute

Comment

privileges

privileges

user-or-group-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-privilege-remove-privilege

PATCH /api/protocols/cifs/users-and-groups/privileges/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

privileges

privileges

Specified privileges will replace all the existing privileges associated with the user or group.

user-or-group-name

name

cifs-privilege-reset-privilege

To reset privileges associated with the user or group, specify the privileges list as empty in REST.

PATCH /api/protocols/cifs/users-and-groups/privileges/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

user-or-group-name

name

cifs-security-get-iter

GET /api/protocols/cifs/services vicon.png

ONTAPI attribute

REST attribute

Comment

encryption-required-for-dc-connections

security.encrypt_dc_connection

is-aes-encryption-enabled

security.kdc_encryption

is-password-complexity-required

NO REST EQUIVALENT

is-signing-required

security.smb_signing

is-smb-encryption-required

security.smb_encryption

kerberos-clock-skew

NO REST EQUIVALENT

kerberos-kdc-timeout

NO REST EQUIVALENT

kerberos-renew-age

NO REST EQUIVALENT

kerberos-ticket-age

NO REST EQUIVALENT

lm-compatibility-level

security.lm_compatibility_level

referral-enabled-for-ad-ldap

security.ldap_referral_enabled

session-security-for-ad-ldap

session_security

smb1-enabled-for-dc-connections

NO REST EQUIVALENT

smb2-enabled-for-dc-connections

NO REST EQUIVALENT

use-ldaps-for-ad-ldap

use_ldaps

use-start-tls-for-ad-ldap

use_start_tls

aes_enabled_for_netlogon_channel

security.aes_netlogon_enabled

try_channel_binding_for_ad_ldap

security.try_ldap_channel_binding

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-security-modify

PATCH /api/protocols/cifs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

admin-password

NO REST EQUIVALENT

admin-username

NO REST EQUIVALENT

encryption-required-for-dc-connections

security.encrypt_dc_connection

is-aes-encryption-enabled

security.kdc_encryption

is-password-complexity-required

NO REST EQUIVALENT

is-signing-required

security.smb_signing

is-smb-encryption-required

security.smb_encryption

kerberos-clock-skew

NO REST EQUIVALENT

kerberos-kdc-timeout

NO REST EQUIVALENT

kerberos-renew-age

NO REST EQUIVALENT

kerberos-ticket-age

NO REST EQUIVALENT

lm-compatibility-level

NO REST EQUIVALENT

referral-enabled-for-ad-ldap

security.ldap_referral_enabled

session-security-for-ad-ldap

session_security

smb1-enabled-for-dc-connections

NO REST EQUIVALENT

smb2-enabled-for-dc-connections

NO REST EQUIVALENT

use-ldaps-for-ad-ldap

use_ldaps

use-start-tls-for-ad-ldap

use_start_tls

aes_enabled_for_netlogon_channel

security.aes_netlogon_enabled

try_channel_binding_for_ad_ldap

security.try_ldap_channel_binding

cifs-server-add-netbios-aliases

PATCH /api/protocols/cifs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

netbios-aliases

netbios.aliases

cifs-server-create

POST /api/protocols/cifs/services vicon.png

ONTAPI attribute

REST attribute

Comment

admin-password

ad_domain.password

admin-username

ad_domain.user

administrative-status

enabled

cifs-server

name

comment

comment

default-site

NO REST EQUIVALENT

domain

ad_domain.fqdn

force-account-overwrite

force

keytab-uri

NO REST EQUIVALENT

netbios-aliases

netbios.aliases

organizational-unit

ad_domain.organizational_unit

realm

NO REST EQUIVALENT

workgroup

NO REST EQUIVALENT

cifs-server-delete

DELETE /api/protocols/cifs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

admin-password

ad_domain.password

admin-username

ad_domain.user

force-account-delete

force

keytab-uri

NO REST EQUIVALENT

cifs-server-get-iter

GET /api/protocols/cifs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

administrative-status

enabled

auth-style

NO REST EQUIVALENT

cifs-server

name

comment

comment

default-site

NO REST EQUIVALENT

domain

ad_domain.fqdn

domain-workgroup

NO REST EQUIVALENT

netbios-aliases

netbios.aliases

organizational-unit

ad_domain.organizational_unit

realm

NO REST EQUIVALENT

vserver

svm.name

workgroup

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-server-modify

PATCH /api/protocols/cifs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

admin-password

ad_domain.password

admin-username

ad_domain.user

administrative-status

NO REST EQUIVALENT

cifs-server

name

comment

comment

default-site

NO REST EQUIVALENT

domain

ad_domain.fqdn

force-account-overwrite

force

keytab-uri

NO REST EQUIVALENT

ou

ad_domain.organizational_unit

workgroup

NO REST EQUIVALENT

cifs-server-remove-netbios-aliases

PATCH /api/protocols/cifs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

netbios-aliases

netbios.aliases

cifs-server-repair-modify

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

cifs-server-start

Set the "enabled" field to perform the operation.

PATCH /api/protocols/cifs/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

cifs-server-stop

Set the "enabled" field to perform the operation.

PATCH /api/protocols/cifs/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

cifs-session-close

DELETE /api/protocols/cifs/sessions/{node.uuid}/{svm.uuid}/{identifier}/{connection_id} vicon.png

ONTAPI attribute

REST attribute

Comment

address

client_ip

auth-mechanism

authentication

connected-time

connected_duration

connection-count

connection_count

connection-id

connection_id

continuously-available

continuous_availability

files

open_files

idle-time

idle_duration

is-large-mtu-enabled

large_mtu

is-session-signed

smb_signing

lif-address

server_ip

netbios-name

NO REST EQUIVALENT

node

node.name

other

open_other

protocol-version

protocol

session-id

identifier

shares

open_shares

smb-encryption-status

smb_encryption

unix-user

mapped_unix_user

user-type

NO REST EQUIVALENT

vserver

svm.name

win-unix-creds

NO REST EQUIVALENT

windows-user

user

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-session-file-close

DELETE /api/protocols/cifs/session/files/{node.uuid}/{svm.uuid}/{identifier}/{connection.identifier}/{session.identifier} vicon.png

ONTAPI attribute

REST attribute

Comment

connection-id

connection.identifier

file-id

identifier

node

node.name

session-id

session.identifier

cifs-session-file-get-iter

GET /api/protocols/cifs/session/files vicon.png

ONTAPI attribute

REST attribute

Comment

connection-count

connection.count

connection-id

connection.identifier

continuously-available

continuously_available

file-id

identifier

file-type

type

flexgroup-msid

NO REST EQUIVALENT

hosting-aggregate

NO REST EQUIVALENT

hosting-volume

volume.name

node

node.name

open-mode

open_mode

path

path

range-locks

range_lock_count

reconnected

NO REST EQUIVALENT

session-id

session.identifier

share

share.name

share-mode

share.mode

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-session-get-iter

GET /api/protocols/cifs/sessions vicon.png

ONTAPI attribute

REST attribute

Comment

address

client_ip

auth-mechanism

authentication

connected-time

connected_duration

connection-count

connection_count

connection-id

connection_id

continuously-available

continuous_availability

files

open_files

idle-time

idle_duration

is-large-mtu-enabled

large_mtu

is-session-signed

smb_signing

lif-address

server_ip

netbios-name

NO REST EQUIVALENT

node

node.name

other

open_other

protocol-version

protocol

session-id

identifier

shares

open_shares

smb-encryption-status

smb_encryption

unix-user

mapped_unix_user

user-type

NO REST EQUIVALENT

vserver

svm.name

win-unix-creds

NO REST EQUIVALENT

windows-user

user

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-shadowcopy-add-files

PATCH /api/protocols/cifs/shadow-copies/{client_uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

client-shadow-copy-id

client_uuid

files

files

cifs-shadowcopy-ems-get-iter

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

cifs-shadowcopy-keep-snapshot

PATCH /api/protocols/cifs/shadowcopy-sets/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

storage-shadow-copy-set-id

uuid

cifs-shadowcopy-restore-dir

PATCH /api/protocols/cifs/shadow-copies vicon.png

ONTAPI attribute

REST attribute

Comment

dst-dir

destination_dir

src-dir

source_dir

volume

volume

with-content

with_content

cifs-share-access-control-create

POST /api/protocols/cifs/shares/{svm.uuid}/{share}/acls vicon.png

ONTAPI attribute

REST attribute

Comment

permission

permission

return-record

return_records

share

share

user-group-type

type

user-or-group

user_or_group

winsid

NO REST EQUIVALENT

cifs-share-access-control-delete

DELETE /api/protocols/cifs/shares/{svm.uuid}/{share}/acls/{user_or_group}/{type} vicon.png

ONTAPI attribute

REST attribute

Comment

share

share

user-group-type

type

user-or-group

user_or_group

cifs-share-access-control-get-iter

GET /api/protocols/cifs/shares/{svm.uuid}/{share}/acls vicon.png

ONTAPI attribute

REST attribute

Comment

permission

permission

share

share

user-group-type

type

user-or-group

user_or_group

vserver

NO REST EQUIVALENT

winsid

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-share-access-control-modify

PATCH /api/protocols/cifs/shares/{svm.uuid}/{share}/acls/{user_or_group}/{type} vicon.png

ONTAPI attribute

REST attribute

Comment

permission

permission

share

share

user-group-type

type

user-or-group

user_or_group

winsid

NO REST EQUIVALENT

cifs-share-create

POST /api/protocols/cifs/shares vicon.png

ONTAPI attribute

REST attribute

Comment

attribute-cache-ttl

NO REST EQUIVALENT

comment

comment

dir-umask

dir_umask

file-umask

file_umask

force-group-for-create

force_group_for_create

is-path-validation-enabled

NO REST EQUIVALENT

max-connections-per-share

NO REST EQUIVALENT

offline-files-mode

offline_files

path

path

return-record

NO REST EQUIVALENT

share-name

name

share-properties

NO REST EQUIVALENT

Share-properties are separate fields in the REST API. You can achieve this functionality by setting the fields "access_based_enumeration", "change_notify", "encryption", "home_directory", "oplocks", "show_snapshot", "continuously_available" and "namespace_caching".

symlink-properties

unix_symlink

vscan-fileop-profile

vscan_profile

cifs-share-delete

DELETE /api/protocols/cifs/shares/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

share-name

name

cifs-share-get-iter

GET /api/protocols/cifs/shares vicon.png

ONTAPI attribute

REST attribute

Comment

acl

acls

attribute-cache-ttl

NO REST EQUIVALENT

cifs-server

NO REST EQUIVALENT

comment

comment

dir-umask

dir_umask

file-umask

file_umask

force-group-for-create

force_group_for_create

max-connections-per-share

NO REST EQUIVALENT

offline-files-mode

offline_files

path

path

share-name

name

share-properties

NO REST EQUIVALENT

symlink-properties

unix_symlink

volume

volume.name

vscan-fileop-profile

vscan_profile

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-share-modify

PATCH /api/protocols/cifs/shares/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

attribute-cache-ttl

NO REST EQUIVALENT

comment

comment

dir-umask

dir_umask

file-umask

file_umask

force-group-for-create

force_group_for_create

is-path-validation-enabled

NO REST EQUIVALENT

max-connections-per-share

NO REST EQUIVALENT

offline-files-mode

offline_files

path

path

share-name

name

share-properties

NO REST EQUIVALENT

Share-properties are separate fields in the REST API. You can achieve this functionality by setting the fields "access_based_enumeration", "change_notify", "encryption", "home_directory", "oplocks", "show_snapshot", "continuously_available" and "namespace_caching".

symlink-properties

unix_symlink

vscan-fileop-profile

vscan_profile

POST /api/protocols/cifs/unix-symlink-mapping vicon.png

ONTAPI attribute

REST attribute

Comment

cifs-path

target.path

cifs-server

target.server

home-directory

target.home_directory

locality

target.locality

return-record

NO REST EQUIVALENT

share-name

target.share

unix-path

target.path

DELETE /api/protocols/cifs/unix-symlink-mapping/{svm.uuid}/{unix_path} vicon.png

ONTAPI attribute

REST attribute

Comment

unix-path

unix_path

GET /api/protocols/cifs/unix-symlink-mapping vicon.png

ONTAPI attribute

REST attribute

Comment

cifs-path

target.path

cifs-server

target.server

home-directory

target.home_directory

locality

target.locality

share-name

target.share

unix-path

unix_path

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

PATCH /api/protocols/cifs/unix-symlink-mapping/{svm.uuid}/{unix_path} vicon.png

ONTAPI attribute

REST attribute

Comment

cifs-path

target.path

cifs-server

target.server

home-directory

target.home_directory

locality

target.locality

share-name

target.share

unix-path

unix_path

cifs-user-home-directory-path-get

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

cifs-user-home-directory-path-get-iter

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

cifs-users-and-group-local-group-members-get-iter

The local group members can also be retrieved using REST API: /api/protocols/cifs/local-groups.

GET /api/protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

NO REST EQUIVALENT

The local group is identified using the SID attribute. This field is not required in REST API.

member

records.name

This is an advanced privilege field in REST API: /api/protocols/cifs/local-groups.

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-users-and-group-local-user-membership-get-iter

This API is merged with cifs-local-user-get-iter in REST API.

GET /api/protocols/cifs/local-users vicon.png

ONTAPI attribute

REST attribute

Comment

membership

membership

This is an advanced privilege field in the REST API.

user-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

cifs-users-and-groups-delete-cifs-lug

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

cifs-users-and-groups-get-import-status

GET /api/protocols/cifs/users-and-groups/bulk-import/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

uri

status_uri.path

uri-password

status_uri.password

uri-username

status_uri.username

operation-status

state

detailed-operation-status

detailed_status.message

num-elements-ignored

elements_ignored

num-elements-ok

elements_imported

cifs-users-and-groups-load-from-uri

POST /api/protocols/cifs/users-and-groups/bulk-import/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

append

NO REST EQUIVALENT

By default append is true so all existing contents are replaced.

file-password

decryption_password

uri

import_uri.path

uri-password

import_uri.password

uri-username

import_uri.username

volume-charmap-get

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

volume-charmap-set

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

cifs-stop-on-target

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

cifs-start-on-target

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

Category: CLOCK

clock-get-clock

The current or "wall clock" time of the node in ISO-8601 date, time, and time zone format.
The ISO-8601 date and time are localized based on the ONTAP cluster’s timezone setting.

GET /api/cluster/nodes?fields=date vicon.png

ONTAPI attribute

REST attribute

Comment

is-compliance-clock

NO REST EQUIVALENT

Use the REST API resource /api/storage/snaplock/compliance-clock to manage the ComplianceClock of the system.

clock-get-timezone

GET /api/cluster?fields=timezone vicon.png

ONTAPI attribute

REST attribute

Comment

timezone

timezone.name

timezone-UTC

NO REST EQUIVALENT

timezone-version

NO REST EQUIVALENT

The timezone version information can be retrieved using the CLI "cluster date zoneinfo show" command.

Category: CLONE

clone-autodelete

The REST API uses LUN UUID in the URL.

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

clone-path

name

enable

enabled

force

NO REST EQUIVALENT

volume

location.volume.name

clone-autodelete-status

The REST API uses LUN UUID in the URL.

GET /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

clone-path

NO REST EQUIVALENT

The response is based on the LUN UUID only.

clone-create

POST /api/storage/file/clone vicon.png

ONTAPI attribute

REST attribute

Comment

autodelete

autodelete

block-ranges

range

bypass-license-check

NO REST EQUIVALENT

bypass-throttle

NO REST EQUIVALENT

destination-exists

overwrite_destination

destination-path

destination_path

destination-volume

NO REST EQUIVALENT

fixed-block-count

NO REST EQUIVALENT

ignore-locks

NO REST EQUIVALENT

ignore-streams

NO REST EQUIVALENT

is-backup

is_backup

is-fixed-block-count

NO REST EQUIVALENT

is-vvol-backup

NO REST EQUIVALENT

lun-serial-number

NO REST EQUIVALENT

nosplit-entry

NO REST EQUIVALENT

qos-adaptive-policy-group-name

NO REST EQUIVALENT

qos-policy-group-name

NO REST EQUIVALENT

snapshot-name

NO REST EQUIVALENT

source-path

source_path

space-reserve

NO REST EQUIVALENT

token-uuid

token-uuid

volume

volume.name

clone-deletion-add-extension

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

clone-deletion-get-iter

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

clone-deletion-minimum-size

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

clone-deletion-remove-extension

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

clone-split-enable

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

clone-split-load-get-iter

GET /api/storage/file/clone/split-loads vicon.png

ONTAPI attribute

REST attribute

Comment

available-split-load

load.allowable

current-split-load

load.current

max-split-load

load.maximum

node

node.name

token-reserved-load

load.token_reserved

max-records

max_records

Specifies the maximum number of records to return before paging.

clone-split-load-get

GET /api/storage/file/clone/split-loads/{node.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

available-split-load

load.allowable

current-split-load

load.current

max-split-load

load.maximum

node

node.name

token-reserved-load

load.token_reserved

max-records

max_records

Specifies the maximum number of records to return before paging.

clone-split-load-modify

PATCH /api/storage/file/clone/split-loads/{node.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

max-split-load

load.maximum

Maximum file clone split load allowed on a node.

node

node.name

Node name

clone-split-status

REST API takes volume UUID as input

GET /api/storage/file/clone/split-status/{volume.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume-name

volume.name

clone-split-status-iter

REST API takes volume UUID as input

GET /api/storage/file/clone/split-status vicon.png

ONTAPI attribute

REST attribute

Comment

volume-name

volume.name

clone-token-create

POST /api/storage/file/clone/tokens vicon.png

ONTAPI attribute

REST attribute

Comment

expiry-limit

expiry-time.limit

node

node.name

reserve-size

reserve-size

clone-token-delete

DELETE /api/storage/file/clone/tokens/{node.uuid}/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

node

node.name

token-uuid

uuid

clone-token-get

GET /api/storage/file/clone/tokens/{node.uuid}/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

node

node.uuid

token-uuid

uuid

clone-token-get-iter

GET /api/storage/file/clone/tokens vicon.png

ONTAPI attribute

REST attribute

Comment

expiry-limit

expiry-time.limit

node

node.name

reserve-size

reserve-size

time-left

expiry-time.left

token-uuid

uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

clone-token-modify-expiry-limit

PATCH /api/storage/file/clone/tokens/{node.uuid}/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

node

node.name

reservation-duration-limit

expiry-time.limit

token-uuid

uuid

Category: CLUSTER-IMAGE

cluster-image-get

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

current-version

nodes.version

date-installed

NO REST EQUIVALENT

cluster-image-get-download-progress

GET /api/cluster/software/download

ONTAPI attribute

REST attribute

Comment

progress-details

message

message holds details of all the cases including failure case

progress-status

state

state will have simplier values than progress-status

failure-reason

message

message will hold reason of failure only in case of package download failed or aborted.

cluster-image-get-iter

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

current-version

nodes.version

date-installed

NO REST EQUIVALENT

cluster-image-get-upgrade-plan

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

cluster-image-metrocluster-update-progress-info-get

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

completed-node-count

NO REST EQUIVALENT

dr-validation-reports

NO REST EQUIVALENT

intermediate-version

NO REST EQUIVALENT

is-two-stage-upgrade

NO REST EQUIVALENT

is-validation-done-by-update

NO REST EQUIVALENT

metrocluster

metrocluster.clusters

This attribute is specific to Two node Metrocluster Configuration

ndu-node-update-list

nodes

node-estimated-duration

update_details.estimated_duration

overall-elapsed-duration

elapsed_duration

overall-estimated-duration

estimated_duration

overall-status

state

package-version

pending_version

paused-node-count

NO REST EQUIVALENT

phase-comments

NO REST EQUIVALENT

progress-detail

metrocluster.progress_details

This attribute is specific to Two node Metrocluster Configuration

progress-summary

metrocluster.progress_summary

This attribute is specific to Two node Metrocluster Configuration

source-version

version

target-version

pending_version

total-node-count

NO REST EQUIVALENT

upgrade-stage

NO REST EQUIVALENT

validation-reports

update_check_list

cluster-image-node-update-progress-info

GET /api/cluster/software?status_details.node={node}

ONTAPI attribute

REST attribute

Comment

node-name

generic_status_details.node

node-update-task-info-list

generic_status_details

cluster-image-package-delete

DELETE /api/cluster/software/packages/{version}

ONTAPI attribute

REST attribute

Comment

package-version

version

cluster-image-package-download

POST /api/cluster/software/download

ONTAPI attribute

REST attribute

Comment

package-url

url

replace-package

NO REST EQUIVALENT

cluster-image-package-download-abort

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

cluster-image-package-local-get

GET /api/cluster/software/packages/{version}

ONTAPI attribute

REST attribute

Comment

package-build-time

create_time

package-details

NO REST EQUIVALENT

package-version

version

cluster-image-package-local-get-iter

GET /api/cluster/software/packages

ONTAPI attribute

REST attribute

Comment

package-build-time

create_time

package-details

NO REST EQUIVALENT

package-version

version

num-records

num_records

Specifies the maximum number of records to return before paging.

cluster-image-update

PATCH /api/cluster/software?stabilize_minutes={minutes}&skip_warnings={skip}

ONTAPI attribute

REST attribute

Comment

estimate-only

NO REST EQUIVALENT

force-rolling

NO REST EQUIVALENT

ignore-validation-warning

skip_warnings

nodes

NO REST EQUIVALENT

package-version

pending_version

pause-after

NO REST EQUIVALENT

stabilize-minutes

stabilize_minutes

cluster-image-update-cancel

PATCH /api/cluster/software?action=cancel

ONTAPI attribute

REST attribute

Comment

cluster-image-update-history-get-iter

GET /api/cluster/software/history

ONTAPI attribute

REST attribute

Comment

completion-time

end_time

component-id

node.name

component-name

NO REST EQUIVALENT

package-version

NO REST EQUIVALENT

previous-version

from_version

start-time

start_time

update-status

state

updated-version

to_version

num-records

num_records

Specifies the maximum number of records to return before paging.

cluster-image-update-log-get-iter

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

cluster-image-update-pause

PATCH /api/cluster/software?action=pause

ONTAPI attribute

REST attribute

Comment

cluster-image-update-progress-get-iter

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

duration

update_details.elapsed_duration

ndu-phase

update_details.phase

phase-comments

NO REST EQUIVALENT

If an error has occurred, this attribute describes the required recovery action. If the phase is completed, it provides the duration of the phase.

phase-status

update_details.state

num-records

num_records

Specifies the maximum number of records to return before paging.

cluster-image-update-progress-info

The REST API GET method contains some of this information, but not all, and not in the desired format.

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

completed-node-count

NO REST EQUIVALENT

intermediate-version

NO REST EQUIVALENT

is-two-stage-upgrade

NO REST EQUIVALENT

is-validation-done-by-update

NO REST EQUIVALENT

node-name

update_details.node.name

node-status

update_details.state

node-estimated-duration

update_details.estimated_duration

overall-elapsed-duration

elapsed_duration

overall-estimated-duration

estimated_duration

overall-status

state

package-version

pending_version

paused-node-count

NO REST EQUIVALENT

phase-comments

NO REST EQUIVALENT

source-version

NO REST EQUIVALENT

target-version

NO REST EQUIVALENT

total-node-count

NO REST EQUIVALENT

upgrade-stage

NO REST EQUIVALENT

validation-reports

update_check_list

cluster-image-update-resume

PATCH /api/cluster/software?action=resume

ONTAPI attribute

REST attribute

Comment

cluster-image-validate

PATCH /api/cluster/software?validate_only=true

ONTAPI attribute

REST attribute

Comment

nodes

NO REST EQUIVALENT

package-version

pending_version

cluster-image-validate

To GET below attributes values PATCH "api/cluster/software?validate=true" is required at first

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

ndu-check

update_check_list.update_check

ndu-status

update_check_list.status

error

update_check_list.issue.message

action

NO REST EQUIVALENT

Not a ui attribute

advice

update_check_list.action.message

Category: CLUSTER-PEER

cluster-peer-active-address-insert

PATCH /api/cluster/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

active-address

remote.ip_addresses

cluster-name

name

cluster-peer-active-addresses-get

GET /api/cluster/peers

ONTAPI attribute

REST attribute

Comment

cluster-name

name

peer-addresses

remote.ip_addresses

cluster-peer-active-addresses-register

This is an unsupported ONTAPI operation.

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

cluster-peer-authn-offer-cancel

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

cluster-peer-authn-offer-get

GET /api/cluster/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

encryption-protocol-proposed

encryption.proposed

initial-allowed-vserver-peers

initial_allowed_svms

offer-creation

NO REST EQUIVALENT

offer-expiration

authentication.expiry_time

peer-cluster-name

name

peer-cluster-uuid

uuid

cluster-peer-authn-offer-get-iter

GET /api/cluster/peers

ONTAPI attribute

REST attribute

Comment

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

encryption-protocol-proposed

encryption.proposed

initial-allowed-vserver-peers

initial_allowed_svms

offer-creation

NO REST EQUIVALENT

offer-expiration

authentication.expiry_time

peer-cluster-name

name

peer-cluster-uuid

uuid

max-records

max_records

Specifies the maximum number of records to return before paging

cluster-peer-authn-offer-modify

PATCH /api/cluster/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

initial-allowed-vserver-peers

initial_allowed_svms

offer-expiration

authentication.expiry_time

peer-cluster-name

name

cluster-peer-connection-destroy

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

cluster-peer-connections-get

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

cluster-peer-connections-get-iter

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

cluster-peer-create

POST /api/cluster/peers

ONTAPI attribute

REST attribute

Comment

address-family

NO REST EQUIVALENT

applications

peer_applications

encryption-protocol-proposed

encryption.proposed

generate-passphrase

authentication.generate_passphrase

initial-allowed-vserver-peers

initial_allowed_svms

ipspace-name

ipspace.name

local-name

remote.name

offer-expiration

authentication.expiry_time

passphrase

authentication.passphrase

password

NO REST EQUIVALENT

peer-addresses

remote.ip_addresses

rpc-connect-timeout

NO REST EQUIVALENT

timeout

NO REST EQUIVALENT

update-ping-timeout

NO REST EQUIVALENT

user-name

NO REST EQUIVALENT

cluster-peer-delete

DELETE /api/cluster/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

cluster-name

NO REST EQUIVALENT

cluster-peer-get

GET /api/cluster/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

cluster-name

name

active-addresses

remote.ip_addresses

address-family

NO REST EQUIVALENT

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

availability

status.state

cluster-uuid

uuid

encryption-protocol

encryption.state

encryption-protocol-proposed

encryption.proposed

ipspace-name

ipspace.name

is-cluster-healthy

NO REST EQUIVALENT

last-updated

status.update_time

peer-addresses

remote.ip_addresses

psk-algorithm

NO REST EQUIVALENT

remote-cluster-name

remote.name

remote-cluster-nodes

NO REST EQUIVALENT

rpc-connect-timeout

NO REST EQUIVALENT

serial-number

remote.serial_number

timeout

NO REST EQUIVALENT

unreachable-local-nodes

NO REST EQUIVALENT

update-ping-timeout

NO REST EQUIVALENT

cluster-peer-get-iter

GET /api/cluster/peers

ONTAPI attribute

REST attribute

Comment

active-addresses

remote.ip_addresses

address-family

NO REST EQUIVALENT

auth-status-admin

authentication.in_use

auth-status-operational

authentication.state

availability

status.state

cluster-name

name

cluster-uuid

uuid

encryption-protocol

encryption.state

encryption-protocol-proposed

encryption.proposed

ipspace-name

ipspace.name

is-cluster-healthy

NO REST EQUIVALENT

last-updated

status.update_time

peer-addresses

remote.ip_addresses

psk-algorithm

NO REST EQUIVALENT

remote-cluster-name

remote.name

remote-cluster-nodes

NO REST EQUIVALENT

rpc-connect-timeout

NO REST EQUIVALENT

serial-number

remote.serial_number

timeout

NO REST EQUIVALENT

unreachable-local-nodes

NO REST EQUIVALENT

update-ping-timeout

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-peer-health-info-get

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

cluster-peer-health-info-get-iter

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

cluster-peer-modify

PATCH /api/cluster/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

address-family

NO REST EQUIVALENT

auth-status-admin

authentication.in_use

cluster-name

name

encryption-protocol-proposed

encryption.proposed

generate-passphrase

authentication.generate_passphrase

ipspace-name

ipspace.name

offer-expiration

authentication.expiry_time

passphrase

authentication.passphrase

peer-addresses

remote.ip_addresses

rpc-connect-timeout

NO REST EQUIVALENT

timeout

NO REST EQUIVALENT

update-ping-timeout

NO REST EQUIVALENT

cluster-peer-modify-local-name

PATCH /api/cluster/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

cluster-name

NO REST EQUIVALENT

new-name

name

cluster-peer-ping-iter

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

cluster-peer-policy-get

GET /api/cluster

ONTAPI attribute

REST attribute

Comment

is-unauthenticated-access-permitted

peering_policy.authentication_required

is-unencrypted-access-permitted

peering_policy.encryption_required

passphrase-minimum-length

peering_policy.minimum_passphrase_length

cluster-peer-policy-modify

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

cluster-peer-stable-addresses-get

This is an unsupported ONTAPI operation.

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

Category: CLUSTER-SWITCH

cluster-switch-configure-health-monitor

Alternatively, the SHM configuration file can be uploaded to the cluster with a POST request on /api/cluster/software/upload.

POST /api/cluster/software/download

ONTAPI attribute

REST attribute

Comment

node

NO REST EQUIVALENT

The SHM configuration file is downloaded on all nodes in the cluster.

package-url

url

cluster-switch-create

POST /api/network/ethernet/switches

ONTAPI attribute

REST attribute

Comment

address

address

community-or-username

snmp.user

device

name

is-monitoring-enabled-admin

monitoring.enabled

model

model

snmp-version

snmp.version

type

network

cluster-switch-delete

DELETE /api/network/ethernet/switches/{name}

ONTAPI attribute

REST attribute

Comment

device

name

force

NO REST EQUIVALENT

cluster-switch-get-iter

GET /api/network/ethernet/switches

ONTAPI attribute

REST attribute

Comment

address

address

device

name

is-monitoring-enabled-operational

monitoring.monitored

model

model

node

NO REST EQUIVALENT

reason

monitoring.reason

serial-number

serial_number

sw-version

version

type

network

version-source

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-switch-modify

PATCH /api/network/ethernet/switches/{name}

ONTAPI attribute

REST attribute

Comment

address

address

community-or-username

snmp.user

device

NO REST EQUIVALENT

is-monitoring-enabled-admin

monitoring.enabled

model

NO REST EQUIVALENT

snmp-version

snmp.version

type

NO REST EQUIVALENT

cluster-switch-poll-get

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

cluster-switch-poll-modify

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

Category: CLUSTER

cluster-add-node

Many of the ONTAPI attributes are parallel lists of values. For the REST API, the input is a list of node objects, so each individual attribute is singular.

POST /api/cluster/nodes

ONTAPI attribute

REST attribute

Comment

cluster-ips

cluster_interface.ip.address

discovery-timeout

NO REST EQUIVALENT

Sending a GET on /api/cluster/nodes?return_timeout=n when in precluster mode will look for nodes for up to n seconds.

node-count

NO REST EQUIVALENT

The node count is implicit by the number of node objects that are passed to the endpoint.

node-ip

management_interface.ip.address

node-names

name

node-uuids

NO REST EQUIVALENT

uuid is not a POSTable field

retry

NO REST EQUIVALENT

cluster-add-node-status-get-iter

You can track the node add job at the job URL returned by the POST /api/cluster/nodes call.

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

cluster-application-record-create

POST /api/private/cluster/notes vicon.png

ONTAPI attribute

REST attribute

Comment

record-name

name

record-value

value

return-record

return_records

vserver

owner.name

cluster-application-record-delete

DELETE /api/private/cluster/notes/{owner.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

record-name

name

vserver

owner.uuid

cluster-application-record-delete-iter

Specify at least one field in the query.

DELETE /api/private/cluster/notes vicon.png

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.name

Can also use owner.uuid

return-failure-list

NO REST EQUIVALENT

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

return-success-list

NO REST EQUIVALENT

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

cluster-application-record-get-iter

GET /api/private/cluster/notes vicon.png

ONTAPI attribute

REST attribute

Comment

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.name

Can also use owner.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-application-record-modify

PATCH /api/private/cluster/notes/{owner.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

record-name

name

record-value

value

vserver

owner.uuid

cluster-application-record-modify-iter

PATCH /api/private/cluster/notes vicon.png

ONTAPI attribute

REST attribute

Comment

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.uuid

continue-on-failure

continue_on_failure

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

last-modified-timestamp

modified_time

modified-from

modified_from

record-name

name

record-value

value

vserver

owner.name

Can also use owner.uuid

return-failure-list

NO REST EQUIVALENT

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

return-success-list

NO REST EQUIVALENT

The REST API call returns a list of all jobs executed. You can examine each job record for details of success or failure.

cluster-contact-get

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

cluster-contact-modify

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

cluster-create

POST /api/cluster

ONTAPI attribute

REST attribute

Comment

cluster-ips

nodes.cluster_interface.ip.address

cluster-name

name

discovery-timeout

NO REST EQUIVALENT

keep-precluster-cert

NO REST EQUIVALENT

license

license.keys

node-count

nodes

node-names

nodes.name

node-uuids

NO REST EQUIVALENT

retry

NO REST EQUIVALENT

single-node-cluster

single_node_cluster

single_node_cluster is a query parameter

cluster-create-join-progress-get

You can track the cluster create job at the job URL returned by the POST /api/cluster call.

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

cluster-ha-get

GET /api/cluster

ONTAPI attribute

REST attribute

Comment

ha-configured

nodes.ha.enabled

cluster-ha-modify

This is an unsupported ONTAPI operation.

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

cluster-identity-get

GET /api/cluster

ONTAPI attribute

REST attribute

Comment

cluster-contact

contact

cluster-location

location

cluster-name

name

cluster-serial-number

NO REST EQUIVALENT

cluster-uuid

uuid

rdb-uuid

NO REST EQUIVALENT

cluster-identity-modify

PATCH /api/cluster

ONTAPI attribute

REST attribute

Comment

cluster-contact

contact

cluster-location

location

cluster-name

name

cluster-join

POST /api/cluster/nodes

ONTAPI attribute

REST attribute

Comment

cluster-ip-address

cluster_interface.ip.address

cluster-name

NO REST EQUIVALENT

cluster-log-forward-create

POST /api/security/audit/destinations

ONTAPI attribute

REST attribute

Comment

destination

address

facility

facility

force

force

force is a query parameter

port

port

protocol

protocol

return-record

return_records

verify-server

verify_server

cluster-log-forward-destroy

DELETE /api/security/audit/destinations/{address}/{port}

ONTAPI attribute

REST attribute

Comment

destination

address

port

port

cluster-log-forward-get

GET /api/security/audit/destinations/{address}/{port}

ONTAPI attribute

REST attribute

Comment

destination

address

facility

facility

force

NO REST EQUIVALENT

port

port

protocol

protocol

verify-server

verify_server

cluster-log-forward-get-iter

GET /api/security/audit/destinations

ONTAPI attribute

REST attribute

Comment

destination

address

facility

facility

force

NO REST EQUIVALENT

port

port

protocol

protocol

verify-server

verify_server

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-log-forward-modify

PATCH /api/security/audit/destinations/{address}/{port}

ONTAPI attribute

REST attribute

Comment

destination

address

facility

facility

port

port

verify-server

verify_server

cluster-log-forward-statistics-get

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

cluster-log-forward-statistics-get-iter

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

cluster-node-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

is-node-eligible

NO REST EQUIVALENT

is-node-epsilon

NO REST EQUIVALENT

is-node-healthy

state

Specifies the health of the node. In the REST API, the node is healthy if the state is "up". If the state is "booting", the node might still indicate "up" state after it has booted.

node-name

name

node-uuid

uuid

cluster-node-get-iter

GET /api/cluster/nodes

ONTAPI attribute

REST attribute

Comment

is-node-eligible

NO REST EQUIVALENT

is-node-epsilon

NO REST EQUIVALENT

is-node-healthy

state

node-name

name

node-uuid

uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

cluster-node-modify

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

is-node-eligible

NO REST EQUIVALENT

is-node-epsilon

NO REST EQUIVALENT

node-name

name

skip-quorum-check-before-eligible

allow_data_outage

skip-quorum-check-before-ineligible

allow_data_outage

cluster-remove-node

DELETE /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

cluster-ip

cluster_interface.ip.address

force

force

node

name

node-uuid

uuid

skip-epsilon-transition-before-unjoin

NO REST EQUIVALENT

Always false in REST API.

skip-last-low-version-node-check

NO REST EQUIVALENT

Always true in REST API.

skip-quorum-check-before-unjoin

NO REST EQUIVALENT

Always false in REST API.

cluster-unjoin

DELETE /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

force

force

node

uuid

skip-quorum-check-before-unjoin

NO REST EQUIVALENT

Always false in REST API.

cluster-zoneinfo-get

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

cluster-zoneinfo-load-from-uri

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

Category: CONFIG-BACKUP

config-backup-copy

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

config-backup-create

POST /api/support/configuration-backup/backups

ONTAPI attribute

REST attribute

Comment

backup-name

name

backup-type

NO REST EQUIVALENT

backup-type is not a POSTable field. Defaults to "cluster" backup.

node

node.name

config-backup-delete

DELETE /api/support/configuration-backup/backups/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

backup-name

name

node

node.uuid

config-backup-download

Direct download of backup files is supported by using the "download_link" property of the REST API response for the /api/support/configuration-backup/backups/{node.uuid}/{name} endpoint

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

config-backup-info-get

GET /api/support/configuration-backup/backups/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

backup-name

name

backup-creation-time

time

backup-size

size

backup-type

type

cluster-name

NO REST EQUIVALENT

cluster-uuid

NO REST EQUIVALENT

is-auto

auto

node

node.name

nodes-in-backup

backup_nodes

schedule

NO REST EQUIVALENT

version

version

config-backup-info-get-iter

Specify at least one field in the query.

GET /api/support/configuration-backup/backups

ONTAPI attribute

REST attribute

Comment

backup-creation-time

time

backup-name

name

backup-size

size

backup-type

type

cluster-name

NO REST EQUIVALENT

cluster-uuid

NO REST EQUIVALENT

is-auto

auto

node

node.name

nodes-in-backup

backup_nodes.name

schedule

NO REST EQUIVALENT

version

version

max-records

max_records

Specifies the maximum number of records to return before paging.

config-backup-rename

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

config-backup-settings-get

GET /api/support/configuration-backup

ONTAPI attribute

REST attribute

Comment

backup-count1

NO REST EQUIVALENT

backup-count2

NO REST EQUIVALENT

backup-count3

NO REST EQUIVALENT

destination-url

url

job-schedule1

NO REST EQUIVALENT

job-schedule2

NO REST EQUIVALENT

job-schedule3

NO REST EQUIVALENT

username-for-destination-url

username

config-backup-settings-modify

PATCH /api/support/configuration-backup

ONTAPI attribute

REST attribute

Comment

backup-count1

NO REST EQUIVALENT

backup-count2

NO REST EQUIVALENT

backup-count3

NO REST EQUIVALENT

destination-url

url

username-for-destination-url

username

config-backup-settings-password-set

PATCH /api/support/configuration-backup

ONTAPI attribute

REST attribute

Comment

password-for-destination-url

password

config-backup-upload

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

Category: CORE-SEGMENT

core-segment-get

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

core-segment-get-iter

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

core-segment-destroy

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

core-segment-delete-all

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

Category: COREDUMP

coredump-config-get

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

coredump-config-get-iter

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

coredump-config-get-total-records

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

coredump-config-modify

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

coredump-config-modify-iter

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

coredump-delete-all

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

coredump-delete-core

DELETE /api/support/coredump/coredumps/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

core-id

NO REST EQUIVALENT

core-name

name

node-name

node.name

coredump-delete-core-iter

DELETE /api/support/coredump/coredumps

ONTAPI attribute

REST attribute

Comment

continue-on-failure

NO REST EQUIVALENT

max-failure-count

NO REST EQUIVALENT

max-records

NO REST EQUIVALENT

ancillary-segment-directory

NO REST EQUIVALENT

core-id

NO REST EQUIVALENT

core-name

name

is-partial

is_partial

is-saved

is_saved

md5-data-chksum

md5_data_checksum

node-name

node.name

panic-node

NO REST EQUIVALENT

panic-string

NO REST EQUIVALENT

panic-system-id

NO REST EQUIVALENT

panic-time

panic_time

save-attempts

NO REST EQUIVALENT

size

size

space-needed

NO REST EQUIVALENT

version

NO REST EQUIVALENT

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

coredump-get

GET /api/support/coredump/coredumps/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

core-id

NO REST EQUIVALENT

core-name

name

ancillary-segment-directory

NO REST EQUIVALENT

is-partial

is_partial

is-saved

is_saved

md5-data-chksum

md5_data_checksum

node-name

node.name

panic-node

NO REST EQUIVALENT

panic-string

NO REST EQUIVALENT

panic-system-id

NO REST EQUIVALENT

panic-time

panic_time

save-attempts

NO REST EQUIVALENT

size

size

space-needed

NO REST EQUIVALENT

version

NO REST EQUIVALENT

coredump-get-iter

GET /api/support/coredump/coredumps

ONTAPI attribute

REST attribute

Comment

ancillary-segment-directory

NO REST EQUIVALENT

core-id

NO REST EQUIVALENT

core-name

name

is-partial

is_partial

is-saved

is_saved

md5-data-chksum

md5_data_checksum

node-name

node.name

panic-node

NO REST EQUIVALENT

panic-string

NO REST EQUIVALENT

panic-system-id

NO REST EQUIVALENT

panic-time

panic_time

save-attempts

NO REST EQUIVALENT

size

size

space-needed

NO REST EQUIVALENT

version

NO REST EQUIVALENT

max-records

NO REST EQUIVALENT

coredump-get-total-records

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

coredump-save-all

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

coredump-save-core

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

coredump-save-core-iter

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

coredump-trigger

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

coredump-upload-core

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

Category: DASHBOARD

dashboard-alarm-get

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

dashboard-alarm-get-iter

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

dashboard-alarm-get-total-records

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

dashboard-alarm-threshold-get

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

dashboard-alarm-threshold-get-iter

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

dashboard-alarm-threshold-get-total-records

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

dashboard-alarm-threshold-modify

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

Category: DIAGNOSIS

diagnosis-alert-definition-get

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

diagnosis-alert-definition-get-iter

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

diagnosis-alert-get

GET /api/private/support/alerts

ONTAPI attribute

REST attribute

Comment

alert-id

name

alerting-resource

resource

acknowledge

acknowledge

acknowledger

acknowledger

additional-info

NO REST EQUIVALENT

alerting-resource-name

NO REST EQUIVALENT

corrective-actions

corrective_action.message

indication-time

time

monitor

monitor

node

node.name

perceived-severity

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

possible-effect

possible_effect.message

probable-cause

NO REST EQUIVALENT

probable-cause-description

cause.message

subsystem

NO REST EQUIVALENT

suppress

suppress

suppressor

suppressor

monitor

monitor

diagnosis-alert-get-iter

GET /api/private/support/alerts

ONTAPI attribute

REST attribute

Comment

alert-id

name

alerting-resource

resource

acknowledge

acknowledge

acknowledger

acknowledger

additional-info

NO REST EQUIVALENT

alerting-resource-name

NO REST EQUIVALENT

corrective-actions

corrective_action.message

indication-time

time

monitor

monitor

node

node.name

perceived-severity

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

possible-effect

possible_effect.message

probable-cause

NO REST EQUIVALENT

probable-cause-description

cause.message

subsystem

NO REST EQUIVALENT

suppress

suppress

suppressor

suppressor

monitor

monitor

max-records

max_records

Specifies the maximum number of records to return before paging.

diagnosis-alert-modify

PATCH /api/private/support/alerts/{node.uuid}/{monitor}/{name}/{resource}

ONTAPI attribute

REST attribute

Comment

acknowledge

acknowledge

acknowledger

acknowledger

alert-id

name

alerting-resource

resource

monitor

monitor

node

NO REST EQUIVALENT

suppress

suppress

suppressor

suppressor

diagnosis-config-get

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

diagnosis-config-get-iter

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

diagnosis-delete-alert

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

diagnosis-policy-definition-get

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

diagnosis-policy-definition-get-iter

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

diagnosis-policy-modify

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

diagnosis-status-get

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

diagnosis-subsystem-config-get

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

diagnosis-subsystem-config-get-iter

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

diagnosis-subsystem-config-modify

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

diagnosis-subscriptions-get

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

diagnosis-subscriptions-get-iter

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

diagnosis-subscriptions-create

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

diagnosis-subscriptions-modify

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

Category: DISK-ENCRYPT

disk-encrypt-get

GET /api/storage/disks/{name}

ONTAPI attribute

REST attribute

Comment

data-key-id

key_id.data

disk-name

name

fips-key-id

key_id.fips

is-fips-certified

fips_certified

is-sed

self_encrypting

protection-mode

protection_mode

type

type

disk-encrypt-get-iter

GET /api/storage/disks?self_encrypting=true

ONTAPI attribute

REST attribute

Comment

data-key-id

key_id.data

disk-name

name

fips-key-id

key_id.fips

is-fips-certified

fips_certified

is-sed

self_encrypting

protection-mode

protection_mode

type

type

max-records

max_records

Specifies the maximum number of records to return before paging.

disk-encrypt-modify

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

disk-encrypt-modify-iter

This REST API only supports modifying the data authentication key of all encrypting drives. You must supply the "encryption_operation query" parameter.

PATCH /api/storage/disks

ONTAPI attribute

REST attribute

Comment

continue-on-failure

NO REST EQUIVALENT

data-key-id

NO REST EQUIVALENT

Automatically generates in the REST API based on the encryption_operation query parameter.

fips-key-id

NO REST EQUIVALENT

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

disk-name

NO REST EQUIVALENT

is-fips-certified

NO REST EQUIVALENT

is-sed

NO REST EQUIVALENT

protection-mode

NO REST EQUIVALENT

type

NO REST EQUIVALENT

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

disk-encrypt-sanitize

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

disk-encrypt-sanitize-iter

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

disk-encrypt-status-get

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

disk-encrypt-status-get-iter

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

Category: DISK

disk-check-autopartition-state

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

disk-fail

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

disk-remove

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

disk-replace-start

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

disk-replace-stop

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

disk-sanown-assign

PATCH /api/storage/disks/{name}

ONTAPI attribute

REST attribute

Comment

all

NO REST EQUIVALENT

auto

NO REST EQUIVALENT

checksum

NO REST EQUIVALENT

copy-owner-from

NO REST EQUIVALENT

disk

NO REST EQUIVALENT

disk-count

NO REST EQUIVALENT

disk-type

NO REST EQUIVALENT

disklist

NO REST EQUIVALENT

force

NO REST EQUIVALENT

is-data-partition

NO REST EQUIVALENT

is-data1-partition

NO REST EQUIVALENT

is-data2-partition

NO REST EQUIVALENT

is-root-partition

NO REST EQUIVALENT

is-spatial-disk-name-format

NO REST EQUIVALENT

node-name

node.name

owner

NO REST EQUIVALENT

owner-id

NO REST EQUIVALENT

pool

NO REST EQUIVALENT

disk-sanown-filer-list-info

There is no direct counterpart in the REST API for this ONTAPI. Refer to the preceding REST API endpoint.

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

node

name

disk-sanown-list-info

This ONTAPI API is not supported as of Data ONTAP 8.3.

GET /api/storage/disks/{name}

ONTAPI attribute

REST attribute

Comment

disk

name

node

NO REST EQUIVALENT

ownership-type

NO REST EQUIVALENT

disk-sanown-reassign

PATCH /api/storage/disks/{name}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

new-owner-id

node.name

old-owner-id

NO REST EQUIVALENT

disk-sanown-remove-ownership

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

disk-unfail

PATCH /api/storage/disks/{name}

ONTAPI attribute

REST attribute

Comment

disk

name

make-spare

state

The REST API provides functionality for attempting to mark
a failed disk as a spare by patching the state field to "spare".
The node can try to salvage filesystem information on a failed disk,
if patching to "present".

disk-update-disk-fw

The REST API does not provide the exact functionality of this ONTAPI. Instead, you can download/upload the disk firmware to the cluster with the following:
- POST /cluster/software/upload
- POST /cluster/software/download
The firmware is installed non-disruptively in the background, instead of triggering the update with disk-update-disk-fw.

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

disk-zero-spares

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

disk-maint-start

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

disk-maint-abort

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

disk-maint-status

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

disk-maint-list

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

disk-mung

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

disk-filesys-usage-list-info

This API is deprecated starting from ONTAP 8.1.

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

Category: EMS

ems-autosupport-log

Use a POST operation with the following list of properties.

POST /api/support/ems/application-logs vicon.png

ONTAPI attribute

REST attribute

Comment

app-version

app_version

auto-support

autosupport_required

category

category

computer-name

computer_name

event-description

event_description

event-id

event_id

event-source

event_source

log-level

severity

ems-config-get

GET /api/support/ems

ONTAPI attribute

REST attribute

Comment

auto-suppress-exempt-filter

NO REST EQUIVALENT

console

NO REST EQUIVALENT

console-log-level

NO REST EQUIVALENT

duplicate-suppression-duration

NO REST EQUIVALENT

log-rotation-size

NO REST EQUIVALENT

mail-from

mail_from

mail-server

mail_server

max-destination-count

NO REST EQUIVALENT

max-filter-count

NO REST EQUIVALENT

max-filter-rule-count

NO REST EQUIVALENT

max-log-show-size

NO REST EQUIVALENT

max-notification-count

NO REST EQUIVALENT

max-target-event-bytes

NO REST EQUIVALENT

max-target-log-size

NO REST EQUIVALENT

proxy-url

proxy_url

proxy-user

proxy_user

rest-delivery-timeout

NO REST EQUIVALENT

suppression

NO REST EQUIVALENT

trace-log-size

NO REST EQUIVALENT

ems-config-modify

PATCH /api/support/ems

ONTAPI attribute

REST attribute

Comment

auto-suppress-exempt-filter

NO REST EQUIVALENT

console

NO REST EQUIVALENT

console-log-level

NO REST EQUIVALENT

duplicate-suppression-duration

NO REST EQUIVALENT

log-rotation-size

NO REST EQUIVALENT

mail-from

mail_from

mail-server

mail_server

max-destination-count

NO REST EQUIVALENT

max-filter-count

NO REST EQUIVALENT

max-filter-rule-count

NO REST EQUIVALENT

max-log-show-size

NO REST EQUIVALENT

max-notification-count

NO REST EQUIVALENT

max-target-event-bytes

NO REST EQUIVALENT

max-target-log-size

NO REST EQUIVALENT

proxy-url

proxy_url

proxy-user

proxy_user

rest-delivery-timeout

NO REST EQUIVALENT

suppression

NO REST EQUIVALENT

trace-log-size

NO REST EQUIVALENT

ems-config-set-proxy-password

PATCH /api/support/ems

ONTAPI attribute

REST attribute

Comment

password-for-proxy-server

proxy_password

ems-destination-create

Deprecated ONTAPI.

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

ems-destination-destroy

Deprecated ONTAPI.

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

ems-destination-destroy-iter

Deprecated ONTAPI.

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

ems-destination-get

Deprecated ONTAPI.

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

ems-destination-get-iter

This is a deprecated ONTAPI.

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

ems-destination-modify

This is a deprecated ONTAPI.

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

ems-destination-modify-iter

This is a deprecated ONTAPI.

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

ems-event-catalog-get-iter

GET /api/support/ems/messages

ONTAPI attribute

REST attribute

Comment

action

corrective_action

deprecated

deprecated

description

description

filter-name

NO REST EQUIVALENT

message-name

name

severity

severity

snmp-trap-type

snmp_trap_type

max-records

max_records

Specifies the maximum number of records to return before paging.

ems-event-filter-copy

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

ems-event-filter-create

You can also specify rules during filter creation.

POST /api/support/ems/filters

ONTAPI attribute

REST attribute

Comment

filter-name

name

ems-event-filter-destroy-iter

To delete multiple filters, use a query. eg: DELETE /api/support/ems/filters?name={name1\|name2\|name3}. You can use attributes other than "name" in the query.

DELETE /api/support/ems/filters

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

force-delete-notification

NO REST EQUIVALENT

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

event-filter-rule

NO REST EQUIVALENT

This attribute is not used by ONTAPI either

filter-name

name

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

ems-event-filter-get-iter

GET /api/support/ems/filters

ONTAPI attribute

REST attribute

Comment

event-filter-rule

rules

In the REST API, an array of rules, not just one rule, unlike the ONTAPI output

filter-name

name

max-records

max_records

Specifies the maximum number of records to return before paging.

ems-event-filter-rename

PATCH /api/support/ems/filters/{name}?new_name={new_name}

ONTAPI attribute

REST attribute

Comment

filter-name

name

new-filter-name

new_name

ems-event-filter-rule-add

POST /api/support/ems/filters/{name}/rules

ONTAPI attribute

REST attribute

Comment

filter-name

name

message-name

message_criteria.name_pattern

position

index

severity

message_criteria.severities

snmp-trap-type

message_criteria.snmp_trap_types

type

type

ems-event-filter-rule-delete

DELETE /api/support/ems/filters/{name}/rules/{index}

ONTAPI attribute

REST attribute

Comment

filter-name

name

position

index

ems-event-filter-rule-reorder

PATCH /api/support/ems/filters/{name}/rules/{index}?new_index={new_index}

ONTAPI attribute

REST attribute

Comment

filter-name

name

position

index

to-position

new_index

ems-event-filter-test

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

ems-event-notification-create

The system creates the notification internally during the creation of a destination. No user intervention is required.

POST /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

destinations

name

filter-name

filters.name

ems-event-notification-destination-check

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

ems-event-notification-destination-create

POST /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

email

destination

The REST API attribute "type" must be set to "email"

name

name

rest-api-url

destination

The REST API attribute "type" must be set to "rest_api"

return-record

NO REST EQUIVALENT

syslog

destination

The REST API attribute "type" must be set to "syslog"

ems-event-notification-destination-destroy-iter

To delete multiple notification destinations, use a query. eg: DELETE /api/support/ems/destinations?name={name1\|name2\|name3}. You can use attributes other than "name" in the query.

DELETE /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

force-delete-notification

NO REST EQUIVALENT

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

email

destination

name

name

rest-api-url

destination

syslog

destination

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

ems-event-notification-destination-get-iter

GET /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

destination

destination

Unlike ONTAPI, the REST API attribute can be an array

is-certificate-valid

NO REST EQUIVALENT

is-server-ca-present

NO REST EQUIVALENT

name

name

type

type

max-records

max_records

Specifies the maximum number of records to return before paging.

ems-event-notification-destination-modify-iter

To modify multiple notification destinations, use a query. eg: PATCH /api/support/ems/destinations?name={name1\|name2\|name3}. You can use attributes other than "name" in the query.

PATCH /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

certificate-authority

certificate.ca

certificate-serial

certificate.serial_number

email

destination

The REST API attribute "type" must be set to "email"

name

name

rest-api-url

destination

The REST API attribute "type" must be set to "rest_api"

syslog

destination

The REST API attribute "type" must be set to "syslog"

continue-on-failure

continue_on_failure

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

ems-event-notification-destroy-iter

Notifications are internally maintained as part of a destination in the REST API. The "filters" attribute creates notifications from the filters to the destination. The notifications can be deleted by modifying the associated destination. To delete multiple notifications, use a query. eg: PATCH /api/support/ems/destinations?name={name1\|name2\|name3} and pass the "filters" list as empty.

PATCH /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

destinations

name

filter-name

filters.name

id

NO REST EQUIVALENT

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

ems-event-notification-get-iter

Notifications are internally maintained as part of a destination in the REST API. The "filters" attribute creates notifications from the filters to the destination.

GET /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

destinations

name

filter-name

filters.name

id

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

ems-event-notification-history-get-iter

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

ems-event-notification-modify-iter

Modifying the destination associated with a notification modifies the notification too. To modify multiple notifications, use a query. eg: PATCH /api/support/ems/destinations?name={name1\|name2\|name3}. You can use attributes other than "name" in the query.

PATCH /api/support/ems/destinations

ONTAPI attribute

REST attribute

Comment

destinations

name

filter-name

filters.name

id

NO REST EQUIVALENT

continue-on-failure

continue_on_failure

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

ems-mail-history-destroy

Deprecated ONTAPI.

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

ems-mail-history-destroy-iter

Deprecated ONTAPI.

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

ems-mail-history-get

Deprecated ONTAPI.

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

ems-mail-history-get-iter

Deprecated ONTAPI.

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

ems-message-get

GET /api/support/ems/events?node={node}&index={seqnum}

ONTAPI attribute

REST attribute

Comment

ems-severity

NO REST EQUIVALENT

event

log_message

event-xml-len

NO REST EQUIVALENT

filter-name

filter.name

kernel-gen

NO REST EQUIVALENT

kernel-seq-num

NO REST EQUIVALENT

message-name

message.name

node

node

num-suppressed-since-last

NO REST EQUIVALENT

parameters

parameters

seq-num

index

severity

message.severity

source

source

time

time

version

NO REST EQUIVALENT

ems-message-get-iter

GET /api/support/ems/events

ONTAPI attribute

REST attribute

Comment

ems-severity

NO REST EQUIVALENT

event

log_message

event-xml-len

NO REST EQUIVALENT

filter-name

filter.name

kernel-gen

NO REST EQUIVALENT

kernel-seq-num

NO REST EQUIVALENT

message-name

message.name

node

node

num-suppressed-since-last

NO REST EQUIVALENT

parameters

parameters

seq-num

index

severity

message.severity

source

source

time

time

version

NO REST EQUIVALENT

node

node

max-records

max_records

Specifies the maximum number of records to return before paging.

ems-routing-add-destination

Deprecated ONTAPI.

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

ems-routing-get

Deprecated ONTAPI.

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

ems-routing-get-iter

Deprecated ONTAPI.

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

ems-routing-modify

Deprecated ONTAPI.

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

ems-routing-modify-iter

Deprecated ONTAPI.

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

ems-routing-remove-destination

Deprecated ONTAPI.

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

ems-snmp-history-destroy

Deprecated ONTAPI.

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

ems-snmp-history-destroy-iter

Deprecated ONTAPI.

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

ems-snmp-history-get

Deprecated ONTAPI.

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

ems-snmp-history-get-iter

Deprecated ONTAPI.

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

ems-status-get

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

ems-status-get-iter

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

Category: ENVIRONMENT

environment-sensors-get-iter

GET /api/cluster/sensors

ONTAPI attribute

REST attribute

Comment

critical-high-threshold

critical_high_threshold

critical-low-threshold

critical_low_threshold

discrete-sensor-state

discrete_state

discrete-sensor-value

discrete_value

node-name

node.name

sensor-name

name

sensor-type

type

threshold-sensor-state

threshold_state

threshold-sensor-value

threshold_value

value-units

value_units

warning-high-threshold

warning_high_threshold

warning-low-threshold

warning_low_threshold

max-records

max_records

Specifies the maximum number of records to return before paging.

environment-sensors-get

GET /api/cluster/sensors/{node.uuid}/{index}

ONTAPI attribute

REST attribute

Comment

critical-high-threshold

critical_high_threshold

critical-low-threshold

critical_low_threshold

discrete-sensor-state

discrete_state

discrete-sensor-value

discrete_value

node-name

node.name

sensor-name

name

sensor-type

type

threshold-sensor-state

threshold_state

threshold-sensor-value

threshold_value

value-units

value_units

warning-high-threshold

warning_high_threshold

warning-low-threshold

warning_low_threshold

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: EXPORTS

export-check-access-get-iter

GET /api/protocols/nfs/services vicon.png

ONTAPI attribute

REST attribute

Comment

access-type

NO REST EQUIVALENT

authentication-method

protocol_access_rules.auth_type

client-ip

protocol_access_rules.client_ip

access

protocol_access_rules

Each of the three access types nfs3_access_type, nfs4_access_type and cifs_access_type under protocol_access_rules may be set.

path

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

policy-owner

NO REST EQUIVALENT

policy-owner-type

NO REST EQUIVALENT

protocol

protocol_access_rules

Each of the three access types nfs3_access_type, nfs4_access_type and cifs_access_type under protocol_access_rules may be set.

rule-index

NO REST EQUIVALENT

volume

protocol_access_rules.volume

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

export-policy-create

POST /api/protocols/nfs/export-policies vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

name

return-record

return_records

export-policy-destroy

DELETE /api/protocols/nfs/export-policies/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

NO REST EQUIVALENT

export-policy-get

GET /api/protocols/nfs/export-policies/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-id

id

policy-name

name

vserver

svm.name

export-policy-get-iter

GET /api/protocols/nfs/export-policies vicon.png

ONTAPI attribute

REST attribute

Comment

policy-id

id

policy-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

export-policy-rename

PATCH /api/protocols/nfs/export-policies/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

new-policy-name

name

policy-name

NO REST EQUIVALENT

export-rule-add-clientmatches

POST /api/protocols/nfs/export-policies/{policy.id}/rules/{index}/clients vicon.png

ONTAPI attribute

REST attribute

Comment

clientmatches

match

policy-name

NO REST EQUIVALENT

rule-index

index

export-rule-create

POST /api/protocols/nfs/export-policies/{policy.id}/rules vicon.png

ONTAPI attribute

REST attribute

Comment

anonymous-user-id

anonymous_user

client-match

clients.match

export-chown-mode

chown_mode

export-ntfs-unix-security-ops

ntfs_unix_security

is-allow-dev-is-enabled

allow_device_creation

is-allow-set-uid-enabled

allow_suid

policy-name

NO REST EQUIVALENT

protocol

protocols

ro-rule

ro_rule

rule-index

index

rw-rule

rw_rule

super-user-security

superuser

export-rule-destroy

DELETE /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

NO REST EQUIVALENT

rule-index

index

export-rule-get

GET /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

anonymous-user-id

anonymous_user

client-match

clients.match

export-chown-mode

chown_mode

export-ntfs-unix-security-ops

ntfs_unix_security

is-allow-dev-is-enabled

allow_device_creation

is-allow-set-uid-enabled

allow_suid

policy-name

NO REST EQUIVALENT

protocol

protocols

ro-rule

ro_rule

rule-index

index

rw-rule

rw_rule

super-user-security

superuser

vserver-name

NO REST EQUIVALENT

policy-name

NO REST EQUIVALENT

export-rule-get-create-defaults

GET /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

anonymous-user-id

anonymous_user

client-match

clients.match

export-chown-mode

NO REST EQUIVALENT

export-ntfs-unix-security-ops

NO REST EQUIVALENT

is-allow-dev-is-enabled

NO REST EQUIVALENT

is-allow-set-uid-enabled

NO REST EQUIVALENT

policy-name

NO REST EQUIVALENT

protocol

protocols

ro-rule

ro_rule

rule-index

index

rw-rule

rw_rule

super-user-security

superuser

vserver-name

NO REST EQUIVALENT

export-rule-get-iter

GET /api/protocols/nfs/export-policies/{policy.id}/rules vicon.png

ONTAPI attribute

REST attribute

Comment

anonymous-user-id

anonymous_user

client-match

clients.match

export-chown-mode

chown_mode

export-ntfs-unix-security-ops

ntfs_unix_security

is-allow-dev-is-enabled

allow_device_creation

is-allow-set-uid-enabled

allow_suid

policy-name

NO REST EQUIVALENT

protocol

protocols

ro-rule

ro_rule

rule-index

index

rw-rule

rw_rule

super-user-security

superuser

vserver-name

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

export-rule-modify

PATCH /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

anonymous-user-id

anonymous_user

client-match

clients.match

export-chown-mode

chown_mode

export-ntfs-unix-security-ops

ntfs_unix_security

is-allow-dev-is-enabled

allow_device_creation

is-allow-set-uid-enabled

allow_suid

policy-name

NO REST EQUIVALENT

protocol

protocols

ro-rule

ro_rule

rule-index

index

rw-rule

rw_rule

super-user-security

superuser

export-rule-remove-clientmatches

DELETE /api/protocols/nfs/export-policies/{policy.id}/rules/{index}/clients/{match} vicon.png

ONTAPI attribute

REST attribute

Comment

clientmatches

match

policy-name

NO REST EQUIVALENT

rule-index

index

export-rule-set-index

PATCH /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

new-rule-index

new_index

policy-name

NO REST EQUIVALENT

rule-index

index

export-rule-test-revert

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

exports-access-cache-all-vservers-get

This API is deprecated in ONTAP 9.0 and later.

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

exports-access-cache-all-vservers-modify

This API is deprecated in ONTAP 9.0 and later.

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

exports-access-cache-config-get

GET /api/protocols/nfs/services vicon.png

ONTAPI attribute

REST attribute

Comment

harvest-timeout

access_cache_config.harvest_timeout

ttl-failure

access_cache_config.ttl_failure

ttl-negative

access_cache_config.ttl_negative

ttl-positive

access_cache_config.ttl_positive

vserver

svm.uuid

exports-access-cache-config-get-iter

GET /api/protocols/nfs/services vicon.png

ONTAPI attribute

REST attribute

Comment

harvest-timeout

access_cache_config.harvest_timeout

ttl-failure

access_cache_config.ttl_failure

ttl-negative

access_cache_config.ttl_negative

ttl-positive

access_cache_config.ttl_positive

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

exports-access-cache-config-modify

PATCH /api/protocols/nfs/services vicon.png

ONTAPI attribute

REST attribute

Comment

harvest-timeout

access_cache_config.harvest_timeout

ttl-failure

access_cache_config.ttl_failure

ttl-negative

access_cache_config.ttl_negative

ttl-positive

access_cache_config.ttl_positive

vserver

svm.uuid

exports-access-cache-config-reset-to-defaults

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

nfs-exportfs-check-permission

GET /api/protocols/nfs/services vicon.png

ONTAPI attribute

REST attribute

Comment

host

rotocol_access_rules.client_ip

pathname

NO REST EQUIVALENT

permission

protocol_access_rules

Each of the three access types nfs3_access_type, nfs4_access_type and cifs_access_type under protocol_access_rules may be set.

is-permissible

NO REST EQUIVALENT

Category: FC

fc-config-adapter-disable

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

fc-config-adapter-enable

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

fc-config-list-info

GET /api/network/fc/ports

ONTAPI attribute

REST attribute

Comment

adapter-name

name

adapter-state

state

adapter-status

statistics.status

adapter-type

NO REST EQUIVALENT

node-name

node.name

pending-fc-type

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

fc-config-set-adapter-fc-type

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

Category: FCP

fcp-adapter-config-down

Set property "enabled" to "false".

PATCH /api/network/fc/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

fcp-adapter

name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

node

node.name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

fcp-adapter-config-up

Set property "enabled" to "true".

PATCH /api/network/fc/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

fcp-adapter

name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

node

node.name

Available for GET in the REST API endpoint. For PATCH, specify the port’s UUID.

fcp-adapter-dump

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

fcp-adapter-get-iter

GET /api/network/fc/ports

ONTAPI attribute

REST attribute

Comment

adapter

name

connection-established

NO REST EQUIVALENT

data-link-rate

fabric.connected_speed

data-protocols-supported

supported_protocols

fabric-established

fabric.connected

fabric-name

fabric.name

firmware-rev

NO REST EQUIVALENT

hardware-rev

NO REST EQUIVALENT

info-name

description

is-sfp-diagnostics-internally-calibrated

NO REST EQUIVALENT

is-sfp-optical-transceiver-valid

NO REST EQUIVALENT

is-sfp-rx-in-los

NO REST EQUIVALENT

is-sfp-rx-power-in-range

NO REST EQUIVALENT

is-sfp-tx-in-disable

NO REST EQUIVALENT

is-sfp-tx-in-fault

NO REST EQUIVALENT

is-sfp-tx-power-in-range

NO REST EQUIVALENT

max-speed

speed.maximum

media-type

NO REST EQUIVALENT

This attribute is obsolete. It is always "p2p" in ONTAP.

node

node.name

node-name

wwnn

physical-protocol

physical_protocol

port-address

fabric.port_address

port-name

wwpn

sfp-connector

NO REST EQUIVALENT

sfp-date-code

NO REST EQUIVALENT

sfp-ddm-capabilities

NO REST EQUIVALENT

sfp-ddm-status-control

NO REST EQUIVALENT

sfp-diagnostic-monitoring-type

NO REST EQUIVALENT

sfp-encoding

NO REST EQUIVALENT

sfp-fc-speedcapabilities

transceiver.capabilities

sfp-formfactor

transceiver.form_factor

sfp-part-number

transceiver.part_number

sfp-rev

NO REST EQUIVALENT

sfp-rx-power

NO REST EQUIVALENT

sfp-serial-number

NO REST EQUIVALENT

sfp-sff8472-compliance

NO REST EQUIVALENT

sfp-tx-power

NO REST EQUIVALENT

sfp-vendor-name

transceiver.manufacturer

sfp-vendor-oui

NO REST EQUIVALENT

sfp-wavelength

NO REST EQUIVALENT

speed

speed.configured

state

enabled

status-admin

enabled

status-extended

NO REST EQUIVALENT

switch-port

fabric.switch_port

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-adapter-reset

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

fcp-adapter-set-speed

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

fcp-adapter-stats-get-iter

GET /api/network/fc/ports

ONTAPI attribute

REST attribute

Comment

adapter

name

adapter-resets

NO REST EQUIVALENT

crc-errors

NO REST EQUIVALENT

discarded-frames

NO REST EQUIVALENT

frame-overruns

NO REST EQUIVALENT

frame-underruns

NO REST EQUIVALENT

initiators-connected

NO REST EQUIVALENT

invalid-xmit-words

NO REST EQUIVALENT

is-sfp-diagnostics-internally-calibrated

NO REST EQUIVALENT

is-sfp-optical-transceiver-valid

NO REST EQUIVALENT

is-sfp-rx-power-in-range

NO REST EQUIVALENT

is-sfp-tx-power-in-range

NO REST EQUIVALENT

link-breaks

NO REST EQUIVALENT

lip-resets

NO REST EQUIVALENT

lr-received

NO REST EQUIVALENT

lr-sent

NO REST EQUIVALENT

node

node.name

nos-received

NO REST EQUIVALENT

ols-received

NO REST EQUIVALENT

protocol-errors

NO REST EQUIVALENT

queue-depth

NO REST EQUIVALENT

scsi-requests-dropped

NO REST EQUIVALENT

sfp-connector

NO REST EQUIVALENT

sfp-date-code

NO REST EQUIVALENT

sfp-encoding

NO REST EQUIVALENT

sfp-fc-speedcapabilities

transceiver.capabilities

sfp-formfactor

transceiver.form_factor

sfp-part-number

transceiver.part_number

sfp-rev

NO REST EQUIVALENT

sfp-rx-power

NO REST EQUIVALENT

sfp-serial-number

NO REST EQUIVALENT

sfp-tx-power

NO REST EQUIVALENT

sfp-vendor-name

transceiver.manufacturer

sfp-vendor-oui

NO REST EQUIVALENT

sfp-wavelength

NO REST EQUIVALENT

spurious-interrupts

NO REST EQUIVALENT

total-logins

NO REST EQUIVALENT

total-logouts

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-initiator-get-iter

GET /api/network/fc/logins vicon.png

ONTAPI attribute

REST attribute

Comment

adapter

interface.name

data-protocol

protocol

fcp-connected-initiators

initiator

This is an object containing several properties of the logged in initiator.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-interface-get-iter

GET /api/network/fc/interfaces vicon.png

ONTAPI attribute

REST attribute

Comment

current-node

location.node.name

current-port

location.port.name

interface-name

name

node-name

wwnn

port-address

port_address

port-name

wwpn

relative-port-id

NO REST EQUIVALENT

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-nameserver-get-iter

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

fcp-node-get-name

GET /api/protocols/san/fcp/services vicon.png

There are no attributes defined for this ONTAPI call.

fcp-node-set-name

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

fcp-ping-igroup-view-get-iter

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

fcp-ping-initiator-get-iter

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

fcp-port-name-get-iter

GET /api/network/fc/interfaces vicon.png

ONTAPI attribute

REST attribute

Comment

fcp-adapter

name

is-used

NO REST EQUIVALENT

This property is obsolete. It is always "true" in ONTAP.

port-name

wwpn

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-port-name-set

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

fcp-service-create

POST /api/protocols/san/fcp/services vicon.png

ONTAPI attribute

REST attribute

Comment

force-node-name

NO REST EQUIVALENT

node-name

NO REST EQUIVALENT

start

enabled

fcp-service-destroy

DELETE /api/protocols/san/fcp/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

fcp-service-get-iter

GET /api/protocols/san/fcp/services vicon.png

ONTAPI attribute

REST attribute

Comment

is-available

enabled

node-name

target.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-service-start

In the REST API, PATCH the enabled property to "true".

PATCH /api/protocols/san/fcp/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

fcp-service-status

In the REST API, GET the value of the enabled property.

GET /api/protocols/san/fcp/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

fcp-service-stop

In the REST API, PATCH the enabled property to "false".

PATCH /api/protocols/san/fcp/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

fcp-topology-get-iter

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

fcp-topology-port-get-iter

FC fabric information is obtained using the REST endpoints under /api/network/fc/fabrics. High-level fabric information is obtained using GET /api/network/fc/fabrics. Switch information is obtained using GET /api/network/fc/fabrics/{fabric.name}/switches.

GET /api/network/fc/fabrics

ONTAPI attribute

REST attribute

Comment

adapter

connections.cluster_port.name

Obtained using GET /api/network/fc/fabrics?fields=connections

domain-id

domain_id

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

node

connections.cluster_port.node.name

Obtained using GET /api/network/fc/fabrics?fields=connections

port-attached-id

NO REST EQUIVALENT

port-attached-visible

NO REST EQUIVALENT

port-attached-wwpn

ports.attached_device.wwpn

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-count

NO REST EQUIVALENT

port-slot

ports.slot

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-state

ports.state

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-type

ports.type

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

port-wwpn

ports.wwpn

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches?fields=ports

switch-name

name

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

switch-release

release

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

switch-vendor

vendor

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

switch-wwn

wwn

Obtained using GET /api/network/fc/fabrics/{fabric.name}/switches

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-wwpnalias-get-iter

GET /api/network/fc/wwpn-aliases vicon.png

ONTAPI attribute

REST attribute

Comment

aliases-alias

alias

aliases-wwpn

wwpn

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fcp-wwpnalias-remove

DELETE /api/network/fc/wwpn-aliases/{svm.uuid}/{alias} vicon.png

ONTAPI attribute

REST attribute

Comment

alias

alias

wwpn

wwpn

To delete all aliases for a WWPN value, first query the aliases by using a GET call, and then delete each alias.

fcp-wwpnalias-set

POST /api/network/fc/wwpn-aliases vicon.png

ONTAPI attribute

REST attribute

Comment

alias

alias

force

NO REST EQUIVALENT

wwpn

wwpn

fcp-zone-get-iter

GET /api/network/fc/fabrics/{fabric.name}/zones

ONTAPI attribute

REST attribute

Comment

adapter

NO REST EQUIVALENT

contents

members.name

domain-id

members.name

node

NO REST EQUIVALENT

port

NO REST EQUIVALENT

port-id

NO REST EQUIVALENT

type

members.type

type-name

members.type

unique

NO REST EQUIVALENT

wwn

members.name

zone-count

NO REST EQUIVALENT

zone-member-count

NO REST EQUIVALENT

zone-name

name

zoneset-name

zoneset.name

Obtained using GET /api/network/fc/fabrics?fields=zoneset

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: FCPORT

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

Category: FEATURE

feature-status-list-info

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

feature-usage-get-iter

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

feature-usage-summary-get-iter

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

Category: FILE-DIRECTORY-SECURITY

file-directory-effective-permissions-get

This API is private as it is only supported by System Manager.

GET /api/protocols/file-security/effective-permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

client-ip-address

NO REST EQUIVALENT

expand-mask

NO REST EQUIVALENT

path

path

share-name

share.name

unix-user-name

user

In the REST API, specify the "type" field as UNIX.

win-user-name

user

In the REST API, specify the "type" field as Windows.

file-directory-security-get

GET /api/protocols/file-security/permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

cifs-share-name

NO REST EQUIVALENT

expand-mask

NO REST EQUIVALENT

inode

inode

lookup-names

NO REST EQUIVALENT

path

path

sddl

NO REST EQUIVALENT

textual-mask

advanced-rights

volume-name

NO REST EQUIVALENT

file-directory-security-ntfs-create

This ONTAPI is deprecated in REST with simplified REST interface. NTFS-SD is created automatically based on the values provided for the NTFS-SD specific attributes. Hence this ONTAPI does not have a separate REST API.

POST /api/protocols/file-security/permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

control-flags-raw

control-flags

group

group

ntfs-sd

NO REST EQUIVALENT

owner

owner

return-record

NO REST EQUIVALENT

file-directory-security-ntfs-dacl-add

Give "access" field as access_allow or access_deny to indicate DACL addition

POST /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl vicon.png

ONTAPI attribute

REST attribute

Comment

access-type

access

account

user

advanced-rights

advanced-rights

apply-to

apply-to

ntfs-sd

NO REST EQUIVALENT

rights

rights

rights-raw

NO REST EQUIVALENT

file-directory-security-ntfs-dacl-get-iter

REST API "/protocols/file-security/permissions/{svm.uuid}/{path}" can be used to display all DACL ACEs. Hence this ONTAPI will not have separate REST API.

GET /api/protocols/file-security/permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

access-type

access

account

user

advanced-rights

advanced-rights

apply-to

apply-to

ntfs-sd

NO REST EQUIVALENT

readable-access-rights

NO REST EQUIVALENT

rights

NO REST EQUIVALENT

rights-raw

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

max-records

NO REST EQUIVALENT

Specifies the maximum number of records to return before paging.

file-directory-security-ntfs-dacl-modify

Give "access" field as access_allow or access_deny to indicate DACL modification

PATCH /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user} vicon.png

ONTAPI attribute

REST attribute

Comment

access-type

access

account

user

advanced-rights

advanced-rights

apply-to

apply-to

ntfs-sd

NO REST EQUIVALENT

rights

rights

rights-raw

NO REST EQUIVALENT

file-directory-security-ntfs-dacl-remove

Give "access" field as access_allow or access_deny to indicate DACL removal

DELETE /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user} vicon.png

ONTAPI attribute

REST attribute

Comment

access-type

access

account

user

ntfs-sd

NO REST EQUIVALENT

file-directory-security-ntfs-delete

Since there is no requirement to create NTFS-SDs explicitly while configuring ACEs through REST, internally created NTFS-SDs are removed automatically during the cleanup process when a job finishes. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-ntfs-get-iter

NTFS-SDs are created automatically for configuring ACEs through REST. These internally created NTFS-SDs are not visible to users. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-ntfs-modify

This ONTAPI is deprecated in REST with simplified REST interface. SD specific information is modified automatically based on the values provided for the NTFS-SD specific attributes. Hence this ONTAPI does not have a separate REST API.

PATCH /api/protocols/file-security/permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

control-flags-raw

control-flags

group

group

ntfs-sd

NO REST EQUIVALENT

owner

owner

file-directory-security-ntfs-sacl-add

Give "access" field as audit_success or audit_falure to indicate SACL addition

POST /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl vicon.png

ONTAPI attribute

REST attribute

Comment

account

user

advanced-rights

advanced-rights

apply-to

apply-to

audit-access-type

access

ntfs-sd

NO REST EQUIVALENT

rights

rights

rights-raw

NO REST EQUIVALENT

file-directory-security-ntfs-sacl-get-iter

REST API "/protocols/file-security/permissions/{svm.uuid}/{path}" can be used to display all SACL ACEs. Hence this ONTAPI does not have a separate REST API.

GET /api/protocols/file-security/permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

account

user

advanced-rights

advanced-rights

apply-to

apply-to

audit-access-type

access

ntfs-sd

NO REST EQUIVALENT

readable-access-rights

NO REST EQUIVALENT

rights

NO REST EQUIVALENT

rights-raw

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

max-records

NO REST EQUIVALENT

Specifies the maximum number of records to return before paging.

file-directory-security-ntfs-sacl-modify

Give "access" field as audit_success or audit_falure to indicate SACL Modification

PATCH /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user} vicon.png

ONTAPI attribute

REST attribute

Comment

account

user

advanced-rights

advanced-rights

apply-to

apply-to

audit-access-type

access

ntfs-sd

NO REST EQUIVALENT

rights

rights

rights-raw

NO REST EQUIVALENT

file-directory-security-ntfs-sacl-remove

Give "access" field as audit_success or audit_falure to indicate SACL removal

DELETE /api/protocols/file-security/permissions/{svm.uuid}/{path}/acl/{user} vicon.png

ONTAPI attribute

REST attribute

Comment

account

user

audit-access-type

access

ntfs-sd

NO REST EQUIVALENT

file-directory-security-policy-create

A policy is created automatically for configuring ACEs through REST. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-delete

Since there is no requirement to create a policy explicitly while configuring ACEs through REST, an internally created policy is removed automatically during the cleanup process when a job finishes. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-get-iter

A policy is created automatically for configuring ACEs through REST. These internally created policies are not visible to users. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-task-add

This ONTAPI is deprecated in REST with simplified REST interface. Policy-task creation happens automatically based on the values provided for the task specific attributes. Hence this ONTAPI does not have a separate REST API.

POST /api/protocols/file-security/permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

access-control

access_control

ntfs-mode

propagation_mode

ntfs-sd

NO REST EQUIVALENT

This field is automatically populated.

path

path

policy-name

NO REST EQUIVALENT

This field is automatically populated.

security-type

NO REST EQUIVALENT

Only the "ntfs" security type is supported in ONTAP CLI.

task-index-number

NO REST EQUIVALENT

Since tasks are created automatically, this field is not required.

file-directory-security-policy-task-get-iter

Policy-tasks are created automatically for configuring ACEs through REST. These internally created tasks are not visible to users. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-policy-task-modify

Since there is no requirement to create policy-tasks explicitly while configuring ACEs through REST, modification of internally created tasks is not required. Hence this ONTAPI dos not have a corresponding REST API.

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

file-directory-security-policy-task-remove

Since there is no requirement to create policy-tasks explicitly while configuring ACEs through REST, internally created tasks are removed automatically during the cleanup process when a job finishes. Hence this ONTAPI does not have a corresponding REST API.

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

file-directory-security-remove-slag

DELETE /api/protocols/file-security/permissions/{svm.uuid}/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

file-directory-security-set

An internally created policy is applied automatically during the execution of a REST call, which sets all the ACEs for the specified path. Hence this ONTAPI does not have a corresponding REST API.

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

Category: FILE

file-assign-qos

PATCH /api/storage/volumes/{volume.uuid}/files/{path}

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 vicon.png

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} vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

perm

unix_permissions

POST /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

symlink

target

file-delete-directory

DELETE /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

file-delete-file

DELETE /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

is-clone-file

NO REST EQUIVALENT

path

path

file-fingerprint-abort

DELETE /api/storage/snaplock/file-fingerprints/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

session-id

id

file-fingerprint-dump

GET /api/storage/snaplock/file-fingerprints/{id} vicon.png

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

In the REST API, you must pass svm.uuid and volume.uuid in the query.

GET /api/storage/snaplock/file-fingerprints vicon.png

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 vicon.png

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 vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

file-get-space-reservation-info

GET /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

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} vicon.png

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 vicon.png

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 vicon.png

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

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.

GET /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

length

NO REST EQUIVALENT

offset

byte_offset

path

path

stream-name

stream_name

GET /api/storage/volumes/{volume.uuid}/files/{path}?return_metadata=true vicon.png

ONTAPI attribute

REST attribute

Comment

path

path

file-rename-file

PATCH /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

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} vicon.png

ONTAPI attribute

REST attribute

Comment

is-fill-enabled

fill_enabled

is-overwrite-enabled

overwrite_enabled

path

path

volume-id

volume.uuid

file-truncate-file

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

file-usage-get

GET /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

length

NO REST EQUIVALENT

path

path

start-offset

byte_offset

file-usage-result-get

The REST API endpoint does not exist for this ONTAPI

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

file-usage-start

The REST API endpoint does not exist for this ONTAPI

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

file-write-file

You MUST include { "Accept" : "multipart/form-data" } in the header.

PATCH /api/storage/volumes/{volume.uuid}/files/{path} vicon.png

ONTAPI attribute

REST attribute

Comment

data

data

offset

byte_offset

overwrite

overwrite

path

path

stream-name

stream_name

Category: FILESERVICE-AUDIT

fileservice-audit-config-create

POST /api/protocols/audit vicon.png

ONTAPI attribute

REST attribute

Comment

destination

log_path

events

events

format

log.format

retention-duration

log.retention.duration

return-record

return_records

rotate-limit

log.retention.count

rotate-schedule-day

log.rotation.schedule.days

rotate-schedule-dayofweek

log.rotation.schedule.weekdays

rotate-schedule-hour

log.rotation.schedule.hours

rotate-schedule-minute

log.rotation.schedule.minutes

rotate-schedule-month

log.rotation.schedule.months

rotate-size

log.rotation.size

fileservice-audit-config-get

GET /api/protocols/audit/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

audit-guarantee

guarantee

destination

log_path

events

events

format

log.format

is-enabled

enabled

retention-duration

log.retention.duration

rotate-limit

log.retention.count

rotate-schedule-day

log.rotation.schedule.days

rotate-schedule-dayofweek

log.rotation.schedule.weekdays

rotate-schedule-hour

log.rotation.schedule.hours

rotate-schedule-minute

log.rotation.schedule.minutes

rotate-schedule-month

log.rotation.schedule.months

rotate-size

log.rotation.size

rotation-schedule-description

NO REST EQUIVALENT

vserver

svm.name

fileservice-audit-config-get-iter

GET /api/protocols/audit vicon.png

ONTAPI attribute

REST attribute

Comment

audit-guarantee

NO REST EQUIVALENT

destination

log_path

events

events

format

log.format

is-enabled

enabled

retention-duration

log.retention.duration

rotate-limit

log.retention.count

rotate-schedule-day

log.rotation.schedule.days

rotate-schedule-dayofweek

log.rotation.schedule.weekdays

rotate-schedule-hour

log.rotation.schedule.hours

rotate-schedule-minute

log.rotation.schedule.minutes

rotate-schedule-month

log.rotation.schedule.months

rotate-size

log.rotation.size

rotation-schedule-description

NO REST EQUIVALENT

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fileservice-audit-config-get-total-records

GET /api/protocols/audit/{svm.uuid}

There are no attributes defined for this ONTAPI call.

fileservice-audit-config-modify

PATCH /api/protocols/audit/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

audit-guarantee

guarantee

destination

log_path

events

events

format

log.format

retention-duration

log.retention.duration

rotate-limit

log.retention.count

rotate-schedule-day

log.rotation.schedule.days

rotate-schedule-dayofweek

log.rotation.schedule.weekdays

rotate-schedule-hour

log.rotation.schedule.hours

rotate-schedule-minute

log.rotation.schedule.minutes

rotate-schedule-month

log.rotation.schedule.months

rotate-size

log.rotation.size

fileservice-audit-disable

PATCH /api/protocols/audit/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

fileservice-audit-enable

PATCH /api/protocols/audit/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

fileservice-audit-remove

DELETE /api/protocols/audit/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

force

fileservice-audit-repair

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

fileservice-audit-rotate-log

PATCH /api/protocols/audit/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

Category: FLASH-DEVICE

flash-device-get-iter

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

average-erase-cycle-count

NO REST EQUIVALENT

capacity

controller.flash_cache.capacity

In the REST API, capacity is returned in bytes instead of GB.

device-id

NO REST EQUIVALENT

firmware-file

NO REST EQUIVALENT

firmware-revision

controller.flash_cache.firmware_version

hardware-revision

controller.flash_cache.hardware_revision

last-change-time

NO REST EQUIVALENT

model-name

controller.flash_cache.model

node

name

part-number

controller.flash_cache.part_number

percent-online

NO REST EQUIVALENT

serial-number

controller.flash_cache.serial_number

service-time

NO REST EQUIVALENT

slot-number

NO REST EQUIVALENT

slot-string

controller.flash_cache.slot

status

controller.flash_cache.state

subslot-number

NO REST EQUIVALENT

threshold-profile

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

flash-device-list-info

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

Category: FLASH

flash-get-thresholds

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

flash-thresholds-get-iter

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

Category: FLEXCACHE

flexcache-connected-cache-get-iter

GET /api/storage/flexcache/origins vicon.png

ONTAPI attribute

REST attribute

Comment

cache-cluster

flexcaches.cluster.name

cache-volume

flexcaches.volume.name

cache-vserver

flexcaches.svm.name

origin-volume

NO REST EQUIVALENT

origin-vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

flexcache-create-async

POST /api/storage/flexcache/flexcaches vicon.png

ONTAPI attribute

REST attribute

Comment

aggr-list

aggregates

aggr-list-multiplier

NO REST EQUIVALENT

auto-provision-as

NO REST EQUIVALENT

junction-path

path

lock-consistent-when-disconnected

NO REST EQUIVALENT

origin-volume

origins.volume.name

origin-vserver

origins.svm.name

size

size

space-guarantee

guarantee.type

use-tiered-aggregate

use_tiered_aggregate

volume

name

flexcache-default-size-get

GET /api/storage/flexcache/flexcaches/{uuid}

ONTAPI attribute

REST attribute

Comment

origin-size

NO REST EQUIVALENT

flexcache-destroy-async

DELETE /api/storage/flexcache/flexcaches/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

flexcache-get-iter

GET /api/storage/flexcache/flexcaches vicon.png

ONTAPI attribute

REST attribute

Comment

aggr-list

NO REST EQUIVALENT

create-time

origins.create_time

flexgroup-msid

NO REST EQUIVALENT

junction-path

path

origin-cluster

origins.cluster.name

origin-volume

origins.volume.name

origin-volume-msid

NO REST EQUIVALENT

origin-vserver

origins.svm.name

origin-vserver-uuid

origins.svm.uuid

size

size

space-guarantee

guarantee.type

volume

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

flexcache-origin-cleanup-cache-relationship

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

flexcache-origin-config-get-iter

GET /api/storage/flexcache/origins vicon.png

ONTAPI attribute

REST attribute

Comment

is-bli-enabled

NO REST EQUIVALENT

origin-volume

NO REST EQUIVALENT

origin-vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

flexcache-origin-config-modify

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

flexcache-usage-get

GET /api/storage/flexcache/flexcaches/{uuid}

There are no attributes defined for this ONTAPI call.

Category: FPOLICY

fpolicy-disable-policy

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

name

fpolicy-enable-policy

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

name

sequence-number

priority

fpolicy-passthrough-read-connection-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/connections?passthrough_read=true vicon.png

ONTAPI attribute

REST attribute

Comment

connected-since

update_time

Specifies the time at which FPolicy passthrough-read is connected or disconnected.

control-session-id

session_uuid

Unique session ID associated with each FPolicy passthrough-read connection and it can be used to identify the established connection.

disconnect-reason

disconnected_reason.message

Indicates the reason for FPolicy passthrough-read disconnection.

disconnected-since

update_time

Specifies the time at which FPolicy passthrough-read is connected or disconnected.

fpolicy-server

server

IP address of the FPolicy server.

node

node.name

policy-name

policy.name

Policy name attached to the FPolicy passthrough-read connection.

server-status

state

Specifies the FPolicy passthrough-read connection state, indicating whether it is in a connected or disconnected state.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-create

POST /api/protocols/fpolicy/{svm.uuid}/policies vicon.png

ONTAPI attribute

REST attribute

Comment

allow-privileged-access

NO REST EQUIVALENT

engine-name

engine.name

events

events.name

is-mandatory

mandatory

is-passthrough-read-enabled

passthrough_read

policy-name

name

privileged-user-name

privileged_user

return-record

return_records

fpolicy-policy-delete

DELETE /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

name

fpolicy-policy-event-create

POST /api/protocols/fpolicy/{svm.uuid}/events vicon.png

ONTAPI attribute

REST attribute

Comment

event-name

name

file-operations

file_operations

filter-string

filters

protocol

protocol

return-record

return_records

volume-operation

volume_monitoring

fpolicy-policy-event-delete

DELETE /api/protocols/fpolicy/{svm.uuid}/events/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

event-name

name

fpolicy-policy-event-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/events vicon.png

ONTAPI attribute

REST attribute

Comment

event-name

name

file-operations

file_operations

filter-string

filters

protocol

protocol

volume-operation

volume_monitoring

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-event-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/events/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

event-name

name

file-operations

file_operations

filter-string

filters

protocol

protocol

volume-operation

volume_monitoring

fpolicy-policy-external-engine-create

POST /api/protocols/fpolicy/{svm.uuid}/engines vicon.png

ONTAPI attribute

REST attribute

Comment

certificate-ca

certificate.ca

certificate-common-name

certificate.name

certificate-serial

certificate.serial_number

engine-name

name

extern-engine-type

type

is-resiliency-enabled

resiliency.enabled

keep-alive-interval

NO REST EQUIVALENT

max-connection-retries

NO REST EQUIVALENT

max-server-requests

max_server_requests

port-number

port

primary-servers

primary_servers

recv-buffer-size

buffer_size.recv_buffer

request-abort-timeout

request_abort_timeout

request-cancel-timeout

request_cancel_timeout

resiliency-directory-path

resiliency.directory_path

resiliency-max-retention-duration

resiliency.retention_duration

return-record

return_records

secondary-servers

secondary_servers

send-buffer-size

buffer_size.send_buffer

server-progress-timeout

server_progress_timeout

session-timeout

NO REST EQUIVALENT

ssl-option

ssl_option

status-request-interval

status_request_interval

fpolicy-policy-external-engine-delete

DELETE /api/protocols/fpolicy/{svm.uuid}/engines/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

engine-name

name

fpolicy-policy-external-engine-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/engines vicon.png

ONTAPI attribute

REST attribute

Comment

certificate-ca

certificate.ca

certificate-common-name

certificate.name

certificate-serial

certificate.serial_number

engine-name

name

extern-engine-type

type

is-resiliency-enabled

resiliency.enabled

keep-alive-interval

NO REST EQUIVALENT

max-connection-retries

NO REST EQUIVALENT

max-server-requests

max_server_requests

port-number

port

primary-servers

primary_servers

recv-buffer-size

buffer_size.recv_buffer

request-abort-timeout

request_abort_timeout

request-cancel-timeout

request_cancel_timeout

resiliency-directory-path

resiliency.directory_path

resiliency-max-retention-duration

resiliency.retention_duration

secondary-servers

secondary_servers

send-buffer-size

buffer_size.send_buffer

server-progress-timeout

server_progress_timeout

session-timeout

NO REST EQUIVALENT

ssl-option

ssl_option

status-request-interval

status_request_interval

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-external-engine-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/engines/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

certificate-ca

certificate.ca

certificate-common-name

certificate.name

certificate-serial

certificate.serial_number

engine-name

name

extern-engine-type

type

is-resiliency-enabled

resiliency.enabled

keep-alive-interval

NO REST EQUIVALENT

max-connection-retries

NO REST EQUIVALENT

max-server-requests

max_server_requests

port-number

port

primary-servers

primary_servers

recv-buffer-size

buffer_size.recv_buffer

request-abort-timeout

request_abort_timeout

request-cancel-timeout

request_cancel_timeout

resiliency-directory-path

resiliency.directory_path

resiliency-max-retention-duration

resiliency.retention_duration

secondary-servers

secondary_servers

send-buffer-size

buffer_size.send_buffer

server-progress-timeout

server_progress_timeout

session-timeout

NO REST EQUIVALENT

ssl-option

ssl_option

status-request-interval

status_request_interval

fpolicy-policy-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

allow-privileged-access

NO REST EQUIVALENT

engine-name

engine.name

events

events

is-mandatory

mandatory

is-passthrough-read-enabled

passthrough_read

policy-name

name

privileged-user-name

privileged_user

vserver

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

allow-privileged-access

NO REST EQUIVALENT

engine-name

engine.name

events

events

is-mandatory

mandatory

is-passthrough-read-enabled

passthrough_read

policy-name

name

privileged-user-name

privileged_user

fpolicy-policy-scope-create

POST /api/protocols/fpolicy/{svm.uuid}/policies vicon.png

ONTAPI attribute

REST attribute

Comment

check-extensions-on-directories

scope.check-extensions-on-directories

export-policies-to-exclude

scope.exclude_export_policies

export-policies-to-include

scope.include_export_policies

file-extensions-to-exclude

scope.exclude_extension

file-extensions-to-include

scope.include_extension

is-monitoring-of-objects-with-no-extension-enabled

scope.object_monitoring_with_no_extension

policy-name

name

return-record

return_records

shares-to-exclude

scope.exclude_shares

shares-to-include

scope.include_shares

volumes-to-exclude

scope.exclude_volumes

volumes-to-include

scope.include_volumes

fpolicy-policy-scope-delete

As per the design, "scope" is an attribute under the "fpolicy/{svm.uuid}/policies" REST end point. After a policy is created, use a PATCH operation on "fpolicy/{svm.uuid}/policies" to modify the scope. As a policy cannot function without a scope, the REST design does not allow for the deletion of the scope only. A DELETE operation on "fpolicy/{svm.uuid}/policies" deletes the policy along with the scope.

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

fpolicy-policy-scope-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

check-extensions-on-directories

scope.check-extensions-on-directories

export-policies-to-exclude

scope.exclude_export_policies

export-policies-to-include

scope.include_export_policies

file-extensions-to-exclude

scope.exclude_extension

file-extensions-to-include

scope.include_extension

is-monitoring-of-objects-with-no-extension-enabled

scope.object_monitoring_with_no_extension

policy-name

name

shares-to-exclude

scope.exclude_shares

shares-to-include

scope.include_shares

volumes-to-exclude

scope.exclude_volumes

volumes-to-include

scope.include_volumes

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-policy-scope-modify

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

check-extensions-on-directories

scope.check-extensions-on-directories

export-policies-to-exclude

scope.exclude_export_policies

export-policies-to-include

scope.include_export_policies

file-extensions-to-exclude

scope.exclude_extension

file-extensions-to-include

scope.include_extension

is-monitoring-of-objects-with-no-extension-enabled

scope.object_monitoring_with_no_extension

policy-name

name

shares-to-exclude

scope.exclude_shares

shares-to-include

scope.include_shares

volumes-to-exclude

scope.exclude_volumes

volumes-to-include

scope.include_volumes

fpolicy-policy-status-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

name

sequence-number

priority

status

enabled

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

fpolicy-server-connect

PATCH /api/protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server} vicon.png

ONTAPI attribute

REST attribute

Comment

node

node.uuid

policy-name

policy.name

server

server

fpolicy-server-disconnect

PATCH /api/protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server} vicon.png

ONTAPI attribute

REST attribute

Comment

node

node.uuid

policy-name

policy.name

server

server

fpolicy-server-status-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/connections vicon.png

ONTAPI attribute

REST attribute

Comment

connected-since

update_time

disconnect-reason

disconnected_reason.message

disconnected-since

update_time

fpolicy-server

server

node

node.name

policy-name

policy

server-status

state

server-type

type

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: GPO

gpo-applied-info-get-iter

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

gpo-get-iter

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

gpo-gpresult-info-get-iter

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

gpo-modify

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

gpo-restricted-group-applied-info-get-iter

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

gpo-restricted-group-defined-info-get-iter

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

gpo-update

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

Category: GROUP-MAPPING

group-mapping-create

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

group-mapping-delete

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

group-mapping-get-iter

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

group-mapping-insert

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

group-mapping-modify

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

group-mapping-swap

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

Category: HA-INTERCONNECT

ha-interconnect-channel-info-get-iter

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

ha-interconnect-clear-error-statistics

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

ha-interconnect-clear-port-counters

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

ha-interconnect-clear-port-symbol-errors

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

ha-interconnect-completion-queue-statistics-get-iter

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

ha-interconnect-config-details-get-iter

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

ha-interconnect-confirm-delivery-statistics-get-iter

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

ha-interconnect-connection-status-get-iter

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

ha-interconnect-flint-flash-details-get-iter

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

ha-interconnect-flint-image-details-get-iter

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

ha-interconnect-flint-verify-flash

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

ha-interconnect-flint-verify-image

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

ha-interconnect-flush-details-get-iter

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

ha-interconnect-get-channel-info

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

ha-interconnect-get-completion-queue-statistics

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

ha-interconnect-get-config-details

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

ha-interconnect-get-confirm-delivery-statistics

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

ha-interconnect-get-connection-status

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

ha-interconnect-get-flint-flash-details

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

ha-interconnect-get-flint-image-details

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

ha-interconnect-get-flush-details

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

ha-interconnect-get-nvram-configuration

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

ha-interconnect-get-ood-status

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

ha-interconnect-get-performance-statistics

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

ha-interconnect-get-port-details

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

ha-interconnect-get-scatter-gather-list-statistics

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

ha-interconnect-get-timeout-values

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

ha-interconnect-get-ulp-information

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

ha-interconnect-get-viif-channel-memory-statistics

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

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

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

ha-interconnect-modify-timeout-values

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

ha-interconnect-nic-reset

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

ha-interconnect-nvram-configuration-get-iter

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

ha-interconnect-ood-clear-error-statistics

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

ha-interconnect-ood-clear-performance-statistics

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

ha-interconnect-ood-disable-statistics

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

ha-interconnect-ood-enable-statistics

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

ha-interconnect-ood-optimization-off

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

ha-interconnect-ood-optimization-on

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

ha-interconnect-ood-send-diagnostic-buffer

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

ha-interconnect-ood-status-get-iter

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

ha-interconnect-performance-statistics-get-iter

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

ha-interconnect-port-details-get-iter

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

ha-interconnect-scatter-gather-list-statistics-get-iter

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

ha-interconnect-timeout-values-get-iter

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

ha-interconnect-ulp-information-get-iter

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

ha-interconnect-viif-channel-memory-statistics-get-iter

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

Category: IGROUP

igroup-add

POST /api/protocols/san/igroups/{igroup.uuid}/initiators vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

This parameter is obsolete in ONTAPI and is ignored.

initiator

name

initiator-group-name

igroup.uuid

In the REST API, the initiator group is identified by "igroup.uuid" in the endpoint path.

igroup-bind-portset

In the REST API, binding a portset to an initiator group is equivalent to PATCHing the initiator group’s "portset.name" or "portset.uuid" property to the name or UUID of an existing portset in the same SVM.

PATCH /api/protocols/san/igroups/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in the endpoint path.

portset-name

portset.name

igroup-create

POST /api/protocols/san/igroups vicon.png

ONTAPI attribute

REST attribute

Comment

bind-portset

portset.name

initiator-group-name

name

initiator-group-type

protocol

os-type

os_type

ostype

os_type

igroup-destroy

DELETE /api/protocols/san/igroups/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

allow_delete_while_mapped

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in the endpoint path.

igroup-disable-aix-support

This API is obsolete. It was valid only for a prior ONTAP version upgrade/revert.

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

igroup-get-iter

GET /api/protocols/san/igroups vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group-alua-enabled

NO REST EQUIVALENT

This attribute is obsolete. It is always "true" in ONTAP.

initiator-group-delete-on-unmap

delete_on_unmap

initiator-group-name

name

initiator-group-os-type

os_type

initiator-group-portset-name

portset.name

initiator-group-report-scsi-name-enabled

NO REST EQUIVALENT

This API is obsolete and no longer implemented in ONTAP.

initiator-group-throttle-borrow

NO REST EQUIVALENT

This attribute is obsolete. It is always "false" in ONTAP.

initiator-group-throttle-reserve

NO REST EQUIVALENT

This attribute is obsolete. It is always "0" in ONTAP.

initiator-group-type

protocol

initiator-group-use-partner

NO REST EQUIVALENT

This attribute is obsolete. It is always "true" in ONTAP.

initiator-group-uuid

uuid

initiator-group-vsa-enabled

NO REST EQUIVALENT

This attribute is obsolete. It is always "false" in ONTAP.

initiators

initiators.name

lun-id

NO REST EQUIVALENT

This attribute is not used in the initiator group context in ONTAPI. The logical unit identifier can be obtained by using the GET /api/protocols/san/lun-maps endpoint.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

igroup-lookup-lun

GET /api/protocols/san/lun-maps vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group-name

igroup.name

lun-id

lun.uuid

igroup-os-type-list

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

igroup-remove

DELETE /api/protocols/san/igroups/{igroup.uuid}/initiators/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

force

allow_delete_while_mapped

initiator

name

initiator-group-name

igroup.uuid

In the REST API, the initiator group is identified by "igroup.uuid" in the endpoint path.

igroup-rename

PATCH /api/protocols/san/igroups/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in the endpoint path.

initiator-group-new-name

name

igroup-set-attribute

This is equivalent to changing property "os_type" in the PATCH /api/protocols/san/igroups/{uuid} endpoint.

PATCH /api/protocols/san/igroups/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

attribute

NO REST EQUIVALENT

force

NO REST EQUIVALENT

initiator-group-name

NO REST EQUIVALENT

In the REST API, the initiator group is identified by "uuid" in the endpoint path.

value

os_type

igroup-unbind-portset

In the REST API, unbinding a portset from an initiator group is equivalent to PATCHing the initiator group’s "portset.name" property to an empty string ("").

PATCH /api/protocols/san/igroups/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group-name

uuid

In the REST API, the initiator group is identified by "uuid" in the endpoint path.

Category: ISCSI

iscsi-add

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

iscsi-auth-add-initiator-address-ranges

PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator

initiator

initiator-address-ranges

initiator_address.ranges

iscsi-auth-generate-chap-password

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

iscsi-auth-remove-initiator-address-ranges

PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator

initiator

initiator-address-ranges

initiator_address.ranges

iscsi-connection-get-iter

GET /api/protocols/san/iscsi/sessions vicon.png

ONTAPI attribute

REST attribute

Comment

connection-id

connections.cid

connection-state

NO REST EQUIVALENT

has-session

NO REST EQUIVALENT

The REST API only reports connections with a session.

interface-name

connections.interface.name

local-ip-address

connections.interface.ip.address

local-ip-port

connections.interface.ip.port

remote-ip-address

connections.initiator_address.address

remote-ip-port

connections.initiator_address.port

session-id

isid

tpgroup-name

target_portal_group

tpgroup-tag

target_portal_group_tag

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

iscsi-connection-shutdown

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

iscsi-delete

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

iscsi-initiator-add-auth

POST /api/protocols/san/iscsi/credentials vicon.png

ONTAPI attribute

REST attribute

Comment

auth-type

authentication_type

initiator

initiator

initiator-address-ranges

initiator_address.ranges

outbound-passphrase

NO REST EQUIVALENT

outbound-password

chap.outbound.password

outbound-user-name

chap.outbound.user

passphrase

NO REST EQUIVALENT

password

chap.inbound.password

radius

NO REST EQUIVALENT

user-name

chap.inbound.user

iscsi-initiator-auth-get-iter

GET /api/protocols/san/iscsi/credentials vicon.png

ONTAPI attribute

REST attribute

Comment

auth-chap-policy

NO REST EQUIVALENT

auth-type

authentication_type

initiator

initiator

initiator-address-ranges

initiator_address.ranges

outbound-user-name

chap.outbound.user

user-name

chap.inbound.user

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

iscsi-initiator-delete-auth

DELETE /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator

initiator

iscsi-initiator-get-auth

GET /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator

initiator

iscsi-initiator-get-default-auth

Provide "default" for {initiator}.

GET /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator} vicon.png

There are no attributes defined for this ONTAPI call.

iscsi-initiator-get-iter

GET /api/protocols/san/iscsi/sessions vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-aliasname

initiator.alias

initiator-group-list

igroups.name

initiator-nodename

NO REST EQUIVALENT

isid

isid

target-session-id

NO REST EQUIVALENT

tpgroup-name

target_portal_group

tpgroup-tag

target_portal_group_tag

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

iscsi-initiator-modify-chap-params

PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator

initiator

outbound-passphrase

NO REST EQUIVALENT

outbound-password

chap.outbound.password

outbound-user-name

chap.outbound.user

passphrase

NO REST EQUIVALENT

password

chap.inbound.password

radius

NO REST EQUIVALENT

remove-outbound

chap.outbound.user

You need to pass the empty string as the outbound user to clear the outbound user and password.

user-name

chap.inbound.user

iscsi-initiator-set-default-auth

Provide "default" for {initiator}.

PATCH /api/protocols/san/iscsi/credentials/{svm.uuid}/{initiator} vicon.png

ONTAPI attribute

REST attribute

Comment

auth-type

authentication_type

outbound-passphrase

NO REST EQUIVALENT

outbound-password

chap.outbound.password

outbound-user-name

chap.outbound.user

passphrase

NO REST EQUIVALENT

password

chap.inbound.password

radius

NO REST EQUIVALENT

user-name

chap.inbound.user

iscsi-interface-accesslist-add

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

iscsi-interface-accesslist-get-iter

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

iscsi-interface-accesslist-remove

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

iscsi-interface-disable

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

iscsi-interface-enable

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

iscsi-interface-get-iter

Use the query: services=data_iscsi

GET /api/network/ip/interfaces vicon.png

ONTAPI attribute

REST attribute

Comment

current-node

location.node.name

current-port

location.port.name

interface-name

name

ip-address

ip.address

ip-port

NO REST EQUIVALENT

is-interface-enabled

enabled

relative-port-id

NO REST EQUIVALENT

sendtargets-fqdn

NO REST EQUIVALENT

tpgroup-name

NO REST EQUIVALENT

tpgroup-tag

NO REST EQUIVALENT

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

iscsi-interface-modify

The REST API does not support modifying the sendtargets-fqdn.

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

iscsi-isns-config

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

iscsi-isns-create

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

iscsi-isns-destroy

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

iscsi-isns-get-info

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

iscsi-isns-get-iter

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

iscsi-isns-start

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

iscsi-isns-stop

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

iscsi-isns-update

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

iscsi-node-get-name

Use the query: fields=target.name

GET /api/protocols/san/iscsi/services/{svm.uuid}

There are no attributes defined for this ONTAPI call.

iscsi-node-set-name

The REST API does not support modifying the iSCSI node name. It does support modification of the alias.

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

iscsi-query

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

iscsi-remove

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

iscsi-service-create

POST /api/protocols/san/iscsi/services vicon.png

ONTAPI attribute

REST attribute

Comment

alias-name

target.alias

node-name

target.name

start

enabled

iscsi-service-destroy

DELETE /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

iscsi-service-get-iter

GET /api/protocols/san/iscsi/services vicon.png

ONTAPI attribute

REST attribute

Comment

alias-name

target.alias

is-available

NO REST EQUIVALENT

login-timeout

NO REST EQUIVALENT

max-cmds-per-session

NO REST EQUIVALENT

max-conn-per-session

NO REST EQUIVALENT

max-error-recovery-level

NO REST EQUIVALENT

node-name

target.name

retain-timeout

NO REST EQUIVALENT

tcp-window-size

NO REST EQUIVALENT

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

iscsi-service-modify

The REST API only supports enabling/disabling the service and changing the target alias.

PATCH /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

login-timeout

NO REST EQUIVALENT

max-cmds-per-session

NO REST EQUIVALENT

max-conn-per-session

NO REST EQUIVALENT

max-error-recovery-level

NO REST EQUIVALENT

retain-timeout

NO REST EQUIVALENT

tcp-window-size

NO REST EQUIVALENT

iscsi-service-start

Set property "enabled" to "true".

PATCH /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

iscsi-service-status

Use the query: fields=enabled

GET /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

iscsi-service-stop

Set property "enabled" to "false".

PATCH /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

iscsi-session-get-iter

GET /api/protocols/san/iscsi/sessions vicon.png

ONTAPI attribute

REST attribute

Comment

cmd-window-size

NO REST EQUIVALENT

data-pdu-in-order

NO REST EQUIVALENT

data-sequence-in-order

NO REST EQUIVALENT

default-time-to-retain

NO REST EQUIVALENT

default-time-to-wait

NO REST EQUIVALENT

error-recovery-level

NO REST EQUIVALENT

first-burst-length

NO REST EQUIVALENT

immediate-data-enabled

NO REST EQUIVALENT

initial-r2t-enabled

NO REST EQUIVALENT

initiator-aliasname

initiator.alias

initiator-nodename

initiator.name

iscsi-session-connection-list-entries

NO REST EQUIVALENT

iscsi-sesssion-cmd-list-entries

NO REST EQUIVALENT

isid

isid

max-burst-length

NO REST EQUIVALENT

max-connections

NO REST EQUIVALENT

This attribute is considered obsolete and is expected to always be "1". Some older iSCSI solutions implement multipathing at the iSCSI session layer, bonding multiple connections into a session below the SCSI layer. All supported iSCSI stacks use a single connection per session.

max-ios-per-session

NO REST EQUIVALENT

max-outstanding-r2t

NO REST EQUIVALENT

session-type

NO REST EQUIVALENT

target-session-id

NO REST EQUIVALENT

tpgroup-name

target_portal_group

tpgroup-tag

target_portal_group_tag

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

iscsi-session-shutdown

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

iscsi-stats-get-iter

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

iscsi-target-alias-clear-alias

Set property "target.alias" to the empty string.

PATCH /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

iscsi-target-alias-get-alias

Use the query: fields=target.alias

GET /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

iscsi-target-alias-set-alias

PATCH /api/protocols/san/iscsi/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

alias-name

target.alias

iscsi-tpgroup-create

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

iscsi-tpgroup-destroy

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

iscsi-tpgroup-get-iter

GET /api/protocols/san/iscsi/sessions vicon.png

ONTAPI attribute

REST attribute

Comment

interface-list-entries

NO REST EQUIVALENT

is-user-defined

NO REST EQUIVALENT

tpgroup-alua-preferred

NO REST EQUIVALENT

tpgroup-alua-state

NO REST EQUIVALENT

tpgroup-name

target_portal_group

tpgroup-tag

target_portal_group_tag

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging..

iscsi-tpgroup-interface-add

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

iscsi-tpgroup-interface-delete

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

Category: JOB

job-bad-erase

This is an unsupported ONTAPI operation.

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

job-bad-get-iter

This is an unsupported ONTAPI operation.

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

job-by-node-get

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

job-by-node-get-iter

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

job-completed-get

GET /api/cluster/jobs/{uuid}?state=success|failure vicon.png

ONTAPI attribute

REST attribute

Comment

is-restarted

NO REST EQUIVALENT

job-category

NO REST EQUIVALENT

job-completion

message

job-description

description

job-dropdead-time

NO REST EQUIVALENT

job-end-time

end_time

job-id

NO REST EQUIVALENT

job-name

NO REST EQUIVALENT

job-node

NO REST EQUIVALENT

job-priority

NO REST EQUIVALENT

job-progress

message

job-queue-time

NO REST EQUIVALENT

job-schedule

NO REST EQUIVALENT

job-start-time

start_time

job-state

state

ONTAPI State → REST API State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

NO REST EQUIVALENT

job-username

NO REST EQUIVALENT

job-uuid

uuid

job-vserver

svm.name

job-id

NO REST EQUIVALENT

job-completed-get-iter

GET /api/cluster/jobs?state=success|failure vicon.png

ONTAPI attribute

REST attribute

Comment

is-restarted

NO REST EQUIVALENT

job-category

NO REST EQUIVALENT

job-completion

message

job-description

description

job-dropdead-time

NO REST EQUIVALENT

job-end-time

end_time

job-id

NO REST EQUIVALENT

job-name

NO REST EQUIVALENT

job-node

NO REST EQUIVALENT

job-priority

NO REST EQUIVALENT

job-progress

message

job-queue-time

NO REST EQUIVALENT

job-schedule

NO REST EQUIVALENT

job-start-time

start_time

job-state

state

ONTAPI State → REST API State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

NO REST EQUIVALENT

job-username

NO REST EQUIVALENT

job-uuid

uuid

job-vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

job-delete

DELETE /api/cluster/jobs/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-id

NO REST EQUIVALENT

The job-id property is represented as the "uuid" in the resource path.

job-delete-iter

This is an unsupported ONTAPI operation.

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

job-expunge

This is an unsupported ONTAPI operation.

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

job-expunge-iter

This is an unsupported ONTAPI operation.

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

job-get

The REST API resource /api/cluster/jobs applies a filter based on the schedule property (@now|-) to remove background system jobs.

GET /api/cluster/jobs/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-restarted

NO REST EQUIVALENT

job-category

NO REST EQUIVALENT

job-completion

message

job-description

description

job-dropdead-time

NO REST EQUIVALENT

job-end-time

end_time

job-id

NO REST EQUIVALENT

job-name

NO REST EQUIVALENT

job-node

NO REST EQUIVALENT

job-priority

NO REST EQUIVALENT

job-progress

message

job-queue-time

NO REST EQUIVALENT

job-schedule

NO REST EQUIVALENT

job-start-time

start_time

job-state

state

ONTAPI State → REST API State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

NO REST EQUIVALENT

job-username

NO REST EQUIVALENT

job-uuid

uuid

job-vserver

svm.name

job-id

NO REST EQUIVALENT

job-get-iter

The REST API resource /api/cluster/jobs applies a filter based on the schedule property (@now|-) to remove background system jobs.

GET /api/cluster/jobs vicon.png

ONTAPI attribute

REST attribute

Comment

is-restarted

NO REST EQUIVALENT

job-category

NO REST EQUIVALENT

job-completion

message

job-description

description

job-dropdead-time

NO REST EQUIVALENT

job-end-time

end_time

job-id

NO REST EQUIVALENT

job-name

NO REST EQUIVALENT

job-node

NO REST EQUIVALENT

job-priority

NO REST EQUIVALENT

job-progress

message

job-queue-time

NO REST EQUIVALENT

job-schedule

NO REST EQUIVALENT

job-start-time

start_time

job-state

state

ONTAPI State → REST API State
dead → failure
dormant → running
error → failure
failure → failure
initial → queued
paused → paused
pausing → running
queued → queued
quit → failure
quitting → running
reschedule → running
restart → running
running → running
success → success
waiting → running
unknown → running

job-status-code

code

job-type

NO REST EQUIVALENT

job-username

NO REST EQUIVALENT

job-uuid

uuid

job-vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

job-history-get

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

job-history-get-iter

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

job-init-state-get

This is an unsupported ONTAPI operation.

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

job-init-state-get-iter

This is an unsupported ONTAPI operation.

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

job-kick

This is an unsupported ONTAPI operation.

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

job-pause

Not all jobs support the pause action. The pause action can only be applied to running jobs.

PATCH /api/cluster/jobs/{uuid}?action=pause vicon.png

ONTAPI attribute

REST attribute

Comment

job-id

NO REST EQUIVALENT

The job-id property is represented as the "uuid" in the resource path.

job-pause-iter

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

job-private-completed-get

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

job-private-completed-get-iter

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

job-private-delete

This is an unsupported ONTAPI operation.

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

job-private-delete-iter

This is an unsupported ONTAPI operation.

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

job-private-get

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

job-private-get-iter

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

job-private-pause

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

job-private-pause-iter

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

job-private-resume

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

job-private-resume-iter

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

job-private-soft-pause

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

job-private-soft-pause-iter

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

job-private-stop

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

job-private-stop-iter

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

job-private-watch-progress

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

job-queue-config-get

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

job-queue-config-modify

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

job-queue-get

This is an unsupported ONTAPI operation.

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

job-queue-get-iter

This is an unsupported ONTAPI operation.

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

job-resume

Not all jobs support the resume action. The pause action can only be applied to paused jobs.

PATCH /api/cluster/jobs/{uuid}?action=resume vicon.png

ONTAPI attribute

REST attribute

Comment

job-id

NO REST EQUIVALENT

The job-id property is represented as the "uuid" in the resource path.

job-resume-iter

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

job-schedule-consumer-get

This is an unsupported ONTAPI operation.

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

job-schedule-consumer-get-iter

This is an unsupported ONTAPI operation.

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

job-schedule-cron-create

POST /api/cluster/schedules vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-cron-day

cron.days

job-schedule-cron-day-of-week

cron.weekdays

job-schedule-cron-hour

cron.hours

job-schedule-cron-minute

cron.minutes

job-schedule-cron-month

cron.months

job-schedule-name

name

return-record

?return-records=true

job-schedule-cron-destroy

DELETE /api/cluster/schedules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

NO REST EQUIVALENT

job-schedule-name

NO REST EQUIVALENT

job-schedule-cron-destroy-iter

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

job-schedule-cron-get

GET /api/cluster/schedules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-cron-day

cron.days

job-schedule-cron-day-of-week

cron.weekdays

job-schedule-cron-hour

cron.hours

job-schedule-cron-minute

cron.minutes

job-schedule-cron-month

cron.months

job-schedule-description

NO REST EQUIVALENT

job-schedule-name

name

job-schedule-cron-get-iter

GET /api/cluster/schedules vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-cron-day

cron.days

job-schedule-cron-day-of-week

cron.weekdays

job-schedule-cron-hour

cron.hours

job-schedule-cron-minute

cron.minutes

job-schedule-cron-month

cron.months

job-schedule-description

NO REST EQUIVALENT

job-schedule-name

name

max-records

max_records

Specifies the maximum number of records to return before paging.

job-schedule-cron-modify

PATCH /api/cluster/schedules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-cron-day

cron.days

job-schedule-cron-day-of-week

cron.weekdays

job-schedule-cron-hour

cron.hours

job-schedule-cron-minute

cron.minutes

job-schedule-cron-month

cron.months

job-schedule-name

name

job-schedule-get

GET /api/cluster/schedules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-description

NO REST EQUIVALENT

job-schedule-name

name

job-schedule-type

NO REST EQUIVALENT

job-schedule-cluster

cluster.name

job-schedule-get-iter

GET /api/cluster/schedules vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-description

NO REST EQUIVALENT

job-schedule-name

name

job-schedule-type

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

job-schedule-interval-create

Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.

POST /api/cluster/schedules vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-interval-days

NO REST EQUIVALENT

job-schedule-interval-hours

NO REST EQUIVALENT

job-schedule-interval-minutes

NO REST EQUIVALENT

job-schedule-interval-seconds

NO REST EQUIVALENT

job-schedule-name

name

return-record

?return-records=true

job-schedule-interval-destroy

DELETE /api/cluster/schedules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

NO REST EQUIVALENT

job-schedule-name

NO REST EQUIVALENT

job-schedule-interval-destroy-iter

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

job-schedule-interval-get

Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.

GET /api/cluster/schedules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-description

NO REST EQUIVALENT

job-schedule-interval-days

interval

job-schedule-interval-hours

interval

job-schedule-interval-minutes

interval

job-schedule-interval-seconds

interval

job-schedule-name

name

job-schedule-interval-get-iter

Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.

GET /api/cluster/schedules vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-description

NO REST EQUIVALENT

job-schedule-interval-days

interval

job-schedule-interval-hours

interval

job-schedule-interval-minutes

interval

job-schedule-interval-seconds

interval

job-schedule-name

name

max-records

max_records

Specifies the maximum number of records to return before paging.

job-schedule-interval-modify

Interval schedules no longer use separate properties for days, hours, minutes, seconds, but use a string interval property that follows the ISO-8601 format.

PATCH /api/cluster/schedules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-schedule-cluster

cluster.name

job-schedule-interval-days

interval

job-schedule-interval-hours

interval

job-schedule-interval-minutes

interval

job-schedule-interval-seconds

interval

job-schedule-name

name

job-soft-pause

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

job-soft-pause-iter

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

job-stop

Not all jobs support the cancel action.

PATCH /api/cluster/jobs/{uuid}?action=cancel vicon.png

ONTAPI attribute

REST attribute

Comment

job-id

NO REST EQUIVALENT

The job-id property is represented as the "uuid" in the resource path.

job-stop-iter

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

job-type-by-category-get

This is an unsupported ONTAPI operation.

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

job-type-by-category-get-iter

This is an unsupported ONTAPI operation.

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

job-type-get

This is an unsupported ONTAPI operation.

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

job-type-get-iter

This is an unsupported ONTAPI operation.

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

job-unclaim

This is an unsupported ONTAPI operation.

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

job-unclaim-iter

This is an unsupported ONTAPI operation.

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

Category: KERBEROS

kerberos-config-get

GET /api/protocols/nfs/kerberos/interfaces/{interface.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

admin-password

NO REST EQUIVALENT

admin-user-name

NO REST EQUIVALENT

force

NO REST EQUIVALENT

interface-name

interface.name

ip-address

interface.ip.address

is-kerberos-enabled

enabled

keytab-uri

NO REST EQUIVALENT

machine-account

NO REST EQUIVALENT

organizational-unit

NO REST EQUIVALENT

permitted-enc-types

encryption_types

service-principal-name

spn

vserver

svm.name

kerberos-config-get-iter

GET /api/protocols/nfs/kerberos/interfaces vicon.png

ONTAPI attribute

REST attribute

Comment

admin-password

NO REST EQUIVALENT

admin-user-name

NO REST EQUIVALENT

force

NO REST EQUIVALENT

interface-name

interface.name

ip-address

interface.ip.address

is-kerberos-enabled

enabled

keytab-uri

NO REST EQUIVALENT

machine-account

NO REST EQUIVALENT

organizational-unit

NO REST EQUIVALENT

permitted-enc-types

encryption_types

service-principal-name

spn

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

kerberos-config-modify

PATCH /api/protocols/nfs/kerberos/interfaces/{interface.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

admin-password

password

admin-user-name

user

force

NO REST EQUIVALENT

interface-name

interface.name

is-kerberos-enabled

enabled

keytab-uri

keytab_uri

machine-account

NO REST EQUIVALENT

organizational-unit

organizational_unit

service-principal-name

spn

kerberos-realm-create

POST /api/protocols/nfs/kerberos/realms vicon.png

ONTAPI attribute

REST attribute

Comment

ad-server-ip

ad_server.address

ad-server-name

ad_server.name

admin-server-ip

NO REST EQUIVALENT

admin-server-port

NO REST EQUIVALENT

clock-skew

NO REST EQUIVALENT

comment

comment

config-name

NO REST EQUIVALENT

kdc-ip

kdc.ip

kdc-port

kdc.port

kdc-vendor

kdc.vendor

password-server-ip

NO REST EQUIVALENT

password-server-port

NO REST EQUIVALENT

realm

name

kerberos-realm-delete

DELETE /api/protocols/nfs/kerberos/realms/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

config-name

NO REST EQUIVALENT

realm

name

kerberos-realm-get-iter

GET /api/protocols/nfs/kerberos/realms vicon.png

ONTAPI attribute

REST attribute

Comment

ad-server-ip

ad_server.address

ad-server-name

ad_server.name

admin-server-ip

NO REST EQUIVALENT

admin-server-port

NO REST EQUIVALENT

clock-skew

NO REST EQUIVALENT

comment

comment

config-name

NO REST EQUIVALENT

kdc-ip

kdc.ip

kdc-port

kdc.port

kdc-vendor

kdc.vendor

password-server-ip

NO REST EQUIVALENT

password-server-port

NO REST EQUIVALENT

permitted-enc-types

encryption_types

realm

name

vserver-name

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

kerberos-realm-modify

PATCH /api/protocols/nfs/kerberos/realms/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

ad-server-ip

ad_server.address

ad-server-name

ad_server.name

admin-server-ip

NO REST EQUIVALENT

admin-server-port

NO REST EQUIVALENT

clock-skew

NO REST EQUIVALENT

comment

comment

config-name

NO REST EQUIVALENT

kdc-ip

kdc.ip

kdc-port

kdc.port

kdc-vendor

kdc.vendor

password-server-ip

NO REST EQUIVALENT

password-server-port

NO REST EQUIVALENT

realm

name

Category: LDAP

ldap-check-get-iter

GET /api/name-services/ldap vicon.png

ONTAPI attribute

REST attribute

Comment

client-config

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-dn-status-details

NO REST EQUIVALENT

This field is not required in the REST API. LDAP server status details will be provided in the status.message field.

ldap-status

status.state

This is an advanced privilege field in the REST API.

ldap-status-details

status.message

This is an advanced privilege field in the REST API.

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

ldap-client-create

The REST API does not treat LDAP client create as an independent operation. Create the LDAP client and LDAP configuration by using LDAP POST. Use the /api/security/authentication/cluster/ldap endpoint to create cluster LDAP configurations.

POST /api/name-services/ldap vicon.png

ONTAPI attribute

REST attribute

Comment

ad-domain

ad_domain

base-dn

base_dn

base-scope

base_scope

bind-as-cifs-server

bind-as-cifs-server

bind-dn

bind_dn

bind-password

bind_password

group-dn

group_dn

group-membership-filter

group_membership_filter

group-scope

group_scope

is-netgroup-byhost-enabled

is_netgroup_byhost_enabled

ldap-client-config

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-servers

servers

min-bind-level

min_bind_level

netgroup-byhost-dn

netgroup_byhost_dn

netgroup-byhost-scope

netgroup_byhost_scope

netgroup-dn

netgroup_dn

netgroup-scope

netgroup_scope

obs-password

NO REST EQUIVALENT

preferred-ad-servers

preferred_ad_servers

query-timeout

query_timeout

referral-enabled

referral_enabled

return-record

?return_records=true

schema

schema

servers

NO REST EQUIVALENT

This field has been deprecated. Use "ldap-servers" parameter.

session-security

session_security

tcp-port

port

use-start-tls

use_start_tls

user-dn

user_dn

user-scope

user_scope

try-channel-binding

try_channel_binding

ldap-client-delete

The REST API does not treat LDAP client delete as an independent operation. Delete the LDAP client and LDAP configuration by using LDAP DELETE. Use the /api/security/authentication/cluster/ldap endpoint to delete cluster LDAP configurations.

DELETE /api/name-services/ldap/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ldap-client-config

NO REST EQUIVALENT

To delete an LDAP client config use the DELETE /api/name-services/ldap REST API endpoint.

ldap-client-get-iter

The REST API does not have a separate LDAP client GET operation. Retrieve LDAP client configurations by using LDAP GET.

GET /api/name-services/ldap vicon.png

ONTAPI attribute

REST attribute

Comment

ad-domain

ad_domain

base-dn

base_dn

base-scope

base_scope

bind-as-cifs-server

bind_as_cifs_server

bind-dn

bind_dn

bind-password

bind_password

group-dn

group_dn

This is an advanced privilege field in the REST API.

group-membership-filter

group_membership_filter

This is an advanced privilege field in the REST API.

group-scope

group_scope

This is an advanced privilege field in the REST API.

is-netgroup-byhost-enabled

is_netgroup_byhost_enabled

This is an advanced privilege field in the REST API.

is-owner

is_owner

ldap-client-config

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-servers

servers

min-bind-level

min_bind_level

netgroup-byhost-dn

netgroup_byhost_dn

This is an advanced privilege field in the REST API.

netgroup-byhost-scope

netgroup_byhost_scope

This is an advanced privilege field in the REST API.

netgroup-dn

netgroup_dn

This is an advanced privilege field in the REST API.

netgroup-scope

netgroup_scope

This is an advanced privilege field in the REST API.

obs-password

NO REST EQUIVALENT

preferred-ad-servers

preferred_ad_servers

query-timeout

query_timeout

referral-enabled

referral_enabled

schema

schema

servers

NO REST EQUIVALENT

This field has been deprecated. Use "ldap-servers" parameter.

session-security

session_security

skip-config-validation

NO REST EQUIVALENT

tcp-port

port

use-start-tls

use_start_tls

user-dn

user_dn

This is an advanced privilege field in the REST API.

user-scope

user_scope

This is an advanced privilege field in the REST API.

vserver

svm.name

try-channel-binding

try_channel_binding

max-records

max_records

Specifies the maximum number of records to return before paging.

ldap-client-modify

The REST API does not have a separate LDAP client modify operation. Update the LDAP client by using LDAP PATCH. Use the /api/security/authentication/cluster/ldap endpoint to modify cluster LDAP configurations.

PATCH /api/name-services/ldap/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ad-domain

ad_domain

base-dn

base_dn

base-scope

base_scope

bind-as-cifs-server

bind_as_cifs_server

bind-dn

bind_dn

bind-password

bind_password

group-dn

group_dn

group-membership-filter

group_membership_filter

group-scope

group_scope

is-netgroup-byhost-enabled

is_netgroup_byhost_enabled

ldap-client-config

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

ldap-servers

servers

min-bind-level

min_bind_level

netgroup-byhost-dn

netgroup_byhost_dn

netgroup-byhost-scope

netgroup_byhost_scope

netgroup-dn

netgroup_dn

netgroup-scope

netgroup_scope

obs-password

NO REST EQUIVALENT

preferred-ad-servers

preferred_ad_servers

query-timeout

query_timeout

referral-enabled

referral_enabled

schema

schema

servers

NO REST EQUIVALENT

This field has been deprecated. Use "ldap-servers" parameter.

session-security

session_security

skip-config-validation

skip_config_validation

tcp-port

port

use-start-tls

use_start_tls

user-dn

user_dn

user-scope

user_scope

try-channel-binding

try_channel_binding

ldap-client-schema-copy

POST /api/name-services/ldap-schemas vicon.png

ONTAPI attribute

REST attribute

Comment

new-schema-name

name

schema

template.name

ldap-client-schema-delete

DELETE /api/name-services/ldap-schemas/{owner.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

schema

name

ldap-client-schema-get-iter

GET /api/name-services/ldap-schemas vicon.png

ONTAPI attribute

REST attribute

Comment

cn-group-attribute

rfc2307.cn.group

cn-netgroup-attribute

rfc2307.cn.netgroup

comment

comment

enable-rfc2307bis

rfc2307bis.enabled

gecos-attribute

rfc2307.attribute.gecos

gid-number-attribute

rfc2307.attribute.gid_number

group-of-unique-names-object-class

rfc2307bis.group_of_unique_names

home-directory-attribute

rfc2307.attribute.home_directory

is-owner

NO REST EQUIVALENT

login-shell-attribute

rfc2307.attribute.login_shell

member-nis-netgroup-attribute

rfc2307.member.nis_netgroup

member-uid-attribute

rfc2307.member.uid

nis-mapentry-attribute

rfc2307.nis.mapentry

nis-mapname-attribute

rfc2307.nis.mapname

nis-netgroup-object-class

rfc2307.nis.netgroup

nis-netgroup-triple-attribute

rfc2307.nis.netgroup_triple

nis-object-class

rfc2307.nis.object

posix-account-object-class

rfc2307.posix.account

posix-group-object-class

rfc2307.posix.group

schema

name

uid-attribute

rfc2307.attribute.uid

uid-number-attribute

rfc2307.attribute.uid_number

unique-member-attribute

rfc2307bis.unique_member

user-password-attribute

rfc2307.attribute.user_password

vserver

owner.uuid

windows-account-attribute

name_mapping.account.windows

windows-to-unix-attribute

name_mapping.windows_to_unix.attribute

windows-to-unix-no-domain-prefix

name_mapping.windows_to_unix.no_domain_prefix

windows-to-unix-object-class

name_mapping.windows_to_unix.object_class

max-records

max_records

Specifies the maximum number of records to return before paging.

ldap-client-schema-modify

PATCH /api/name-services/ldap-schemas/{owner.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

cn-group-attribute

rfc2307.cn.group

cn-netgroup-attribute

rfc2307.cn.netgroup

comment

comment

enable-rfc2307bis

rfc2307bis.enabled

gecos-attribute

rfc2307.attribute.gecos

gid-number-attribute

rfc2307.attribute.gid_number

group-of-unique-names-object-class

rfc2307bis.group_of_unique_names

home-directory-attribute

rfc2307.attribute.home_directory

login-shell-attribute

rfc2307.attribute.login_shell

member-nis-netgroup-attribute

rfc2307.member.nis_netgroup

member-uid-attribute

rfc2307.member.uid

nis-mapentry-attribute

rfc2307.nis.mapentry

nis-mapname-attribute

rfc2307.nis.mapname

nis-netgroup-object-class

rfc2307.nis.netgroup

nis-netgroup-triple-attribute

rfc2307.nis.netgroup_triple

nis-object-class

rfc2307.nis.object

posix-account-object-class

rfc2307.posix.account

posix-group-object-class

rfc2307.posix.group

schema

name

uid-attribute

rfc2307.attribute.uid

uid-number-attribute

rfc2307.attribute.uid_number

unique-member-attribute

rfc2307bis.unique_member

user-password-attribute

rfc2307.attribute.user_password

windows-account-attribute

name_mapping.account.windows

windows-to-unix-attribute

name_mapping.windows_to_unix.attribute

windows-to-unix-no-domain-prefix

name_mapping.windows_to_unix.no_domain_prefix

windows-to-unix-object-class

name_mapping.windows_to_unix.object_class

ldap-config-create

Use the /api/security/authentication/cluster/ldap REST API endpoint to create cluster LDAP configurations.

POST /api/name-services/ldap vicon.png

ONTAPI attribute

REST attribute

Comment

client-config

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

client-enabled

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

return-record

?return_records=true

skip-config-validation

skip_config_validation

ldap-config-delete

Use the /api/security/authentication/cluster/ldap REST API endpoint to delete cluster LDAP configurations.

DELETE /api/name-services/ldap/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

ldap-config-get-iter

GET /api/name-services/ldap vicon.png

ONTAPI attribute

REST attribute

Comment

client-config

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

client-enabled

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

skip-config-validation

NO REST EQUIVALENT

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

ldap-config-modify

Use the /api/security/authentication/cluster/ldap REST API endpoint to modify cluster LDAP configurations.

PATCH /api/name-services/ldap/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

client-config

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

client-enabled

NO REST EQUIVALENT

ldap-client-config and ldap-config are merged into a single endpoint in the REST API. Each SVM can have only one LDAP client config. This field is not required in the REST API.

skip-config-validation

skip_config_validation

Category: LICENSE-V2

license-v2-add

POST /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

codes

keys

license-v2-apply

POST /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

content

keys

Each element of the keys attribute MUST be a JSON string, enclosed in double quotes, with all double quotes within the original string prefaced (escaped) with a "\".

license-v2-capacity-create

POST /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

license-input

keys

Applies only to ONTAP Select. Each element of the keys attribute MUST be a JSON string, enclosed in double quotes, with all double quotes within the original string prefaced (escaped) with a "\".

license-v2-capacity-get-iter

GET /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

current-capacity

licenses.capacity.used_size

expiration-time

licenses.expiry_time

max-capacity

licenses.capacity.maximum_size

owner

licenses.owner

package

name

reported-state

state

serial-number

licenses.serial_number

max-records

max_records

Specifies the maximum number of records to return before paging.

license-v2-cleanup-list-info

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

license-v2-delete

DELETE /api/cluster/licensing/licenses/{name}?serial_number={serial_number}

ONTAPI attribute

REST attribute

Comment

package

name

serial-number

serial_number

license-v2-delete-expired

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

license-v2-delete-unused

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

license-v2-entitlement-risk-get-iter

Key information can be obtained from this REST API.

GET /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

action

NO REST EQUIVALENT

action-code

NO REST EQUIVALENT

node-license-usage

owner,serial_number

package

name

risk

NO REST EQUIVALENT

the non-compliant state indicates risk.

max-records

max_records

Specifies the maximum number of records to return before paging.

license-v2-leases-update

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

license-v2-license-manager-config-get

GET /api/cluster/licensing/license-managers/{uuid}

ONTAPI attribute

REST attribute

Comment

host

uri.host

license-v2-license-manager-config-modify

PATCH /api/cluster/licensing/license-managers/{uuid}

ONTAPI attribute

REST attribute

Comment

host

uri.host

license-v2-license-manager-status-get-iter

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

license-v2-list-info

This ONTAPI does NOT apply to capacity pool licenses.

GET /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

serial-number

licenses.serial_number

package

name

owner

licenses.owner

description

NO REST EQUIVALENT

type

NO REST EQUIVALENT

expiration-time

licenses.expiry_time

legacy

NO REST EQUIVALENT

customer-id

NO REST EQUIVALENT

license-v2-status-get-iter

This ONTAPI does NOT apply to capacity pool licenses.

GET /api/cluster/licensing/licenses/{name}

ONTAPI attribute

REST attribute

Comment

detailed-status

NO REST EQUIVALENT

license

name

scope

scope

status

state

max-records

max_records

Specifies the maximum number of records to return before paging.

license-v2-status-list-info

GET /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

detailed-status

NO REST EQUIVALENT

license

name

scope

scope

status

state

max-records

max_records

Specifies the maximum number of records to return before paging.

license-v2-status-list-info

POST /api/cluster/licensing/licenses

ONTAPI attribute

REST attribute

Comment

license-input

NO REST EQUIVALENT

Each element of the keys attribute MUST be a JSON string, enclosed in double quotes, with all double quotes within the original string prefaced (escaped) with a "\".

license-v2-subscription-get-iter

GET /api/cluster/licensing/licenses?name=cloud

ONTAPI attribute

REST attribute

Comment

alert

NO REST EQUIVALENT

description

NO REST EQUIVALENT

expiration

licenses.expiry_time

is-default

NO REST EQUIVALENT

owner

licenses.owner

package

name

serial-number

licenses.serial_number

state

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

system-license-aggregate-get-iter

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

Category: LOCK

lock-break-iter

DELETE /api/protocols/locks/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

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.

bytelock-length

byte_lock.length

bytelock-offset

byte_lock.offset

client-address

client_address

client-address-type

NO REST EQUIVALENT

client-id

NO REST EQUIVALENT

delegation-type

delegation

flexcache-cluster

NO REST EQUIVALENT

flexcache-lock-authority

NO REST EQUIVALENT

flexcache-volume

NO REST EQUIVALENT

flexcache-vserver

NO REST EQUIVALENT

is-bytelock-exclusive

byte_lock.exclusive

is-bytelock-mandatory

byte_lock.mandatory

is-bytelock-soft

byte_lock.soft

is-bytelock-super

byte_lock.super

is-constituent

constituent

is-flexcache-lock

NO REST EQUIVALENT

is-sharelock-soft

share_lock.soft

lif

interface.name

lock-state

state

lock-type

type

lockid

uuid

node

node.name

oplock-cache-level

oplock_level

owner-id

owner_id

path

path

protocol

protocol

sharelock-mode

share_lock.mode

smb-connect-state

smb.connect_state

smb-expiration-time

NO REST EQUIVALENT

smb-open-group-id

smb.open_group_id

smb-open-type

smb.open_type

volume

volume.name

vserver

svm.name

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

lock-get-iter

GET /api/protocols/locks vicon.png

ONTAPI attribute

REST attribute

Comment

bytelock-length

byte_lock.length

bytelock-offset

byte_lock.offset

client-address

client_address

client-address-type

NO REST EQUIVALENT

client-id

NO REST EQUIVALENT

delegation-type

delegation

flexcache-cluster

NO REST EQUIVALENT

flexcache-lock-authority

NO REST EQUIVALENT

flexcache-volume

NO REST EQUIVALENT

flexcache-vserver

NO REST EQUIVALENT

is-bytelock-exclusive

byte_lock.exclusive

is-bytelock-mandatory

byte_lock.mandatory

is-bytelock-soft

byte_lock.soft

is-bytelock-super

byte_lock.super

is-constituent

constituent

is-flexcache-lock

NO REST EQUIVALENT

is-sharelock-soft

share_lock.soft

lif

interface.name

lock-state

state

lock-type

type

lockid

uuid

node

node.name

oplock-cache-level

oplock_level

owner-id

owner_id

path

path

protocol

protocol

sharelock-mode

share_lock.mode

smb-connect-state

smb.connect_state

smb-expiration-time

NO REST EQUIVALENT

smb-open-group-id

smb.open_group_id

smb-open-type

smb.open_type

volume

volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: LUN

lun-alignment-get-iter

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

lun-alignment-reset-statistics

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

lun-bind

POST /api/protocols/san/vvol-bindings vicon.png

ONTAPI attribute

REST attribute

Comment

protocol-endpoint-path

protocol_endpoint.name

vvol-path

vvol.name

lun-bind-get-iter

GET /api/protocols/san/vvol-bindings vicon.png

ONTAPI attribute

REST attribute

Comment

is-optimal

is_optimal

protocol-endpoint-path

protocol_endpoint.name

protocol-endpoint-uuid

protocol_endpoint.uuid

reference-count

count

secondary-lun

NO REST EQUIVALENT

vserver

svm

vvol-path

vvol.name

vvol-uuid

vvol.uuid

max-records

max_records

Specifies the maximum number of records to return before paging..

lun-clear-persistent-reservation-info

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

lun-cluster-config-get

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

lun-copy-cancel

The preferred method for canceling a copy is to delete the destination LUN.

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

lun-copy-get-iter

Active LUN copy operations are reported in the "copy" properties of LUN GET. "copy.destinations" is populated with LUNs that are the destination of one or more copies of the containing LUN, which is the source. "copy.source" is populated with the LUN that is the source of a copy of the containing LUN, which is the destination.

GET /api/storage/luns vicon.png

ONTAPI attribute

REST attribute

Comment

cutover-time

NO REST EQUIVALENT

destination-path

copy.destinations.name or name depending on the containing LUN’s relationship to the copy operation.

destination-vserver

svm.name

elapsed-time

NO REST EQUIVALENT

is-destination-ready

NO REST EQUIVALENT

is-promoted-early

NO REST EQUIVALENT

All LUN copy operations started using the LUN REST API use early promotion.

is-snapshot-fenced

copy.destinations.progress.volume_snapshot_blocked or copy.source.progress.volume_snapshot_blocked

job-status

copy.destinations.progress.state or copy.source.progress.state

job-uuid

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

last-failure-reason

copy.destinations.progress.failure or copy.source.progress.failure

lun-index

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

max-throughput

copy.destinations.max_throughput or copy.source.max_throughput

progress-percent

copy.destinations.progress.percent_complete or copy.source.progress.percent_complete

scanner-progress

NO REST EQUIVALENT

scanner-total

NO REST EQUIVALENT

source-path

copy.source.name or name depending on the containing LUN’s relationship to the copy operation.

source-snapshot-instance-uuid

NO REST EQUIVALENT

source-vserver

svm.name

max-records

NO REST EQUIVALENT

lun-copy-modify

PATCH property "copy.source.max_throughput" of the destination copy destination LUN.

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-uuid

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

lun-index

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

max-throughput

copy.source.max_throughput

lun-copy-pause

PATCH property "source.copy.progress.state" of the copy destination LUN to "pause".

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-uuid

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

lun-index

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

lun-copy-resume

PATCH property "source.copy.progress.state" of the copy destination LUN to "replicating".

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-uuid

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

lun-index

NO REST EQUIVALENT

A particular LUN copy job is identified in REST by its source and destination.

lun-copy-start

POST a LUN and specify property "copy.source.uuid" and/or "copy.source.name" to start an asynchronous LUN copy operation.

POST /api/storage/luns vicon.png

ONTAPI attribute

REST attribute

Comment

destination-vserver

svm.name

max-throughput

NO REST EQUIVALENT

paths

name and source.name

promote-early

NO REST EQUIVALENT

All copy operations started with the REST API use early protmotion.

reference-path

NO REST EQUIVALENT

serial-number

NO REST EQUIVALENT

source-vserver

svm.name

lun-create-by-size

POST /api/storage/luns vicon.png

ONTAPI attribute

REST attribute

Comment

application

NO REST EQUIVALENT

block-size

NO REST EQUIVALENT

caching-policy

NO REST EQUIVALENT

class

class

comment

comment

foreign-disk

NO REST EQUIVALENT

ostype

os_type

path

name

In the REST API, the LUN name is the traditional LUN path from the CLI/ONTAPI. The traditional LUN tuple of (volume, qtree, lun) is now represented by the location property of the LUN REST APIs.

prefix-size

NO REST EQUIVALENT

qos-adaptive-policy-group

qos_policy.name

qos-policy-group

qos_policy.name

size

space.size

space-allocation-enabled

space.scsi_thin_provisioning_support_enabled

space-reservation-enabled

space.guarantee.requested

type

os_type

use-exact-size

NO REST EQUIVALENT

lun-create-from-file

Creating a LUN from a file can be accomplished by creating the LUN, then using
the LUN data write functionality of the REST API to copy the file contents
to the LUN.

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

application

NO REST EQUIVALENT

block-size

NO REST EQUIVALENT

caching-policy

NO REST EQUIVALENT

class

NO REST EQUIVALENT

comment

NO REST EQUIVALENT

file-name

NO REST EQUIVALENT

ostype

NO REST EQUIVALENT

path

NO REST EQUIVALENT

preserve-ids

NO REST EQUIVALENT

qos-adaptive-policy-group

NO REST EQUIVALENT

qos-policy-group

NO REST EQUIVALENT

space-allocation-enabled

NO REST EQUIVALENT

space-reservation-enabled

NO REST EQUIVALENT

lun-debug-get

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

lun-destroy

DELETE /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destroy-application-lun

NO REST EQUIVALENT

destroy-fenced-lun

NO REST EQUIVALENT

force

allow_delete_while_mapped

path

name

The best practice with the REST API is to delete LUNs by specifying the UUID in the URI. The REST API also supports a query by the LUN name. You must ensure that you specify both the name and SVM: ?svm.name={svm}&name=/vol/{vol}/{lun}.

lun-generate-serial

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

lun-get-attribute

GET /api/storage/luns/{lun.uuid}/attributes/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

name

NO REST EQUIVALENT

The attribute name is specified as part of the endpoint URI.

path

NO REST EQUIVALENT

The LUN is specified using the LUN’s UUID as part of the endpoint URI.

value

value

lun-get-attributes

Attributes can also be fetched using GET /api/storage/luns/{lun.uuid}?fields=attributes.

GET /api/storage/luns/{lun.uuid}/attributes vicon.png

ONTAPI attribute

REST attribute

Comment

name

name

path

NO REST EQUIVALENT

The LUN is specified using the LUN’s UUID as part of the endpoint URI.

lun-get-comment

Use the query: fields=comment

GET /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

name

lun-get-geometry

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

lun-get-inquiry-info

See the target property of the initiator group endpoint.

GET /api/protocols/san/igroups vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group-name

name

lun-get-iter

GET /api/storage/luns vicon.png

ONTAPI attribute

REST attribute

Comment

alignment

NO REST EQUIVALENT

application

NO REST EQUIVALENT

application-uuid

NO REST EQUIVALENT

backing-snapshot

NO REST EQUIVALENT

block-size

NO REST EQUIVALENT

caching-policy

NO REST EQUIVALENT

class

class

clone-backing-snapshot

NO REST EQUIVALENT

comment

comment

creation-timestamp

create_time

device-binary-id

NO REST EQUIVALENT

device-id

NO REST EQUIVALENT

device-text-id

NO REST EQUIVALENT

is-clone

NO REST EQUIVALENT

is-clone-autodelete-enabled

auto_delete

is-inconsistent-import

NO REST EQUIVALENT

is-restore-inaccessible

NO REST EQUIVALENT

is-space-alloc-enabled

space.scsi_thin_provisioning_support_enabled

is-space-reservation-enabled

space.guarantee.requested

mapped

status.mapped

multiprotocol-type

os_type

node

location.node.name

online

enabled

path

name

prefix-size

NO REST EQUIVALENT

qos-adaptive-policy-group

qos_policy.name

qos-policy-group

qos_policy.name

qtree

location.qtree.name

read-only

status.read_only

serial-7-mode

NO REST EQUIVALENT

serial-number

serial_number

share-state

NO REST EQUIVALENT

size

space.size

size-used

space.used

staging

NO REST EQUIVALENT

state

status.state

suffix-size

NO REST EQUIVALENT

uuid

uuid

volume

location.volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

lun-get-maxsize

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

lun-get-minsize

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

lun-get-occupied-size

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

lun-get-persistent-reservation-info

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

lun-get-select-attribute

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

lun-get-serial-number

Use the query: fields=serial_number

GET /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

name

lun-get-space-reservation-info

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

lun-get-vdisk-attributes

Use the query: serial_number={value}. Note that both the ONTAPI and REST API equivalent are not optimized and might check every LUN in the system, which will be slow with a large number of LUNs.

GET /api/storage/luns

ONTAPI attribute

REST attribute

Comment

serial-number

serial_number

lun-group-internal-rebuild

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

lun-has-scsi-reservations

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

lun-import-create

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

lun-import-delete

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

lun-import-get-iter

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

lun-import-pause

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

lun-import-resume

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

lun-import-start

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

lun-import-stop

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

lun-import-throttle

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

lun-import-verify-start

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

lun-import-verify-stop

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

lun-initiator-list-map-info

The contents of this ONTAPI are split across the initiator group (igroup), LUN, and LUN map REST API endpoints. The igroups endpoint efficiently finds the igroups that contain the specified initiator by using the query ?initiators.name={initiator}. The "lun_maps" property of the igroup API returns the mapped LUNs. From there, you can query the LUNs or LUN maps APIs with the LUN UUIDs of the mapped LUNs to return the remaining details that are provided by this ONTAPI.

GET /api/protocols/san/igroups

ONTAPI attribute

REST attribute

Comment

initiator

initiators.name

lun-initiator-logged-in

Another valid endpoint is: /api/protocols/san/iscsi/sessions.

GET /api/network/fc/logins

ONTAPI attribute

REST attribute

Comment

initiator

initiator.wwpn

initiator.name is valid for both possible endpoints.

lun-lun-rescan

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

lun-map

POST /api/protocols/san/lun-maps vicon.png

ONTAPI attribute

REST attribute

Comment

additional-reporting-node

additional_reporting_node

Specify the cluster node name and/or UUID in additional_reporting_node.name and/or additional_reporting_node.uuid.

force

NO REST EQUIVALENT

initiator-group

igroup.name

lun-id

logical_unit_number

path

lun.name

lun-map-add-reporting-nodes

POST /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes vicon.png

ONTAPI attribute

REST attribute

Comment

all

NO REST EQUIVALENT

This is not supported in the REST API. It was added to ZAPI to address upgrade/revert issues when the Selective LUN Map (SLM) feature was added to ONTAP and is now obsolete.

destination-aggregate

NO REST EQUIVALENT

This is not supported directly in the REST API, but a caller can determine the cluster node of a LUN move destination aggregate and use POST /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes to acheive the same result.

destination-volume

NO REST EQUIVALENT

This is not supported directly in the REST API, but a caller can determine the cluster node of a LUN move destination volume and use POST /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes to acheive the same result.

igroup

NO REST EQUIVALENT

The initiator group (igroup) is specified using the igroup UUID in the resource URI.

nodes

NO REST EQUIVALENT

Specify the uuid and/or name property in the POST body.

path

NO REST EQUIVALENT

The LUN is specified using the LUN UUID in the resource URI.

lun-map-get-iter

LUN maps are also available through the GET /api/storage/luns and GET /api/protocols/san/igroups endpoints.

GET /api/protocols/san/lun-maps vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group

igroup.name

initiator-group-uuid

igroup.uuid

lun-id

logical_unit_number

lun-uuid

lun.uuid

node

lun.node.name

path

lun.name

reporting-nodes

reporting_nodes

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

lun-map-list-info

Use the query: fields=lun_maps. Note that the initiators are not included in this API, but you can retrieve them from the /api/protocols/san/igroups REST API endpoint.

GET /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

name

lun-map-remove-reporting-nodes

DELETE /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

igroup

NO REST EQUIVALENT

The initiator group (igroup) is specified using the igroup UUID in the resource URI.

nodes

NO REST EQUIVALENT

The cluster node is specified using the node UUID in the resource URI.

path

NO REST EQUIVALENT

The LUN is specified using the LUN UUID in the resource URI.

lun-move

A PATCH that modifies the qtree and/or base name portion of the LUN name is considered a rename operation.

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

new-path

name

path

name

lun-move-cancel

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

lun-move-get-iter

GET /api/storage/luns vicon.png

ONTAPI attribute

REST attribute

Comment

cutover-time

NO REST EQUIVALENT

destination-path

movement.paths.destination

elapsed-time

movement.progress.elapsed

is-destination-ready

NO REST EQUIVALENT

is-promoted-late

NO REST EQUIVALENT

Always false if started from the REST API.

is-snapshot-fenced

movement.progress.volume_snapshot_blocked

job-status

movement.progress.state

job-uuid

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

last-failure-reason

movement.progress.failure.message

lun-index

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

max-throughput

movement.max_throughput

progress-percent

movement.progress.percent_complete

scanner-progress

NO REST EQUIVALENT

scanner-total

NO REST EQUIVALENT

source-path

movement.paths.source

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

lun-move-modify

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-uuid

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

lun-index

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

max-throughput

movement.max_throughput

lun-move-pause

PATCH the "movement.progress.state" property of a moving LUN to "paused".

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-uuid

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

lun-index

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

lun-move-resume

PATCH the "movement.progress.state" property of a moving LUN to "replicating".

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

job-uuid

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

lun-index

NO REST EQUIVALENT

A particular LUN move job is identified in REST by the LUN’s unique identifier.

lun-move-start

In the REST API, changing the volume of a LUN by using the "name", "location.volume.name", or "location.volume.uuid" property starts a LUN move to the specified volume.

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

max-throughput

movement.max_throughput

paths

NO REST EQUIVALENT

The REST API is limited to moving one LUN at a time.

promote-late

NO REST EQUIVALENT

In the REST API, LUN moves are always promoted late.

reference-path

NO REST EQUIVALENT

lun-offline

PATCH the "enabled" property to "false".

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

name

lun-online

PATCH the "enabled" property to "true".

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

path

name

lun-os-type-list

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

lun-port-has-scsi-reservations

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

lun-prepare-to-downgrade

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

lun-resize

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

Always false in the REST API.

path

name

size

space.size

lun-set-attribute

Attributes can be set while creating a LUN using POST /api/storage/luns. Additional attributes can be added to an existing LUN using POST /api/storage/luns/{lun.uuid}/attributes.

PATCH /api/storage/luns/{lun.uuid}/attributes/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

name

NO REST EQUIVALENT

The attribute name is specified as part of the endpoint URI.

path

NO REST EQUIVALENT

The LUN is specified using the LUN’s UUID as part of the endpoint URI.

value

value

lun-set-comment

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

path

name

lun-set-device-id

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

lun-set-qos-policy-group

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

name

qos-adaptive-policy-group

qos_policy.name

qos-policy-group

qos_policy.name

lun-set-select-attribute

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

lun-set-serial-number

The REST API does not support user provided LUN serial numbers. This ONTAPI is only supported for backward compatibility and should not be used.

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

lun-set-space-alloc

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

enable

space.scsi_thin_provisioning_support_enabled

path

name

lun-set-space-reservation-info

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

enable

space.guarantee.requested

path

name

lun-stats-get-iter

While not a one-to-one replacement, the "metric" and "statistics" properties of the LUN REST API are intended to replace the functionality of this ONTAPI. Note that while the property names are similar, the REST API implementation is more advanced and might return slightly different values than the corresponding ONTAPI property.

GET /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

block-size

NO REST EQUIVALENT

last-zeroed

NO REST EQUIVALENT

other-ops

NO REST EQUIVALENT

path

name

read-blocks

NO REST EQUIVALENT

read-ops

NO REST EQUIVALENT

scsi-errors

NO REST EQUIVALENT

vserver

svm.name

write-blocks

NO REST EQUIVALENT

write-ops

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

lun-test-vdisk-size

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

lun-testmap

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

lun-transition-7mode-destroy

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

lun-transition-7mode-get-iter

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

lun-transition-start

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

lun-transition-volume-get-iter

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

lun-unbind

DELETE /api/protocols/san/vvol-bindings/{protocol_endpoint.uuid}/{vvol.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

delete_all_references

protocol-endpoint-path

NO REST EQUIVALENT

The protocol endpoint LUN of the vVol binding is specified in REST endpoint path using the UUID in place of the LUN path.

vvol-path

NO REST EQUIVALENT

The vVol LUN of the vVol binding is specified in REST endpoint path using the UUID in place of the LUN path.

lun-unmap

DELETE /api/protocols/san/lun-maps/{lun.uuid}/{igroup.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

initiator-group

NO REST EQUIVALENT

The initiator group of the LUN map is specified in REST endpoint path using the UUID in place of the initiator group name.

path

NO REST EQUIVALENT

The LUN of the LUN map is specified in REST endpoint path using the UUID in place of the LUN path.

lun-unset-attribute

DELETE /api/storage/luns/{lun.uuid}/attributes/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

name

NO REST EQUIVALENT

The attribute name is specified as part of the endpoint URI.

path

NO REST EQUIVALENT

The LUN is specified using the LUN’s UUID as part of the endpoint URI.

lun-unset-device-id

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

lun-alignment-list-info

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

lun-write-raw

Writing data is performed using a PATCH request on the LUN endpoint. The request header must
include `Content-Type: multipart/form-data`. The request body must be `multipart/form-data`
content with exactly one form entry containing the data to write.

PATCH /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

NO REST EQUIVALENT

The LUN to which to write is identfied by the UUID in the REST URI.

offset

data.offset

length

NO REST EQUIVALENT

The size of the data to write is implied by the REST request content.

encoded-data

NO REST EQUIVALENT

lun-read-raw

Reading data is performed using a GET request on the LUN endpoint. The request header must
include `Accept: multipart/form-data`. Data is returned as `multipart/form-data` content
with exactly one form entry containing the data.

GET /api/storage/luns/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

NO REST EQUIVALENT

The LUN from which to read is identfied by the UUID in the REST URI.

offset

data.offset

length

data.size

lun-create-vld-metadir-entry

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

lun-delete-vld-metadir-entry

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

lun-preserve-qtree-nondisruptive-restore

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

lun-restore-qtree-nondisruptive-restore

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

lun-cleanup-qtree-nondisruptive-restore

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

lun-id-swap

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

lun-lba-hole-range-query

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

lun-lba-is-hole

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

Category: METROCLUSTER-CHECK-CONNECTION

metrocluster-check-connection-get-iter

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

Category: METROCLUSTER-CONFIGURATION-SETTINGS

metrocluster-configuration-settings-get-iter

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

Category: METROCLUSTER-CONNECTION

metrocluster-connection-check

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

metrocluster-connection-connect-async

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

metrocluster-connection-disconnect-async

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

metrocluster-connection-get-iter

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

Category: METROCLUSTER-DR-GROUP

metrocluster-dr-group-create

POST /api/cluster/metrocluster/dr-groups

ONTAPI attribute

REST attribute

Comment

local-node

dr_pairs.node.name

partner-cluster

partner_cluster

remote-node

dr_pairs.partner.name

metrocluster-dr-group-delete

DELETE /api/cluster/metrocluster/dr-groups

ONTAPI attribute

REST attribute

Comment

dr-group-id

id

metrocluster-dr-group-get-iter

GET /api/cluster/metrocluster/dr-groups

ONTAPI attribute

REST attribute

Comment

cluster

partner_cluster.name

cluster-uuid

partner_cluster.uuid

dr-group-id

id

dr-partner-node

NO REST EQUIVALENT

dr-partner-node-uuid

NO REST EQUIVALENT

node

dr_pairs.node.name

node-uuid

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: METROCLUSTER-INTERFACE

metrocluster-interface-create

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

metrocluster-interface-delete

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

metrocluster-interface-get-iter

GET /api/cluster/metrocluster/interconnects

ONTAPI attribute

REST attribute

Comment

address

interfaces.address

cluster

NO REST EQUIVALENT

cluster-uuid

NO REST EQUIVALENT

config-error-info

NO REST EQUIVALENT

config-state

NO REST EQUIVALENT

dr-group-id

NO REST EQUIVALENT

gateway

interfaces.gateway

home-port

adapter

netmask

interfaces.netmask

node

node.name

node-uuid

node.uuid

vlan-id

vlan_id

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-interface-modify

PATCH /api/cluster/metrocluster/interconnects

ONTAPI attribute

REST attribute

Comment

address

interfaces.address

cluster-name

NO REST EQUIVALENT

gateway

interfaces.gateway

home-node

node.uuid

home-port

adapter

netmask

interfaces.netmask

Category: METROCLUSTER

metrocluster-add-disks

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

metrocluster-check-aggregate-eligibility-get

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

metrocluster-check-aggregate-eligibility-get-iter

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

metrocluster-check-aggregate-get-iter

GET /api/cluster/metrocluster/diagnostics

ONTAPI attribute

REST attribute

Comment

additional-info

aggregate.details.checks.additional_info

aggregate

aggregate.details.aggregate.name

check

aggregate.details.checks.name

cluster-name

aggregate.details.cluster.name

node-name

aggregate.details.node.name

result

aggregate.details.checks.result

timestamp

aggregate.details.timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-check-capture-status-get

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

metrocluster-check-cluster-get-iter

GET /api/cluster/metrocluster/diagnostics

ONTAPI attribute

REST attribute

Comment

additional-info

cluster.details.checks.additional_info

check

cluster.details.checks.name

cluster-name

cluster.details.cluster.name

result

cluster.details.checks.result

timestamp

cluster.details.timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-check-config-replication-get

GET /api/cluster/metrocluster/diagnostics

ONTAPI attribute

REST attribute

Comment

cluster-recovery-steps

cluster.summary

cluster-streams

NO REST EQUIVALENT

heartbeat-recovery-steps

NO REST EQUIVALENT

is-enabled

NO REST EQUIVALENT

is-running

NO REST EQUIVALENT

last-heartbeat-received

NO REST EQUIVALENT

last-heartbeat-sent

NO REST EQUIVALENT

recovery-steps

config-replication.summary

remote-heartbeat

NO REST EQUIVALENT

storage-in-use

NO REST EQUIVALENT

storage-non-healthy-reason

NO REST EQUIVALENT

storage-recovery-steps

NO REST EQUIVALENT

storage-status

NO REST EQUIVALENT

vserver-recovery-steps

NO REST EQUIVALENT

vserver-streams

NO REST EQUIVALENT

metrocluster-check-get-iter

GET /api/cluster/metrocluster/diagnostics

ONTAPI attribute

REST attribute

Comment

additional-info

NO REST EQUIVALENT

Component’s additional-info is listed as summary in the metrocluster_diagnostics object

component

NO REST EQUIVALENT

Component is listed as a property in the metrocluster_diagnostics object

result

state

timestamp

timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-check-lif-repair-placement

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

metrocluster-check-lif-update-vserver-name

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

metrocluster-check-node-get-iter

GET /api/cluster/metrocluster/diagnostics

ONTAPI attribute

REST attribute

Comment

additional-info

node.details.checks.additional_info

check

node.details.checks.name

cluster-name

node.details.cluster.name

node-name

node.details.node.name

result

node.details.checks.result

timestamp

node.details.timestamp

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-check-run

POST /api/cluster/metrocluster/diagnostics

ONTAPI attribute

REST attribute

Comment

skip-dr-simulation

NO REST EQUIVALENT

In the REST API, skip-dr-simulation is "true".

start-on-node-and-skip-node-version-checks

NO REST EQUIVALENT

metrocluster-check-volume-get-iter

GET /api/cluster/metrocluster/diagnostics

ONTAPI attribute

REST attribute

Comment

additional-info

volume.summary

check

NO REST EQUIVALENT

result

volume.state

timestamp

volume.timestamp

volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-config-diff-get

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

metrocluster-config-diff-get-iter

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

metrocluster-config-replication-cluster-storage-configuration-get

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

metrocluster-config-replication-cluster-storage-configuration-modify

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

metrocluster-config-replication-resync-status-get

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

metrocluster-configure

POST /api/cluster/metrocluster

ONTAPI attribute

REST attribute

Comment

node-name

NO REST EQUIVALENT

refresh

NO REST EQUIVALENT

start-on-node-and-skip-node-version-checks

NO REST EQUIVALENT

metrocluster-create-periodic-job

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

metrocluster-delete-periodic-job

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

metrocluster-disable

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

metrocluster-disable-periodic-check

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

metrocluster-enable-periodic-check

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

metrocluster-get

GET /api/cluster/metrocluster

ONTAPI attribute

REST attribute

Comment

configuration-type

NO REST EQUIVALENT

Available as metrocluster in the GET /api/cluster/nodes endpoint response.

local-auso-failure-domain

NO REST EQUIVALENT

local-cluster-name

local.cluster.name

local-configuration-state

local.configuration_state

local-mode

local.mode

local-periodic-check-enabled

local.periodic_check_enabled

remote-auso-failure-domain

NO REST EQUIVALENT

remote-cluster-name

remote.cluster.name

remote-configuration-state

remote.configuration_state

remote-mode

remote.mode

remote-periodic-check-enabled

remote.periodic_check_enabled

metrocluster-heal

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

metrocluster-interconnect-adapter-auto-reset-on-error-modify

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

metrocluster-interconnect-adapter-get-iter

GET /api/cluster/metrocluster/interconnects

ONTAPI attribute

REST attribute

Comment

adapter-name

adapter

adapter-type

type

firmware-version

NO REST EQUIVALENT

ip-address

NO REST EQUIVALENT

is-ood-enabled

NO REST EQUIVALENT

link-speed

NO REST EQUIVALENT

link-speed-neg-type

NO REST EQUIVALENT

node-name

node.name

physical-link-status

state

port-name

NO REST EQUIVALENT

port-wwn

NO REST EQUIVALENT

remote-adapter-list

NO REST EQUIVALENT

switch-model

NO REST EQUIVALENT

switch-name

NO REST EQUIVALENT

switch-port-name

NO REST EQUIVALENT

switch-port-wwn

NO REST EQUIVALENT

switch-status

NO REST EQUIVALENT

switch-vendor

NO REST EQUIVALENT

switch-wwn

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-interconnect-adapter-modify

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

metrocluster-interconnect-adapter-reset

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

metrocluster-interconnect-ipfo-get-iter

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

metrocluster-interconnect-mirror-get-iter

GET /api/cluster/metrocluster/interconnects

ONTAPI attribute

REST attribute

Comment

adapter-name

adapter

adapter-type

type

mirroring-admin-status

mirror.enabled

mirroring-oper-status

mirror.state

node-name

node.name

partner-name

NO REST EQUIVALENT

partner-type

partner_type

physical-link-status

state

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-interconnect-mirror-modify

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

metrocluster-interconnect-mirror-multipath-get-iter

GET /api/cluster/metrocluster/interconnects

ONTAPI attribute

REST attribute

Comment

multipath-policy

multipath_policy

node-name

node.name

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-interconnect-remotecluster-get-iter

GET /api/cluster/metrocluster

ONTAPI attribute

REST attribute

Comment

is-remote-cluster-reachable

local.partner_cluster_reachable

node

NO REST EQUIVALENT

node-uuid

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-is-configured

Listed as local.configuration_state in the GET of /api/cluster/metrocluster

GET /api/cluster/metrocluster

There are no attributes defined for this ONTAPI call.

metrocluster-node-get-iter

GET /api/cluster/metrocluster/nodes

ONTAPI attribute

REST attribute

Comment

additional-configuration-info

NO REST EQUIVALENT

automatic-uso

automatic_uso

cluster-name

cluster.name

configuration-state

configuration_state

dr-auxiliary-cluster-uuid

NO REST EQUIVALENT

dr-auxiliary-partner-node-name

NO REST EQUIVALENT

dr-auxiliary-partner-uuid

NO REST EQUIVALENT

dr-auxiliary-systemid

NO REST EQUIVALENT

dr-cluster-name

NO REST EQUIVALENT

dr-group-id

dr_group_id

dr-mirroring-state

dr_mirroring_state

dr-operation-duration

NO REST EQUIVALENT

dr-operation-state

dr_operation_state

dr-partner-cluster-uuid

NO REST EQUIVALENT

dr-partner-node-name

NO REST EQUIVALENT

Node and dr-partner-node is available in the GET /api/cluster/metrocluster/dr-groups endpoint response.

dr-partner-systemid

NO REST EQUIVALENT

dr-partner-uuid

NO REST EQUIVALENT

force-node-object-limit

NO REST EQUIVALENT

ha-partner-cluster-uuid

NO REST EQUIVALENT

ha-partner-node-name

NO REST EQUIVALENT

ha-partner-systemid

NO REST EQUIVALENT

ha-partner-uuid

NO REST EQUIVALENT

mccip-node

NO REST EQUIVALENT

node-cluster-uuid

NO REST EQUIVALENT

node-name

node.name

node-systemid

NO REST EQUIVALENT

node-uuid

node.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-operation-get-iter

GET /api/cluster/metrocluster/operations

ONTAPI attribute

REST attribute

Comment

additional-info

additional_info

cluster-name

NO REST EQUIVALENT

command-line

command_line

end-time

end_time

error-list

errors

job-id

NO REST EQUIVALENT

node-name

node.name

operation

type

operation-uuid

uuid

start-time

start_time

state

state

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-operation-statistics-get-iter

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

metrocluster-progress-table-get-iter

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

metrocluster-remove-dr-group

DELETE /api/cluster/metrocluster/dr-groups

ONTAPI attribute

REST attribute

Comment

dr-group-id

id

start-on-node-and-skip-node-version-checks

NO REST EQUIVALENT

metrocluster-show-lif-placement-failures-get-iter

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

metrocluster-switchback

PATCH /api/cluster/metrocluster

ONTAPI attribute

REST attribute

Comment

override-cluster-stream-resync-errors

NO REST EQUIVALENT

override-vetoes

NO REST EQUIVALENT

override-vserver-stream-resync-errors

NO REST EQUIVALENT

simulate

action

start-on-node-and-skip-node-version-checks

NO REST EQUIVALENT

metrocluster-switchover

Refer to the ONTAP REST API documentation for the usage of switchover.

PATCH /api/cluster/metrocluster

ONTAPI attribute

REST attribute

Comment

automatic

NO REST EQUIVALENT

controller-replacement

NO REST EQUIVALENT

force-nvfail-all

NO REST EQUIVALENT

forced-on-disaster

NO REST EQUIVALENT

To perform switchover on disaster, you can specify the action value as switchover

override-vetoes

NO REST EQUIVALENT

retry-failed-nodes

NO REST EQUIVALENT

simulate

NO REST EQUIVALENT

To perform simulate switchover, you can specify the action value as negotiated_switchover_simulate

start-on-node-and-skip-node-version-checks

NO REST EQUIVALENT

metrocluster-tracelog-dump

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

metrocluster-unconfigure

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

metrocluster-vserver-get-iter

GET /api/cluster/metrocluster/svms

ONTAPI attribute

REST attribute

Comment

cluster

cluster_name

configuration-state

configuration_state

failed-reason

failed_reason

failed-row

NO REST EQUIVALENT

partner-vserver

partner_svm_name

vserver

svm_name

max-records

max_records

Specifies the maximum number of records to return before paging.

metrocluster-vserver-resync

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

Category: NAME-MAPPING

name-mapping-create

POST /api/name-services/name-mappings vicon.png

ONTAPI attribute

REST attribute

Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

return-record

return_records

name-mapping-delete

DELETE /api/name-services/name-mappings/{svm.uuid}/{direction}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

direction

direction

position

index

name-mapping-get-iter

GET /api/name-services/name-mappings vicon.png

ONTAPI attribute

REST attribute

Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-mapping-insert

PATCH /api/name-services/name-mappings/{svm.uuid}/{direction}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

name-mapping-modify

PATCH /api/name-services/name-mappings/{svm.uuid}/{direction}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

address

client_match

direction

direction

hostname

client_match

pattern

pattern

position

index

replacement

replacement

name-mapping-refresh-hostname

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

name-mapping-swap

PATCH /api/name-services/name-mappings/{svm.uuid}/{direction}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

direction

direction

position

index

with-position

new_index

name-mapping-unix-group-add-user

POST /api/name-services/unix-groups/{svm.uuid}/{unix_group.name}/users vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

unix_group.name

UNIX group name should be specified as path parameter.

user-name

name

name parameter is used to add single user to the specified group.

name-mapping-unix-group-add-users

POST /api/name-services/unix-groups/{svm.uuid}/{unix_group.name}/users vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

unix_group.name

UNIX group name should be specified as path parameter.

user-list

records

records parameter is used to add multiple users in a single REST API call.

name-mapping-unix-group-create

POST /api/name-services/unix-groups vicon.png

ONTAPI attribute

REST attribute

Comment

group-id

id

group-name

name

return-record

return_records

skip-name-validation

skip_name_validation

name-mapping-unix-group-delete-user

DELETE /api/name-services/unix-groups/{svm.uuid}/{unix_group.name}/users/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

unix_group.name

UNIX group name should be specified as path parameter.

user-name

name

UNIX user to be deleted should be specified as path parameter.

name-mapping-unix-group-destroy

DELETE /api/name-services/unix-groups/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

group-name

name

name-mapping-unix-group-get

GET /api/name-services/unix-groups vicon.png

ONTAPI attribute

REST attribute

Comment

group-id

id

group-name

name

skip-name-validation

NO REST EQUIVALENT

skip-name-validation is a create field and will not be displayed in GET.

users

users

vserver

svm.name

group-name

name

name-mapping-unix-group-get-iter

GET /api/name-services/unix-groups/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

group-id

id

group-name

name

skip-name-validation

NO REST EQUIVALENT

skip-name-validation is a create field and will not be displayed in GET.

users

users

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-mapping-unix-group-modify

PATCH /api/name-services/unix-groups/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

group-id

id

group-name

name

name-mapping-unix-user-create

POST /api/name-services/unix-users vicon.png

ONTAPI attribute

REST attribute

Comment

full-name

full_name

group-id

primary_gid

return-record

?return_records=true

skip-name-validation

skip_name_validation

user-id

id

user-name

name

name-mapping-unix-user-destroy

DELETE /api/name-services/unix-users/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

user-name

name

name-mapping-unix-user-get

GET /api/name-services/unix-users/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

full-name

full_name

group-id

primary_gid

skip-name-validation

NO REST EQUIVALENT

This field is only available for UNIX users POST end-point.

user-id

id

user-name

name

vserver

svm.name

user-name

name

name-mapping-unix-user-get-iter

GET /api/name-services/unix-users vicon.png

ONTAPI attribute

REST attribute

Comment

full-name

full_name

group-id

primary_gid

skip-name-validation

NO REST EQUIVALENT

This field is only available for UNIX users POST end-point.

user-id

id

user-name

name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-mapping-unix-user-modify

PATCH /api/name-services/unix-users/{svm.uuid}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

full-name

full_name

group-id

primary_gid

user-id

id

user-name

name

name-service-unix-group-limits-get

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

name-service-unix-user-limits-get

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

Category: NAMESERVICE

name-service-cache-group-membership-settings-get

GET /api/name-services/cache/group-membership/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

grplist-ttl

ttl

is-enabled

enabled

vserver-name

svm.name

name-service-cache-group-membership-settings-get-iter

GET /api/name-services/cache/group-membership/settings vicon.png

ONTAPI attribute

REST attribute

Comment

grplist-ttl

ttl

is-enabled

enabled

vserver-name

svm.name

max-records

num-records

name-service-cache-group-membership-settings-modify

PATCH /api/name-services/cache/group-membership/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

grplist-ttl

ttl

is-enabled

enabled

name-service-cache-hosts-settings-get

GET /api/name-services/cache/host/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-dns-ttl-enabled

dns-ttl-enabled

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

name-service-cache-hosts-settings-get-iter

GET /api/name-services/cache/host/settings vicon.png

ONTAPI attribute

REST attribute

Comment

is-dns-ttl-enabled

dns-ttl-enabled

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

max-records

num-records

name-service-cache-hosts-settings-modify

PATCH /api/name-services/cache/host/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-dns-ttl-enabled

dns-ttl-enabled

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

negative-ttl

negative-ttl

ttl

ttl

name-service-cache-netgroup-settings-get

GET /api/name-services/cache/netgroup/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled-byhost

negative-ttl

negative-ttl-byhost

ttl

ttl-byhost

ttl-members

ttl-for-members

vserver-name

svm.name

name-service-cache-netgroup-settings-get-iter

GET /api/name-services/cache/netgroup/settings vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled-byhost

negative-ttl

negative-ttl-byhost

ttl

ttl-byhost

ttl-members

ttl-for-members

vserver-name

svm.name

max-records

num-records

NA

name-service-cache-netgroup-settings-modify

PATCH /api/name-services/cache/netgroup/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled-byhost

negative-ttl

negative-ttl-byhost

ttl

ttl-byhost

ttl-members

ttl-for-members

name-service-cache-unix-group-settings-get

GET /api/name-services/cache/unix-group/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

name-service-cache-unix-group-settings-get-iter

GET /api/name-services/cache/unix-group/settings vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

max-records

num-records

name-service-cache-unix-group-settings-modify

PATCH /api/name-services/cache/unix-group/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

name-service-cache-unix-user-settings-get

GET /api/name-services/cache/unix-user/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

name-service-cache-unix-user-settings-get-iter

GET /api/name-services/cache/unix-user/settings vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

vserver-name

svm.name

max-records

num-records

name-service-cache-unix-user-settings-modify

PATCH /api/name-services/cache/unix-user/settings/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

is-negative-cache-enabled

negative-cache-enabled

is-propagation-enabled

propagation-enabled

negative-ttl

negative-ttl

ttl

ttl

name-service-nis-binding-detail-get

GET /api/name-services/nis/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

bound-server

binding_details.server

bound-status

binding_details.status.message

nis-domain

domain

vserver

svm.uuid

name-service-nis-binding-detail-get-iter

GET /api/name-services/nis vicon.png

ONTAPI attribute

REST attribute

Comment

bound-server

binding_details.server

bound-status

binding_details.status.message

nis-domain

domain

vserver

svm.uuid

max-records

max_records

name-service-nis-show-bound

The REST API does not have a separate NIS show-bound operation. You can retrieve NIS bound-servers by using NIS GET. Use the /api/security/authentication/cluster/nis REST API endpoint to retrieve cluster NIS configurations.

GET /api/name-services/nis/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

bound-servers

bound_servers

nis-domain

domain

vserver

svm.name

name-service-nis-show-bound-iter

The REST API does not have a separate NIS show-bound operation. You can retrieve NIS bound-servers by using NIS GET.

GET /api/name-services/nis vicon.png

ONTAPI attribute

REST attribute

Comment

bound-servers

bound_servers

nis-domain

domain

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

name-service-unix-group-fileonly-get

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

name-service-unix-group-fileonly-modify

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

name-service-unix-user-fileonly-get

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

name-service-unix-user-fileonly-modify

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

nameservice-get-hostname-from-ipv4

GET /api/name-services/host-record/{svm.uuid}/{host}

ONTAPI attribute

REST attribute

Comment

ip-address

host

node

NO REST EQUIVALENT

show-source

NO REST EQUIVALENT

vserver

svm.uuid

nameservice-get-ip-from-hostname

GET /api/name-services/host-record/{svm.uuid}/{host}

ONTAPI attribute

REST attribute

Comment

address-family

NO REST EQUIVALENT

Both IPv4 and IPv6 IP addresses are sent as a separate list in REST API.

hostname

host

node

NO REST EQUIVALENT

show-source

NO REST EQUIVALENT

vserver

svm.uuid

nameservice-get-ipv4-from-hostname

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

nameservice-nsswitch-create

POST /api/svm/svms vicon.png

ONTAPI attribute

REST attribute

Comment

nameservice-database

NO REST EQUIVALENT

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases can also be specified:
nsswitch.group → specify group databse sources
nsswitch.passwd → specify passwd database sources
nsswitch.netgroup → specify netgroup database sources
nsswitch.namemap → specify namemap database sources

return-record

?return_records=true

nameservice-nsswitch-destroy

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

nameservice-nsswitch-get

GET /api/svm/svms/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

nameservice-database

NO REST EQUIVALENT

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases are also retrieved:
nsswitch.group → group databse sources
nsswitch.passwd → passwd database sources
nsswitch.netgroup → netgroup database sources
nsswitch.namemap → namemap database sources

vserver-name

name

nameservice-nsswitch-get-iter

GET /api/svm/svms vicon.png

ONTAPI attribute

REST attribute

Comment

nameservice-database

NO REST EQUIVALENT

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases are also retrieved:
nsswitch.group → group databse sources
nsswitch.passwd → passwd database sources
nsswitch.netgroup → netgroup database sources
nsswitch.namemap → namemap database sources

vserver-name

name

max-records

max_records

Specifies the maximum number of records to return before paging.

nameservice-nsswitch-modify

PATCH /api/svm/svms/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

nameservice-database

NO REST EQUIVALENT

The "database" property is merged with the "nameservice-sources" property.

nameservice-sources

nsswitch.hosts

Similar to hosts database, nsswitch sources for other databases can also be specified:
nsswitch.group → specify group databse sources
nsswitch.passwd → specify passwd database sources
nsswitch.netgroup → specify netgroup database sources
nsswitch.namemap → specify namemap database sources

Category: NDMP

ndmp-node-attributes-get-iter

GET /api/protocols/ndmp/nodes

ONTAPI attribute

REST attribute

Comment

clear-text

authentication_types

enable

enabled

node-name

node.name

user-id

user

max-records

max_records

Specifies the maximum number of records to return before paging.

ndmp-node-attributes-modify

PATCH /api/protocols/ndmp/nodes/{node.uuid}

ONTAPI attribute

REST attribute

Comment

clear-text

authentication_types

enable

enabled

node-name

NO REST EQUIVALENT

user-id

user

ndmp-node-modify-password

PATCH /api/protocols/ndmp/nodes/{node.uuid}

ONTAPI attribute

REST attribute

Comment

node-name

NO REST EQUIVALENT

password

password

ndmp-node-scope-mode-enable

PATCH /api/protocols/ndmp

There are no attributes defined for this ONTAPI call.

ndmp-node-scope-mode-status

GET /api/protocols/ndmp

There are no attributes defined for this ONTAPI call.

ndmp-node-service-disable

PATCH /api/protocols/ndmp/nodes/{node.uuid}

ONTAPI attribute

REST attribute

Comment

node-name

NO REST EQUIVALENT

ndmp-node-service-enable

PATCH /api/protocols/ndmp/nodes/{node.uuid}

ONTAPI attribute

REST attribute

Comment

node-name

NO REST EQUIVALENT

ndmp-node-session-info-get-iter

GET /api/protocols/ndmp/sessions

ONTAPI attribute

REST attribute

Comment

client-addr

client_address

client-port

client_port

data-backup-mode

backup_engine

data-bytes-processed

data.bytes_processed

data-con-addr

data.connection.address

data-con-addr-type

data.connection.type

data-con-port

data.connection.port

data-halt-reason

data.reason

data-operation

data.operation

data-path

data_path

data-state

data.state

eff-host

NO REST EQUIVALENT

is-secure-control-connection

NO REST EQUIVALENT

mover-bytes-left-to-read

NO REST EQUIVALENT

mover-bytes-moved

mover.bytes_moved

mover-con-addr

mover.connection.address

mover-con-addr-type

mover.connection.type

mover-con-port

mover.connection.port

mover-halt-reason

mover.reason

mover-mode

mover.mode

mover-pause-reason

mover.reason

mover-position

NO REST EQUIVALENT

mover-record-num

NO REST EQUIVALENT

mover-record-size

NO REST EQUIVALENT

mover-seek-position

NO REST EQUIVALENT

mover-setrecordsize-flag

NO REST EQUIVALENT

mover-setwindow-flag

NO REST EQUIVALENT

mover-state

mover.state

mover-window-length

NO REST EQUIVALENT

mover-window-offset

NO REST EQUIVALENT

ndmp-version

NO REST EQUIVALENT

node-name

node.name

session-authorized

NO REST EQUIVALENT

session-id

id

source-addr

source_address

spt-device-id

scsi.device_id

spt-ha

scsi.host_adapter

spt-scsi-id

scsi.target_id

spt-scsi-lun

scsi.lun_id

tape-device

tape_device

tape-mode

tape_mode

max-records

max_records

Specifies the maximum number of records to return before paging.

ndmp-node-session-kill

DELETE /api/protocols/ndmp/sessions/{owner.uuid}/{session.id}

ONTAPI attribute

REST attribute

Comment

node-name

owner.uuid

session-id

session.id

ndmp-node-session-kill-all

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

ndmp-password-generate

GET /api/protocols/ndmp/svms/{svm.uuid}/passwords/{user} vicon.png

ONTAPI attribute

REST attribute

Comment

password

password

user-name

user

vserver-name

svm.name

user-name

user

ndmp-vserver-attributes-get-iter

GET /api/protocols/ndmp/svms vicon.png

ONTAPI attribute

REST attribute

Comment

abort-on-disk-error

NO REST EQUIVALENT

authtype

authentication_types

backup-log-enable

NO REST EQUIVALENT

data-port-range

NO REST EQUIVALENT

debug-enable

NO REST EQUIVALENT

debug-filter

NO REST EQUIVALENT

dump-detailed-stats

NO REST EQUIVALENT

dump-logical-find

NO REST EQUIVALENT

enable

enabled

fh-dir-retry-interval

NO REST EQUIVALENT

fh-node-retry-interval

NO REST EQUIVALENT

ignore-ctime-enabled

NO REST EQUIVALENT

is-secure-control-connection-enabled

NO REST EQUIVALENT

maxversion

NO REST EQUIVALENT

offset-map-enable

NO REST EQUIVALENT

per-qtree-exclude-enable

NO REST EQUIVALENT

preferred-interface-role

NO REST EQUIVALENT

restore-vm-cache-size

NO REST EQUIVALENT

secondary-debug-filter

NO REST EQUIVALENT

tcpnodelay

NO REST EQUIVALENT

tcpwinsize

NO REST EQUIVALENT

vserver-name

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

ndmp-vserver-attributes-modify

PATCH /api/protocols/ndmp/svms/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

abort-on-disk-error

NO REST EQUIVALENT

authtype

authentication_types

backup-log-enable

NO REST EQUIVALENT

data-port-range

NO REST EQUIVALENT

debug-enable

NO REST EQUIVALENT

debug-filter

NO REST EQUIVALENT

dump-detailed-stats

NO REST EQUIVALENT

dump-logical-find

NO REST EQUIVALENT

enable

enabled

fh-dir-retry-interval

NO REST EQUIVALENT

fh-node-retry-interval

NO REST EQUIVALENT

ignore-ctime-enabled

NO REST EQUIVALENT

is-secure-control-connection-enabled

NO REST EQUIVALENT

offset-map-enable

NO REST EQUIVALENT

per-qtree-exclude-enable

NO REST EQUIVALENT

preferred-interface-role

NO REST EQUIVALENT

restore-vm-cache-size

NO REST EQUIVALENT

secondary-debug-filter

NO REST EQUIVALENT

tcpnodelay

NO REST EQUIVALENT

tcpwinsize

NO REST EQUIVALENT

ndmp-vserver-aware-mode-enable

PATCH /api/protocols/ndmp

There are no attributes defined for this ONTAPI call.

ndmp-vserver-aware-mode-status

GET /api/protocols/ndmp

There are no attributes defined for this ONTAPI call.

ndmp-vserver-service-disable

PATCH /api/protocols/ndmp/svms/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

ndmp-vserver-service-enable

PATCH /api/protocols/ndmp/svms/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

ndmp-vserver-session-info-get-iter

GET /api/protocols/ndmp/sessions vicon.png

ONTAPI attribute

REST attribute

Comment

client-addr

client_address

client-port

client_port

data-backup-mode

backup_engine

data-bytes-processed

data.bytes_processed

data-con-addr

data.connection.address

data-con-addr-type

data.connection.type

data-con-port

data.connection.port

data-halt-reason

data.reason

data-operation

data.operation

data-path

data_path

data-state

data.state

eff-host

NO REST EQUIVALENT

is-secure-control-connection

NO REST EQUIVALENT

mover-bytes-left-to-read

NO REST EQUIVALENT

mover-bytes-moved

mover.bytes_moved

mover-con-addr

mover.connection.address

mover-con-addr-type

mover.connection.type

mover-con-port

mover.connection.port

mover-halt-reason

mover.reason

mover-mode

mover.mode

mover-pause-reason

mover.reason

mover-position

NO REST EQUIVALENT

mover-record-num

NO REST EQUIVALENT

mover-record-size

NO REST EQUIVALENT

mover-seek-position

NO REST EQUIVALENT

mover-setrecordsize-flag

NO REST EQUIVALENT

mover-setwindow-flag

NO REST EQUIVALENT

mover-state

mover.state

mover-window-length

NO REST EQUIVALENT

mover-window-offset

NO REST EQUIVALENT

ndmp-version

NO REST EQUIVALENT

node-name

node.name

session-authorized

NO REST EQUIVALENT

session-id

id

source-addr

source_address

spt-device-id

scsi.device_id

spt-ha

scsi.host_adapter

spt-scsi-id

scsi.target_id

spt-scsi-lun

scsi.lun_id

tape-device

tape_device

tape-mode

tape_mode

vserver-name

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

ndmp-vserver-session-kill

DELETE /api/protocols/ndmp/sessions/{owner.uuid}/{session.id} vicon.png

ONTAPI attribute

REST attribute

Comment

session-id

session.id

ndmp-vserver-session-kill-all

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

Category: NET

data-lif-capacity

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

data-lif-capacity-details

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

net-active-routes-get

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

net-active-routes-get-iter

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

net-arp-active-entry-destroy

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

net-arp-active-entry-get

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

net-arp-active-entry-get-iter

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

net-arp-create

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

net-arp-destroy

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

net-arp-get

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

net-arp-get-iter

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

net-bgp-config-create

POST /api/network/ip/bgp/peer-groups

ONTAPI attribute

REST attribute

Comment

asn

peer.asn

hold-time

NO REST EQUIVALENT

node

local.port.node.name

return-record

return_records

router-id

NO REST EQUIVALENT

net-bgp-config-destroy

DELETE /api/network/ip/bgp/peer-groups/{uuid}

ONTAPI attribute

REST attribute

Comment

node

NO REST EQUIVALENT

The node is uniqely identified by the uuid.

net-bgp-config-get

GET /api/network/ip/bgp/peer-groups/{uuid}

ONTAPI attribute

REST attribute

Comment

asn

peer.asn

hold-time

NO REST EQUIVALENT

node

local.port.node.name

router-id

NO REST EQUIVALENT

net-bgp-config-get-iter

GET /api/network/ip/bgp/peer-groups

ONTAPI attribute

REST attribute

Comment

asn

peer.asn

hold-time

NO REST EQUIVALENT

node

local.port.node.name

router-id

NO REST EQUIVALENT

max-records

max_records

The maximum number of records to return before paging

net-bgp-config-modify

PATCH /api/network/ip/bgp/peer-groups/{uuid}

ONTAPI attribute

REST attribute

Comment

asn

peer.asn

hold-time

NO REST EQUIVALENT

node

NO REST EQUIVALENT

router-id

NO REST EQUIVALENT

net-bgp-defaults-get

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

net-bgp-defaults-modify

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

net-bgp-peer-group-create

POST /api/network/ip/bgp/peer-groups

ONTAPI attribute

REST attribute

Comment

bgp-lif

local.interface.name

Alternatively, you can specify "local.interface.uuid". The ipspace.name or ipspace.uuid is required when you specify the local interface. Refer to the REST API documentation for the usage of local.ip and local.port parameters.

ipspace

ipspace.name

peer-address

peer.address

peer-asn

peer.asn

peer-group

name

route-preference

NO REST EQUIVALENT

net-bgp-peer-group-destroy

DELETE /api/network/ip/bgp/peer-groups/{uuid}

ONTAPI attribute

REST attribute

Comment

ipspace

NO REST EQUIVALENT

peer-group

NO REST EQUIVALENT

net-bgp-peer-group-get

GET /api/network/ip/bgp/peer-groups/{uuid}

ONTAPI attribute

REST attribute

Comment

bgp-lif

local.interface.name

bgp-node

local.port.node.name

bgp-port

local.port.name

Alternatively, you can use "local.port.uuid".

ipspace

ipspace.name

peer-address

peer.address

peer-asn

peer.asn

peer-group

name

route-preference

NO REST EQUIVALENT

state

state

net-bgp-peer-group-get-iter

GET /api/network/ip/bgp/peer-groups

ONTAPI attribute

REST attribute

Comment

bgp-lif

local.interface.name

bgp-node

local.port.node.name

bgp-port

local.port.name

Alternatively, you can use "local.port.uuid".

ipspace

ipspace.name

peer-address

peer.address

peer-asn

peer.asn

peer-group

name

route-preference

NO REST EQUIVALENT

state

state

max-records

max_records

Specifies the maximum number of records to return before paging.

net-bgp-peer-group-modify

PATCH /api/network/ip/bgp/peer-groups/{uuid}

ONTAPI attribute

REST attribute

Comment

ipspace

ipspace.name

peer-address

peer.address

peer-group

NO REST EQUIVALENT

net-bgp-peer-group-rename

PATCH /api/network/ip/bgp/peer-groups/{uuid}

ONTAPI attribute

REST attribute

Comment

ipspace

ipspace.name

new-name

NO REST EQUIVALENT

peer-group

name

net-bgp-vserver-status-get

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

net-bgp-vserver-status-get-iter

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

net-check-failover

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

net-cluster-ping

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

net-cluster-ping6

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

net-connections-receive-window-size-get

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

net-connections-receive-window-size-get-iter

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

net-connections-receive-window-size-modify

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

net-ddns-get

Dynamic DNS is added as an object in DNS endpoint.

GET /api/name-services/dns vicon.png

ONTAPI attribute

REST attribute

Comment

domain-name

fqdn

is-enabled

enabled

skip-fqdn-validation

skip_fqdn_validation

ttl

time_to_live

use-secure

use_secure

vserver-name

svm.name

net-ddns-get-iter

Dynamic DNS is added as an object in DNS endpoint.

GET /api/name-services/dns/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

domain-name

fqdn

is-enabled

enabled

skip-fqdn-validation

skip_fqdn_validation

ttl

time_to_live

use-secure

use_secure

vserver-name

svm.name

max-records

NO REST EQUIVALENT

Maximum number of records applies to the DNS GET endpoint.

net-ddns-modify

Dynamic DNS is added as an object in DNS endpoint.

PATCH /api/name-services/dns/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

domain-name

fqdn

is-enabled

enabled

skip-fqdn-validation

skip_fqdn_validation

ttl

time_to_live

use-secure

use_secure

net-device-discovery-get-iter

GET /api/network/ethernet/ports

ONTAPI attribute

REST attribute

Comment

capabilities

discovered_devices.capabilities

chassis-id

discovered_devices.chassis_id

device-ip

discovered_devices.ip_addresses

discovered-device

discovered_devices.name

hold-time-remaining

discovered_devices.remaining_hold_time

interface

discovered_devices.remote_port

node

node.name

platform

discovered_devices.platform

port

name

protocol

discovered_devices.protocol

system-name

discovered_devices.system_name

version

discovered_devices.version

max-records

NO REST EQUIVALENT

Maximum number of records applies to the port GET endpoint.

net-disable-readonly

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

net-dns-check-get-iter

DNS check is an advanced parameter in DNS GET endpoint. It can be fetched using fields=** or fields=status.

GET /api/name-services/dns vicon.png

ONTAPI attribute

REST attribute

Comment

name-server

name_server

status

state

status-details

message

vserver

svm.name

max-records

NO REST EQUIVALENT

Maximum number of records applies to the DNS GET endpoint.

net-dns-create

POST /api/name-services/dns vicon.png

ONTAPI attribute

REST attribute

Comment

attempts

attempts

dns-state

NO REST EQUIVALENT

This field has been deprecated in the REST API. State is by default enabled when DNS is configured.

domains

domains

is-tld-query-enabled

tld_query_enabled

name-servers

servers

require-packet-query-match

packet_query_match

require-source-address-match

source_address_match

return-record

return_records

skip-config-validation

skip_config_validation

timeout

timeout

net-dns-destroy

DELETE /api/name-services/dns/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

net-dns-get

GET /api/name-services/dns/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

attempts

attempts

dns-state

NO REST EQUIVALENT

This field has been deprecated in the REST API. State is by default enabled when DNS is configured.

domains

domains

is-tld-query-enabled

tld_query_enabled

This field is an advanced parameter in DNS GET endpoint. It can be fetched using fields=** or fields=tld_query_enabled.

name-servers

servers

require-packet-query-match

packet_query_match

This field is an advanced parameter in DNS GET endpoint. It can be fetched using fields=** or fields=packet_query_match.

require-source-address-match

source_address_match

This field is an advanced parameter in DNS GET endpoint. It can be fetched using fields=** or fields=source_address_match.

skip-config-validation

skip_config_validation

timeout

timeout

vserver-name

svm.name

net-dns-get-iter

GET /api/name-services/dns vicon.png

ONTAPI attribute

REST attribute

Comment

attempts

attempts

dns-state

NO REST EQUIVALENT

This field has been deprecated in the REST API. State is by default enabled when DNS is configured.

domains

domains

is-tld-query-enabled

tld_query_enabled

This field is an advanced parameter in DNS GET endpoint. It can be fetched using fields=** or fields=tld_query_enabled.

name-servers

servers

require-packet-query-match

packet_query_match

This field is an advanced parameter in DNS GET endpoint. It can be fetched using fields=** or fields=packet_query_match.

require-source-address-match

source_address_match

This field is an advanced parameter in DNS GET endpoint. It can be fetched using fields=** or fields=source_address_match.

skip-config-validation

skip_config_validation

timeout

timeout

vserver-name

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

net-dns-modify

PATCH /api/name-services/dns/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

attempts

attempts

dns-state

NO REST EQUIVALENT

This field has been deprecated in the REST API. State is by default enabled when DNS is configured.

domains

domains

is-tld-query-enabled

tld_query_enabled

name-servers

servers

require-packet-query-match

packet_query_match

require-source-address-match

source_address_match

skip-config-validation

skip_config_validation

timeout

timeout

net-enable-readonly

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

net-external-route-table-create

This ONTAPI is published as an unsupported ONTAPI. It is available through the REST API by using the CLI passthrough /api/private/cli/network/cloud/routing-table.

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

net-external-route-table-delete

This ONTAPI is published as an unsupported ONTAPI. It is available through the REST API by using the CLI passthrough /api/private/cli/network/cloud/routing-table.

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

net-failover-group-add-targets

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-failover-group-create

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-failover-group-destroy

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-failover-group-get

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-failover-group-get-iter

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-failover-group-modify

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-failover-group-remove-targets

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-failover-group-rename

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API. Refer to the /api/network/ethernet/broadcast-domains/ REST API endpoint for documentation on broadcast domains.

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

net-firewall-config-get

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-config-get-iter

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-config-modify

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-config-modify-iter

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-policy-create

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-policy-destroy

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-policy-get

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-policy-get-iter

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-firewall-policy-modify

Firewall policies are deprecated in favor of service policies. Refer to the /api/network/ip/service-policies/ REST API documentation.

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

net-hosts-create

POST /api/name-services/local-hosts vicon.png

ONTAPI attribute

REST attribute

Comment

aliases

aliases

host-ip-address

address

hostname

hostname

vserver

owner.uuid

Can also use owner.name. Since we have used the scope variable in REST, we have a change in variable name of the vserver.

return-record

return_records

net-hosts-destroy

DELETE /api/name-services/local-hosts/{owner.uuid}/{address} vicon.png

ONTAPI attribute

REST attribute

Comment

host-ip-address

address

vserver

owner.uuid

Since we have used the scope variable in REST, we have a change in variable name of the vserver.

net-hosts-get

GET /api/name-services/local-hosts/{owner.uuid}/{address} vicon.png

ONTAPI attribute

REST attribute

Comment

aliases

aliases

host-ip-address

address

hostname

hostname

vserver-name

owner.name

Since we have used the scope variable in REST, we have a change in variable name of the vserver.

net-hosts-get-iter

GET /api/name-services/local-hosts vicon.png

ONTAPI attribute

REST attribute

Comment

aliases

aliases

host-ip-address

address

hostname

hostname

vserver-name

owner.name

Since we have used the scope variable in REST, we have a change in variable name of the vserver.

max-records

max_records

net-hosts-modify

PATCH /api/name-services/local-hosts/{owner.uuid}/{address} vicon.png

ONTAPI attribute

REST attribute

Comment

aliases

aliases

host-ip-address

address

hostname

hostname

vserver

owner.uuid

Since we have used the scope variable in REST, we have a change in variable name of the vserver.

net-interface-create

POST /api/network/ip/interfaces

ONTAPI attribute

REST attribute

Comment

address

ip.address

administrative-status

enabled

comment

NO REST EQUIVALENT

data-protocols

service_policy.uuid

In the REST API, data-protocols are deprecated and replaced with service_policy.

dns-domain-name

dns_zone

failover-group

location.broadcast_domain.uuid

In the REST API, failover-group is defined by the broadcast-domain.

failover-policy

location.failover

firewall-policy

service_policy.uuid

force-subnet-association

fail_if_subnets_conflict

The mapped fields are opposite in behavior i.e. setting force-subnet-association to TRUE is equivalent to setting fail_if_subnets_conflict to FALSE and vice versa.

home-node

location.home_node

home-port

location.home_port

interface-name

name

is-auto-revert

location.auto_revert

is-dns-update-enabled

ddns_enabled

is-ipv4-link-local

NO REST EQUIVALENT

is-vip

vip

listen-for-dns-query

NO REST EQUIVALENT

netmask

ip.netmask

netmask-length

ip.netmask

probe-port

probe_port

return-record

return_records

role

service_policy.uuid

routing-group-name

NO REST EQUIVALENT

This field is deprecated.

service-policy

service_policy.name

subnet-name

subnet.name

Also subnet.uuid uniquely identifies a subnet. Use /api/network/ip/subnets GET to get the list of subnets.

use-failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

vserver

NO REST EQUIVALENT

net-interface-delete

DELETE /api/network/ip/interfaces/{uuid}

ONTAPI attribute

REST attribute

Comment

interface-name

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

net-interface-get

GET /api/network/ip/interfaces/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

address

ip.address

address-family

ip.family

administrative-status

enabled

comment

NO REST EQUIVALENT

current-node

location.node.name

current-port

location.port.name

data-protocols

services

dns-domain-name

dns_zone

extended-status

NO REST EQUIVALENT

failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

failover-policy

location.failover

force-subnet-association

NO REST EQUIVALENT

home-node

location.home_node.name

home-port

location.home_port.name

interface-name

name

ipspace

ipspace.name

is-auto-revert

location.auto_revert

is-dns-update-enabled

ddns_enabled

is-home

location.is_home

is-ipv4-link-local

NO REST EQUIVALENT

is-vip

vip

lif-uuid

uuid

listen-for-dns-query

NO REST EQUIVALENT

netmask

NO REST EQUIVALENT

For the REST API, refer to "ip.netmask".

netmask-length

ip.netmask

operational-status

state

probe-port

probe_port

role

services

routing-group-name

NO REST EQUIVALENT

This field is deprecated.

service-names

services

service-policy

service_policy.name

subnet-name

NO REST EQUIVALENT

use-failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

vserver

svm.name

wwpn

NO REST EQUIVALENT

For the REST API, refer to the /api/network/fc/interfaces endpoint for this field.

net-interface-get-iter

GET /api/network/ip/interfaces vicon.png

ONTAPI attribute

REST attribute

Comment

address

ip.address

address-family

ip.family

administrative-status

enabled

comment

NO REST EQUIVALENT

current-node

location.node.name

current-port

location.port.name

data-protocols

services

dns-domain-name

dns_zone

extended-status

NO REST EQUIVALENT

failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

firewall-policy

service_policy.uuid

force-subnet-association

NO REST EQUIVALENT

home-node

location.home_node.name

home-port

location.home_port.name

interface-name

name

ipspace

ipspace.name

is-auto-revert

location.auto_revert

is-dns-update-enabled

ddns_enabled

is-home

location.is_home

is-ipv4-link-local

NO REST EQUIVALENT

is-vip

vip

lif-uuid

uuid

listen-for-dns-query

NO REST EQUIVALENT

netmask

ip.netmask

netmask-length

ip.netmask

operational-status

state

probe-port

probe_port

role

services

routing-group-name

NO REST EQUIVALENT

This field is deprecated.

service-names

services

service-policy

service_policy.name

subnet-name

NO REST EQUIVALENT

use-failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

vserver

svm.name

wwpn

NO REST EQUIVALENT

For the REST API, refer to the /api/network/fc/interfaces endpoint for this field.

max-records

max_records

Specifies the maximum number of records to return before paging.

net-interface-migrate

PATCH /api/network/ip/interfaces/{uuid}

ONTAPI attribute

REST attribute

Comment

destination-node

location.node.name

destination-port

location.port.name

force

NO REST EQUIVALENT

lif

NO REST EQUIVALENT

vserver

svm.name

net-interface-modify

PATCH /api/network/ip/interfaces/{uuid}

ONTAPI attribute

REST attribute

Comment

address

ip.address

administrative-status

enabled

comment

NO REST EQUIVALENT

dns-domain-name

dns_zone

failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

failover-policy

location.failover

firewall-policy

service_policy.uuid

force-subnet-association

fail_if_subnets_conflict

The mapped fields are opposite in behavior i.e. setting force-subnet-association to TRUE is equivalent to setting fail_if_subnets_conflict to FALSE and vice versa.

home-node

location.home_node.name

home-port

location.home_port.name

interface-name

NO REST EQUIVALENT

is-auto-revert

location.auto_revert

is-dns-update-enabled

ddns_enabled

listen-for-dns-query

NO REST EQUIVALENT

netmask

NO REST EQUIVALENT

netmask-length

ip.netmask

routing-group-name

NO REST EQUIVALENT

This field is deprecated.

service-policy

service_policy.name

subnet-name

subnet.name

Also subnet.uuid uniquely identifies a subnet. Use /api/network/ip/subnets GET to get the list of subnets.

use-failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

vserver

svm.name

net-interface-modify-iter

PATCH /api/network/ip/interfaces/{uuid}

ONTAPI attribute

REST attribute

Comment

address

ip.address

address-family

ip.family

administrative-status

enabled

comment

NO REST EQUIVALENT

current-node

location.node.name

current-port

location.port.name

data-protocols

service_policy.uuid

In the REST API, data-protocols are deprecated and replaced with service_policy.

dns-domain-name

dns_zone

extended-status

NO REST EQUIVALENT

failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

failover-policy

location.failover

firewall-policy

service_policy.uuid

force-subnet-association

fail_if_subnets_conflict

The mapped fields are opposite in behavior i.e. setting force-subnet-association to TRUE is equivalent to setting fail_if_subnets_conflict to FALSE and vice versa.

home-node

location.home_node.name

home-port

location.home_port.name

interface-name

name

ipspace

ipspace.name

is-auto-revert

location.auto_revert

is-dns-update-enabled

ddns_enabled

is-home

location.is_home

is-ipv4-link-local

NO REST EQUIVALENT

is-vip

vip

lif-uuid

uuid

listen-for-dns-query

NO REST EQUIVALENT

netmask

NO REST EQUIVALENT

For the REST API, refer to "ip.netmask".

netmask-length

ip.netmask

operational-status

state

probe-port

NO REST EQUIVALENT

role

service_policy.uuid

routing-group-name

NO REST EQUIVALENT

This field is deprecated.

service-names

services

service-policy

service_policy.name

subnet-name

subnet.name

Also subnet.uuid uniquely identifies a subnet. Use /api/network/ip/subnets GET to get the list of subnets.

use-failover-group

NO REST EQUIVALENT

For the REST API, refer to broadcast-domains.

vserver

svm.name

wwpn

NO REST EQUIVALENT

For the REST API, refer to the /api/network/fc/interfaces endpoint for this field.

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

net-interface-rename

PATCH /api/network/ip/interfaces/{uuid}

ONTAPI attribute

REST attribute

Comment

interface-name

NO REST EQUIVALENT

new-name

name

vserver

svm.name

net-interface-revert

PATCH /api/network/ip/interfaces/{uuid}

ONTAPI attribute

REST attribute

Comment

interface-name

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

net-interface-service-get

GET /api/network/ip/service-policies/{uuid}

ONTAPI attribute

REST attribute

Comment

failover-policy

NO REST EQUIVALENT

In the REST API, this information is exposed in the "location.failover" field in the /api/network/ip/interfaces endpoint.

ports

NO REST EQUIVALENT

service

NO REST EQUIVALENT

vserver-policy

NO REST EQUIVALENT

service

NO REST EQUIVALENT

net-interface-service-get-iter

GET /api/network/ip/service-policies

ONTAPI attribute

REST attribute

Comment

failover-policy

NO REST EQUIVALENT

In the REST API, this information is exposed in the location.failover field in the /api/network/ip/interfaces endpoint.

ports

NO REST EQUIVALENT

service

NO REST EQUIVALENT

vserver-policy

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

net-interface-service-policy-add-service

PATCH /api/network/ip/service-policies/{uuid}

ONTAPI attribute

REST attribute

Comment

allowed-addresses

NO REST EQUIVALENT

allowed-address list defaults to 0.0.0.0/0 in REST

policy

NO REST EQUIVALENT

policy is implied by service-policy’s uuid

service

services

vserver

NO REST EQUIVALENT

vserver is implied by service-policy’s uuid

net-interface-service-policy-clone

First a GET /api/network/ip/service-policies needs to be done on the specific service policy to be cloned, to fetch the list of services associated with it and followed by a POST to create a new one.

POST /api/network/ip/service-policies

ONTAPI attribute

REST attribute

Comment

policy

NO REST EQUIVALENT

The policy would be specified in the GET response (name field) of the service policy to be cloned.

target-policy

name

target-vserver

svm.name

svm.uuid also uniquely identifies the vserver. For system vserver, use ipspace.name and/or ipspace.uuid

vserver

NO REST EQUIVALENT

The vserver would be specified in the GET response (svm.name field) of the service policy to be cloned.

net-interface-service-policy-create

POST /api/network/ip/service-policies

ONTAPI attribute

REST attribute

Comment

policy

name

return-record

return_records

services

services

vserver

svm

For system vserver, use ipspace.name and/or ipspace.uuid

net-interface-service-policy-destroy

DELETE /api/network/ip/service-policies/{uuid}

ONTAPI attribute

REST attribute

Comment

policy

NO REST EQUIVALENT

policy is implied by service-policy’s uuid

vserver

NO REST EQUIVALENT

vserver is implied by service-policy’s uuid

net-interface-service-policy-entry-get

GET /api/network/ip/service-policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

allowed-addresses

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

service

services

vserver

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

service

NO REST EQUIVALENT

net-interface-service-policy-entry-get-iter

GET /api/network/ip/service-policies

ONTAPI attribute

REST attribute

Comment

allowed-addresses

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

service

services

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

net-interface-service-policy-get

GET /api/network/ip/service-policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-built-in

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

services

services

vserver

svm.name

policy

NO REST EQUIVALENT

net-interface-service-policy-get-iter

GET /api/network/ip/service-policies vicon.png

ONTAPI attribute

REST attribute

Comment

is-built-in

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

services

services

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

net-interface-service-policy-modify-service

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

net-interface-service-policy-remove-service

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

net-interface-service-policy-rename

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

net-interface-service-policy-restore-defaults

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

net-ipspaces-assign-vserver

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

net-ipspaces-create

POST /api/network/ipspaces

ONTAPI attribute

REST attribute

Comment

ipspace

name

return-record

return_records

net-ipspaces-destroy

DELETE /api/network/ipspaces/{uuid}

ONTAPI attribute

REST attribute

Comment

ipspace

name

net-ipspaces-get

GET /api/network/ipspaces/{uuid}

ONTAPI attribute

REST attribute

Comment

ipspace

name

net-ipspaces-get-iter

GET /api/network/ipspaces

ONTAPI attribute

REST attribute

Comment

broadcast-domains

NO REST EQUIVALENT

A list of broadcast domains can be retrieved by sending a GET request to the /api/network/ethernet/broadcast-domains?ipspace.name={ipspace} endpoint.

id

NO REST EQUIVALENT

ipspace

name

ports

NO REST EQUIVALENT

A list of ports can be retrieved by sending a GET request to the /api/network/ethernet/ports?broadcast_domain.ipspace.name={ipspace} endpoint.

uuid

uuid

vservers

NO REST EQUIVALENT

A list of SVMs can be retrieved by sending a GET request to the /api/svm/svms?ipspace.name={ipspace} endpoint.

max-records

max_records

Specifies the maximum number of records to return before paging.

net-ipspaces-rename

PATCH /api/network/ipspaces/{uuid}

ONTAPI attribute

REST attribute

Comment

ipspace

NO REST EQUIVALENT

new-name

name

net-ndp-active-neighbor-destroy

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

net-ndp-active-neighbor-get

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

net-ndp-active-neighbor-get-iter

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

net-ndp-default-router-delete-all

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

net-ndp-default-router-get

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

net-ndp-default-router-get-iter

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

net-ndp-neighbor-create

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

net-ndp-neighbor-destroy

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

net-ndp-neighbor-get

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

net-ndp-neighbor-get-iter

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

net-ndp-prefix-delete-all

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

net-ndp-prefix-get

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

net-ndp-prefix-get-iter

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

net-options-get

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

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

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

net-options-modify

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

net-placement-cache-delete

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

net-placement-cache-get-iter

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

net-placement-discover

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

net-port-broadcast-domain-add-ports

PATCH /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

broadcast-domain

broadcast_domain.name

In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain.

ipspace

broadcast_domain.ipspace.name

In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain.

ports

uuid

In the REST API, the UUID specified in the patch identifies the port to be added to the broadcast domain.

net-port-broadcast-domain-create

POST /api/network/ethernet/broadcast-domains

ONTAPI attribute

REST attribute

Comment

broadcast-domain

name

ipspace

ipspace.name

In the REST API, ipspace.uuid also uniquely identifies the IPspace.

mtu

mtu

ports

NO REST EQUIVALENT

In the REST API, you cannot specify ports as part of broadcast-domain POST. To add a port to a broadcast-domain, use /api/network/ethernet/ports/{uuid} PATCH.

net-port-broadcast-domain-destroy

DELETE /api/network/ethernet/broadcast-domains/{uuid}

ONTAPI attribute

REST attribute

Comment

broadcast-domain

uuid

In the REST API, uuid uniquely identifies the broadcast domain to be deleted.

ipspace

uuid

In the REST API, uuid uniquely identifies the broadcast domain to be deleted.

net-port-broadcast-domain-get

GET /api/network/ethernet/broadcast-domains/{uuid}

ONTAPI attribute

REST attribute

Comment

broadcast-domain

name

failover-groups

NO REST EQUIVALENT

The common practice will be to use default failover groups, which are all the ports of a broadcast domain. Custom failover groups are not presented in the REST API.

ipspace

ipspace.name

is-vip

NO REST EQUIVALENT

mtu

mtu

port-update-status-combined

NO REST EQUIVALENT

ports

ports.name

Also ports.uuid uniquely identifies a port

subnet-names

NO REST EQUIVALENT

net-port-broadcast-domain-get-iter

GET /api/network/ethernet/broadcast-domains

ONTAPI attribute

REST attribute

Comment

broadcast-domain

name

failover-groups

NO REST EQUIVALENT

In the REST API, common practice is to use default failover groups, which are all the ports of a broadcast domain. The REST API does not present custom failover groups.

ipspace

ipspace.name

is-vip

NO REST EQUIVALENT

mtu

mtu

port-update-status-combined

NO REST EQUIVALENT

ports

ports.name

In the REST API, ports.uuid also uniquely identifies a port.

subnet-names

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

net-port-broadcast-domain-merge

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

net-port-broadcast-domain-modify

PATCH /api/network/ethernet/broadcast-domains/{uuid}

ONTAPI attribute

REST attribute

Comment

broadcast-domain

name

ipspace

ipspace.name

In the REST API ipspace.uuid also uniquely identifies the IPspace.

mtu

mtu

net-port-broadcast-domain-remove-ports

PATCH /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

broadcast-domain

broadcast_domain.name

In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain.

ipspace

broadcast_domain.ipspace.name

In the REST API, broadcast_domain.uuid also uniquely identifies a broadcast domain.

ports

uuid

In the REST API, uuid specified in the patch identifies the port to be added to the broadcast domain.

net-port-broadcast-domain-rename

PATCH /api/network/ethernet/broadcast-domains/{uuid}

ONTAPI attribute

REST attribute

Comment

broadcast-domain

NO REST EQUIVALENT

ipspace

NO REST EQUIVALENT

new-name

name

net-port-broadcast-domain-split

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

net-port-delete

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

net-port-get

GET /api/network/ethernet/ports/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

administrative-duplex

NO REST EQUIVALENT

administrative-flowcontrol

NO REST EQUIVALENT

administrative-speed

NO REST EQUIVALENT

autorevert-delay

NO REST EQUIVALENT

broadcast-domain

broadcast_domain.name

In the REST API, broadcast_domain.uuid uniquely identifies a broadcast domain.

health-degraded-reasons

NO REST EQUIVALENT

health-status

NO REST EQUIVALENT

ifgrp-distribution-function

lag.distribution_policy

ifgrp-mode

lag.mode

ifgrp-node

NO REST EQUIVALENT

ifgrp-port

name

ignore-health-status

NO REST EQUIVALENT

ipspace

broadcast_domain.ipspace.name

is-administrative-auto-negotiate

NO REST EQUIVALENT

is-administrative-up

enabled

is-operational-auto-negotiate

NO REST EQUIVALENT

link-status

state

mac-address

mac_address

mtu

mtu

mtu-admin

NO REST EQUIVALENT

node

node.name

operational-duplex

NO REST EQUIVALENT

operational-flowcontrol

NO REST EQUIVALENT

operational-speed

speed

port

name

port-type

type

remote-device-id

NO REST EQUIVALENT

role

NO REST EQUIVALENT

vlan-id

vlan.tag

vlan-node

vlan.base_port.node.name

vlan-port

vlan.base_port.name

vm-network-name

NO REST EQUIVALENT

net-port-get-iter

GET /api/network/ethernet/ports vicon.png

ONTAPI attribute

REST attribute

Comment

administrative-duplex

NO REST EQUIVALENT

administrative-flowcontrol

NO REST EQUIVALENT

administrative-speed

NO REST EQUIVALENT

autorevert-delay

NO REST EQUIVALENT

broadcast-domain

broadcast_domain.name

In the REST API, broadcast_domain.uuid uniquely identifies a broadcast domain.

health-degraded-reasons

NO REST EQUIVALENT

health-status

NO REST EQUIVALENT

ifgrp-distribution-function

lag.distribution_policy

ifgrp-mode

lag.mode

ifgrp-node

NO REST EQUIVALENT

ifgrp-port

name

ignore-health-status

NO REST EQUIVALENT

ipspace

broadcast_domain.ipspace.name

is-administrative-auto-negotiate

NO REST EQUIVALENT

is-administrative-up

enabled

is-operational-auto-negotiate

NO REST EQUIVALENT

link-status

state

mac-address

mac_address

mtu

mtu

mtu-admin

NO REST EQUIVALENT

node

node.name

operational-duplex

NO REST EQUIVALENT

operational-flowcontrol

NO REST EQUIVALENT

operational-speed

speed

port

name

port-type

type

remote-device-id

NO REST EQUIVALENT

role

NO REST EQUIVALENT

vlan-id

vlan.tag

vlan-node

vlan.base_port.node.name

vlan-port

vlan.base_port.name

vm-network-name

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

net-port-health-monitor-disable

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

net-port-health-monitor-enable

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

net-port-health-monitor-get

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

net-port-health-monitor-get-iter

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

net-port-ifgrp-add-port

PATCH /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

ifgrp-name

name

node

lag.member_ports.node.name

Alternatively, in the REST API, you can specify "lag.member_ports.uuid".

port

lag.member_ports.name

Alternatively, in the REST API, you can specify "lag.member_ports.uuid".

skip-broadcast-domain-placement

NO REST EQUIVALENT

"Set the broadcast_domain property to the desired broadcast domain in PATCH or POST of an ifgrp in /api/network/ethernet/ports in order to skip automatic broadcast domain placement."

net-port-ifgrp-create

POST /api/network/ethernet/ports

ONTAPI attribute

REST attribute

Comment

distribution-function

lag.distribution_policy

ifgrp-name

name

mode

lag.mode

node

node.name

return-record

return_records

net-port-ifgrp-destroy

DELETE /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

ifgrp-name

NO REST EQUIVALENT

In the REST API, uuid uniquely identifies the port to delete.

node

NO REST EQUIVALENT

In the REST API, uuid uniquely identifies the port to delete.

net-port-ifgrp-get

GET /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

distribution-function

lag.distribution_policy

down-ports

NO REST EQUIVALENT

In the REST API, a combination of lag.member_ports and lag.active_ports yields down-ports.

ifgrp-name

name

mac-address

mac_address

mode

lag.mode

node

node.name

port-participation

Compare the values of lag.active_ports and lag.member_ports to determine whether all, some, or none of the ports are active.

ports

lag.member_ports

up-ports

lag.active_ports

net-port-ifgrp-remove-port

PATCH /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

ifgrp-name

NO REST EQUIVALENT

node

NO REST EQUIVALENT

port

lag.member_ports

net-port-modify

PATCH /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

administrative-duplex

NO REST EQUIVALENT

administrative-flowcontrol

NO REST EQUIVALENT

administrative-speed

NO REST EQUIVALENT

autorevert-delay

NO REST EQUIVALENT

ignore-health-status

NO REST EQUIVALENT

ipspace

NO REST EQUIVALENT

is-administrative-auto-negotiate

NO REST EQUIVALENT

is-administrative-up

enabled

mtu

NO REST EQUIVALENT

node

NO REST EQUIVALENT

In the REST API, uuid uniquely identifies the port to be patched.

port

NO REST EQUIVALENT

In the REST API, uuid uniquely identifies the port to be patched.

role

NO REST EQUIVALENT

net-port-modify-iter

PATCH /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

administrative-duplex

NO REST EQUIVALENT

administrative-flowcontrol

NO REST EQUIVALENT

administrative-speed

NO REST EQUIVALENT

autorevert-delay

NO REST EQUIVALENT

broadcast-domain

broadcast_domain.name

health-degraded-reasons

NO REST EQUIVALENT

health-status

NO REST EQUIVALENT

ifgrp-distribution-function

NO REST EQUIVALENT

ifgrp-mode

NO REST EQUIVALENT

ifgrp-node

NO REST EQUIVALENT

ifgrp-port

name

ignore-health-status

NO REST EQUIVALENT

ipspace

broadcast_domain.ipspace.name

is-administrative-auto-negotiate

NO REST EQUIVALENT

is-administrative-up

enabled

is-operational-auto-negotiate

NO REST EQUIVALENT

link-status

NO REST EQUIVALENT

mac-address

NO REST EQUIVALENT

mtu

NO REST EQUIVALENT

In the REST API, this attribute is set by the broadcast domain.

mtu-admin

NO REST EQUIVALENT

node

NO REST EQUIVALENT

operational-duplex

NO REST EQUIVALENT

operational-flowcontrol

NO REST EQUIVALENT

operational-speed

NO REST EQUIVALENT

port

NO REST EQUIVALENT

port-type

NO REST EQUIVALENT

remote-device-id

NO REST EQUIVALENT

role

NO REST EQUIVALENT

vlan-id

NO REST EQUIVALENT

vlan-node

NO REST EQUIVALENT

vlan-port

NO REST EQUIVALENT

vm-network-name

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

net-qos-marking-get-iter

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

net-qos-marking-modify

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

net-routes-create

POST /api/network/ip/routes vicon.png

ONTAPI attribute

REST attribute

Comment

destination

destination.address

gateway

destination.netmask

metric

metric

return-record

return_records

net-routes-destroy

DELETE /api/network/ip/routes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination

NO REST EQUIVALENT

In the REST API, uuid uniquely identifies the route entry to be deleted.

gateway

NO REST EQUIVALENT

In the REST API, uuid uniquely identifies the route entry to be deleted.

net-routes-get

GET /api/network/ip/routes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

address-family

destination.family

destination

destination.address

gateway

gateway

metric

metric

vserver

svm.name

net-routes-get-iter

GET /api/network/ip/routes vicon.png

ONTAPI attribute

REST attribute

Comment

address-family

destination.family

destination

destination.address

gateway

gateway

metric

metric

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

net-routes-lifs-get

GET /api/network/ip/routes/{uuid}?fields=interfaces.name vicon.png

ONTAPI attribute

REST attribute

Comment

address-family

destination.family

destination

destination.address

gateway

gateway

lif-names

interfaces.name

vserver

svm.name

net-routes-lifs-get-iter

GET /api/network/ip/routes?fields=interfaces.name vicon.png

ONTAPI attribute

REST attribute

Comment

address-family

destination.family

destination

destination.address

gateway

gateway

lif-names

interfaces.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

net-san-lif-placement-get

Placement for Fibre Channel interfaces is implemented as a GET on REST
endpoint /api/network/fc/interfaces using the "recommend" family of
query parameters.
Placement for SAN IP interfaces is not available in REST.

GET /api/network/fc/interfaces

ONTAPI attribute

REST attribute

Comment

adapter-type

NO REST EQUIVALENT

broadcast-domain

NO REST EQUIVALENT

ipspace-name

NO REST EQUIVALENT

lifs-per-node

Query parameter "recommend.interfaces_per_node".

nodelist

Query parameter "recommend.nodes.name" or "recommend.nodes.uuid".

protocol

Query parameter "recommend.data_protocol".

subnet-name

NO REST EQUIVALENT

net-subnet-add-ranges

PATCH /api/network/ip/subnets/{uuid}

ONTAPI attribute

REST attribute

Comment

force-update-lif-associations

fail_if_lifs_conflict

The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa.

ip-ranges

ip_ranges.*

ip_ranges.start and ip_ranges.end

ipspace

ipspace.name

The parameter ipspace.uuid can also be used to uniquely identify the IPspace.

subnet-name

name

net-subnet-create

POST /api/network/ip/subnets

ONTAPI attribute

REST attribute

Comment

broadcast-domain

broadcast_domain.name

The parameter broadcast_domain.uuid can also be used to uniquely identify the broadcast domain.

force-update-lif-associations

fail_if_lifs_conflict

The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa.

gateway

gateway

ip-ranges

ip_ranges.*

ip_ranges.start and ip_ranges.end

ipspace

ipspace.name

The parameter ipspace.uuid can also be used to uniquely identify the IPspace.

return-record

return_records

subnet

subnet.*

subnet.address and subnet.netmask

subnet-name

name

net-subnet-destroy

DELETE /api/network/ip/subnets/{uuid}

ONTAPI attribute

REST attribute

Comment

force-update-lif-associations

NO REST EQUIVALENT

ipspace

NO REST EQUIVALENT

subnet-name

NO REST EQUIVALENT

net-subnet-get

GET /api/network/ip/subnets/{uuid}

ONTAPI attribute

REST attribute

Comment

available-count

available_count

broadcast-domain

broadcast_domain.name

The parameter broadcast_domain.uuid can also be used to uniquely identify the broadcast domain.

force-update-lif-associations

NO REST EQUIVALENT

gateway

gateway

ip-ranges

ip_ranges.*

ip_ranges.start and ip_ranges.end

ipspace

ipspace.*

ipspace.uuid and ipspace.name

subnet

subnet.*

subnet.address, subnet.netmask and subnet.family

subnet-name

name

total-count

total_count

used-count

used_count

net-subnet-get-iter

GET /api/network/ip/subnets

ONTAPI attribute

REST attribute

Comment

available-count

available_count

broadcast-domain

broadcast_domain.name

The parameter broadcast_domain.uuid can also be used to uniquely identify the broadcast domain.

force-update-lif-associations

NO REST EQUIVALENT

gateway

gateway

ip-ranges

ip_ranges.*

ip_ranges.start and ip_ranges.end

ipspace

ipspace.*

ipspace.uuid and ipspace.name

subnet

subnet.*

subnet.address, subnet.netmask * subnet.family

subnet-name

name

total-count

total_count

used-count

used_count

max-records

max_records

net-subnet-modify

PATCH /api/network/ip/subnets/{uuid}

ONTAPI attribute

REST attribute

Comment

force-update-lif-associations

fail_if_lifs_conflict

The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa.

gateway

gateway

ip-ranges

ip_ranges.*

ip_ranges.start and ip_ranges.end

ipspace

ipspace.*

ipspace.uuid and ipspace.name

subnet

subnet.*

subnet.address, subnet.netmask and subnet.family

subnet-name

name

net-subnet-remove-ranges

PATCH /api/network/ip/subnets/{uuid}

ONTAPI attribute

REST attribute

Comment

force-update-lif-associations

fail_if_lifs_conflict

The mapped fields are opposite in behavior i.e. setting force-update-lif-associations to TRUE is equivalent to setting fail_if_lifs_conflict to FALSE and vice versa.

ip-ranges

ip_ranges.*

ip_ranges.start and ip_ranges.end

ipspace

ipspace.*

ipspace.uuid and ipspace.name

subnet-name

name

net-subnet-rename

PATCH /api/network/ip/subnets/{uuid}

ONTAPI attribute

REST attribute

Comment

ipspace

ipspace.*

ipspace.uuid and ipspace.name

new-name

name

subnet-name

NO REST EQUIVALENT

net-subnets-for-broadcast-domain-get

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

net-subnets-for-broadcast-domain-get-iter

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

net-test-path

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

net-traceroute6

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

net-tuning-icmp-get

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

net-tuning-icmp-modify

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

net-tuning-icmp6-get

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

net-tuning-icmp6-modify

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

net-tuning-tcp-get

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

net-tuning-tcp-modify

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

net-vip-port-create

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

net-vip-port-destroy

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

net-vip-port-get

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

net-vip-port-get-iter

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

net-vlan-create

POST /api/network/ethernet/ports

ONTAPI attribute

REST attribute

Comment

gvrp-enabled

NO REST EQUIVALENT

interface-name

name

node

node.name

parent-interface

vlan.base_port

skip-broadcast-domain-placement

NO REST EQUIVALENT

"Set the broadcast_domain property to the desired broadcast domain in order to skip automatic broadcast domain placement."

vlanid

vlan.tag

net-vlan-delete

DELETE /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

vlan-info

NO REST EQUIVALENT

In the REST API, uuid uniquely identifies the VLAN port to be deleted.

net-vlan-get

GET /api/network/ethernet/ports/{uuid}

ONTAPI attribute

REST attribute

Comment

gvrp-enabled

NO REST EQUIVALENT

interface-name

name

node

node.name

parent-interface

vlan.base_port

skip-broadcast-domain-placement

NO REST EQUIVALENT

vlanid

vlan.tag

net-vlan-get-iter

GET /api/network/ethernet/ports

ONTAPI attribute

REST attribute

Comment

gvrp-enabled

NO REST EQUIVALENT

interface-name

name

node

node.name

parent-interface

vlan.base_port

skip-broadcast-domain-placement

NO REST EQUIVALENT

vlanid

vlan.tag

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: NETGROUP

netgroups-file-delete

DELETE /api/name-services/netgroup-files/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

vserver-name

svm.uuid

netgroups-file-get

The raw netgroup file of the given SVM is displayed by setting the header as "accept: multipart/form-data".

GET /api/name-services/netgroup-files/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

domain

NO REST EQUIVALENT

The raw netgroup file of the given SVM is displayed, instead of parsing the file contents.

host

NO REST EQUIVALENT

The raw netgroup file of the given SVM is displayed, instead of parsing the file contents.

member-netgroup

NO REST EQUIVALENT

The raw netgroup file of the given SVM is displayed, instead of parsing the file contents.

netgroup-name

NO REST EQUIVALENT

The raw netgroup file of the given SVM is displayed, instead of parsing the file contents.

user

NO REST EQUIVALENT

The raw netgroup file of the given SVM is displayed, instead of parsing the file contents.

vserver

svm.uuid

netgroups-file-get-iter

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

Category: NFS

nfs-all-flash-optimized-get

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

nfs-all-flash-optimized-get-iter

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

nfs-disable

PATCH /api/protocols/nfs/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

nfs-enable

PATCH /api/protocols/nfs/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

nfs-exportfs-append-rules

POST /api/protocols/nfs/export-policies/{policy.id}/rules vicon.png

ONTAPI attribute

REST attribute

Comment

create-multi-clientmatch

NO REST EQUIVALENT

persistent

NO REST EQUIVALENT

rules

info

verbose

NO REST EQUIVALENT

nfs-exportfs-append-rules-2

POST /api/protocols/nfs/export-policies/{policy.id}/rules vicon.png

ONTAPI attribute

REST attribute

Comment

create-multi-clientmatch

NO REST EQUIVALENT

persistent

NO REST EQUIVALENT

rules

info

verbose

NO REST EQUIVALENT

nfs-exportfs-check-permission

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

nfs-exportfs-delete-rules

DELETE /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

all-pathnames

NO REST EQUIVALENT

pathnames

NO REST EQUIVALENT

persistent

NO REST EQUIVALENT

verbose

NO REST EQUIVALENT

nfs-exportfs-list-rules

GET /api/protocols/nfs/export-policies/{policy.id}/rules vicon.png

ONTAPI attribute

REST attribute

Comment

pathname

NO REST EQUIVALENT

persistent

NO REST EQUIVALENT

nfs-exportfs-list-rules-2

GET /api/protocols/nfs/export-policies/{policy.id}/rules vicon.png

ONTAPI attribute

REST attribute

Comment

pathname

NO REST EQUIVALENT

persistent

NO REST EQUIVALENT

nfs-exportfs-modify-rule

PATCH /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

create-multi-clientmatch

NO REST EQUIVALENT

persistent

NO REST EQUIVALENT

rule

info

nfs-exportfs-modify-rule-2

PATCH /api/protocols/nfs/export-policies/{policy.id}/rules/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

create-multi-clientmatch

NO REST EQUIVALENT

persistent

NO REST EQUIVALENT

rule

info

nfs-get-supported-sec-flavors

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

nfs-service-create

POST /api/protocols/nfs/services vicon.png

ONTAPI attribute

REST attribute

Comment

allow-idle-connection

NO REST EQUIVALENT

auth-sys-extended-groups

auth_sys_extended_groups_enabled

cached-cred-harvest-timeout

NO REST EQUIVALENT

cached-cred-negative-ttl

credential_cache.negative_ttl

cached-cred-positive-ttl

credential_cache.positive_ttl

cached-transient-err-ttl

credential_cache.transient_error_ttl

chown-mode

security.chown_mode

default-windows-group

NO REST EQUIVALENT

default-windows-user

windows.default_user

enable-ejukebox

protocol.v3_features.ejukebox_enabled

extended-groups-limit

extended_groups_limit

file-session-io-grouping-count

NO REST EQUIVALENT

file-session-io-grouping-duration

NO REST EQUIVALENT

hadoop-allow-non-root-mount

NO REST EQUIVALENT

idle-connection-timeout

NO REST EQUIVALENT

ignore-nt-acl-for-root

root.ignore_nt_acl

is-checksum-enabled-for-replay-cache

NO REST EQUIVALENT

is-mount-rootonly-enabled

protocol.v3_features.mount_root_only

is-netgroup-dns-domain-search

NO REST EQUIVALENT

is-nfs-access-enabled

enabled

is-nfs-rootonly-enabled

NO REST EQUIVALENT

is-nfsv2-enabled

NO REST EQUIVALENT

is-nfsv3-64bit-identifiers-enabled

protocol.v3_64bit_identifiers_enabled

is-nfsv3-connection-drop-enabled

protocol.v3_features.connection_drop

is-nfsv3-enabled

protocol.v3_enabled

is-nfsv3-fsid-change-enabled

protocol.v3_features.fsid_change

is-nfsv4-64bit-identifiers-enabled

protocol.v4_64bit_identifiers_enabled

is-nfsv4-fsid-change-enabled

NO REST EQUIVALENT

is-nfsv4-numeric-ids-enabled

NO REST EQUIVALENT

is-nfsv40-acl-enabled

protocol.v40_features.acl_enabled

is-nfsv40-enabled

protocol.v40_enabled

is-nfsv40-migration-enabled

NO REST EQUIVALENT

is-nfsv40-read-delegation-enabled

protocol.v40_features.read_delegation_enabled

is-nfsv40-referrals-enabled

NO REST EQUIVALENT

is-nfsv40-req-open-confirm-enabled

NO REST EQUIVALENT

is-nfsv40-write-delegation-enabled

protocol.v40_features.write_delegation_enabled

is-nfsv41-acl-enabled

protocol.v41_features.acl_enabled

is-nfsv41-acl-preserve-enabled

protocol.v40_features.acl_preserve

is-nfsv41-enabled

protocol.v41_enabled

is-nfsv41-migration-enabled

NO REST EQUIVALENT

is-nfsv41-pnfs-enabled

protocol.v41_features.pnfs_enabled

is-nfsv41-read-delegation-enabled

protocol.v41_features.read_delegation_enabled

is-nfsv41-referrals-enabled

NO REST EQUIVALENT

is-nfsv41-state-protection-enabled

NO REST EQUIVALENT

is-nfsv41-write-delegation-enabled

protocol.v41_features.write_delegation_enabled

is-rquota-enabled

rquota_enabled

is-tcp-enabled

transport.tcp_enabled

is-udp-enabled

transport.udp_enabled

is-v3-hide-snapshot

NO REST EQUIVALENT

is-v3-ms-dos-client-enabled

windows.v3_ms_dos_client_enabled

is-validate-qtree-export-enabled

qtree.validate_export

is-vstorage-enabled

vstorage_enabled

map-unknown-uid-to-default-windows-user

windows.map_unknown_uid_to_default_user

mountd-port

protocol.v3_features.mount_daemon_port

name-service-lookup-protocol

exports.name_service_lookup_protocol

netgroup-trust-any-ns-switch-no-match

exports.netgroup_trust_any_nsswitch_no_match

nfsv4-acl-max-aces

protocol.v40_features.acl_max_aces

nfsv4-grace-seconds

NO REST EQUIVALENT

nfsv4-id-domain

protocol.v4_id_domain

nfsv4-lease-seconds

NO REST EQUIVALENT

nfsv41-implementation-id-domain

protocol.v41_features.implementation_domain

nfsv41-implementation-id-name

protocol.v41_features.implementation_name

nfsv41-implementation-id-time

NO REST EQUIVALENT

nfsv4x-session-num-slots

NO REST EQUIVALENT

nfsv4x-session-slot-reply-cache-size

NO REST EQUIVALENT

nlm-port

protocol.v3_features.network_lock_manager_port

nsm-port

protocol.v3_features.network_status_monitor_port

ntacl-display-permissive-perms

security.nt_acl_display_permission

ntfs-unix-security-ops

security.ntfs_unix_security

permitted-enc-types

security.permitted_encryption_types

return-record

NO REST EQUIVALENT

rpcsec-ctx-high

NO REST EQUIVALENT

rpcsec-ctx-idle

security.rpcsec_context_idle

rquotad-port

protocol.v3_features.rquota_daemon_port

showmount

showmount_enabled

showmount-rootonly

NO REST EQUIVALENT

skip-root-owner-write-perm-check

root.skip_write_permission_check

tcp-max-xfer-size

transport.tcp_max_transfer_size

udp-max-xfer-size

NO REST EQUIVALENT

v3-search-unconverted-filename

NO REST EQUIVALENT

v4-inherited-acl-preserve

NO REST EQUIVALENT

nfs-service-destroy

DELETE /api/protocols/nfs/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

nfs-service-get

GET /api/protocols/nfs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

allow-idle-connection

NO REST EQUIVALENT

auth-sys-extended-groups

NO REST EQUIVALENT

cached-cred-harvest-timeout

NO REST EQUIVALENT

cached-cred-negative-ttl

NO REST EQUIVALENT

cached-cred-positive-ttl

NO REST EQUIVALENT

cached-transient-err-ttl

NO REST EQUIVALENT

chown-mode

NO REST EQUIVALENT

default-windows-group

NO REST EQUIVALENT

default-windows-user

NO REST EQUIVALENT

enable-ejukebox

NO REST EQUIVALENT

extended-groups-limit

NO REST EQUIVALENT

file-session-io-grouping-count

NO REST EQUIVALENT

file-session-io-grouping-duration

NO REST EQUIVALENT

hadoop-allow-non-root-mount

NO REST EQUIVALENT

idle-connection-timeout

NO REST EQUIVALENT

ignore-nt-acl-for-root

NO REST EQUIVALENT

is-checksum-enabled-for-replay-cache

NO REST EQUIVALENT

is-mount-rootonly-enabled

NO REST EQUIVALENT

is-netgroup-dns-domain-search

NO REST EQUIVALENT

is-nfs-access-enabled

NO REST EQUIVALENT

is-nfs-rootonly-enabled

NO REST EQUIVALENT

is-nfsv2-enabled

NO REST EQUIVALENT

is-nfsv3-64bit-identifiers-enabled

NO REST EQUIVALENT

is-nfsv3-connection-drop-enabled

NO REST EQUIVALENT

is-nfsv3-enabled

NO REST EQUIVALENT

is-nfsv3-fsid-change-enabled

NO REST EQUIVALENT

is-nfsv4-64bit-identifiers-enabled

NO REST EQUIVALENT

is-nfsv4-fsid-change-enabled

NO REST EQUIVALENT

is-nfsv4-numeric-ids-enabled

NO REST EQUIVALENT

is-nfsv40-acl-enabled

NO REST EQUIVALENT

is-nfsv40-enabled

NO REST EQUIVALENT

is-nfsv40-migration-enabled

NO REST EQUIVALENT

is-nfsv40-read-delegation-enabled

NO REST EQUIVALENT

is-nfsv40-referrals-enabled

NO REST EQUIVALENT

is-nfsv40-req-open-confirm-enabled

NO REST EQUIVALENT

is-nfsv40-write-delegation-enabled

NO REST EQUIVALENT

is-nfsv41-acl-enabled

NO REST EQUIVALENT

is-nfsv41-acl-preserve-enabled

NO REST EQUIVALENT

is-nfsv41-enabled

NO REST EQUIVALENT

is-nfsv41-migration-enabled

NO REST EQUIVALENT

is-nfsv41-pnfs-enabled

NO REST EQUIVALENT

is-nfsv41-read-delegation-enabled

NO REST EQUIVALENT

is-nfsv41-referrals-enabled

NO REST EQUIVALENT

is-nfsv41-state-protection-enabled

NO REST EQUIVALENT

is-nfsv41-write-delegation-enabled

NO REST EQUIVALENT

is-qtree-export-enabled

NO REST EQUIVALENT

is-qtree-qos-enabled

NO REST EQUIVALENT

is-rquota-enabled

NO REST EQUIVALENT

is-tcp-enabled

NO REST EQUIVALENT

is-udp-enabled

NO REST EQUIVALENT

is-v3-hide-snapshot

NO REST EQUIVALENT

is-v3-ms-dos-client-enabled

NO REST EQUIVALENT

is-validate-qtree-export-enabled

NO REST EQUIVALENT

is-vstorage-enabled

NO REST EQUIVALENT

map-unknown-uid-to-default-windows-user

NO REST EQUIVALENT

mountd-port

NO REST EQUIVALENT

name-service-lookup-protocol

NO REST EQUIVALENT

netgroup-trust-any-ns-switch-no-match

NO REST EQUIVALENT

nfsv4-acl-max-aces

NO REST EQUIVALENT

nfsv4-grace-seconds

NO REST EQUIVALENT

nfsv4-id-domain

NO REST EQUIVALENT

nfsv4-lease-seconds

NO REST EQUIVALENT

nfsv41-implementation-id-domain

NO REST EQUIVALENT

nfsv41-implementation-id-name

NO REST EQUIVALENT

nfsv41-implementation-id-time

NO REST EQUIVALENT

nfsv4x-session-num-slots

NO REST EQUIVALENT

nfsv4x-session-slot-reply-cache-size

NO REST EQUIVALENT

nlm-port

NO REST EQUIVALENT

nsm-port

NO REST EQUIVALENT

ntacl-display-permissive-perms

NO REST EQUIVALENT

ntfs-unix-security-ops

NO REST EQUIVALENT

permitted-enc-types

NO REST EQUIVALENT

rpcsec-ctx-high

NO REST EQUIVALENT

rpcsec-ctx-idle

NO REST EQUIVALENT

rquotad-port

NO REST EQUIVALENT

showmount

NO REST EQUIVALENT

showmount-rootonly

NO REST EQUIVALENT

showmount-timestamp

NO REST EQUIVALENT

skip-root-owner-write-perm-check

NO REST EQUIVALENT

tcp-max-xfer-size

NO REST EQUIVALENT

udp-max-xfer-size

NO REST EQUIVALENT

v3-search-unconverted-filename

NO REST EQUIVALENT

v4-inherited-acl-preserve

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

nfs-service-get-create-defaults

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

nfs-service-get-create-defaults

GET /api/protocols/nfs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

allow-idle-connection

NO REST EQUIVALENT

auth-sys-extended-groups

auth_sys_extended_groups_enabled

cached-cred-harvest-timeout

NO REST EQUIVALENT

cached-cred-negative-ttl

credential_cache.negative_ttl

cached-cred-positive-ttl

credential_cache.positive_ttl

cached-transient-err-ttl

credential_cache.transient_error_ttl

chown-mode

security.chown_mode

default-windows-group

NO REST EQUIVALENT

default-windows-user

windows.default_user

enable-ejukebox

protocol.v3_features.ejukebox_enabled

extended-groups-limit

extended_groups_limit

file-session-io-grouping-count

NO REST EQUIVALENT

file-session-io-grouping-duration

NO REST EQUIVALENT

hadoop-allow-non-root-mount

NO REST EQUIVALENT

idle-connection-timeout

NO REST EQUIVALENT

ignore-nt-acl-for-root

root.ignore_nt_acl

is-checksum-enabled-for-replay-cache

NO REST EQUIVALENT

is-mount-rootonly-enabled

protocol.v3_features.mount_root_only

is-netgroup-dns-domain-search

NO REST EQUIVALENT

is-nfs-access-enabled

enabled

is-nfs-rootonly-enabled

NO REST EQUIVALENT

is-nfsv2-enabled

NO REST EQUIVALENT

is-nfsv3-64bit-identifiers-enabled

protocol.v3_64bit_identifiers_enabled

is-nfsv3-connection-drop-enabled

protocol.v3_features.connection_drop

is-nfsv3-enabled

protocol.v3_enabled

is-nfsv3-fsid-change-enabled

protocol.v3_features.fsid_change

is-nfsv4-64bit-identifiers-enabled

protocol.v4_64bit_identifiers_enabled

is-nfsv4-fsid-change-enabled

NO REST EQUIVALENT

is-nfsv4-numeric-ids-enabled

NO REST EQUIVALENT

is-nfsv40-acl-enabled

protocol.v40_features.acl_enabled

is-nfsv40-enabled

protocol.v40_enabled

is-nfsv40-migration-enabled

NO REST EQUIVALENT

is-nfsv40-read-delegation-enabled

protocol.v40_features.read_delegation_enabled

is-nfsv40-referrals-enabled

NO REST EQUIVALENT

is-nfsv40-req-open-confirm-enabled

NO REST EQUIVALENT

is-nfsv40-write-delegation-enabled

protocol.v40_features.write_delegation_enabled

is-nfsv41-acl-enabled

protocol.v41_features.acl_enabled

is-nfsv41-acl-preserve-enabled

protocol.v40_features.acl_preserve

is-nfsv41-enabled

protocol.v41_enabled

is-nfsv41-migration-enabled

NO REST EQUIVALENT

is-nfsv41-pnfs-enabled

protocol.v41_features.pnfs_enabled

is-nfsv41-read-delegation-enabled

protocol.v41_features.read_delegation_enabled

is-nfsv41-referrals-enabled

NO REST EQUIVALENT

is-nfsv41-state-protection-enabled

NO REST EQUIVALENT

is-nfsv41-write-delegation-enabled

protocol.v41_features.write_delegation_enabled

is-qtree-export-enabled

NO REST EQUIVALENT

is-qtree-qos-enabled

NO REST EQUIVALENT

is-rquota-enabled

rquota_enabled

is-tcp-enabled

transport.tcp_enabled

is-udp-enabled

transport.udp_enabled

is-v3-hide-snapshot

NO REST EQUIVALENT

is-v3-ms-dos-client-enabled

windows.v3_ms_dos_client_enabled

is-validate-qtree-export-enabled

qtree.validate_export

is-vstorage-enabled

vstorage_enabled

map-unknown-uid-to-default-windows-user

windows.map_unknown_uid_to_default_user

mountd-port

protocol.v3_features.mount_daemon_port

name-service-lookup-protocol

exports.name_service_lookup_protocol

netgroup-trust-any-ns-switch-no-match

exports.netgroup_trust_any_nsswitch_no_match

nfsv4-acl-max-aces

protocol.v40_features.acl_max_aces

nfsv4-grace-seconds

NO REST EQUIVALENT

nfsv4-id-domain

protocol.v4_id_domain

nfsv4-lease-seconds

NO REST EQUIVALENT

nfsv41-implementation-id-domain

protocol.v41_features.implementation_domain

nfsv41-implementation-id-name

protocol.v41_features.implementation_name

nfsv41-implementation-id-time

NO REST EQUIVALENT

nfsv4x-session-num-slots

NO REST EQUIVALENT

nfsv4x-session-slot-reply-cache-size

NO REST EQUIVALENT

nlm-port

protocol.v3_features.network_lock_manager_port

nsm-port

protocol.v3_features.network_status_monitor_port

ntacl-display-permissive-perms

security.nt_acl_display_permission

ntfs-unix-security-ops

security.ntfs_unix_security

permitted-enc-types

security.permitted_encryption_types

rpcsec-ctx-high

NO REST EQUIVALENT

rpcsec-ctx-idle

security.rpcsec_context_idle

rquotad-port

protocol.v3_features.rquota_daemon_port

showmount

showmount_enabled

showmount-rootonly

NO REST EQUIVALENT

showmount-timestamp

NO REST EQUIVALENT

skip-root-owner-write-perm-check

root.skip_write_permission_check

tcp-max-xfer-size

transport.tcp_max_transfer_size

udp-max-xfer-size

NO REST EQUIVALENT

v3-search-unconverted-filename

NO REST EQUIVALENT

v4-inherited-acl-preserve

NO REST EQUIVALENT

vserver

svm.name

nfs-service-get-iter

GET /api/protocols/nfs/services vicon.png

ONTAPI attribute

REST attribute

Comment

allow-idle-connection

NO REST EQUIVALENT

auth-sys-extended-groups

auth_sys_extended_groups_enabled

cached-cred-harvest-timeout

NO REST EQUIVALENT

cached-cred-negative-ttl

credential_cache.negative_ttl

cached-cred-positive-ttl

credential_cache.positive_ttl

cached-transient-err-ttl

credential_cache.transient_error_ttl

chown-mode

security.chown_mode

default-windows-group

NO REST EQUIVALENT

default-windows-user

windows.default_user

enable-ejukebox

protocol.v3_features.ejukebox_enabled

extended-groups-limit

extended_groups_limit

file-session-io-grouping-count

NO REST EQUIVALENT

file-session-io-grouping-duration

NO REST EQUIVALENT

hadoop-allow-non-root-mount

NO REST EQUIVALENT

idle-connection-timeout

NO REST EQUIVALENT

ignore-nt-acl-for-root

root.ignore_nt_acl

is-checksum-enabled-for-replay-cache

NO REST EQUIVALENT

is-mount-rootonly-enabled

protocol.v3_features.mount_root_only

is-netgroup-dns-domain-search

NO REST EQUIVALENT

is-nfs-access-enabled

enabled

is-nfs-rootonly-enabled

NO REST EQUIVALENT

is-nfsv2-enabled

NO REST EQUIVALENT

is-nfsv3-64bit-identifiers-enabled

protocol.v3_64bit_identifiers_enabled

is-nfsv3-connection-drop-enabled

protocol.v3_features.connection_drop

is-nfsv3-enabled

protocol.v3_enabled

is-nfsv3-fsid-change-enabled

protocol.v3_features.fsid_change

is-nfsv4-64bit-identifiers-enabled

protocol.v4_64bit_identifiers_enabled

is-nfsv4-fsid-change-enabled

NO REST EQUIVALENT

is-nfsv4-numeric-ids-enabled

NO REST EQUIVALENT

is-nfsv40-acl-enabled

protocol.v40_features.acl_enabled

is-nfsv40-enabled

protocol.v40_enabled

is-nfsv40-migration-enabled

NO REST EQUIVALENT

is-nfsv40-read-delegation-enabled

protocol.v40_features.read_delegation_enabled

is-nfsv40-referrals-enabled

NO REST EQUIVALENT

is-nfsv40-req-open-confirm-enabled

NO REST EQUIVALENT

is-nfsv40-write-delegation-enabled

protocol.v40_features.write_delegation_enabled

is-nfsv41-acl-enabled

protocol.v41_features.acl_enabled

is-nfsv41-acl-preserve-enabled

protocol.v40_features.acl_preserve

is-nfsv41-enabled

protocol.v41_enabled

is-nfsv41-migration-enabled

NO REST EQUIVALENT

is-nfsv41-pnfs-enabled

protocol.v41_features.pnfs_enabled

is-nfsv41-read-delegation-enabled

protocol.v41_features.read_delegation_enabled

is-nfsv41-referrals-enabled

NO REST EQUIVALENT

is-nfsv41-state-protection-enabled

NO REST EQUIVALENT

is-nfsv41-write-delegation-enabled

protocol.v41_features.write_delegation_enabled

is-qtree-export-enabled

NO REST EQUIVALENT

is-qtree-qos-enabled

NO REST EQUIVALENT

is-rquota-enabled

rquota_enabled

is-tcp-enabled

transport.tcp_enabled

is-udp-enabled

transport.udp_enabled

is-v3-hide-snapshot

NO REST EQUIVALENT

is-v3-ms-dos-client-enabled

windows.v3_ms_dos_client_enabled

is-validate-qtree-export-enabled

qtree.validate_export

is-vstorage-enabled

vstorage_enabled

map-unknown-uid-to-default-windows-user

windows.map_unknown_uid_to_default_user

mountd-port

protocol.v3_features.mount_daemon_port

name-service-lookup-protocol

exports.name_service_lookup_protocol

netgroup-trust-any-ns-switch-no-match

exports.netgroup_trust_any_nsswitch_no_match

nfsv4-acl-max-aces

protocol.v40_features.acl_max_aces

nfsv4-grace-seconds

NO REST EQUIVALENT

nfsv4-id-domain

protocol.v4_id_domain

nfsv4-lease-seconds

NO REST EQUIVALENT

nfsv41-implementation-id-domain

protocol.v41_features.implementation_domain

nfsv41-implementation-id-name

protocol.v41_features.implementation_name

nfsv41-implementation-id-time

NO REST EQUIVALENT

nfsv4x-session-num-slots

NO REST EQUIVALENT

nfsv4x-session-slot-reply-cache-size

NO REST EQUIVALENT

nlm-port

protocol.v3_features.network_lock_manager_port

nsm-port

protocol.v3_features.network_status_monitor_port

ntacl-display-permissive-perms

security.nt_acl_display_permission

ntfs-unix-security-ops

security.ntfs_unix_security

permitted-enc-types

security.permitted_encryption_types

rpcsec-ctx-high

NO REST EQUIVALENT

rpcsec-ctx-idle

security.rpcsec_context_idle

rquotad-port

protocol.v3_features.rquota_daemon_port

showmount

showmount_enabled

showmount-rootonly

NO REST EQUIVALENT

showmount-timestamp

NO REST EQUIVALENT

skip-root-owner-write-perm-check

root.skip_write_permission_check

tcp-max-xfer-size

transport.tcp_max_transfer_size

udp-max-xfer-size

NO REST EQUIVALENT

v3-search-unconverted-filename

NO REST EQUIVALENT

v4-inherited-acl-preserve

NO REST EQUIVALENT

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

nfs-service-modify

PATCH /api/protocols/nfs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

allow-idle-connection

NO REST EQUIVALENT

auth-sys-extended-groups

auth_sys_extended_groups_enabled

cached-cred-harvest-timeout

NO REST EQUIVALENT

cached-cred-negative-ttl

credential_cache.negative_ttl

cached-cred-positive-ttl

credential_cache.positive_ttl

cached-transient-err-ttl

credential_cache.transient_error_ttl

chown-mode

security.chown_mode

default-windows-group

NO REST EQUIVALENT

default-windows-user

windows.default_user

enable-ejukebox

protocol.v3_features.ejukebox_enabled

extended-groups-limit

extended_groups_limit

file-session-io-grouping-count

NO REST EQUIVALENT

file-session-io-grouping-duration

NO REST EQUIVALENT

hadoop-allow-non-root-mount

NO REST EQUIVALENT

idle-connection-timeout

NO REST EQUIVALENT

ignore-nt-acl-for-root

root.ignore_nt_acl

is-checksum-enabled-for-replay-cache

NO REST EQUIVALENT

is-mount-rootonly-enabled

protocol.v3_features.mount_root_only

is-netgroup-dns-domain-search

NO REST EQUIVALENT

is-nfs-access-enabled

enabled

is-nfs-rootonly-enabled

NO REST EQUIVALENT

is-nfsv2-enabled

NO REST EQUIVALENT

is-nfsv3-64bit-identifiers-enabled

protocol.v3_64bit_identifiers_enabled

is-nfsv3-connection-drop-enabled

protocol.v3_features.connection_drop

is-nfsv3-enabled

protocol.v3_enabled

is-nfsv3-fsid-change-enabled

protocol.v3_features.fsid_change

is-nfsv4-64bit-identifiers-enabled

protocol.v4_64bit_identifiers_enabled

is-nfsv4-fsid-change-enabled

NO REST EQUIVALENT

is-nfsv4-numeric-ids-enabled

NO REST EQUIVALENT

is-nfsv40-acl-enabled

protocol.v40_features.acl_enabled

is-nfsv40-enabled

protocol.v40_enabled

is-nfsv40-migration-enabled

NO REST EQUIVALENT

is-nfsv40-read-delegation-enabled

protocol.v40_features.read_delegation_enabled

is-nfsv40-referrals-enabled

NO REST EQUIVALENT

is-nfsv40-req-open-confirm-enabled

NO REST EQUIVALENT

is-nfsv40-write-delegation-enabled

protocol.v40_features.write_delegation_enabled

is-nfsv41-acl-enabled

protocol.v41_features.acl_enabled

is-nfsv41-acl-preserve-enabled

protocol.v40_features.acl_preserve

is-nfsv41-enabled

protocol.v41_enabled

is-nfsv41-migration-enabled

NO REST EQUIVALENT

is-nfsv41-pnfs-enabled

protocol.v41_features.pnfs_enabled

is-nfsv41-read-delegation-enabled

protocol.v41_features.read_delegation_enabled

is-nfsv41-referrals-enabled

NO REST EQUIVALENT

is-nfsv41-state-protection-enabled

NO REST EQUIVALENT

is-nfsv41-write-delegation-enabled

protocol.v41_features.write_delegation_enabled

is-rquota-enabled

rquota_enabled

is-tcp-enabled

transport.tcp_enabled

is-udp-enabled

transport.udp_enabled

is-v3-hide-snapshot

NO REST EQUIVALENT

is-v3-ms-dos-client-enabled

windows.v3_ms_dos_client_enabled

is-validate-qtree-export-enabled

qtree.validate_export

is-vstorage-enabled

vstorage_enabled

map-unknown-uid-to-default-windows-user

windows.map_unknown_uid_to_default_user

mountd-port

protocol.v3_features.mount_daemon_port

name-service-lookup-protocol

exports.name_service_lookup_protocol

netgroup-trust-any-ns-switch-no-match

exports.netgroup_trust_any_nsswitch_no_match

nfsv4-acl-max-aces

protocol.v40_features.acl_max_aces

nfsv4-grace-seconds

NO REST EQUIVALENT

nfsv4-id-domain

protocol.v4_id_domain

nfsv4-lease-seconds

NO REST EQUIVALENT

nfsv41-implementation-id-domain

protocol.v41_features.implementation_domain

nfsv41-implementation-id-name

protocol.v41_features.implementation_name

nfsv41-implementation-id-time

NO REST EQUIVALENT

nfsv4x-session-num-slots

NO REST EQUIVALENT

nfsv4x-session-slot-reply-cache-size

NO REST EQUIVALENT

nlm-port

protocol.v3_features.network_lock_manager_port

nsm-port

protocol.v3_features.network_status_monitor_port

ntacl-display-permissive-perms

security.nt_acl_display_permission

ntfs-unix-security-ops

security.ntfs_unix_security

permitted-enc-types

security.permitted_encryption_types

rpcsec-ctx-high

NO REST EQUIVALENT

rpcsec-ctx-idle

security.rpcsec_context_idle

rquotad-port

protocol.v3_features.rquota_daemon_port

showmount

showmount_enabled

showmount-rootonly

NO REST EQUIVALENT

skip-root-owner-write-perm-check

root.skip_write_permission_check

tcp-max-xfer-size

transport.tcp_max_transfer_size

udp-max-xfer-size

NO REST EQUIVALENT

v3-search-unconverted-filename

NO REST EQUIVALENT

v4-inherited-acl-preserve

NO REST EQUIVALENT

nfs-status

GET /api/protocols/nfs/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

status

state

Category: NIS

nis-create

Use the /api/security/authentication/cluster/nis REST API endpoint to create cluster NIS configurations.

POST /api/name-services/nis vicon.png

ONTAPI attribute

REST attribute

Comment

is-active

NO REST EQUIVALENT

This property has been deprecated.

nis-domain

domain

nis-fqdn

servers

nis-servers

NO REST EQUIVALENT

This property has been deprecated. Use the "nis-fqdn" field.

return-record

?return_records=true

skip-config-validation

NO REST EQUIVALENT

nis-destroy

Use the /api/security/authentication/cluster/nis REST API endpoint to delete cluster NIS configurations.

DELETE /api/name-services/nis/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

nis-domain

NO REST EQUIVALENT

The "nis-domain" field does not need to be specified since each SVM will have only one NIS config.

nis-get

Use the /api/security/authentication/cluster/nis REST API endpoint to retrieve cluster NIS configurations.

GET /api/name-services/nis/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-active

NO REST EQUIVALENT

This property has been deprecated.

nis-domain

domain

nis-fqdn

servers

nis-servers

NO REST EQUIVALENT

This property has been deprecated. Use the "nis-fqdn" field.

skip-config-validation

NO REST EQUIVALENT

vserver

svm.name

nis-domain

NO REST EQUIVALENT

nis-get-iter

GET /api/name-services/nis vicon.png

ONTAPI attribute

REST attribute

Comment

is-active

NO REST EQUIVALENT

This property has been deprecated.

nis-domain

domain

nis-fqdn

servers

nis-servers

NO REST EQUIVALENT

This property has been deprecated. Use the "nis-fqdn" field.

skip-config-validation

NO REST EQUIVALENT

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

nis-modify

Use the /api/security/authentication/cluster/nis REST API endpoint to modify cluster NIS configurations.

PATCH /api/name-services/nis/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-active

NO REST EQUIVALENT

This property has been deprecated.

nis-domain

domain

nis-fqdn

servers

nis-servers

NO REST EQUIVALENT

This property has been deprecated. Use the "nis-fqdn" field.

skip-config-validation

NO REST EQUIVALENT

Category: NTP-SERVER

ntp-server-create

POST /api/cluster/ntp/servers

ONTAPI attribute

REST attribute

Comment

is-preferred

NO REST EQUIVALENT

key-id

key.id

return-record

NO REST EQUIVALENT

server-name

server

version

version

ntp-server-delete

DELETE /api/cluster/ntp/servers/{server}

ONTAPI attribute

REST attribute

Comment

server-name

server

ntp-server-get

GET /api/cluster/ntp/servers/{server}

ONTAPI attribute

REST attribute

Comment

is-authentication-enabled

authentication_enabled

is-preferred

NO REST EQUIVALENT

is-public-default

NO REST EQUIVALENT

key-id

key.id

server-name

server

version

version

ntp-server-get-iter

GET /api/cluster/ntp/servers

ONTAPI attribute

REST attribute

Comment

is-authentication-enabled

authentication_enabled

is-preferred

NO REST EQUIVALENT

is-public-default

NO REST EQUIVALENT

key-id

key.id

server-name

server

version

version

max-records

max_records

Specifies the maximum number of records to return before paging.

ntp-server-key-create

POST /api/cluster/ntp/keys

ONTAPI attribute

REST attribute

Comment

id

id

return-record

NO REST EQUIVALENT

type

digest_type

value

value

ntp-server-key-delete

DELETE /api/cluster/ntp/keys/{id}

ONTAPI attribute

REST attribute

Comment

id

NO REST EQUIVALENT

ntp-server-key-get-iter

GET /api/cluster/ntp/keys

ONTAPI attribute

REST attribute

Comment

id

id

type

digest_type

value

value

max-records

max_records

Specifies the maximum number of records to return before paging.

ntp-server-key-modify

PATCH /api/cluster/ntp/keys/{id}

ONTAPI attribute

REST attribute

Comment

id

NO REST EQUIVALENT

type

digest_type

value

value

ntp-server-modify

PATCH /api/cluster/ntp/servers/{server}

ONTAPI attribute

REST attribute

Comment

is-authentication-enabled

authentication_enabled

is-preferred

NO REST EQUIVALENT

key-id

key.id

server-name

server

server-name is not a patchable field

version

version

ntp-server-reset

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

ntp-server-security-get

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

ntp-server-security-set

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

ntp-server-status-get

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

ntp-server-status-get-iter

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

ntp-server-validate

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

Category: NVME

nvme-create

POST /api/protocols/nvme/services vicon.png

ONTAPI attribute

REST attribute

Comment

is-available

enabled

return-record

return_records

nvme-delete

DELETE /api/protocols/nvme/services/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

nvme-disable-experimental

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

nvme-enable-experimental

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

nvme-feature-get

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

nvme-get-iter

GET /api/protocols/nvme/services vicon.png

ONTAPI attribute

REST attribute

Comment

is-available

enabled

vserver

svm.name

vserver-uuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

nvme-initialize-anagrpids

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

nvme-interface-get-iter

GET /api/protocols/nvme/interfaces vicon.png

ONTAPI attribute

REST attribute

Comment

comment

NO REST EQUIVALENT

You can retrieve the comment property by using the HTTP GET method at the /api/network/fc/interfaces endpoint.

fc-wwnn

fc_interface.wwnn

fc-wwpn

fc_interface.wwpn

home-node

node.name

home-port

fc_interface.port.name

lif

name

lif-uuid

uuid

physical-protocol

NO REST EQUIVALENT

status-admin

enabled

transport-address

transport_address

transport-protocols

NO REST EQUIVALENT

vserver

svm.name

vserver-uuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

nvme-license-grace-period-get

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

nvme-modify

PATCH /api/protocols/nvme/services/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-available

enabled

nvme-namespace-create

POST /api/storage/namespaces vicon.png

ONTAPI attribute

REST attribute

Comment

application

NO REST EQUIVALENT

block-size

space.block_size

comment

comment

ostype

os_type

path

name

return-record

return_records

size

space.size

uuid

uuid

nvme-namespace-delete

DELETE /api/storage/namespaces/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destroy-application-namespace

NO REST EQUIVALENT

path

uuid

The REST API call provides the namespace UUID instead of the namespace path.

skip-mapped-check

allow_delete_while_mapped

nvme-namespace-get-iter

GET /api/storage/namespaces vicon.png

ONTAPI attribute

REST attribute

Comment

anagrpid

subsystem_map.anagrpid

application

NO REST EQUIVALENT

application-uuid

NO REST EQUIVALENT

block-size

space.block_size

comment

comment

creation-timestamp

create_time

is-read-only

status.read_only

node

location.node.name

nsid

subsystem_map.nsid

ostype

os_type

path

name

qtree

location.qtree.name

restore-inaccessible

NO REST EQUIVALENT

size

space.size

size-used

space.used

state

status.state

subsystem

subsystem_map.subsystem.name

uuid

subsystem_map.subsystem.uuid

volume

location.volume.name

vserver

svm.name

vserver-uuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

nvme-namespace-modify

PATCH /api/storage/namespaces/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

path

uuid

The REST API call provides the namespace UUID instead of the namespace path.

nvme-namespace-os-type-list

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

nvme-namespace-resize

The REST API does not support resizing namespaces.

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

nvme-revert-anagrpids

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

nvme-subsystem-controller-get-iter

GET /api/protocols/nvme/subsystem-controllers vicon.png

ONTAPI attribute

REST attribute

Comment

admin-queue-depth

admin_queue.depth

controller-id

id

host-nqn

host.nqn

initiator-transport-address

interface.transport_address

io-queue-count

io_queue.count

io-queue-depth

io_queue.depth

lif

interface.name

lif-uuid

interface.uuid

node

node.name

subsystem

subsystem.name

subsystem-uuid

subsystem.uuid

transport-protocol

NO REST EQUIVALENT

vserver

svm.name

vserver-uuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

nvme-subsystem-controller-shutdown

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

nvme-subsystem-create

POST /api/protocols/nvme/subsystems vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

delete-on-unmap

delete_on_unmap

ostype

os_type

return-record

return_records

subsystem

name

nvme-subsystem-delete

DELETE /api/protocols/nvme/subsystems/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

skip-host-check

allow_delete_with_hosts

skip-mapped-check

allow_delete_while_mapped

subsystem

NO REST EQUIVALENT

The REST API call provides the subsystem UUID instead of the subsystem name.

nvme-subsystem-get-iter

GET /api/protocols/nvme/subsystems vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

default-io-queue-count

io_queue.default.count

default-io-queue-depth

io_queue.default.depth

delete-on-unmap

delete_on_unmap

ostype

os_type

serial-number

serial_number

subsystem

name

target-nqn

target_nqn

uuid

uuid

vserver

svm.name

vserver-uuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

nvme-subsystem-host-add

POST /api/protocols/nvme/subsystems/{subsystem.uuid}/hosts vicon.png

ONTAPI attribute

REST attribute

Comment

host-nqn

nqn

subsystem

subsystem.uuid

The REST API call provides the subsystem UUID instead of the subsystem name.

nvme-subsystem-host-get-iter

GET /api/protocols/nvme/subsystems/{subsystem.uuid}/hosts vicon.png

ONTAPI attribute

REST attribute

Comment

host-nqn

nqn

io-queue-count

io_queue.count

io-queue-depth

io_queue.depth

subsystem

subsystem.uuid

The REST API call provides the subsystem UUID instead of the subsystem name. You can retrieve the subsystem name by sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint.

subsystem-uuid

subsystem.uuid

The REST API call provides the subsystem UUID instead of the subsystem name. You can retrieve the subsystem UUID by sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint.

vserver

NO REST EQUIVALENT

You can retrieve the vserver nameby sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint.

vserver-uuid

NO REST EQUIVALENT

You can retrieve the vserver UUID by sending a GET request to the /api/protocols/nvme/subsystems/{uuid} endpoint.

max-records

max_records

Specifies the maximum number of records to return before paging.

nvme-subsystem-host-remove

DELETE /api/protocols/nvme/subsystems/{subsystem.uuid}/hosts/{nqn} vicon.png

ONTAPI attribute

REST attribute

Comment

host-nqn

nqn

subsystem

subsystem.uuid

The REST API call provides the subsystem UUID instead of the subsystem name.

nvme-subsystem-map-add

POST /api/protocols/nvme/subsystem-maps vicon.png

ONTAPI attribute

REST attribute

Comment

path

namespace.name

subsystem

subsystem.name

nvme-subsystem-map-get-iter

GET /api/protocols/nvme/subsystem-maps vicon.png

ONTAPI attribute

REST attribute

Comment

anagrpid

anagrpid

namespace-uuid

namespace.uuid

nsid

nsid

path

namespace.name

subsystem

subsystem.name

subsystem-uuid

subsystem.uuid

vserver

svm.name

vserver-uuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

nvme-subsystem-map-remove

DELETE /api/protocols/nvme/subsystem-maps/{subsystem.uuid}/{namespace.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

namespace.uuid

The REST API call provides the namespace UUID instead of the namespace path.

subsystem

subsystem.uuid

The REST API call provides the subsystem UUID instead of the subsystem name.

nvme-subsystem-modify

PATCH /api/protocols/nvme/subsystems/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

delete-on-unmap

delete_on_unmap

subsystem

uuid

The REST API call provides the subsystem UUID instead of the subsystem name.

nvme-subsystem-os-type-list

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

Category: OPTIONS

options-get

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

options-get-iter

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

options-list-info

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

options-modify-iter

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

options-set

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

Category: PERF

perf-archive-config-get

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

perf-archive-config-modify

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

perf-archive-datastore-get-iter

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

perf-awa-get

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

perf-awa-get-iter

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

perf-awa-start

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

perf-awa-stop

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

perf-awa-volume-get

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

perf-awa-volume-get-iter

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

perf-clean-stale-sample-data

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

perf-cleanup-sample-duration

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

perf-object-counter-list-info

GET /api/cluster/counter/tables/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

filter-data

NO REST EQUIVALENT

This element is deprecated in Data ONTAP 8.2 and later, as filtering by node is no longer necessary. Each node contains the same set of counter definitions, so filtering by node yields the same results as not filtering.

objectname

name

counter-info.aggregation-style

NO REST EQUIVALENT

Aggregation-style is deprecated in Data ONTAP 8.2 and later. This field has never been used.

counter-info.base-counter

counter_schemas.denominator.name

Name of the counter used as the denominator to calculate values of counters involving averages and percentages.

counter-info.desc

counter_schemas.description

counter-info.is-deprecated

NO REST EQUIVALENT

counter-info.is-key

NO REST EQUIVALENT

counter-info.labels

NO REST EQUIVALENT

counter-info.name

counter_schemas.name

counter-info.privilege-level

NO REST EQUIVALENT

counter-info.replace-by

NO REST EQUIVALENT

counter-info.translation-input-counter

NO REST EQUIVALENT

Translation-input-counter is deprecated in Data ONTAP 8.2 and later. This field does not provide useful information about counters. It was previously used for diagnostic purposes only and is no longer needed.

counter-info.type

counter_schema.type

counter-info.unit

counter_schema.unit

perf-object-get-instances

GET /api/cluster/counter/tables/{counter_table.name}/rows vicon.png

ONTAPI attribute

REST attribute

Comment

counters

counters.name

filter-data

NO REST EQUIVALENT

The REST interface requires each individual field to be queried.

instance-uuids

NO REST EQUIVALENT

instances

id

The REST interface uses instance ID as a key and index.

max

max_records

objectname

counter_table.name

privilege-level

NO REST EQUIVALENT

sample-id

NO REST EQUIVALENT

sort-key

NO REST EQUIVALENT

sort-order

NO REST EQUIVALENT

perf-object-instance-list-info-iter

GET /api/cluster/counter/tables/{counter_table.name}/rows vicon.png

ONTAPI attribute

REST attribute

Comment

desired-attributes

fields

filter-data

NO REST EQUIVALENT

The REST interface requires each individual field to be queried.

max-records

max_records

Specifies the maximum number of records to return before paging.

objectname

counter_table.name

query

NO REST EQUIVALENT

Each field is queried individually in REST. For example, ' …/value?counters.name=myname'.

instance-info.name

id

instance-info.uuid

id

perf-object-list-info

GET /api/cluster/counter/tables vicon.png

ONTAPI attribute

REST attribute

Comment

filter-data

NO REST EQUIVALENT

This element is deprecated in Data ONTAP 8.2 and later, as filtering by node is no longer necessary. Each node contains the same set of counter definitions, so filtering by node yields the same results as not filtering.

object-info.description

description

object-info.get-instances-preferred-counter

NO REST EQUIVALENT

object-info.is-deprecated

NO REST EQUIVALENT

object-info.name

name

object-info.privilege-level

NO REST EQUIVALENT

object-info.replaced-by

NO REST EQUIVALENT

perf-object-start

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

perf-object-stop

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

perf-preset-create

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

perf-preset-delete

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

perf-preset-detail-get

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

perf-preset-get-iter

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

perf-preset-modify

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

perf-samples-delete

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

perf-samples-get-iter

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

Category: PLATFORM-CAP

platform-cap-get-iter

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

Category: PLATFORM

haosc-lookup

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

Category: PORTSET

portset-add

POST /api/protocols/san/portsets/{portset.uuid}/interfaces vicon.png

ONTAPI attribute

REST attribute

Comment

portset-name

portset.uuid

In the REST API, the portset is identified by "portset.uuid" in the endpoint path.

portset-port-name

fc.name or ip.name

In the REST API, a network interface to add to a portset can be identified by name or UUID.

portset-create

POST /api/protocols/san/portsets vicon.png

ONTAPI attribute

REST attribute

Comment

portset-name

name

portset-type

protocol

portset-destroy

DELETE /api/protocols/san/portsets/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

allow_delete_while_bound

portset-name

uuid

In the REST API, the portset is identified by "uuid" in the endpoint path.

portset-get-iter

GET /api/protocols/san/portsets

ONTAPI attribute

REST attribute

Comment

initiator-group-info

igroups

portset-name

name

portset-port-info

interfaces

portset-port-total

NO REST EQUIVALENT

This can be obtained by counting the number of elements in the "interfaces" array.

portset-type

protocol

portset-uuid

uuid

vserver

svm

max-records

max_records

Specifies the maximum number of records to return before paging.

portset-remove

DELETE /api/protocols/san/portsets/{portset.uuid}/interfaces/{uuid}

ONTAPI attribute

REST attribute

Comment

portset-name

portset.uuid

In the REST API, the portset is identified by "portset.uuid" in the endpoint path.

portset-port-name

uuid

In the REST API, the network interface is identified by "uuid" in the endpoint path.

Category: PROTECTION-TYPE

protection-type-get-iter

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

Category: QOS

cache-policy-get

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

cache-policy-get-iter

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

cache-policy-modify

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

cache-policy-modify-iter

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

qos-adaptive-policy-group-create

Adaptive parameters are required.

POST /api/storage/qos/policies

ONTAPI attribute

REST attribute

Comment

absolute-min-iops

adaptive.absolute_min_iops

block-size

adaptive.block_size

expected-iops

adaptive.expected_iops

expected-iops-allocation

NO REST EQUIVALENT

peak-iops

adaptive.peak_iops

peak-iops-allocation

adaptive.peak_iops_allocation

policy-group

name

return-record

return_records

vserver

svm.name

With the REST API, you can also use svm.uuid, the existing SVM owning the QoS policy.

qos-adaptive-policy-group-delete

The UUID of the adaptive policy group is a required field.

DELETE /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

policy-group

NO REST EQUIVALENT

qos-adaptive-policy-group-delete-iter

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

qos-adaptive-policy-group-get

GET /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

absolute-min-iops

adaptive.absolute_min_iops

block-size

adaptive.block_size

expected-iops

adaptive.expected_iops

expected-iops-allocation

adaptive.expected_iops_allocation

num-workloads

object_count

peak-iops

adaptive.peak_iops

peak-iops-allocation

NO REST EQUIVALENT

pgid

pgid

uuid

uuid

vserver

svm.name

policy-group

name

policy-group-class

policy_class

qos-adaptive-policy-group-get-iter

GET /api/storage/qos/policies

ONTAPI attribute

REST attribute

Comment

absolute-min-iops

adaptive.absolute_min_iops

block-size

adaptive.block_size

expected-iops

adaptive.expected_iops

expected-iops-allocation

adaptive.expected_iops_allocation

num-workloads

object_count

peak-iops

adaptive.peak_iops

peak-iops-allocation

NO REST EQUIVALENT

pgid

pgid

policy-group

name

uuid

uuid

vserver

svm.name

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

policy-group-class

policy_class

max-records

max_records

Specifies the maximum number of records to return before paging.

qos-adaptive-policy-group-modify

The UUID of the adaptive policy group is a required field.

PATCH /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

absolute-min-iops

adaptive.absolute_min_iops

block-size

adaptive.block_size

expected-iops

adaptive.expected_iops

expected-iops-allocation

NO REST EQUIVALENT

peak-iops

adaptive.peak_iops

peak-iops-allocation

NO REST EQUIVALENT

policy-group

name

qos-adaptive-policy-group-modify-iter

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

qos-adaptive-policy-group-rename

The UUID of the adaptive policy group is a required field.

PATCH /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

new-name

name

policy-group-name

NO REST EQUIVALENT

qos-policy-group-create

Fixed parameters are required. "capacity.shared" is set to "false" by default.

POST /api/storage/qos/policies

ONTAPI attribute

REST attribute

Comment

is-shared

fixed.capacity_shared

max-throughput

fixed.max_throughput_iops

With the REST API, you can also specify throughput by using "fixed.max_throughput_mbps".

min-throughput

fixed.min_throughput_iops

With the REST API, you can also specify throughput by using "fixed.min_throughput_mbps".

policy-group

name

return-record

return_records

vserver

svm.name

With the REST API, you can also use svm.uuid, the existing SVM owning the QoS policy.

qos-policy-group-delete

The UUID of the policy group is a required field.

DELETE /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

policy-group

NO REST EQUIVALENT

qos-policy-group-delete-iter

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

qos-policy-group-get

GET /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

is-auto-generated

NO REST EQUIVALENT

is-shared

fixed.capacity_shared

max-throughput

fixed.max_throughput_iops

With the REST API, you can also specify throughput by using "fixed.max_throughput_mbps".

min-throughput

fixed.min_throughput_iops

With the REST API, you can also specify throughput by using "fixed.min_throughput_mbps".

num-workloads

object_count

pgid

pgid

policy-group-class

policy_class

uuid

uuid

vserver

svm.name

policy-group

name

qos-policy-group-get-iter

GET /api/storage/qos/policies

ONTAPI attribute

REST attribute

Comment

is-auto-generated

NO REST EQUIVALENT

is-shared

fixed.capacity_shared

max-throughput

fixed.max_throughput_iops

With the REST API, you can also specify throughput by using "fixed.max_throughput_mbps".

min-throughput

fixed.min_throughput_iops

With the REST API, you can also specify throughput by using "fixed.min_throughput_mbps".

num-workloads

object_count

pgid

pgid

policy-group

name

policy-group-class

policy_class

uuid

uuid

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

qos-policy-group-modify

The UUID of the policy group is a required field.

PATCH /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

max-throughput

fixed.max_throughput_iops

With the REST API, you can also specify throughput by using "fixed.max_throughput_mbps".

min-throughput

fixed.min_throughput_iops

With the REST API, you can also specify throughput by using "fixed.min_throughput_mbps".

policy-group

name

qos-policy-group-modify-iter

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

qos-policy-group-rename

The UUID of the policy group is a required field.

PATCH /api/storage/qos/policies/{uuid}

ONTAPI attribute

REST attribute

Comment

new-name

name

policy-group-name

NO REST EQUIVALENT

qos-settings-read-ahead-create

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

qos-settings-read-ahead-destroy

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

qos-settings-read-ahead-destroy-iter

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

qos-settings-read-ahead-get

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

qos-settings-read-ahead-get-iter

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

qos-settings-read-ahead-modify

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

qos-settings-read-ahead-modify-iter

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

qos-test-smf-zapi-error

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

qos-workload-delete

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

qos-workload-delete-iter

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

qos-workload-get

GET /api/storage/qos/workloads/{uuid}

ONTAPI attribute

REST attribute

Comment

category

NO REST EQUIVALENT

file

file

is-adaptive

NO REST EQUIVALENT

is-constituent

NO REST EQUIVALENT

lun

lun

max-throughput

NO REST EQUIVALENT

min-throughput

NO REST EQUIVALENT

policy-group

NO REST EQUIVALENT

qtree

qtree

read-ahead

NO REST EQUIVALENT

volume

volume

vserver

svm.name

wid

wid

workload-class

class

workload-name

name

workload-uuid

uuid

qos-workload-get-iter

GET /api/storage/qos/workloads

ONTAPI attribute

REST attribute

Comment

category

NO REST EQUIVALENT

file

file

is-adaptive

NO REST EQUIVALENT

is-constituent

NO REST EQUIVALENT

lun

lun

max-throughput

NO REST EQUIVALENT

min-throughput

NO REST EQUIVALENT

policy-group

NO REST EQUIVALENT

qtree

qtree

read-ahead

NO REST EQUIVALENT

volume

volume

vserver

svm.name

wid

wid

workload-class

class

workload-name

name

workload-uuid

uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

qos-workload-modify

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

qos-workload-modify-iter

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

qos-workload-policy-count-get

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

Category: QTREE

qtree-create

POST /api/storage/qtrees vicon.png

ONTAPI attribute

REST attribute

Comment

export-policy

export_policy.name

mode

unix_permissions

oplocks

NO REST EQUIVALENT

This attribute is instead available through the REST API using the CLI passthrough /api/private/cli/qtree.

qos-policy-group

qos_policy.name

qtree

name

security-style

security_style

volume

volume.name

qtree-delete

DELETE /api/storage/qtrees/{volume.uuid}/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

qtree

NO REST EQUIVALENT

qtree-delete-async

DELETE /api/storage/qtrees/{volume.uuid}/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

qtree

NO REST EQUIVALENT

qtree-list-iter

GET /api/storage/qtrees vicon.png

ONTAPI attribute

REST attribute

Comment

export-policy

export_policy.name

id

id

is-export-policy-inherited

NO REST EQUIVALENT

The REST API provides export_policy.name which can used instead. This value can be compared with export_policy.name of qtree "".

mode

unix_permissions

oplocks

NO REST EQUIVALENT

This attribute is instead available through the REST API using the CLI passthrough /api/private/cli/qtree.

qos-policy-group

qos_policy.name

qtree

name

security-style

security_style

status

NO REST EQUIVALENT

volume

volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

qtree-modify

PATCH /api/storage/qtrees/{volume.uuid}/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

export-policy

export_policy.name

mode

unix_permissions

oplocks

NO REST EQUIVALENT

This attribute is instead available through the REST API using the CLI passthrough /api/private/cli/qtree.

qos-policy-group

qos_policy.name

qtree

name

security-style

security_style

volume

volume.name

qtree-rename

The REST API has no separate RENAME operation. You can qtree rename by using PATCH.

PATCH /api/storage/qtrees/{volume.uuid}/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

new-qtree-name

NO REST EQUIVALENT

qtree

name

Category: QUOTA

quota-add-entry

POST /api/storage/quota/rules vicon.png

ONTAPI attribute

REST attribute

Comment

disk-limit

space.hard_limit

file-limit

files.hard_limit

perform-user-mapping

user_mapping

policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

qtree

qtree.name

quota-target

NO REST EQUIVALENT

The REST API uses one of the three separate fields instead of quota-target: users/group/qtree.

quota-type

type

soft-disk-limit

space.soft_limit

soft-file-limit

files.soft_limit

threshold

NO REST EQUIVALENT

The REST API provides space.soft_limit which has similar functionality.

volume

volume.name

quota-delete-entry

DELETE /api/storage/quota/rules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

qtree

qtree.name

quota-target

NO REST EQUIVALENT

The REST API uses one of the three separate fields instead of quota-target: users/group/qtree.

quota-type

type

volume

NO REST EQUIVALENT

quota-get-entry

GET /api/storage/quota/rules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

qtree

qtree.name

quota-target

NO REST EQUIVALENT

The REST API uses one of the three separate fields instead of quota-target: users/group/qtree.

quota-type

type

volume

NO REST EQUIVALENT

quota-list-entries-iter

GET /api/storage/quota/rules vicon.png

ONTAPI attribute

REST attribute

Comment

disk-limit

space.hard_limit

file-limit

files.hard_limit

perform-user-mapping

user_mapping

policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

qtree

qtree.name

quota-target

NO REST EQUIVALENT

The REST API uses one of the three separate fields instead of quota-target: users/group/qtree.

quota-type

type

soft-disk-limit

space.soft_limit

soft-file-limit

files.soft_limit

threshold

NO REST EQUIVALENT

The REST API provides space.soft_limit which has similar functionality.

volume

volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

quota-modify-entry

PATCH /api/storage/quota/rules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

disk-limit

space.hard_limit

file-limit

files.hard_limit

perform-user-mapping

user_mapping

policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

qtree

qtree.name

quota-target

NO REST EQUIVALENT

The REST API uses one of the three separate fields instead of quota-target: users/group/qtree.

quota-type

type

soft-disk-limit

space.soft_limit

soft-file-limit

files.soft_limit

threshold

NO REST EQUIVALENT

The REST API provides space.soft_limit which has similar functionality.

volume

NO REST EQUIVALENT

quota-off

Refer to the "quota.enabled" attribute of "/api/storage/volumes/{uuid}" REST endpoint.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

quota-on

Refer to the "quota.enabled" attribute of "/api/storage/volumes/{uuid}" REST endpoint.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

quota-policy-copy

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

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

quota-policy-create

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

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

quota-policy-delete

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

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

quota-policy-delete-iter

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

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

quota-policy-get-iter

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

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

quota-policy-rename

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

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

quota-policy-rule-count-get

Option "?return_records=false" is recommended when counting quota rules.

GET /api/storage/quota/rules vicon.png

ONTAPI attribute

REST attribute

Comment

count-where-policy

NO REST EQUIVALENT

count-where-policy-volume

NO REST EQUIVALENT

count-where-policy-volume-qtree

NO REST EQUIVALENT

count-where-policy-volume-qtree-type

NO REST EQUIVALENT

count-where-policy-volume-type

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

qtree

qtree.name

quota-type

type

volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

quota-policy-rule-count-get-iter

Option "?return_records=false" is recommended when counting quota rules.

GET /api/storage/quota/rules vicon.png

ONTAPI attribute

REST attribute

Comment

count-where-policy

NO REST EQUIVALENT

count-where-policy-volume

NO REST EQUIVALENT

count-where-policy-volume-qtree

NO REST EQUIVALENT

count-where-policy-volume-qtree-type

NO REST EQUIVALENT

count-where-policy-volume-type

NO REST EQUIVALENT

policy

NO REST EQUIVALENT

qtree

qtree.name

quota-type

type

volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

quota-report-iter

GET /api/storage/quota/reports vicon.png

ONTAPI attribute

REST attribute

Comment

disk-limit

space.hard_limit

disk-used

space.used.total

disk-used-pct-disk-limit

space.used.hard_limit_percent

disk-used-pct-soft-disk-limit

space.used.soft_limit_percent

disk-used-pct-threshold

NO REST EQUIVALENT

The REST API provides space.used.soft_limit_percent which has similar functionality.

file-limit

files.hard_limit

files-used

files.used.total

files-used-pct-file-limit

files.used.hard_limit_percent

files-used-pct-soft-file-limit

files.used.soft_limit_percent

path

NO REST EQUIVALENT

quota-target

NO REST EQUIVALENT

quota-type

type

quota-users

NO REST EQUIVALENT

The REST API uses one of the two separate fields instead of quota-users: users/group.

soft-disk-limit

space.soft_limit

soft-file-limit

files.soft_limit

threshold

NO REST EQUIVALENT

The REST API provides space.soft_limit which has similar functionality.

tree

qtree.name

volume

volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

quota-resize

Changes to quota rule limits ("space.hard_limit", "space.soft_limit", "files.hard_limit", and "files.soft_limit") are applied automatically without requiring a quota resize operation.

PATCH /api/storage/quota/rules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

quota-set-entry

PATCH /api/storage/quota/rules/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

disk-limit

space.hard_limit

file-limit

files.hard_limit

perform-user-mapping

user_mapping

policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

qtree

qtree.name

quota-target

NO REST EQUIVALENT

The REST API uses one of the three separate fields instead of quota-target: users/group/qtree.

quota-type

type

soft-disk-limit

space.soft_limit

soft-file-limit

files.soft_limit

threshold

NO REST EQUIVALENT

The REST API provides space.soft_limit which has similar functionality.

volume

NO REST EQUIVALENT

quota-status

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

percent-complete

NO REST EQUIVALENT

quota-errors

NO REST EQUIVALENT

status

quota.state

substatus

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

quota-status-iter

GET /api/storage/volumes vicon.png

ONTAPI attribute

REST attribute

Comment

percent-complete

NO REST EQUIVALENT

quota-error-msgs

NO REST EQUIVALENT

reason

NO REST EQUIVALENT

status

quota.state

substatus

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: SECD

secd-auth-get-claim-name

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

secd-auth-get-dc-info

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

secd-auth-show-ontap-admin-unix-creds-using-uid

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

secd-auth-show-ontap-admin-unix-creds-using-unix-user-name

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

secd-auth-sid-to-uid

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

secd-auth-sid-to-unix-user-name

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

secd-auth-translate-gid-to-groupname

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

secd-auth-translate-sid-to-win-user-name

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

secd-auth-translate-uid-to-username

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

secd-auth-translate-unix-group-name-to-gid

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

secd-auth-translate-unix-user-name-to-uid

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

secd-auth-translate-windows-user-name-to-sid

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

secd-auth-uid-to-sid

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

secd-connection-timeout-get

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

secd-connection-timeout-get-iter

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

secd-connection-timeout-modify

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

secd-dns-forward-lookup

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

secd-dns-srv-lookup

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

secd-name-mapping-show

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

secd-server-discovery-host

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

secd-server-discovery-reset

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

secd-server-discovery-site

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

secd-server-discovery-test

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

Category: SECTRACE

sectrace-find-or-create-filter

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

security-trace-filter-create

This API is private as it is only supported by System Manager.

POST /api/protocols/file-access-tracing/filters vicon.png

ONTAPI attribute

REST attribute

Comment

client-ip

client_ip

enabled

enabled

index

index

path

path

protocols

protocol

return-record

return_records

time-enabled

NO REST EQUIVALENT

trace-allow

trace_allowed_ops

unix-name

unix_user

windows-name

windows_user

security-trace-filter-delete

This API is private as it is only supported by System Manager.

DELETE /api/protocols/file-access-tracing/filters/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

index

index

security-trace-filter-get-iter

This API is private as it is only supported by System Manager.

GET /api/protocols/file-access-tracing/filters vicon.png

ONTAPI attribute

REST attribute

Comment

client-ip

client_ip

enabled

enabled

index

index

path

path

protocols

protocol

time-enabled

NO REST EQUIVALENT

trace-allow

trace_allowed_ops

unix-name

unix_user

vserver

svm.name

windows-name

windows_user

max-records

max_records

Specifies the maximum number of records to return before paging.

security-trace-filter-modify

This API is private as it is only supported by System Manager.

PATCH /api/protocols/file-access-tracing/filters/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

client-ip

client_ip

enabled

enabled

index

index

path

path

protocols

protocol

time-enabled

NO REST EQUIVALENT

trace-allow

trace_allowed_ops

unix-name

unix_user

windows-name

windows_user

security-trace-result-delete

This API is private as it is only supported by System Manager.

DELETE /api/protocols/file-access-tracing/events/{node.uuid}/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

node

NO REST EQUIVALENT

In the REST API, provide the node uuid here instead of node name.

seqnum

index

security-trace-result-show

This API is private as it is only supported by System Manager.

GET /api/protocols/file-access-tracing/events/{node.uuid}/{svm.uuid}/{index} vicon.png

ONTAPI attribute

REST attribute

Comment

client-ip

filter.client_ip

index

filter.index

keytime

NO REST EQUIVALENT

node

node.name

path

filter.path

protocol

filter.protocol

result

reason.message

security-style

NO REST EQUIVALENT

seqnum

index

session-id

session_id

share-name

share.name

unix-user

filter.unix_user

user-name

filter.windows_user

volume-name

volume.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: SECURITY-CERTIFICATE

security-certificate-ca-issued-get

Two GET requests are used here. The first GET request filters on "root-ca" for the "type" attribute. The second GET request sets the "type" filter to "server|client" and adds a separate filter on the "ca" attribute using the set of values returned for "ca" by the first GET request.

GET /api/security/certificates vicon.png

ONTAPI attribute

REST attribute

Comment

ca-serial-number

serial_number

The value from the first GET response applies here.

certificate-authority

ca

The value is the same in both GET responses.

common-name

common_name

The value from the second GET reponse applies here.

country

NO REST EQUIVALENT

email-addr

NO REST EQUIVALENT

expiration-date

expiry_time

The value from the second GET response applies here.

locality

NO REST EQUIVALENT

organization

NO REST EQUIVALENT

organization-unit

NO REST EQUIVALENT

revocation-date

NO REST EQUIVALENT

serial-number

serial_number

The value from the second GET response applies here.

state

NO REST EQUIVALENT

status

NO REST EQUIVALENT

vserver

svm.name

The value is the same in both GET responses.

security-certificate-ca-issued-get-iter

Two GET requests are used here. The first GET request filters on "root-ca" for the "type" attribute. The second GET request sets the "type" filter to "server|client" and adds a separate filter on the "ca" attribute using the set of values returned for "ca" by the first GET request.

GET /api/security/certificates vicon.png

ONTAPI attribute

REST attribute

Comment

ca-serial-number

serial_number

The value from the first GET response applies here.

certificate-authority

ca

The value is the same in both GET responses.

common-name

common_name

The value from the second GET reponse applies here.

country

NO REST EQUIVALENT

email-addr

NO REST EQUIVALENT

expiration-date

expiry_time

The value from the second GET response applies here.

locality

NO REST EQUIVALENT

organization

NO REST EQUIVALENT

organization-unit

NO REST EQUIVALENT

revocation-date

NO REST EQUIVALENT

serial-number

serial_number

The value from the second GET response applies here.

state

NO REST EQUIVALENT

status

NO REST EQUIVALENT

vserver

svm.name

The value is the same in both GET responses.

max-records

max_records

Specifies the maximum number of records to return before paging.

security-certificate-create

POST /api/security/certificates vicon.png

ONTAPI attribute

REST attribute

Comment

cert-name

name

common-name

common_name

country

NO REST EQUIVALENT

email-address

NO REST EQUIVALENT

expire-days

expiry_time

hash-function

hash_function

is-system-internal-certificate

NO REST EQUIVALENT

locality

NO REST EQUIVALENT

organization

NO REST EQUIVALENT

organization-unit

NO REST EQUIVALENT

size

key_size

state

NO REST EQUIVALENT

type

type

vserver

svm.name

security-certificate-delete

DELETE /api/security/certificates/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

cert-name

name

certificate-authority

ca

common-name

common_name

is-system-internal-certificate

NO REST EQUIVALENT

serial-number

serial_number

subtype

NO REST EQUIVALENT

This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available.

type

type

vserver

svm.name

security-certificate-delete-iter

DELETE /api/security/certificates vicon.png

ONTAPI attribute

REST attribute

Comment

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.

cert-name

name

certificate-authority

ca

common-name

common_name

country

NO REST EQUIVALENT

email-address

NO REST EQUIVALENT

expiration-date

expiry_time

expire-days

NO REST EQUIVALENT

hash-function

hash_function

is-default

NO REST EQUIVALENT

is-root

NO REST EQUIVALENT

is-system-generated

NO REST EQUIVALENT

locality

NO REST EQUIVALENT

organization

NO REST EQUIVALENT

organization-unit

NO REST EQUIVALENT

protocol

NO REST EQUIVALENT

public-certificate

public_certificate

self-signed

NO REST EQUIVALENT

serial-number

serial_number

size

key_size

start-date

NO REST EQUIVALENT

state

NO REST EQUIVALENT

subtype

NO REST EQUIVALENT

This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available.

type

type

vserver

svm.name

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

security-certificate-file-get-iter

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

security-certificate-generate-csr

POST /api/security/certificate-signing-request vicon.png

ONTAPI attribute

REST attribute

Comment

common-name

subject_name

All subject names, including common name, are supported through this field.

country

NO REST EQUIVALENT

email-address

NO REST EQUIVALENT

hash-function

hash_function

locality

NO REST EQUIVALENT

organization

NO REST EQUIVALENT

organization-unit

NO REST EQUIVALENT

size

security_strength

Security strength in bits as opposed to "size" which is RSA-key bits.

state

NO REST EQUIVALENT

security-certificate-get

GET /api/security/certificates/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

cert-name

name

certificate-authority

ca

common-name

common_name

country

NO REST EQUIVALENT

email-address

NO REST EQUIVALENT

expiration-date

expiry_time

expire-days

NO REST EQUIVALENT

hash-function

hash_function

is-default

NO REST EQUIVALENT

is-root

NO REST EQUIVALENT

is-system-generated

NO REST EQUIVALENT

locality

NO REST EQUIVALENT

organization

NO REST EQUIVALENT

organization-unit

NO REST EQUIVALENT

protocol

NO REST EQUIVALENT

public-certificate

public_certificate

self-signed

NO REST EQUIVALENT

serial-number

serial_number

size

key_size

start-date

NO REST EQUIVALENT

state

NO REST EQUIVALENT

subtype

NO REST EQUIVALENT

This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available.

type

type

vserver

svm.name

security-certificate-get-iter

GET /api/security/certificates vicon.png

ONTAPI attribute

REST attribute

Comment

cert-name

name

certificate-authority

ca

common-name

common_name

country

NO REST EQUIVALENT

email-address

NO REST EQUIVALENT

expiration-date

expiry_time

expire-days

NO REST EQUIVALENT

hash-function

hash_function

is-default

NO REST EQUIVALENT

is-root

NO REST EQUIVALENT

is-system-generated

NO REST EQUIVALENT

locality

NO REST EQUIVALENT

organization

NO REST EQUIVALENT

organization-unit

NO REST EQUIVALENT

protocol

NO REST EQUIVALENT

public-certificate

public_certificate

self-signed

NO REST EQUIVALENT

serial-number

serial_number

size

key_size

start-date

NO REST EQUIVALENT

state

NO REST EQUIVALENT

subtype

NO REST EQUIVALENT

This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available.

type

type

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

security-certificate-install

POST /api/security/certificates vicon.png

ONTAPI attribute

REST attribute

Comment

cert-name

name

certificate

public_certificate

common-name

common_name

intermediate-cert-list

intermediate_certificates

is-system-internal-certificate

NO REST EQUIVALENT

private-key

private_key

subtype

NO REST EQUIVALENT

This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available.

type

type

vserver

svm.name

security-certificate-remove-precluster-cert

The entity to which this ZAPI refers is not externally visible after cluster setup and is no longer in use by system. It is automatically deleted 24 hours after creation of the first data SVM. If a need arises to explicitly delete it, use the diagnostic "security certificate remove-precluster-cert" command.

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

security-certificate-rename

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

security-certificate-revoke

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

security-certificate-sign

POST /api/security/certificates/{ca.uuid}/sign vicon.png

ONTAPI attribute

REST attribute

Comment

ca-serial-number

NO REST EQUIVALENT

certificate-authority

NO REST EQUIVALENT

csr

signing_request

destination

NO REST EQUIVALENT

expire-days

expiry_time

filepassword

NO REST EQUIVALENT

format

NO REST EQUIVALENT

hash-function

hash_function

password

NO REST EQUIVALENT

private-key

NO REST EQUIVALENT

username

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

Not required. With the REST API, you can determine vserver by the ca.uuid resource.

security-certificate-truststore-clear

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

security-certificate-truststore-load

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

Category: SECURITY-KEY-MANAGER-KEY

security-key-manager-key-get-iter

The security-key-manager-key-get-iter ONTAPI is deprecated as of ONTAP 9.6. It is replaced by the key-query-get-iter ONTAPI. In ONTAP 9.8 and earlier releases, there is no REST API to list individual keys.

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

Category: SECURITY-KEY-MANAGER

external-restore-get-iter

In ONTAP 9.8 and earlier releases, there is no REST API to restore key IDs from key management servers.

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

external-status-get-iter

In ONTAP 9.8 and earlier releases, there is no REST API to return key management server status.

GET /api/security/key-managers vicon.png

ONTAPI attribute

REST attribute

Comment

key-server

NO REST EQUIVALENT

key-server-status

NO REST EQUIVALENT

node

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

key-query-get-iter

The REST API is available in ONTAP 9.11 release and onwards. In ONTAP 9.10 and earlier releases, there is no REST API to return information about individual keys.

GET /api/security/key-managers/{security_key_manager.uuid}/keys/{node.uuid}/key-ids vicon.png

ONTAPI attribute

REST attribute

Comment

key-id

key-id

key-server

key-server

key-store

key-store

key-tag

key-tag

key-type

key-type

key-user

key-user

node

node-uuid

restored

restored

vserver

svm-name

max-records

max_records

Specifies the maximum number of records to return before paging.

security-key-manager-add

The security-key-manager-add ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-external-add-servers.

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

security-key-manager-add-iter

The security-key-manager-add-iter ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-external-add-servers.

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

security-key-manager-backup-get

The security-key-manager-backup-get ONTAPI has been deprecated as of ONTAP 9.6. This ONTAPI has been replaced by security-key-manager-onboard-backup-get.

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

security-key-manager-config-get

In ONTAP 9.8 and earlier releases, there is no REST API to retrieve key manager configuration options.

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

security-key-manager-config-modify

In ONTAP 9.8 and earlier releases, there is no REST API to modify key manager configuration options.

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

security-key-manager-create-key

The security-key-manager-create-key ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-key-database-create-key. In ONTAP 9.8 and earlier releases, there is no REST API to create an authentication key.

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

security-key-manager-delete

The security-key-manager-delete ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-external-remove-servers.

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

security-key-manager-delete-iter

The security-key-manager-delete-iter ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-external-remove-servers.

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

security-key-manager-delete-keys

The security-key-manager-delete-keys ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-onboard-disable.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-delete-kmip-config

The security-key-manager-delete-kmip-config ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-external-disable.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-external-add-servers

POST /api/security/key-managers/{uuid}/key-servers vicon.png

ONTAPI attribute

REST attribute

Comment

key-servers

server

When adding a single server, use the server REST API attribute. To add multiple key-servers, use records, which is an array of servers.

vserver

NO REST EQUIVALENT

When using a REST API to add key-servers, identify the key manager by the UUID in the path.

security-key-manager-external-disable

DELETE /api/security/key-managers/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

vserver

NO REST EQUIVALENT

When using a REST API to disable a key manager, identify the key manager by the UUID in the path.

security-key-manager-external-enable

POST /api/security/key-managers vicon.png

ONTAPI attribute

REST attribute

Comment

client-cert

external.client_certificate

key-servers

external.servers

keyservers-are-clustered

external.servers.secondary_key_servers

In the REST API, if external.servers.secondary_key_servers is populated, then the key servers are clustered.

server-ca-certs

external.server_ca_certificates

vserver

svm

UUID of the SVM to add key-manager to. Not applicable if adding to Vserver.

security-key-manager-external-get

GET /api/security/key-managers/{uuid}/key-servers/{server} vicon.png

ONTAPI attribute

REST attribute

Comment

client-cert

NO REST EQUIVALENT

info

NO REST EQUIVALENT

key-server

server

keyservers-are-clustered

NO REST EQUIVALENT

server-ca-certs

NO REST EQUIVALENT

timeout

timeout

vserver

NO REST EQUIVALENT

UUID in the REST API identifies the key manager.

key-server

NO REST EQUIVALENT

ONTAPI attribute key-server is already described in this section.

security-key-manager-external-get-iter

GET /api/security/key-managers/{uuid}/key-servers vicon.png

ONTAPI attribute

REST attribute

Comment

client-cert

NO REST EQUIVALENT

info

NO REST EQUIVALENT

key-server

server

keyservers-are-clustered

NO REST EQUIVALENT

server-ca-certs

NO REST EQUIVALENT

timeout

timeout

vserver

NO REST EQUIVALENT

UUID in the REST API path identifies the key manager.

max-records

max_records

Specifies the maximum number of records to return before paging.

security-key-manager-external-modify

PATCH /api/security/key-managers/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

client-cert

external.client_certificate

keyservers-are-clustered

external.servers.secondary_key_servers

In the REST API, if external.servers.secondary_key_servers is populated, then the key servers are clustered.

server-ca-certs

external.server_ca_certificates

vserver

NO REST EQUIVALENT

UUID in the REST API path identifies the key manager to be updated.

security-key-manager-external-modify-server

PATCH /api/security/key-managers/{uuid}/key-servers/{server} vicon.png

ONTAPI attribute

REST attribute

Comment

key-server

NO REST EQUIVALENT

UUID of the key server is in the REST API path.

password

password

secondary-servers

secondary_key_servers

timeout

timeout

username

username

vserver

NO REST EQUIVALENT

UUID of the key manager to which the key server is associated is in the REST API path.

security-key-manager-external-remove-servers

DELETE /api/security/key-managers/{uuid}/key-servers/{server} vicon.png

ONTAPI attribute

REST attribute

Comment

key-servers

NO REST EQUIVALENT

UUID of the key-server to remove is in the REST API path.

vserver

NO REST EQUIVALENT

UUID of the key manager to which the key server is associated is in the REST API path.

security-key-manager-get

The security-key-manager-add ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-external-get.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-get-iter

The security-key-manager-add ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-external-get..

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-key-database-create-key

In ONTAP 9.8 and earlier releases, there is no REST API to create a key.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-key-database-delete-key

In ONTAP 9.8 and earlier releases, there is no REST API to delete a key.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-key-migrate

POST /api/security/key-managers/{source.uuid}/migrate vicon.png

ONTAPI attribute

REST attribute

Comment

from-vserver

NO REST EQUIVALENT

source.uuid in the REST API path specifies the from key-manager

to-vserver

uuid

uuid specifies the "to" key-manager

security-key-manager-key-store-get-iter

In ONTAP 9.8 and earlier releases, there is no REST API to retrieve the key-store of each key manager. However, you can use the GET /api/security/key-managers REST API to get information about one or more key managers. Included in that information are the details about the key-store for each key manager.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-onboard-backup-get

GET /api/security/key-managers/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

vserver

NO REST EQUIVALENT

UUID in the REST API path identifies the key manager for which to retrieve the backup.

security-key-manager-onboard-disable

DELETE /api/security/key-managers/{uuid}

ONTAPI attribute

REST attribute

Comment

vserver

NO REST EQUIVALENT

UUID in the REST API path identifies the key manager to disable.

security-key-manager-onboard-enable

POST /api/security/key-managers

ONTAPI attribute

REST attribute

Comment

cc-mode-enabled

NO REST EQUIVALENT

okm-on-usb-enabled

NO REST EQUIVALENT

onboard-passphrase

onboard.passphrase

vserver

NO REST EQUIVALENT

security-key-manager-onboard-sync

PATCH /api/security/key-managers/{uuid}

ONTAPI attribute

REST attribute

Comment

passphrase

onboard.existing_passphrase

vserver

NO REST EQUIVALENT

UUID in the REST API path identifies the key manager to sync.

security-key-manager-onboard-update-passphrase

PATCH /api/security/key-managers/{uuid}

ONTAPI attribute

REST attribute

Comment

existing-passphrase

onboard.existing_passphrase

new-passphrase

onboard.passphrase

vserver

NO REST EQUIVALENT

UUID in the REST API path identifies the key manager to update.

security-key-manager-query-get

The security-key-manager-query-get ONTAPI is deprecated. This ONTAPI is replaced by key-query-get-iter. In ONTAP 9.8 and earlier releases, there is no REST API to query individual keys.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-query-get-iter

The security-key-manager-query-get-iter ONTAPI is deprecated. This ONTAPI is replaced by key-query-get-iter. In ONTAP 9.8 and earlier releases, there is currently no REST API to query individual keys.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-query-v2-get

The security-key-manager-query-v2-get ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by key-query-get-iter. In ONTAP 9.8 and earlier releases, there is no REST API to query individual keys.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-query-v2-get-iter

The security-key-manager-query-v2-get-iter ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by key-query-get-iter. In ONTAP 9.8 and earlier releases, there is no REST API to query individual keys.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-restore-get

The security-key-manager-restore-get ONTAPI is deprecated. This ONTAPI is replaced by external-restore-get-iter. In ONTAP 9.8 and earlier releases, there is no REST API to restore key IDs from key management servers.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-restore-get-iter

The security-key-manager-restore-get-iter ONTAPI is deprecated. This ONTAPI is replaced by external-restore-get-iter. In ONTAP 9.8 and earlier releases, there is no REST API to restore key IDs from key management servers.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-restore-v2-get

The security-key-manager-restore-v2-get ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by external-restore-get-iter. In ONTAP 9.8 and earlier releases, there is no REST API to restore key IDs from key management servers.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-restore-v2-get-iter

The security-key-manager-restore-v2-get-iter ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by external-restore-get-iter. In ONTAP 9.8 and earlier releases, there is no REST API to restore key IDs from key management servers.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-setup

The security-key-manager-setup ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-onboard-enable for Onboard Key Manager (OKM) and security-key-manager-external-enable for External Key Management (EKM).

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-update-passphrase

The security-key-manager-update-passphrase ONTAPI is deprecated as of ONTAP 9.6. This ONTAPI is replaced by security-key-manager-onboard-update-passphrase to update the passphrase on the local cluster and security-key-manager-onboard-sync to update the passphrase on the partner cluster.

This ONTAPI call does not have an equivalent REST API call.

security-key-manager-volume-encryption-supported

There is no REST API to determine if volume_encryption is supported. However, you can use the GET /api/security/key-managers REST API to get information about one or more key managers. Included in that information is whether volume_encryption is supported.

This ONTAPI call does not have an equivalent REST API call.

Category: SECURITY-SESSION

security-session-application-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-kill-cli-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-application-create

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-application-delete

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-application-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-application-modify

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-create

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-delete

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-location-create

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-location-delete

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-location-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-location-modify

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-modify

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-request-create

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-request-delete

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-request-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-request-modify

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-user-create

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-user-delete

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-user-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-user-modify

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-vserver-create

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-vserver-delete

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-vserver-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-limit-vserver-modify

This ONTAPI call does not have an equivalent REST API call.

security-session-location-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-request-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-reset-statistics

This ONTAPI call does not have an equivalent REST API call.

security-session-running-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-user-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-session-vserver-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

Category: SECURITY-SSL

security-ssl-get

GET /api/security/certificates/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

certificate-authority

ca

Certificate authority.

certificate-serial-number

serial_number

Serial number of certificate.

client-authentication-enabled

NO REST EQUIVALENT

See "client_enabled" in /api/cluster/web and /api/svm/svms/{svm.uuid}/web.

common-name

common_name

FQDN or custom common name.

ocsp-default-responder

NO REST EQUIVALENT

ocsp-enabled

NO REST EQUIVALENT

See "ocsp_enabled" in /api/cluster/web and /api/svm/svms/{svm.uuid}/web.

ocsp-max-response-age

NO REST EQUIVALENT

ocsp-max-response-time-skew

NO REST EQUIVALENT

ocsp-override-responder

NO REST EQUIVALENT

ocsp-responder-timeout

NO REST EQUIVALENT

ocsp-use-request-nonce

NO REST EQUIVALENT

server-authentication-enabled

NO REST EQUIVALENT

vserver

svm.name

The name of the SVM.

security-ssl-get-iter

GET /api/security/certificates vicon.png

ONTAPI attribute

REST attribute

Comment

certificate-authority

ca

Certificate authority.

certificate-serial-number

serial_number

Serial number of certificate.

client-authentication-enabled

NO REST EQUIVALENT

See "client_enabled" in /api/cluster/web and /api/svm/svms/{svm.uuid}/web.

common-name

common_name

FQDN or custom common name.

ocsp-default-responder

NO REST EQUIVALENT

ocsp-enabled

NO REST EQUIVALENT

See "ocsp_enabled" in /api/cluster/web and /api/svm/svms/{svm.uuid}/web.

ocsp-max-response-age

NO REST EQUIVALENT

ocsp-max-response-time-skew

NO REST EQUIVALENT

ocsp-override-responder

NO REST EQUIVALENT

ocsp-responder-timeout

NO REST EQUIVALENT

ocsp-use-request-nonce

NO REST EQUIVALENT

server-authentication-enabled

NO REST EQUIVALENT

vserver

svm.name

The name of the SVM.

max-records

max_records

Specifies the maximum number of records to return before paging.

security-ssl-modify

The certificate’s UUID is used to identify the certificate to use for the SVM. To update the certificate of the admin SVM, use PATCH /api/cluster/web. Example:
curl -XPATCH "https://{mgmt-ip}/api/svm/svms/1cd8a442-86d1-11e0-ae1c-123478563412/web" -d {"certificate": { "uuid": "abc8a442-86d1-11e0-ae1c-123478563333" } }

PATCH /api/svm/svms/{svm.uuid}/web vicon.png

ONTAPI attribute

REST attribute

Comment

certificate-authority

NO REST EQUIVALENT

The certificate authority associated with the certificate.

certificate-serial-number

NO REST EQUIVALENT

The serial number for the certificate.

client-authentication-enabled

client_enabled

Indicates whether client authentication is enabled.

common-name

NO REST EQUIVALENT

FQDN or custom common name for the certificate.

ocsp-default-responder

NO REST EQUIVALENT

ocsp-enabled

ocsp_enabled

Indicates whether online certificate status protocol verification is enabled.

ocsp-max-response-age

NO REST EQUIVALENT

ocsp-max-response-time-skew

NO REST EQUIVALENT

ocsp-override-responder

NO REST EQUIVALENT

ocsp-responder-timeout

NO REST EQUIVALENT

ocsp-use-request-nonce

NO REST EQUIVALENT

server-authentication-enabled

NO REST EQUIVALENT

SSL server authentication. To disable this field, delete the certificate using DELETE /api/security/certificates/{uuid}.

vserver

name

The name of the SVM.

Category: SECURITY

security-config-get

GET /api/security

ONTAPI attribute

REST attribute

Comment

cluster-security-config-ready

NO REST EQUIVALENT

interface

NO REST EQUIVALENT

This was required in ONTAPI but only allowed a single valid value. Not exposed in the REST API.

is-fips-enabled

fips.enabled

supported-ciphers

NO REST EQUIVALENT

This was optional in ONTAPI but is now deprecated in favor of supported-cipher-suites. Not exposed in the REST API.

supported-cipher-suites

tls.cipher_suites

supported-protocols

tls.protocol_versions

interface

NO REST EQUIVALENT

This was required in ONTAPI but only allowed a single valid value. Not exposed in the REST API.

security-config-modify

PATCH /api/security

ONTAPI attribute

REST attribute

Comment

interface

NO REST EQUIVALENT

This was required in ONTAPI but only allowed a single valid value. Not exposed in the REST API.

is-fips-enabled

fips.enabled

supported-ciphers

NO REST EQUIVALENT

This was optional in ONTAPI but is now deprecated in favor of supported-cipher-suites. Not exposed in the REST API.

supported-cipher-suites

tls.cipher_suites

supported-protocols

tls.protocol_versions

security-config-ocsp-disable

Use the advanced "security config ocsp disable" command.

This ONTAPI call does not have an equivalent REST API call.

security-config-ocsp-enable

Use the advanced "security config ocsp enable" command.

This ONTAPI call does not have an equivalent REST API call.

security-config-ocsp-get-iter

Use the advanced "security config ocsp show" command.

This ONTAPI call does not have an equivalent REST API call.

security-last-login-info

This ONTAPI call does not have an equivalent REST API call.

security-login-create

You cannot create SNMP users by using this endpoint. To create SNMP users, use the POST /api/support/snmp/users REST API endpoint.

POST /api/security/accounts

ONTAPI attribute

REST attribute

Comment

application

applications.application

authentication-method

applications.authentication_methods

comment

comment

is-ns-switch-group

NO REST EQUIVALENT

is-password-hashed

NO REST EQUIVALENT

password

password

remote-switch-ipaddress

NO REST EQUIVALENT

role-name

role.name

second-authentication-method

applications.second_authentication_method

snmpv3-login-info

NO REST EQUIVALENT

SNMP (including SNMPv3) users are managed by the "/api/support/snmp/users" REST API endpoint.

user-name

name

name is specified as a path parameter.

vserver

owner.name

Can also use owner.uuid

security-login-delete

The /api/security/accounts/{owner.uuid}/{name} REST API endpoint deletes all the entries for the user account, that is, it deletes entries for all applications and all authentication methods corresponding to the user account. You cannot delete SNMP users by using this endpoint. To delete SNMP users, use the DELETE /api/support/snmp/users/{engine-id}/{name} REST API endpoint.

DELETE /api/security/accounts/{owner.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

application

applications.application

authentication-method

applications.authentication_methods

remote-switch-ipaddress

NO REST EQUIVALENT

user-name

name

name is specified as a path parameter.

vserver

owner.uuid

owner.uuid is specified as a path parameter.

security-login-delete-iter

You cannot delete SNMP users by using this endpoint. To delete a set of SNMP users, use the DELETE /api/support/snmp/users REST API collection.

DELETE /api/security/accounts

ONTAPI attribute

REST attribute

Comment

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.

application

applications.application

authentication-method

applications.authentication_methods

comment

comment

is-locked

locked

is-ns-switch-group

NO REST EQUIVALENT

password-hash-algorithm

password_hash_algorithm

remote-switch-ipaddress

NO REST EQUIVALENT

role-name

role.name

second-authentication-method

applications.second_authentication_method

user-name

name

vserver

owner.name

Can also specify "owner.uuid"

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

security-login-expire-password

This ONTAPI call does not have an equivalent REST API call.

security-login-expire-password-iter

This ONTAPI call does not have an equivalent REST API call.

security-login-get

You cannot retrieve SNMP users by using this endpoint. To retrieve SNMP users, use GET /api/support/snmp/users/{engine_id}/{name} REST API call.

GET /api/security/accounts/{owner.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

application

applications.application

authentication-method

applications.authentication_methods

comment

comment

is-locked

locked

is-ns-switch-group

NO REST EQUIVALENT

password-hash-algorithm

password_hash_algorithm

remote-switch-ipaddress

NO REST EQUIVALENT

role-name

role.name

second-authentication-method

applications.second_authentication_method

user-name

name

name is specified as a path parameter.

vserver

owner.uuid

owner.uuid is specified as a path parameter.

security-login-get-iter

You cannot retrieve SNMP users by using this endpoint. To retrieve a set of SNMP users, use the GET /api/support/snmp/users REST API collection.

GET /api/security/accounts

ONTAPI attribute

REST attribute

Comment

application

applications.application

authentication-method

applications.authentication_methods

comment

comment

is-locked

locked

is-ns-switch-group

NO REST EQUIVALENT

password-hash-algorithm

password_hash_algorithm

remote-switch-ipaddress

NO REST EQUIVALENT

role-name

role.name

second-authentication-method

applications.second_authentication_method

user-name

name

vserver

owner.name

Can also use "owner.uuid"

max-records

max_records

Specifies the maximum number of records to return before paging.

security-login-lock

Set the "locked" REST API attribute to "true".

PATCH /api/security/accounts/{owner.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

user-name

name

name is specified as a path parameter.

vserver

owner.uuid

owner.uuid is specified as a path parameter.

security-login-modify

You cannot modify SNMP users by using this endpoint. To modify SNMP users, use the PATCH /api/support/snmp/users/{engine_id}/{name} REST API call.

PATCH /api/security/accounts/{owner.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

application

applications.application

authentication-method

applications.authentication_methods

comment

comment

is-ns-switch-group

NO REST EQUIVALENT

remote-switch-ipaddress

NO REST EQUIVALENT

role-name

role.name

second-authentication-method

applications.second_authentication_method

user-name

name

name is specified as a path parameter.

vserver

owner.uuid

owner.uuid is specified as a path parameter.

security-login-modify-iter

Update SNMP users by using the /api/support/snmp/users REST API endpoint.

PATCH /api/security/accounts

ONTAPI attribute

REST attribute

Comment

application

applications.application

Can specify as a query parameter.

authentication-method

applications.authentication_methods

Can specify as a query parameter.

comment

comment

Must specify in the PATCH body.

is-locked

locked

Must specify in the PATCH body.

is-ns-switch-group

NO REST EQUIVALENT

password-hash-algorithm

NO REST EQUIVALENT

remote-switch-ipaddress

NO REST EQUIVALENT

role-name

role.name

Must specify in the PATCH body.

second-authentication-method

applications.second_authentication_method

user-name

name

Must specify as a query parameter.

vserver

owner.name

Can also use owner.uuid.

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

security-login-modify-password

In the REST API, specify owner.name, that is, the SVM name or owner.uuid (SVM UUID REST API attributes in the body of a POST request) to specify the SVM to which the user belongs. If you do not specify owner.uuid or owner.name, the SVM is selected based on the LIF or IP address to which the REST API is issued.

POST /api/security/authentication/password vicon.png

ONTAPI attribute

REST attribute

Comment

is-password-hashed

NO REST EQUIVALENT

new-password

password

password-hash-algorithm

password_hash_algorithm

user-name

name

security-login-role-config-get

This ONTAPI call does not have an equivalent REST API call.

security-login-role-config-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-login-role-config-modify

This ONTAPI call does not have an equivalent REST API call.

security-login-role-config-modify-iter

This ONTAPI call does not have an equivalent REST API call.

security-login-role-create

You can use the POST method of the /security/roles endpoint to create a new legacy role.

POST /api/security/roles

ONTAPI attribute

REST attribute

Comment

access-level

privileges.access

command-directory-name

privileges.path

return-record

NO REST EQUIVALENT

role-name

name

role-query

privileges.query

vserver

owner.name

security-login-role-delete

DELETE /api/security/roles/{owner.uuid}/{name}/privileges/{path}

ONTAPI attribute

REST attribute

Comment

command-directory-name

privileges.path

role-name

name

vserver

owner.name

security-login-role-delete-iter

This ONTAPI call does not have an equivalent REST API call.

security-login-role-get

GET /api/security/roles/{owner.uuid}/{name}/privileges/{path}

ONTAPI attribute

REST attribute

Comment

command-directory-name

privileges.path

access-level

privileges.access

role-name

name

role-query

privileges.query

vserver

owner.name

security-login-role-get-iter

GET /api/security/roles

ONTAPI attribute

REST attribute

Comment

access-level

privileges.access

command-directory-name

privileges.path

role-name

name

role-query

privileges.query

vserver

owner.name

max-records

NO REST EQUIVALENT

security-login-role-modify

PATCH /api/security/roles/{owner.uuid}/{name}/privileges/{path}

ONTAPI attribute

REST attribute

Comment

access-level

privileges.access

command-directory-name

privileges.path

role-name

name

role-query

privileges.query

vserver

owner.name

security-login-role-modify-iter

This ONTAPI call does not have an equivalent REST API call.

security-login-unlock

Set the locked REST API attribute to false.

PATCH /api/security/accounts/{owner.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

user-name

name

name is specified as a path parameter.

vserver

owner.uuid

owner.uuid is a path parameter.

security-login-whoami

This ONTAPI call does not have an equivalent REST API call.

security-protocol-get

GET /api/security

ONTAPI attribute

REST attribute

Comment

application

management_protocols

To retrieve RSH and Telnet protocols, use the /api/security?fields=management_protocols REST API call.

enabled

management_protocols

To retrieve RSH and Telnet protocol statuses, use the fields management_protocols.rsh_enabled and management_protocols.telnet_enabled.

security-protocol-modify

PATCH /api/security

ONTAPI attribute

REST attribute

Comment

application

management_protocols

enabled

management_protocols

To modify RSH and Telnet protocols, use the parameters rsh_enabled and telnet_enabled.

security-protocol-ssh-get

GET /api/security/ssh

ONTAPI attribute

REST attribute

Comment

connections-per-second

connections_per_second

max-instances

max_instances

per-source-limit

per_source_limit

security-protocol-ssh-modify

PATCH /api/security/ssh

ONTAPI attribute

REST attribute

Comment

connections-per-second

connections_per_second

max-instances

max_instances

per-source-limit

per_source_limit

security-reset

This ONTAPI call does not have an equivalent REST API call.

security-saml-sp-create-async

POST /api/security/authentication/cluster/saml-sp

ONTAPI attribute

REST attribute

Comment

cert-ca

certificate.ca

cert-common-name

certificate.common_name

cert-serial

certificate.serial_number

idp-uri

idp_uri

sp-host

host

verify-metadata-server

verify_metadata_server

security-saml-sp-destroy

DELETE /api/security/authentication/cluster/saml-sp

There are no attributes defined for this ONTAPI call.

security-saml-sp-get

GET /api/security/authentication/cluster/saml-sp

ONTAPI attribute

REST attribute

Comment

cert-ca

certificate.ca

cert-common-name

certificate.common_name

cert-serial

certificate.serial_number

idp-uri

idp_uri

is-enabled

enabled

sp-host

host

verify-metadata-server

verify_metadata_server

security-saml-sp-modify

PATCH /api/security/authentication/cluster/saml-sp

ONTAPI attribute

REST attribute

Comment

is-enabled

enabled

security-saml-sp-repair

This ONTAPI call does not have an equivalent REST API call.

security-saml-sp-status-get-iter

This ONTAPI call does not have an equivalent REST API call.

security-security-login-password-prepare-to-downgrade

This is an unsupported ZAPI. Hence it is not exposed through a REST API.

This ONTAPI call does not have an equivalent REST API call.

security-ssh-add

To use the functionality of security-ssh-add for "Administrative SVM", use the PATCH /api/security/ssh REST API call.

PATCH /api/security/ssh/svms/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ciphers

ciphers

key-exchange-algorithms

key_exchange_algorithms

mac-algorithms

mac_algorithms

vserver

svm.uuid

svm.uuid is specified as a path parameter.The vserver parameter defaults to Administrative SVM for /api/security/ssh REST API.

security-ssh-get-iter

To use the functionality of security-ssh-get-iter for "Administrative SVM", use GET on /api/security/ssh REST API call

GET /api/security/ssh/svms vicon.png

ONTAPI attribute

REST attribute

Comment

ciphers

ciphers

key-exchange-algorithms

key_exchange_algorithms

mac-algorithms

mac_algorithms

max-authentication-retry-count

max_authentication_retry_count

vserver-name

svm.name

Vserver parameter defaults to "Administrative SVM" in the REST API /api/security/ssh.

max-records

max_records

Specifies the maximum number of records to return before paging.

security-ssh-remove

To use the functionality of security-ssh-remove for "Administrative SVM", use the PATCH /api/security/ssh REST API call.

PATCH /api/security/ssh/svms/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ciphers

ciphers

key-exchange-algorithms

key_exchange_algorithms

mac-algorithms

mac_algorithms

vserver

svm.uuid

svm.uuid is specified as a path parameter.The vserver parameter defaults to Administrative SVM for /api/security/ssh REST API.

security-ssh-reset

To reset the SSH configuration for "Administrative SVM", use the PATCH /api/security/ssh REST API call.

PATCH /api/security/ssh/svms/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ciphers

ciphers

key-exchange-algorithms

key_exchange_algorithms

mac-algorithms

mac_algorithms

max-authentication-retry-count

max_authentication_retry_count

vserver

svm.uuid

svm.uuid is specified as a path parameter.The vserver parameter defaults to Administrative SVM for /api/security/ssh REST API.

ssh-prepare-to-downgrade

This ONTAPI call does not have an equivalent REST API call.

Category: SERVICE-PROCESSOR

service-processor-api-service-disable-installed-certificates

This ONTAPI call does not have an equivalent REST API call.

service-processor-api-service-enable-installed-certificates

This ONTAPI call does not have an equivalent REST API call.

service-processor-api-service-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

is-enabled

service_processor.api_service.enabled

limit-access

service_processor.api_service.limit_access

port

service_processor.api_service.port

service-processor-api-service-modify

This ONTAPI call does not have an equivalent REST API call.

service-processor-api-service-renew-internal-certificates

This ONTAPI call does not have an equivalent REST API call.

service-processor-asup-config-get

This ONTAPI call does not have an equivalent REST API call.

service-processor-asup-config-set

This ONTAPI call does not have an equivalent REST API call.

service-processor-asup-invoke

This ONTAPI call does not have an equivalent REST API call.

service-processor-auto-configuration-disable

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

address-family

auto_config.ipv4_subnet

Set this field to null or an empty string "" for the address family for which auto-config needs to be disabled

service-processor-auto-configuration-enable

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

address-family

NO REST EQUIVALENT

subnet-name

auto_config.ipv4_subnet

Give the subnet name for the respective address family for which auto-config needs to be enabled

service-processor-auto-configuration-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

subnet-name-v4

auto_config.ipv4_subnet

subnet-name-v6

auto_config.ipv6_subnet

service-processor-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

device-revision

NO REST EQUIVALENT

firmware-version

service_processor.firmware_version

ip-address

service_processor.ipv4_interface.address

If IPv6 networking is enabled, retrieve the IPv6 address at service_processor.ipv6_interface.address.

is-autoupdate-enabled

service_processor.autoupdate_enabled

is-ip-configured

service_processor.is_ip_configured

mac-address

service_processor.mac_address

node

name

part-num

NO REST EQUIVALENT

serial-num

NO REST EQUIVALENT

status

service_processor.state

type

service_processor.type

node

name

service-processor-get-iter

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

device-revision

NO REST EQUIVALENT

firmware-version

service_processor.firmware_version

ip-address

service_processor.ipv4_interface.address

If IPv6 networking is enabled, retrieve the IPv6 address at service_processor.ipv6_interface.address.

is-autoupdate-enabled

service_processor.autoupdate_enabled

is-ip-configured

service_processor.is_ip_configured

mac-address

service_processor.mac_address

node

name

part-num

NO REST EQUIVALENT

serial-num

NO REST EQUIVALENT

status

service_processor.state

type

service_processor.type

max-records

max_records

Specifies the maximum number of records to return before paging.

service-processor-image-get

In the REST API, service processor image information is reported directly under "service_processor.primary" or "service_processor.backup" rather than firmware-image.

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

firmware-image

NO REST EQUIVALENT

In the REST API, service processor image information is reported directly under "service_processor.primary" or "service_processor.backup" rather than firmware-image.

is-autoupdate-enabled

service_processor.autoupdate_enabled

is-current

service_processor.primary.is_current

In the REST API, service processor backup "is_current" is retrieved using "service_processor.backup.is_current".

last-update-status

service_processor.last_update_state

node

NO REST EQUIVALENT

status

service_processor.primary.state

In the REST API, service processor backup "status" is retrieved using "service_processor.backup.state".

type

service_processor.type

version

service_processor.primary.version

In the REST API, service processor backup version is retrieved using "service_processor.backup.version".

firmware-image

NO REST EQUIVALENT

In the REST API, service processor image information is reported directly under "service_processor.primary" or "service_processor.backup" rather than firmware-image.

node

NO REST EQUIVALENT

service-processor-image-modify

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

is-autoupdate-enabled

service_processor.autoupdate_enabled

node

NO REST EQUIVALENT

service-processor-image-update

This ONTAPI call does not have an equivalent REST API call.

service-processor-image-update-progress-get

This ONTAPI call does not have an equivalent REST API call.

service-processor-log-allocation-get

This ONTAPI call does not have an equivalent REST API call.

service-processor-log-allocation-get-iter

This ONTAPI call does not have an equivalent REST API call.

service-processor-network-get

In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type.

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

address-type

NO REST EQUIVALENT

In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type.

device-type

service_processor.type

dhcp

service_processor.dhcp_enabled

gateway-ip-address

service_processor.ipv4_interface.gateway

If IPv6 networking is enabled, retrieve the IPv6 gateway address at "service_processor.ipv6_interface.gateway".

ip-address

service_processor.ipv4_interface.address

If IPv6 networking is enabled, retrieve the IPv6 address at "service_processor.ipv6_interface.address".

is-enabled

NO REST EQUIVALENT

In the REST API, if service_processor.ipvX_interface fields are present, is-enabled is "true".

is-ipv6-ra-enabled

service_processor.ipv6_interface.is_ipv6_ra_enabled

link-local-ip-address

service_processor.ipv6_interface.link_local_ip

link-status

NO REST EQUIVALENT

mac-address

service_processor.mac_address

netmask

service_processor.ipv4_interface.netmask

node

name

prefix-length

service_processor.ipv6_interface.netmask

router-ip-address

service_processor.ipv6_interface.router_ip

setup-failure-reason

NO REST EQUIVALENT

setup-status

service_processor.ipv4_interface.setup_state

If IPv6 networking is enabled, retrieve the IPv6 setup status at "service_processor.ipv6_interface.setup_state".

status

service_processor.state

subnet-name

NO REST EQUIVALENT

node

name

service-processor-network-get-iter

In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type.

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

address-type

NO REST EQUIVALENT

In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type.

device-type

service_processor.type

dhcp

service_processor.dhcp_enabled

gateway-ip-address

service_processor.ipv4_interface.gateway

If IPv6 networking is enabled, retrieve the IPv6 gateway address at "service_processor.ipv6_interface.gateway".

ip-address

service_processor.ipv4_interface.address

If IPv6 networking is enabled, retrieve the IPv6 address at "service_processor.ipv6_interface.address".

is-enabled

service_processor.ipv4_interface.enabled

If IPv6 networking is enabled, retrieve the IPv6 enabled at "service_processor.ipv6_interface.enabled".

is-ipv6-ra-enabled

service_processor.ipv6_interface.is_ipv6_ra_enabled

link-local-ip-address

service_processor.ipv6_interface.link_local_ip

link-status

NO REST EQUIVALENT

mac-address

service_processor.mac_address

netmask

service_processor.ipv4_interface.netmask

node

name

prefix-length

service_processor.ipv6_interface.netmask

router-ip-address

service_processor.ipv6_interface.router_ip

setup-failure-reason

NO REST EQUIVALENT

setup-status

service_processor.ipv4_interface.setup_state

If IPv6 networking is enabled, retrieve the IPv6 setup status at "service_processor.ipv6_interface.setup_state".

status

service_processor.state

subnet-name

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

service-processor-network-modify

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

address-type

NO REST EQUIVALENT

dhcp

service_processor.dhcp_enabled

gateway-ip-address

service_processor.ipv4_interface.gateway

Use the service_processor.ipv6_interface.gateway field to modify the IPv6 gateway address.

ip-address

service_processor.ipv4_interface.address

Use the service_processor.ipv6_interface.address field to modify the IPv6 address.

is-enabled

service_processor.ipv4_interface.enabled

Use the service_processor.ipv4_interface.enabled field to enable or disable IPv4 addresses and use the service_processor.ipv6_interface.enabled field to enable or disable IPv6 addresses.

netmask

service_processor.ipv4_interface.netmask

node

name

It is a query-only field.

prefix-length

service_processor.ipv6_interface.netmask

service-processor-network-modify-iter

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

address-type

NO REST EQUIVALENT

In the REST API, service processor networking information is reported directly under service_processor.ipv4_interface or service_processor.ipv6_interface instead of under address type.

device-type

NO REST EQUIVALENT

dhcp

service_processor.dhcp_enabled

gateway-ip-address

service_processor.ipv4_interface.gateway

Use the service_processor.ipv6_interface.gateway field to set the IPv6 gateway address.

ip-address

service_processor.ipv4_interface.address

Use the service_processor.ipv6_interface.address field to set the IPv6 address.

is-enabled

service_processor.ipv4_interface.enabled

Use the service_processor.ipv4_interface.enabled field to enable or disable IPv4 addresses and use the service_processor.ipv6_interface.enabled field to enable or disable IPv6 addresses.

is-ipv6-ra-enabled

NO REST EQUIVALENT

link-local-ip-address

NO REST EQUIVALENT

link-status

NO REST EQUIVALENT

mac-address

NO REST EQUIVALENT

netmask

service_processor.ipv4_interface.netmask

node

name

It is a query-only field.

prefix-length

service_processor.ipv6_interface.netmask

router-ip-address

NO REST EQUIVALENT

setup-failure-reason

NO REST EQUIVALENT

setup-status

NO REST EQUIVALENT

status

NO REST EQUIVALENT

subnet-name

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

service-processor-reboot

The URL should include "?service_processor.action=reboot" to reboot the service processor. The URL can include "?service_processor.firmware_image=" as either "primary" or "backup" to specify the image to boot from after a reboot and "?name=" to specify the node name.

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

firmware-image

NO REST EQUIVALENT

node

NO REST EQUIVALENT

service-processor-ssh-add-allowed-addresses

This ONTAPI call does not have an equivalent REST API call.

service-processor-ssh-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

service-processor-ssh-info

service_processor.ssh_info

Service processor SSH allowed IP addresses configuration applied across the cluster allowed-addresses → service_processor.ssh_info.allowed_addresses

service-processor-ssh-remove-allowed-addresses

This ONTAPI call does not have an equivalent REST API call.

Category: SES

storage-shelf-bay-list-info

The REST API GET method contains some of this information, but not all, and not in the desired format.

GET /api/storage/shelves

ONTAPI attribute

REST attribute

Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

storage-shelf-environment-list-info

The REST API GET method contains some of this information, but not all, and not in the desired format.

GET /api/storage/shelves

ONTAPI attribute

REST attribute

Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

shelves-present

NO REST EQUIVALENT

is-channel-monitor-enabled

NO REST EQUIVALENT

is-shelf-channel-failure

NO REST EQUIVALENT

controller-device-path

NO REST EQUIVALENT

controller-device-path-port

NO REST EQUIVALENT

shelf-type

module_type

is-shelf-monitor-enabled

NO REST EQUIVALENT

shelf-status

state

shelf-status is simplified to "ok" and "error" in REST.

status-reads-attempted

NO REST EQUIVALENT

status-reads-failed

NO REST EQUIVALENT

control-writes-attempted

NO REST EQUIVALENT

control-writes-failed

NO REST EQUIVALENT

ses-generic-info

See comment column for details

ses-logical-id → NA
ses-vendor-id → manufacturer.name
ses-contact-state → NA
ses-product-id → model
ses-product-revision → NA
ses-chassis-part-number → NA
ses-midplane-serial-number → NA
ses-midplane-part-number → NA

attached-shelf-bay-list

bays.id

select bays with bays.has_disk set to true.

attached-shelf-bay-error-list

bays.id

select bays with bays.has_disk set to true and bays.state set to "error".

serial-no

serial_number

power-supply-list

See comment column for details

power-supply-element-no → frus.id
power-supply-is-not-installed → frus.installed
power-supply-is-error → frus.state
comment: power-supply-is-error is simplified to "ok" and "error" in REST
power-supply-serial-no → frus.serial_number
power-supply-part-no → frus.part_number
is-auto-power-reset-enabled → NA
power-supply-type → frus.psu.model
power-supply-firmware-revision → frus.firmware_version
power-supply-swap-count → NA

voltage-sensor-list

See comment column for details

voltage-sensor-no → voltage_sensors.id
is-sensor-not-installed → NA
is-sensor-error → voltage_sensors.state
comment: is-sensor-error is simplified to "ok" and "error" in REST
sensor-reading → voltage_sensors.voltage
sensor-condition → NA

current-sensor-list

See comment column for details

current-sensor-no → current_sensors.id
is-sensor-not-installed → NA
is-sensor-error → current_sensors.state
comment: is-sensor-error is simplified to "ok" and "error" in REST
sensor-condition → NA
sensor-reading → current_sensors.current

cooling-element-list

See comment column for details

cooling-element-number → fans.id
cooling-element-is-not-installed → NA
cooling-element-is-error → fans.state
comment: cooling-element-is-error is simplified to "ok" and "error" in REST
rpm → fans.rpm

temp-sensor-list

See comment column for details

temp-sensor-element-no → temperature_sensors.id
temp-sensor-is-not-installed → NA
temp-sensor-is-error → temperature_sensors.state
comment: temp-sensor-is-error is simplified to "ok" and "error" in REST
temp-sensor-current-temperature → temperature_sensors.temperature
temp-sensor-is-ambient → temperature_sensors.ambient
temp-sensor-current-condition → NA
temp-sensor-low-warning → temperature_sensors.threshold.low.warning
temp-sensor-low-critical → temperature_sensors.threshold.low.critical
temp-sensor-hi-warning → temperature_sensors.threshold.high.warning
temp-sensor-hi-critical → temperature_sensors.threshold.high.critical

es-electronics-list

See comment column for details

es-electronics-element-no → frus.id
comment: frus.id is zero-based for modules
es-electronics-is-not-installed → frus.installed
es-electronics-is-error → frus.state
comment: es-electronics-is-error is simplified to "ok" and "error" in REST
es-electronics-is-reporting-element → NA
es-electronics-serial-no → frus.serial_number
es-part-number → frus.part_number
es-revision → NA
es-swap-count → NA

sas-connector-list

See comment column for details

connector-no → ports.id
comment: ports.id is zero-based
is-cable-connected → ports.state
comment: is-cable-connected is converted to "connected" and "disconnected" in REST
is-connector-error → NA
shelf-module → ports.module_id
connector-designator → ports.designator
swap-count → NA
cable-manufacturer → NA
cable-type → NA
cable-technology → ports.designator
cable-length → ports.cable.length
cable-end-identifier → NA
cable-serial-no → ports.cable.identifier
attached-serial-number → ports.cable.serial_number
cable-part-no → ports.cable.part_number
cable-remote-con-wwn → ports.remote.wwn
cable-local-conn-wwn → ports.wwn

alternate-control-path-information

See comment column for details

acp-element-no → NA
is-acp-element-not-installed → NA
is-acp-element-error → NA
is-controller-acp-enabled → acps.enabled
is-controller-acp-active → NA
controller-acp-connection-status → NA
controller-acp-ethernet-port → NA
controller-acp-ip-address → NA
controller-acp-domain → NA
controller-acp-netmask → NA
module-mac-address → NA
module-name → NA
module-ip-address → NA
module-reset-count → NA
module-firmware-revision → NA
module-status → NA
module-status-time → NA

processor-complex-information

NO REST EQUIVALENT

enclosure-type

NO REST EQUIVALENT

module-list

See comment column for details

module-number → frus.id
is-module-error → frus.state
comment: is-module-error is simplified to "ok" and "error" in REST
is-sas-expander-master-module → NA
module-connector-wwn → NA

shelf-environ-channel-address

See comment column for details

shelf-environ-channel-address-map.address-map → bays.id
drawer-address-map.drawer-number → bays.drawer.id
drawer-address-map.address-map → bays.drawer.slot

dcm-list

See comment column for details

dcm-number → NA
is-dcm-installed → NA
is-dcm-error → drawers.state
comment: is-dcm-error is simplified to "ok" and "error" in REST
dcm-serial-number → drawers.serial_number
dcm-part-number → drawers.part_number
dcm-firmware-version → NA
dcm-type → NA
dcm-vendor → NA

attached-shelf-drawer-bay-list

See comment column for details

shelf-drawer-bay.drawer-number → bays.drawer.id
shelf-drawer-bay.attached-drawer-bay-list → bays.drawer.slot

attached-shelf-drawer-bay-error-list

NO REST EQUIVALENT

storage-shelf-get-shelf-info

The REST API GET method contains some of this information, but not all, and not in the desired format.

GET /api/storage/shelves

ONTAPI attribute

REST attribute

Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

storage-shelf-list-info

The GET method contains some of this information, but not all, and not in the desired format.

GET /api/storage/shelves

ONTAPI attribute

REST attribute

Comment

channel-name

paths.name

node-name

paths.node.name

shelf-id

id

storage-shelf-enclosure-list-info

The GET method contains some of this information, but not all, and not in the desired format.

GET /api/storage/shelves

There are no attributes defined for this ONTAPI call.

Category: SIS

sis-check

This ONTAPI call does not have an equivalent REST API call.

sis-disable

Setting all efficiencies to "none" disables the sis operation.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

NO REST EQUIVALENT

API uses volume.uuid from URL

sis-disable-async

Setting all efficiencies to "none" for the FlexGroup parent volume disables the sis operation.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume-name

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

sis-enable

Setting any efficiency enables the sis operation.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

path

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

sis-enable-async

Setting any efficiency for the FlexGroup parent volume enables the sis operation.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume-name

NO REST EQUIVALENT

API uses volume.uuid from URL

sis-get

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.

GET /api/storage/volumes/{uuid} vicon.png

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 vicon.png

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 vicon.png

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} vicon.png

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} vicon.png

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 vicon.png

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} vicon.png

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

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.

PATCH /api/storage/volumes/{uuid} vicon.png

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} vicon.png

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

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

build-metadata

NO REST EQUIVALENT

delete-checkpoint

NO REST EQUIVALENT

path

efficiency.volume_path

qos-policy

NO REST EQUIVALENT

queue-operation

NO REST EQUIVALENT

restart-checkpoint

NO REST EQUIVALENT

run-compaction-scan

NO REST EQUIVALENT

run-compression-scan

efficiency.scanner.compression

run-dedupe-scan

efficiency.scanner.dedupe

scan

efficiency.scanner.scan_old_data

scan-all

NO REST EQUIVALENT

sis-start-async

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

build-metadata

NO REST EQUIVALENT

delete-checkpoint

NO REST EQUIVALENT

qos-policy

NO REST EQUIVALENT

queue-operation

NO REST EQUIVALENT

restart-checkpoint

NO REST EQUIVALENT

run-compaction-scan

NO REST EQUIVALENT

run-compression-scan

efficiency.scanner.compression

run-dedupe-scan

efficiency.scanner.dedupe

scan

efficiency.scanner.scan_old_data

scan-all

NO REST EQUIVALENT

volume-name

name

sis-status

This ONTAPI call does not have an equivalent REST API call.

sis-stop

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

all-operations

NO REST EQUIVALENT

path

efficiency.volume_path

sis-stop-async

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

all-operations

NO REST EQUIVALENT

volume-name

name

sis-undo

This ONTAPI call does not have an equivalent REST API call.

sis-idcs-start

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

inactive_days

efficiency.idcs_scanner.inactive_days

sis-idcs-stop

PATCH /api/storage/volumes/{uuid} vicon.png

There are no attributes defined for this ONTAPI call.

sis-idcs-show

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

status

efficiency.idcs_scanner.status

progress

efficiency.idcs_scanner.operation_state

is-enabled

efficiency.idcs_scanner.enabled

threshold_days

efficiency.idcs_scanner.threshold_inactive_time

scan_mode

efficiency.idcs_scanner.mode

Category: SNAPDIFF

snapdiff-iter-end

This ONTAPI call does not have an equivalent REST API call.

snapdiff-iter-next

This ONTAPI call does not have an equivalent REST API call.

snapdiff-iter-start

POST /api/storage/volumes/{volume.uuid}/snapdiff/sessions vicon.png

ONTAPI attribute

REST attribute

Comment

application-name

application.name

application-type

application.type

atime

access_time

base-snapshot

base_snapshot.name

base-snapshot-id

base_snapshot.uuid

checkpointing

checkpoint_enabled

constituent-role

NO REST EQUIVALENT

diff-snapshot

diff_snapshot.name

diff-snapshot-id

diff_snapshot.uuid

file-access-protocol

file_access_protocol

Default value of file_access_protocol is "nfs".

include-file-attributes

report_file_attributes

Default value of report_file_attributes is "true".

max-diffs

max_diffs

Default value of max_diffs is "256".

mhost-session-id

NO REST EQUIVALENT

namespace-base-snapshot-id

NO REST EQUIVALENT

namespace-constituent-dsid

NO REST EQUIVALENT

namespace-constituent-orig-msid

NO REST EQUIVALENT

namespace-diff-snapshot-id

NO REST EQUIVALENT

restart-cookie

restart_cookie

version

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

This is a required field in ONTAPI, but for Rest you specify the volume uuid instead and its a part of the url.

volume-dsid

NO REST EQUIVALENT

snapdiff-iter-status

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-create

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-destroy

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-disable

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-enable

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-get

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-get-create-defaults

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-get-iter

This ONTAPI call does not have an equivalent REST API call.

snapdiff-rpc-server-modify

This ONTAPI call does not have an equivalent REST API call.

Category: SNAPLOCK

snaplock-archive-vserver-log

You must pass the field "log_archive.archive" as "true" in the body.

PATCH /api/storage/snaplock/audit-logs/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

base-name

log_archive.base_name

snaplock-create-vserver-log

POST /api/storage/snaplock/audit-logs vicon.png

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} vicon.png

There are no attributes defined for this ONTAPI call.

snaplock-event-retention-abort

DELETE /api/storage/snaplock/event-retention/operations/{id} vicon.png

ONTAPI attribute

REST attribute

Comment

operation-id

id

snaplock-event-retention-apply-start

POST /api/storage/snaplock/event-retention/operations vicon.png

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 vicon.png

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 vicon.png

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} vicon.png

ONTAPI attribute

REST attribute

Comment

name

policy.name

snaplock-event-retention-policy-get-iter

GET /api/storage/snaplock/event-retention/policies vicon.png

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} vicon.png

ONTAPI attribute

REST attribute

Comment

name

name

retention-period

retention_period

snaplock-file-privileged-delete

DELETE /api/storage/snaplock/file/{volume.uuid}/{path} vicon.png

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} vicon.png

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}

ONTAPI attribute

REST attribute

Comment

node

node.uuid

snaplock-get-vserver-active-log-files-iter

GET /api/storage/snaplock/audit-logs vicon.png

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 vicon.png

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} vicon.png

ONTAPI attribute

REST attribute

Comment

operation-id

id

Can also use POST on /api/storage/snaplock/litigations/{litigation.id}/operations

POST /api/storage/snaplock/litigations vicon.png

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 vicon.png

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 vicon.png

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

You can use DELETE on the API /api/storage/snaplock/litigations/{id} to end all the litigations for a litigation ID.

POST /api/storage/snaplock/litigations/{litigation.id}/operations vicon.png

ONTAPI attribute

REST attribute

Comment

litigation-name

NO REST EQUIVALENT

path

path

volume

NO REST EQUIVALENT

GET /api/storage/snaplock/litigations vicon.png

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

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} vicon.png

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} vicon.png

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

ONTAPI attribute

REST attribute

Comment

node

node.uuid

node.name can also be used.

snaplock-volume-set-privileged-delete

Pass the "snaplock.privileged_delete" field as "enabled" in the REST API body.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

state

NO REST EQUIVALENT

volume

uuid

volume-get-snaplock-attrs

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

name

volume-set-snaplock-attrs

PATCH /api/storage/volumes/{uuid} vicon.png

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

Category: SNAPMIRROR-OBJECT-STORE

snapmirror-object-store-config-create

POST /api/cloud/targets vicon.png

ONTAPI attribute

REST attribute

Comment

access-key

access_key

aws-region

NO REST EQUIVALENT

azure-account

azure_account

azure-private-key

azure_private_key

container-name

container

ignore-warning-codes

NO REST EQUIVALENT

ipspace

ipspace.name

You can also use ispace.uuid with the REST API.

is-certificate-validation-enabled

certificate_validation_enabled

is-ssl-enabled

ssl_enabled

object-store-name

name

port

port

provider-type

provider_type

secret-password

secret_password

server

server

url-style

url_style

usage

NO REST EQUIVALENT

use-iam-role

NO REST EQUIVALENT

vserver-name

svm.name

You can also use svm.uuid with the REST API.

snapmirror-object-store-config-delete

DELETE /api/cloud/targets/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

object-store-name

NO REST EQUIVALENT

snapmirror-object-store-config-get

GET /api/cloud/targets/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

access-key

access_key

azure-account

azure_account

azure-private-key

NO REST EQUIVALENT

config-id

NO REST EQUIVALENT

confirm-warning-codes

NO REST EQUIVALENT

confirm-warning-texts

NO REST EQUIVALENT

container-name

container

ignore-warning-codes

NO REST EQUIVALENT

ipspace

ipspace.name

is-certificate-validation-enabled

certificate_validation_enabled

is-ssl-enabled

ssl_enabled

object-store-name

name

port

port

provider-type

provider_type

secret-password

NO REST EQUIVALENT

server

server

url-style

url_style

usage

NO REST EQUIVALENT

use-http-proxy

use_http_proxy

use-iam-role

NO REST EQUIVALENT

vserver-name

svm.name

vsuuid

svm.uuid

object-store-name

name

snapmirror-object-store-config-get-iter

GET /api/cloud/targets vicon.png

ONTAPI attribute

REST attribute

Comment

access-key

access_key

azure-account

azure_account

azure-private-key

azure_private_key

config-id

NO REST EQUIVALENT

confirm-warning-codes

NO REST EQUIVALENT

confirm-warning-texts

NO REST EQUIVALENT

container-name

container

ignore-warning-codes

NO REST EQUIVALENT

ipspace

ipspace.name

is-certificate-validation-enabled

NO REST EQUIVALENT

is-ssl-enabled

ssl_enabled

object-store-name

name

port

port

provider-type

provider_type

secret-password

NO REST EQUIVALENT

server

server

url-style

url_style

usage

NO REST EQUIVALENT

use-http-proxy

use_http_proxy

use-iam-role

NO REST EQUIVALENT

vserver-name

svm.name

vsuuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-object-store-config-modify

PATCH /api/cloud/targets/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

access-key

access_key

aws-region

NO REST EQUIVALENT

azure-account

azure_account

azure-private-key

azure_private_key

ignore-warning-codes

NO REST EQUIVALENT

ipspace

ipspace.name

You can also use ipspace.uuid with the REST API.

is-certificate-validation-enabled

certificate_validation_enabled

is-ssl-enabled

ssl_enabled

new-object-store-name

name

object-store-name

NO REST EQUIVALENT

port

port

secret-password

secret_password

server

server

url-style

NO REST EQUIVALENT

usage

NO REST EQUIVALENT

use-iam-role

NO REST EQUIVALENT

vserver-name

NO REST EQUIVALENT

snapmirror-object-store-endpoint-delete

The REST API does not support this ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-object-store-snapshot-delete

The REST API does not support this ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-object-store-snapshot-get

The REST API does not support this ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-object-store-snapshot-get-iter

The REST API does not support this ONTAPI.

This ONTAPI call does not have an equivalent REST API call.

Category: SNAPMIRROR-POLICY

snapmirror-policy-add-rule

A SnapMirror policy rule is referred to as SnapMirror policy retention object. To add a new retention object, use this REST API after appending the new retention object to the existing list of "retention" objects.

PATCH /api/snapmirror/policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

keep

retention.count

policy-name

name

prefix

retention.prefix

preserve

NO REST EQUIVALENT

schedule

retention.creation_schedule.name

snapmirror-label

retention.label

warn

NO REST EQUIVALENT

snapmirror-policy-create

POST /api/snapmirror/policies vicon.png

ONTAPI attribute

REST attribute

Comment

archive-after-days

NO REST EQUIVALENT

are-data-ops-sequentially-split

NO REST EQUIVALENT

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.name

discard-configs

NO REST EQUIVALENT

ignore-atime

NO REST EQUIVALENT

is-network-compression-enabled

network_compression_enabled

keep

retention.count

owner

scope

policy-name

name

prefix

retention.prefix

preserve

NO REST EQUIVALENT

restart

NO REST EQUIVALENT

return-record

NO REST EQUIVALENT

schedule

retention.creation_schedule.name

snapmirror-label

retention.label

transfer-priority

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

type

type

warn

NO REST EQUIVALENT

window-size-for-tdp-mirror

NO REST EQUIVALENT

snapmirror-policy-delete

The SnapMirror policy UUID uniquely identifies the policy that should be deleted.

DELETE /api/snapmirror/policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

NO REST EQUIVALENT

snapmirror-policy-get

GET /api/snapmirror/policies vicon.png

ONTAPI attribute

REST attribute

Comment

archive-after-days

NO REST EQUIVALENT

are-data-ops-sequentially-split

NO REST EQUIVALENT

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.name

create-snapshot

NO REST EQUIVALENT

discard-configs

NO REST EQUIVALENT

ignore-atime

NO REST EQUIVALENT

is-network-compression-enabled

network_compression_enabled

owner

scope

policy-name

name

restart

NO REST EQUIVALENT

snapmirror-policy-rules

retention

total-keep

NO REST EQUIVALENT

total-rules

NO REST EQUIVALENT

transfer-priority

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

type

type

vserver-name

svm.name

window-size-for-tdp-mirror

NO REST EQUIVALENT

policy-name

name

snapmirror-policy-get-iter

GET /api/snapmirror/policies vicon.png

ONTAPI attribute

REST attribute

Comment

archive-after-days

NO REST EQUIVALENT

are-data-ops-sequentially-split

NO REST EQUIVALENT

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.name

create-snapshot

NO REST EQUIVALENT

discard-configs

NO REST EQUIVALENT

ignore-atime

NO REST EQUIVALENT

is-network-compression-enabled

network_compression_enabled

owner

scope

policy-name

name

restart

NO REST EQUIVALENT

snapmirror-policy-rules

retention

total-keep

NO REST EQUIVALENT

total-rules

NO REST EQUIVALENT

transfer-priority

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

type

type

vserver-name

svm.name

window-size-for-tdp-mirror

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-policy-modify

PATCH /api/snapmirror/policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

archive-after-days

NO REST EQUIVALENT

are-data-ops-sequentially-split

NO REST EQUIVALENT

comment

comment

common-snapshot-schedule

sync_common_snapshot_schedule.name

discard-configs

NO REST EQUIVALENT

ignore-atime

NO REST EQUIVALENT

is-network-compression-enabled

network_compression_enabled

keep

retention.count

owner

NO REST EQUIVALENT

policy-name

name

prefix

retention.prefix

preserve

NO REST EQUIVALENT

restart

NO REST EQUIVALENT

schedule

retention.creation_schedule.name

snapmirror-label

retention.label

transfer-priority

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

warn

NO REST EQUIVALENT

window-size-for-tdp-mirror

NO REST EQUIVALENT

snapmirror-policy-modify-rule

A SnapMirror policy rule is referred to as a SnapMirror policy retention object. To modify a retention object, use this REST API by appending the modified retention object to the existing list of "retention" objects.

PATCH /api/snapmirror/policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

keep

retention.count

policy-name

name

prefix

retention.prefix

preserve

NO REST EQUIVALENT

schedule

retention.creation_schedule.name

snapmirror-label

retention.label

warn

NO REST EQUIVALENT

snapmirror-policy-remove-rule

A SnapMirror policy rule is referred to as SnapMirror policy retention object. To delete a retention object, use this REST API by specifying the final list of "retention" objects excluding the retention object that must be deleted.

PATCH /api/snapmirror/policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

NO REST EQUIVALENT

snapmirror-label

NO REST EQUIVALENT

Category: SNAPMIRROR

snapmirror-abort

To abort an ongoing SnapMirror transfer, refer to snapmirror-abort-async.

PATCH /api/snapmirror/relationships/{relationship.uuid}/transfers/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

check-only

NO REST EQUIVALENT

clear-checkpoint

NO REST EQUIVALENT

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-abort-async

To abort an ongoing SnapMirror transfer, set the tranfer state to "aborted".

PATCH /api/snapmirror/relationships/{relationship.uuid}/transfers/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

check-only

NO REST EQUIVALENT

clear-checkpoint

state

To clear the checkpoint in the REST API, set the state to "hard_aborted".

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-abort-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-add-exclude

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-off

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-on

This ONTAPI call does not have an equivalent REST API call.

snapmirror-auto-protect-remove-exclude

This ONTAPI call does not have an equivalent REST API call.

snapmirror-break

To break a SnapMirror relationship, refer to snapmirror-break-async.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-break-async

To break a SnapMirror relationship, set the relationship state to "broken_off".

PATCH /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

recover

recover_after_break

restore-destination-to-snapshot

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-break-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cache-rebuild-relationship

This ONTAPI call does not have an equivalent REST API call.

snapmirror-capabilities-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-capabilities-get-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-check

This ONTAPI call does not have an equivalent REST API call.

snapmirror-check-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-config-replication-cluster-storage-configuration-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-config-replication-cluster-storage-configuration-modify

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-aggregate-eligibility-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-aggregate-eligibility-get-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-comm-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-comm-get-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-cr-status-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-create

POST /api/snapmirror/relationships vicon.png

ONTAPI attribute

REST attribute

Comment

cg-item-mappings

See comment column for details

Supply all of the following REST API properties:
destination.consistency_group_volumes.name
destination.consistency_group_volumes.uuid
source.consistency_group_volumes.name
source.consistency_group_volumes.uuid

destination-cluster

See comment column for details

Supply all of the following REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-endpoint-uuid

NO REST EQUIVALENT

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following REST API properties:
destination.svm.name
destination.svm.uuid

identity-preserve

NO REST EQUIVALENT

Identity preservation for an SVM DR relationship is part of the SnapMirror policy associated with the SnapMirror relationship.

is-auto-expand-enabled

NO REST EQUIVALENT

FlexGroup volume’s automatic expand is set to "true" by default. This behavior cannot be altered through the REST API.

is-catalog-enabled

NO REST EQUIVALENT

max-transfer-rate

throttle

policy

See comment column for details

Supply all the following REST API properties:
policy.name
policy.uuid

relationship-type

NO REST EQUIVALENT

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

return-record

NO REST EQUIVALENT

schedule

transfer_schedule

Supply either or both of the following REST API properties:
transfer_schedule.name
transfer_schedule.uuid

source-cluster

See comment column for details

Supply all the following REST API properties:
source.cluster.name
source.cluster.uuid

source-endpoint-uuid

NO REST EQUIVALENT

source-location

source.path

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

snapmirror-destroy

To destroy a SnapMirror relationship, refer to snapmirror-destroy-async.

DELETE /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-destroy-async

When you do not specify a query, the SnapMirror relationship is deleted from the destination cluster and the relationship is also released from the source cluster. When you specify the query "destination_only=true", the SnapMirror relationship is deleted from the cluster that contains the destination endpoint and the relationship is not released from the source cluster.

DELETE /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-destroy-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-get

GET /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

break-failed-count

NO REST EQUIVALENT

break-successful-count

NO REST EQUIVALENT

catalog-status

NO REST EQUIVALENT

catalog-total-progress

NO REST EQUIVALENT

catalog-transfer-snapshot

NO REST EQUIVALENT

relationship_group_type

group_type

last_transfer_type

last_transfer_type

cg-item-mappings

source.consistency_group_volumes.name

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
source.consistency_group_volumes.name

current-max-transfer-rate

NO REST EQUIVALENT

current-operation-id

NO REST EQUIVALENT

current-transfer-error

NO REST EQUIVALENT

current-transfer-priority

NO REST EQUIVALENT

current-transfer-type

NO REST EQUIVALENT

destination-cluster

See comment column for details

Supply all the following the REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-endpoint-uuid

NO REST EQUIVALENT

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-volume-node

NO REST EQUIVALENT

destination-vserver

destination.svm.name

destination-vserver-uuid

destination.svm.uuid

exported-snapshot

exported_snapshot

exported-snapshot-timestamp

NO REST EQUIVALENT

file-restore-file-count

NO REST EQUIVALENT

file-restore-file-list

NO REST EQUIVALENT

identity-preserve

NO REST EQUIVALENT

is-auto-expand-enabled

NO REST EQUIVALENT

is-catalog-enabled

NO REST EQUIVALENT

is-constituent

NO REST EQUIVALENT

is-healthy

healthy

lag-time

lag_time

last-transfer-duration

transfer.total_duration

last-transfer-end-timestamp

transfer.end_time

last-transfer-error

unhealthy_reason.message

last-transfer-error-codes

unhealthy_reason.code

last-transfer-from

NO REST EQUIVALENT

last-transfer-network-compression-ratio

NO REST EQUIVALENT

last-transfer-size

transfer.bytes_transferred

last-transfer-type

NO REST EQUIVALENT

max-transfer-rate

throttle

mirror-state

state

network-compression-ratio

NO REST EQUIVALENT

newest-snapshot

NO REST EQUIVALENT

newest-snapshot-timestamp

NO REST EQUIVALENT

opmask

NO REST EQUIVALENT

policy

See comment column for details

Supply all the following the REST API properties:
policy.name
policy.uuid

policy-type

policy.type

progress-last-updated

NO REST EQUIVALENT

relationship-control-plane

NO REST EQUIVALENT

relationship-group-type

NO REST EQUIVALENT

relationship-id

uuid

relationship-progress

transfer.bytes_transferred

relationship-status

state

relationship-type

NO REST EQUIVALENT

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

resync-failed-count

NO REST EQUIVALENT

resync-successful-count

NO REST EQUIVALENT

schedule

transfer_schedule

Shows both of the following REST API properties:
transfer_schedule.name
transfer_schedule.uuid

snapshot-checkpoint

NO REST EQUIVALENT

snapshot-progress

NO REST EQUIVALENT

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-endpoint-uuid

NO REST EQUIVALENT

source-location

source.path

source-volume

NO REST EQUIVALENT

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

source-vserver-uuid

source.svm.uuid

total-transfer-bytes

transfer.bytes_transferred

total-transfer-time-secs

NO REST EQUIVALENT

transfer-snapshot

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

unhealthy-reason

See comment column for details

Supply all the following the REST API properties:
unhealthy_reason.message
unhealthy_reason.code

update-failed-count

NO REST EQUIVALENT

update-successful-count

NO REST EQUIVALENT

vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

destination-cluster

See comment column for details

Supply all the following the REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-location

source.path

source-volume

NO REST EQUIVALENT

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

snapmirror-get-destination

Use the query "list_destinations_only=true" to list the source side SnapMirror relationships.

GET /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

relationship_group_type

group_type

last_transfer_type

last_transfer_type

cg-item-mappings

source.consistency_group_volumes.name

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
source.consistency_group_volumes.name

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

is-constituent

NO REST EQUIVALENT

policy-type

policy.type

progress-last-updated

NO REST EQUIVALENT

relationship-group-type

NO REST EQUIVALENT

relationship-id

uuid

relationship-status

state

relationship-type

NO REST EQUIVALENT

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

source-location

source.path

source-volume

NO REST EQUIVALENT

source-volume-node

NO REST EQUIVALENT

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

transfer-progress

transfer.state

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

source-location

source.path

source-volume

NO REST EQUIVALENT

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

snapmirror-get-destination-iter

Use the query "list_destinations_only=true" to list the source side SnapMirror relationships.

GET /api/snapmirror/relationships vicon.png

ONTAPI attribute

REST attribute

Comment

relationship_group_type

group_type

last_transfer_type

last_transfer_type

cg-item-mappings

source.consistency_group_volumes.name

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
source.consistency_group_volumes.name

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

is-constituent

NO REST EQUIVALENT

policy-type

policy.type

progress-last-updated

NO REST EQUIVALENT

relationship-group-type

NO REST EQUIVALENT

relationship-id

uuid

relationship-status

state

relationship-type

NO REST EQUIVALENT

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API.

source-location

source.path

source-volume

NO REST EQUIVALENT

source-volume-node

NO REST EQUIVALENT

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

transfer-progress

transfer.bytes_transferred

expand

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-get-dp-personality

This feature is obsolete and deprecated. Not implemented in REST API.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-get-iter

GET /api/snapmirror/relationships vicon.png

ONTAPI attribute

REST attribute

Comment

break-failed-count

NO REST EQUIVALENT

break-successful-count

NO REST EQUIVALENT

catalog-status

NO REST EQUIVALENT

catalog-total-progress

NO REST EQUIVALENT

catalog-transfer-snapshot

NO REST EQUIVALENT

relationship_group_type

group_type

last_transfer_type

last_transfer_type

cg-item-mappings

source.consistency_group_volumes.name

Supply all the following the REST API properties:
destination.consistency_group_volumes.name
source.consistency_group_volumes.name

current-max-transfer-rate

NO REST EQUIVALENT

current-operation-id

NO REST EQUIVALENT

current-transfer-error

NO REST EQUIVALENT

current-transfer-priority

NO REST EQUIVALENT

current-transfer-type

NO REST EQUIVALENT

destination-cluster

See comment column for details

Supply all the following the REST API properties:
destination.cluster.name
destination.cluster.uuid

destination-endpoint-uuid

NO REST EQUIVALENT

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-volume-node

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

destination-vserver-uuid

destination.svm.uuid

exported-snapshot

exported_snapshot

exported-snapshot-timestamp

NO REST EQUIVALENT

file-restore-file-count

NO REST EQUIVALENT

file-restore-file-list

NO REST EQUIVALENT

identity-preserve

NO REST EQUIVALENT

is-auto-expand-enabled

NO REST EQUIVALENT

is-catalog-enabled

NO REST EQUIVALENT

is-constituent

NO REST EQUIVALENT

is-healthy

healthy

lag-time

lag_time

last-transfer-duration

transfer.total_duration

last-transfer-end-timestamp

transfer.end_time

last-transfer-error

unhealthy_reason.message

last-transfer-error-codes

unhealthy_reason.code

last-transfer-from

NO REST EQUIVALENT

last-transfer-network-compression-ratio

NO REST EQUIVALENT

last-transfer-size

transfer.bytes_transferred

last-transfer-type

NO REST EQUIVALENT

max-transfer-rate

throttle

mirror-state

state

network-compression-ratio

NO REST EQUIVALENT

newest-snapshot

NO REST EQUIVALENT

newest-snapshot-timestamp

NO REST EQUIVALENT

opmask

NO REST EQUIVALENT

policy

policy.name

policy-type

policy.type

progress-last-updated

NO REST EQUIVALENT

relationship-control-plane

NO REST EQUIVALENT

relationship-group-type

NO REST EQUIVALENT

relationship-id

uuid

relationship-progress

NO REST EQUIVALENT

relationship-status

state

relationship-type

NO REST EQUIVALENT

Extended Data Protection (XDP) SnapMirror relationships are the only relationship types that are supported through the REST API

resync-failed-count

NO REST EQUIVALENT

resync-successful-count

NO REST EQUIVALENT

schedule

transfer_schedule

Shows both of the following REST API properties:
transfer_schedule.name
transfer_schedule.uuid

snapshot-checkpoint

NO REST EQUIVALENT

snapshot-progress

NO REST EQUIVALENT

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-endpoint-uuid

NO REST EQUIVALENT

source-location

source.path

source-volume

NO REST EQUIVALENT

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

source-vserver-uuid

source.svm.uuid

total-transfer-bytes

transfer.bytes_transferred

total-transfer-time-secs

NO REST EQUIVALENT

transfer-snapshot

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

unhealthy-reason

unhealthy_reason.message

update-failed-count

NO REST EQUIVALENT

update-successful-count

NO REST EQUIVALENT

vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

expand

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-get-total-records

This ONTAPI call does not have an equivalent REST API call.

snapmirror-get-volume-status

This ONTAPI call does not have an equivalent REST API call.

snapmirror-history-get

GET /api/snapmirror/relationships/{relationship.uuid}/transfers/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

additional-info

error_info.message

destination-location

relationship.destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

relationship.destination.svm.name

end-time

end_time

operation-id

uuid

operation-type

NO REST EQUIVALENT

relationship-group-type

NO REST EQUIVALENT

relationship-id

relationship.uuid

result

state

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

start-time

NO REST EQUIVALENT

transfer-size

bytes_transferred

destination-location

irelationship.destination.path`

destination-volume

NO REST EQUIVALENT

destination-vserver

relationship.destination.svm

operation-id

uuid

snapmirror-history-get-iter

Use the GET /api/snapirror/relationships/{relationship.uuid}/transfers REST API to obtain all transfer information for a SnapMirror relationship within the last 24 hours. Refer to audit.log for information on other operations.

GET /api/snapmirror/relationships/{relationship.uuid}/transfers vicon.png

ONTAPI attribute

REST attribute

Comment

additional-info

error_info.message

destination-location

relationship.destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

relationship.destination.svm

end-time

end_time

operation-id

uuid

operation-type

NO REST EQUIVALENT

relationship-group-type

NO REST EQUIVALENT

relationship-id

relationship.uuid

result

state

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

start-time

NO REST EQUIVALENT

transfer-size

bytes_transferred

max-records

max_records

Specifies the maximum number of records to return before paging.

snapmirror-initialize

Use the PATCH /api/snapmirror/relationships/{uuid} REST API call, setting the "state" property to "snapmirrored", to initialize the SnapMirror relationship or use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to start the initialize transfer on the SnapMirror relationship.

PATCH /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-snapshot

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

is-adaptive

NO REST EQUIVALENT

is-auto-expand-enabled

NO REST EQUIVALENT

is-catalog-enabled

NO REST EQUIVALENT

max-transfer-rate

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-snapshot

source_snapshot

Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to specify the Snapshot copy on the source to be transfered to the destination.

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

transfer-priority

NO REST EQUIVALENT

snapmirror-initialize-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-initialize-ls-set

This feature is deprecated. Not implemented in REST API.

This ONTAPI call does not have an equivalent REST API call.

snapmirror-list-unprotected

To list the unprotected volumes, set the query on the property "snapmirror.is_protected" to "false".

GET /api/storage/volumes vicon.png

ONTAPI attribute

REST attribute

Comment

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

snapmirror-modify

PATCH /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

destination.path

destination-volume

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

is-auto-expand-enabled

NO REST EQUIVALENT

is-catalog-enabled

NO REST EQUIVALENT

max-transfer-rate

throttle

policy

See comment column for details

Supply all the following the REST API properties:
policy.name
policy.uuid

schedule

transfer_schedule

Supply either or both of the following REST API properties:
transfer_schedule.name
transfer_schedule.uuid

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

source-location

source.path

source-volume

NO REST EQUIVALENT

source-vserver

See comment column for details

Supply all the following the REST API properties:
source.svm.name
source.svm.uuid

tries

NO REST EQUIVALENT

vserver

destination.svm.name

snapmirror-modify-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-promote

This ONTAPI call does not have an equivalent REST API call.

snapmirror-promote-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-protect

Use the "create_destination" object to provision the destination endpoint when establishing a SnapMirror relationship for a FlexVol volume, FlexGroup volume, SVM, or Consistency Group. Given a source endpoint, the destination endpoint is provisioned in the SVM specified in the "destination.path" property. While protecting an SVM, the SVM destination endpoint can only be provisioned on the local cluster. Note that the snapmirror-protect ONTAPI generates the name for the destination endpoint, but the REST API requires that you specify the name of the destination endpoint in the "destination path" property.

POST /api/snapmirror/relationships vicon.png

ONTAPI attribute

REST attribute

Comment

auto-initialize

state

When you specify the "create_destination.enabled" option while making a POST for a SnapMirror relationship, the relationship can be automatically initialized by setting the "state" either to "snapmirrored" when the policy is of type "async" or to "in_sync" when the policy is of type "sync"

destination-object-store

NO REST EQUIVALENT

destination-volume-prefix

NO REST EQUIVALENT

destination-volume-suffix

NO REST EQUIVALENT

destination-vserver

See comment column for details

Supply all the following the REST API properties:
destination.svm.name
destination.svm.uuid

destination-vserver-ipspace

destination.ipspace

is-catalog-enabled

NO REST EQUIVALENT

path-list

source.path

Can protect one source endpoint at a time.

policy

See comment column for details

Supply all the following the REST API properties:
policy.name
policy.uuid

schedule

NO REST EQUIVALENT

source-cluster

See comment column for details

Supply all the following the REST API properties:
source.cluster.name
source.cluster.uuid

A POST request to create the destination FlexVol volume, FlexGroup volume, and Consistency Group endpoints can optionally specify this property when the source SVM and the destination SVM are peered. A POST request to establish a SnapMirror relationship between the source endpoint and destination endpoint and when the source SVM and the destination SVM are not peered, must specify this property for the remote endpoint. A POST request to create the destination SVM endpoint or to establish an SVM DR relationship must populate this property with the remote source cluster details.

support-tiering

create_destination.tiering.supported

tiering-policy

create_destination.tiering.policy

snapmirror-quiesce

To quiesce the relationship, suspending further transfers, PATCH the "state" to "paused" for relationships with a policy of type "async" or "sync". SnapMirror relationships with the policy type as "sync" and "sync_type" as "automated_failover" cannot be "paused".

PATCH /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-quiesce-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-release

Use the query "source_only=true" to release the SnapMirror relationship and delete the Snapshot copies from the cluster that contains the source endpoint. Use the query "source_info_only=true" to release the SnapMirror relationship information from the cluster that contains the source endpoint.

DELETE /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-endpoint-uuid

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

relationship-id

NO REST EQUIVALENT

relationship-info-only

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-release-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-restore

Use the POST /api/snapmirror/relationships REST API call with the property "restore=true" to create the SnapMirror restore relationship. Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to start the restore transfer on the SnapMirror relationship.

POST /api/snapmirror/relationships vicon.png

ONTAPI attribute

REST attribute

Comment

archive-retrieval-priority

NO REST EQUIVALENT

cg-item-mappings

NO REST EQUIVALENT

clean-up-failure

NO REST EQUIVALENT

Use the DELETE /api/snapmirror/relationships/{uuid} REST API call to delete a SnapMirror restore relationship.

create-check-snapshot

NO REST EQUIVALENT

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

Use the POST /api/snapmirror/relationships REST API call to specify the "destination.path" property and create the SnapMirror restore relationship.

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

disable-storage-efficiency

storage_efficiency_enabled

Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to set this property to "false" to turn off storage efficiency for data transferred over the wire and written to the destination.

max-transfer-rate

throttle

Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to set the transfer rate to restrict the speed of the transfer to the maximum KB/s.

on-demand

NO REST EQUIVALENT

on-demand-attrs

NO REST EQUIVALENT

restore-file-list

See comment column for details

Supply all the following the REST API properties:
files.source_path
files.destination_path

Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API endpoint to specify the list of files or LUNs to be restored. The list can contain up to eight files or LUNs.

restore-object-expiry

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-endpoint-uuid

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

Use the POST /api/snapmirror/relationships REST API call to specify the "source.path" property and create the SnapMirror restore relationship.

source-snapshot

source_snapshot

Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to specify the Snapshot copy on the source to be transferred to the destination.

source-snapshot-uuid

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

transfer-priority

NO REST EQUIVALENT

tries

NO REST EQUIVALENT

use-network-compression

NO REST EQUIVALENT

snapmirror-resume

In the REST API, to resume transfers for a paused SnapMirror relationship, PATCH the "state" property to "snapmirrored" for relationships with a policy of type "async" or "in_sync" for relationships with a policy of type "sync".

PATCH /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

snapmirror-resume-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-resync

In the REST API, to resync the broken SnapMirror relationship, PATCH the "state" to "snapmirrored" for relationships with a policy of type "async" or "in_sync" for relationships with a policy of type "sync".

PATCH /api/snapmirror/relationships/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-endpoint-uuid

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-snapshot

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

is-adaptive

NO REST EQUIVALENT

is-auto-expand-enabled

NO REST EQUIVALENT

is-catalog-enabled

NO REST EQUIVALENT

max-transfer-rate

NO REST EQUIVALENT

preserve

NO REST EQUIVALENT

quick-resync

NO REST EQUIVALENT

remove-catalog-base-owners

NO REST EQUIVALENT

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-snapshot

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

transfer-priority

NO REST EQUIVALENT

snapmirror-resync-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-create

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-destroy

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-get

This ONTAPI call does not have an equivalent REST API call.

snapmirror-snapshot-owner-get-snapshots

This ONTAPI call does not have an equivalent REST API call.

snapmirror-update

Use the REST API POST method with an empty JSON body to start the SnapMirror update transfer on the relationship.

POST /api/snapmirror/relationships/{relationship.uuid}/transfers vicon.png

ONTAPI attribute

REST attribute

Comment

destination-cluster

NO REST EQUIVALENT

destination-location

NO REST EQUIVALENT

destination-snapshot

NO REST EQUIVALENT

destination-volume

NO REST EQUIVALENT

destination-vserver

NO REST EQUIVALENT

enable-storage-efficiency

NO REST EQUIVALENT

max-transfer-rate

throttle

Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to set the transfer rate to restrict the speed of the transfer to the maximum KB/s.

source-cluster

NO REST EQUIVALENT

source-location

NO REST EQUIVALENT

source-snapshot

source_snapshot

Use the POST /api/snapmirror/relationships/{relationship.uuid}/transfers REST API call to specify the Snapshot copy on the source to be transfered to the destination.

source-volume

NO REST EQUIVALENT

source-vserver

NO REST EQUIVALENT

transfer-priority

NO REST EQUIVALENT

snapmirror-update-iter

This ONTAPI call does not have an equivalent REST API call.

snapmirror-update-ls-set

This feature is deprecated. Not implemented in REST API.

This ONTAPI call does not have an equivalent REST API call.

Category: SNAPSHOT

snapshot-add-test-owners

This ONTAPI call does not have an equivalent REST API call.

snapshot-autodelete-list-info

The REST API field name is "space.snapshot.autodelete_enabled".

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-autodelete-set-option

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

option-name

space.snapshot.autodelete_enabled

option-value

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL

snapshot-create

POST /api/storage/volumes/{volume.uuid}/snapshots vicon.png

ONTAPI attribute

REST attribute

Comment

async

NO REST EQUIVALENT

All REST API POST endpoints are async.

comment

comment

expiry-time

expiry_time

is-valid-lun-clone-snapshot

NO REST EQUIVALENT

snapmirror-label

snapmirror_label

snapshot

name

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-create-async

This ONTAPI call does not have an equivalent REST API call.

snapshot-delete

DELETE /api/storage/volumes/{volume.uuid}/snapshots/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ignore-owners

NO REST EQUIVALENT

snapshot

NO REST EQUIVALENT

The REST API uses snapshot.uuid from the URL.

snapshot-instance-uuid

NO REST EQUIVALENT

Field is present in the URL as "snapshot.uuid".

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-delete-async

This ONTAPI call does not have an equivalent REST API call.

snapshot-delta-info

This ONTAPI call does not have an equivalent REST API call.

snapshot-get-iter

GET /api/storage/volumes/{volume.uuid}/snapshots/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

access-time

create_time

afs-used

NO REST EQUIVALENT

busy

NO REST EQUIVALENT

comment

comment

Optional parameter. Must be part of query only.

compress-savings

NO REST EQUIVALENT

compression-type

NO REST EQUIVALENT

contains-lun-clones

NO REST EQUIVALENT

convert-recovery

NO REST EQUIVALENT

cumulative-percentage-of-total-blocks

NO REST EQUIVALENT

cumulative-percentage-of-used-blocks

NO REST EQUIVALENT

cumulative-total

NO REST EQUIVALENT

dedup-savings

NO REST EQUIVALENT

dependency

owners

Dependencies are denoted by the "dependent" suffix.

expiry-time

expiry_time

Optional parameter. Must be part of query only.

infinite-snaplock-expiry-time

NO REST EQUIVALENT

inofile-version

NO REST EQUIVALENT

is-7-mode-snapshot

NO REST EQUIVALENT

is-constituent-snapshot

NO REST EQUIVALENT

name

name

Optional parameter. Must be part of query only.

percentage-of-total-blocks

NO REST EQUIVALENT

percentage-of-used-blocks

NO REST EQUIVALENT

performance-metadata

NO REST EQUIVALENT

snaplock-expiry-time

snaplock_expiry_time

Optional parameter. Must be part of query only.

snapmirror-label

snapmirror_label

Optional parameter. Must be part of query only.

snapshot-instance-uuid

uuid

Optional parameter. Must be part of query only.

snapshot-owners-list

owners

Optional parameter. Must be part of query only.

snapshot-version-uuid

version_uuid

state

state

Optional parameter. Must be part of query only.

total

size

Optional parameter. Used only as part of a query. The value of size is in bytes.

vbn0-savings

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

volume-provenance-uuid

provenance_volume.uuid

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

snapshot-get-reserve

The REST API field name is "space.snapshot.reserve_percent".

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

API uses volume uuid from URL

snapshot-get-schedule

The REST API field name is "schedule.uuid". You can retrieve The REST API field snapshot_policy.uuid by using the GET /api/storage/volumes endpoint.

GET /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

snapshot-list-info

GET /api/storage/volumes/{volume.uuid}/snapshots vicon.png

ONTAPI attribute

REST attribute

Comment

is-7-mode-snapshot

NO REST EQUIVALENT

lun-clone-snapshot

NO REST EQUIVALENT

snapowners

owners

target-name

NO REST EQUIVALENT

target-type

NO REST EQUIVALENT

terse

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-modify-iter

PATCH /api/storage/volumes/{volume.uuid}/snapshots/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

access-time

NO REST EQUIVALENT

afs-used

NO REST EQUIVALENT

busy

NO REST EQUIVALENT

comment

comment

compress-savings

NO REST EQUIVALENT

compression-type

NO REST EQUIVALENT

contains-lun-clones

NO REST EQUIVALENT

convert-recovery

NO REST EQUIVALENT

cumulative-percentage-of-total-blocks

NO REST EQUIVALENT

cumulative-percentage-of-used-blocks

NO REST EQUIVALENT

cumulative-total

NO REST EQUIVALENT

dedup-savings

NO REST EQUIVALENT

dependency

NO REST EQUIVALENT

expiry-time

expiry_time

infinite-snaplock-expiry-time

NO REST EQUIVALENT

inofile-version

NO REST EQUIVALENT

is-7-mode-snapshot

NO REST EQUIVALENT

is-constituent-snapshot

NO REST EQUIVALENT

name

name

percentage-of-total-blocks

NO REST EQUIVALENT

percentage-of-used-blocks

NO REST EQUIVALENT

performance-metadata

NO REST EQUIVALENT

snaplock-expiry-time

NO REST EQUIVALENT

In the REST API, "snaplock-expiry-time" is a read-only field.

snapmirror-label

snapmirror_label

snapshot-instance-uuid

NO REST EQUIVALENT

snapshot-owners-list

NO REST EQUIVALENT

In the REST API, "owners" is a read-only field.

snapshot-version-uuid

NO REST EQUIVALENT

state

NO REST EQUIVALENT

In the REST API, "state" is a read-only field.

total

NO REST EQUIVALENT

vbn0-savings

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

volume-provenance-uuid

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

continue-on-failure

NO REST EQUIVALENT

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

snapshot-modify-snaplock-expiry-time

PATCH /api/storage/volumes/{volume.uuid}/snapshots/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

expiry-time

expiry_time

infinite-expiry-time

NO REST EQUIVALENT

snapshot

NO REST EQUIVALENT

The REST API uses snapshot uuid from the URL

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-multicreate

All attributes are part of the records array.

POST /api/storage/volumes/*/snapshots vicon.png

ONTAPI attribute

REST attribute

Comment

cleanup

NO REST EQUIVALENT

snapmirror-label

snapmirror_label

snapshot

name

volume-names

volume.name

wait-for-sync

NO REST EQUIVALENT

snapshot-multicreate-validate

This ONTAPI call does not have an equivalent REST API call.

snapshot-multidelete

All attributes are part of the records array.

DELETE /api/storage/volumes/*/snapshots vicon.png

ONTAPI attribute

REST attribute

Comment

reverting

NO REST EQUIVALENT

reverting-fg

NO REST EQUIVALENT

snapshot

name

snapshot-tags

NO REST EQUIVALENT

use-snapshot-as-prefix

NO REST EQUIVALENT

volume-names

volume.name

volume-uuids

volume.uuid

snapshot-multirename

All attributes are part of the records array.

PATCH /api/storage/volumes/*/snapshots vicon.png

ONTAPI attribute

REST attribute

Comment

new-snapshot-name

name

snapshot-name

uuid

volume-names

volume.name

snapshot-partial-restore-file

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

byte-count

restore_to.byte_count

path

restore_to.path

snapshot

restore_to.snapshot.name

snapshot-instance-uuid

restore_to.snapshot.uuid

start-byte

restore_to.start_byte

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

volume-dsid

NO REST EQUIVALENT

snapshot-partial-restore-file-list-info

This ONTAPI call does not have an equivalent REST API call.

snapshot-policy-add-schedule

POST /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules vicon.png

ONTAPI attribute

REST attribute

Comment

count

count

policy

NO REST EQUIVALENT

The REST API uses snapshot_policy.uuid from the URL.

prefix

prefix

schedule

schedule.name

snapmirror-label

snapmirror_label

snapshot-policy-create

POST /api/storage/snapshot-policies vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

count1

copies.count

count2

copies.count

count3

copies.count

count4

copies.count

count5

copies.count

enabled

enabled

policy

name

prefix1

copies.prefix

prefix2

copies.prefix

prefix3

copies.prefix

prefix4

copies.prefix

prefix5

copies.prefix

schedule1

copies.schedule.name

schedule2

copies.schedule.name

schedule3

copies.schedule.name

schedule4

copies.schedule.name

schedule5

copies.schedule.name

snapmirror-label1

copies.snapmirror_label

snapmirror-label2

copies.snapmirror_label

snapmirror-label3

copies.snapmirror_label

snapmirror-label4

copies.snapmirror_label

snapmirror-label5

copies.snapmirror_label

snapshot-policy-delete

DELETE /api/storage/snapshot-policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

policy

NO REST EQUIVALENT

API uses snapshot_policy.uuid from URL

snapshot-policy-get

"snapshot_policy.uuid" is an optional parameter.

GET /api/storage/snapshot-policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

Optional parameter. Must be part of query only.

enabled

enabled

Optional parameter. Must be part of query only.

policy

name

Optional parameter. Must be part of query only.

policy-owner

NO REST EQUIVALENT

snapshot-policy-schedules

copies.schedule.name

Optional parameter. Must be part of query only.

total-schedules

copies.count

Optional parameter. Must be part of query only.

vserver-name

svm.name

Optional parameter. Must be part of query only. You can also use "svm.uuid".

snapshot-policy-get-iter

GET /api/storage/snapshot-policies vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

Optional parameter. Must be part of query only.

enabled

enabled

Optional parameter. Must be part of query only.

policy

name

Optional parameter. Must be part of query only.

policy-owner

NO REST EQUIVALENT

snapshot-policy-schedules

copies.schedule.name

Optional parameter. Must be part of query only.

total-schedules

NO REST EQUIVALENT

vserver-name

svm.name

Optional parameter. Must be part of query only.

max-records

max_records

Specifies the maximum number of records to return before paging.

snapshot-policy-modify

PATCH /api/storage/snapshot-policies/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

comment

comment

enabled

enabled

policy

name

snapshot-policy-modify-schedule

PATCH /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules/{schedule.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

new-count

count

new-snapmirror-label

snapmirror_label

policy

NO REST EQUIVALENT

The REST API uses snapshot_policy.uuid from the URL.

schedule

NO REST EQUIVALENT

The REST API uses schedule.uuid from the URL.

snapshot-policy-remove-schedule

DELETE /api/storage/snapshot-policies/{snapshot_policy.uuid}/schedules/{schedule.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

policy

NO REST EQUIVALENT

The REST API uses snapshot_policy.uuid from the URL.

schedule

NO REST EQUIVALENT

The REST API uses schedule.uuid from the URL.

snapshot-reclaimable-info

GET /api/storage/volumes/{volume.uuid}/snapshots?fields=reclaimable_space vicon.png

ONTAPI attribute

REST attribute

Comment

snapshots

name

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-remove-owner

This ONTAPI call does not have an equivalent REST API call.

snapshot-rename

PATCH /api/storage/volumes/{volume.uuid}/snapshots/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

current-name

NO REST EQUIVALENT

The REST API uses snapshot uuid from the URL

new-name

name

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-reserve-list-info

The REST API field name is space.snapshot.reserve_percent

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-restore-file

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ignore-streams

NO REST EQUIVALENT

path

restore_to.path

restore-path

restore_to.restore_path

snapshot

restore_to.snapshot.name

snapshot-instance-uuid

restore_to.snapshot.uuid

space-efficient-split-disabled

NO REST EQUIVALENT

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

volume-dsid

NO REST EQUIVALENT

snapshot-restore-file-info

This ONTAPI call does not have an equivalent REST API call.

snapshot-restore-volume

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

preserve-lun-ids

preserve_lun_ids

sched-snap-name

scheduled_snapshot_naming_scheme

snapshot

restore_to.snapshot.name

snapshot-instance-uuid

restore_to.snapshot.uuid

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-restore-volume-async

This ONTAPI call does not have an equivalent REST API call.

snapshot-set-reserve

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

percentage

space.snapshot.reserve_percent

volume

NO REST EQUIVALENT

The REST API uses volume.uuid from the URL.

snapshot-volume-info

This ONTAPI call does not have an equivalent REST API call.

Category: SNMP

snmp-community-add

POST /api/support/snmp/users vicon.png

ONTAPI attribute

REST attribute

Comment

access-control

NO REST EQUIVALENT

access-control is set to the default value in the REST API.

community

name

snmp-community-delete

DELETE /api/support/snmp/users/{engine_id}/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

access-control

NO REST EQUIVALENT

community

name

snmp-community-delete-all

Set the query parameter "authentication-method" to "community".

DELETE /api/support/snmp/users vicon.png

There are no attributes defined for this ONTAPI call.

snmp-disable

Set the parameter "enabled" to "false".

PATCH /api/support/snmp

There are no attributes defined for this ONTAPI call.

snmp-enable

Set the parameter "enabled" to "true".

PATCH /api/support/snmp

There are no attributes defined for this ONTAPI call.

snmp-enable-snmpv3

This ONTAPI call does not have an equivalent REST API call.

snmp-get

SNMP objects can be accessed using SNMP.

This ONTAPI call does not have an equivalent REST API call.

snmp-get-next

SNMP objects can be accessed using SNMP.

This ONTAPI call does not have an equivalent REST API call.

snmp-prepare-to-downgrade

This ONTAPI call does not have an equivalent REST API call.

snmp-status

This ONTAPI call does not have an equivalent REST API call.

snmp-test-trap-trigger

Set the parameter "trigger_test_trap" to "true" to generate a test trap.

PATCH /api/support/snmp

There are no attributes defined for this ONTAPI call.

snmp-trap-disable

Set the parameter "traps_enabled" to "false" to disable SNMP traps.

PATCH /api/support/snmp

There are no attributes defined for this ONTAPI call.

snmp-trap-enable

Set the parameter "traps_enabled" to "true" to enable SNMP traps.

PATCH /api/support/snmp

There are no attributes defined for this ONTAPI call.

snmp-traphost-add

POST /api/support/snmp/traphosts

ONTAPI attribute

REST attribute

Comment

host

host

username

user.name

snmp-traphost-delete

DELETE /api/support/snmp/traphosts/{host}

ONTAPI attribute

REST attribute

Comment

host

host

username

user.name

In the REST API, you can optionally specify user.name as a query parameter.

Category: STORAGE-ACP-FIRMWARE

storage-acp-firmware-file-get-iter

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-ADAPTER

storage-adapter-enable-adapter

This ONTAPI call does not have an equivalent REST API call.

storage-adapter-get-adapter-info

GET /api/storage/ports/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

adapter-fc

See comment column for details

adapter-fc-info.adapter-bar → NA
adapter-fc-info.adapter-model → NA
adapter-fc-info.adapter-sff-info → NA
adapter-fc-info.adapter-sfp-info.part-number → cable.part_number
adapter-fc-info.adapter-sfp-info.serial-number → cable.serial_number
adapter-fc-info.adapter-sfp-info.speed-capabilities → NA
adapter-fc-info.adapter-sfp-info.vendor → NA
adapter-fc-info.cache-line-sz → NA
comment: adapter-fc-info.adapter-model available as part of the "description" attribute
adapter-fc-info.fc-link-rate → speed
adapter-fc-info.fc-node-name → NA
adapter-fc-info.fc-packet-size → NA
adapter-fc-info.fc-port-name → wwpn
comment: adapter-fc-info.fc-port-name contains ":" in ONTAPI, but not in REST
adapter-fc-info.firmware-rev → firmware_version
adapter-fc-info.hardware-rev → NA
comment: adapter-fc-info.hardware-rev available as part of the "description" attribute
adapter-fc-info.host-loop-id → NA
adapter-fc-info.host-port-id → NA
adapter-fc-info.is-enabled → state
comment: adapter-fc-info.is-enabled is false when the REST "state" is "offline"
adapter-fc-info.is-ext-gbic → NA
adapter-fc-info.is-in-use → in_use
adapter-fc-info.is-pci-64-capable → NA
adapter-fc-info.is-redundant → redundant
adapter-fc-info.is-sram-parity → NA
adapter-fc-info.preload-table-rev → NA

adapter-name

name

adapter-parallel-scsi

NO REST EQUIVALENT

adapter-sas

See comment column for details

adapter-sas-info.adapter-board-revision → NA
adapter-sas-info.adapter-date-code → NA
adapter-sas-info.adapter-family → NA
comment: adapter-sas-info.adapter-family available as part of the "description" attribute
adapter-sas-info.adapter-manufacturer → NA
adapter-sas-info.adapter-manufacturer-part-number → NA
adapter-sas-info.adapter-model → NA
comment: adapter-sas-info.adapter-model available as part of the "description" attribute
adapter-sas-info.adapter-slot → NA
comment: adapter-sas-info.adapter-slot available as part of the "name" attribute
adapter-sas-info.adapter-state → state
comment: adapter-sas-info.adapter-state is simplified to "online", "offline", and "error" in REST
adapter-sas-info.adapter-part-number → part_number
adapter-sas-info.adapter-serial-number → serial_number
adapter-sas-info.adapter-vendor → NA
comment: adapter-sas-info.adapter-family available as part of the "description" attribute
adapter-sas-info.base-wwn → wwn
comment: adapter-sas-info.base-wwn contains ":" in ONTAPI, but not in REST
adapter-sas-info.firmware-rev → firmware_version
adapter-sas-info.hardware-rev → NA
comment: adapter-sas-info.hardware-rev available as part of the "description" attribute
adapter-sas-info.is-enabled → state
comment: adapter-sas-info.is-enabled is false when the REST "state" is "offline"
adapter-sas-info.is-in-use → in_use
adapter-sas-info.is-redundant → redundant
adapter-sas-info.sas-adapter-disabled-phy-count → NA
adapter-sas-info.sas-adapter-enabled-phy-count → NA
adapter-sas-info.sas-adapter-expander-phy-states → NA
adapter-sas-info.sas-phy → NA
adapter-sas-info.sas-qsfp-cable.sas-qsfp-cable-info.attached-serial-number → cable.serial_number
adapter-sas-info.sas-qsfp-cable.sas-qsfp-cable-info.cable-end-identifier → NA
adapter-sas-info.sas-qsfp-cable.sas-qsfp-cable-info.cable-length → cable.length
adapter-sas-info.sas-qsfp-cable.sas-qsfp-cable-info.cable-manufacturer → NA
adapter-sas-info.sas-qsfp-cable.sas-qsfp-cable-info.cable-part-number → cable.part_number
adapter-sas-info.sas-qsfp-cable.sas-qsfp-cable-info.cable-serial-number → cable.identifier
adapter-sas-info.sas-qsfp-cable.sas-qsfp-cable-info.cable-technology → NA

adapter-type

type

ONTAPI adapter-type → REST API type
ADT_IF_ATA → NA
ADT_IF_PARALLEL_SCSI → NA
ADT_IF_SAS → sas
ADT_IF_FC → fc

node-name

node.name

storage-adapter-get-adapter-list

GET /api/storage/ports

ONTAPI attribute

REST attribute

Comment

node-name

node.name

Category: STORAGE-ARRAY

storage-array-get-config-summary

This ONTAPI call does not have an equivalent REST API call.

storage-array-list-info

This ONTAPI call does not have an equivalent REST API call.

storage-array-modify

This ONTAPI call does not have an equivalent REST API call.

storage-array-port-modify

This ONTAPI call does not have an equivalent REST API call.

storage-array-ports-list-info

This ONTAPI call does not have an equivalent REST API call.

storage-array-rename

This ONTAPI call does not have an equivalent REST API call.

storage-array-stats-list-info

This ONTAPI call does not have an equivalent REST API call.

storage-array-port-stats-list-info

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-BRIDGE

storage-bridge-config-dump-collect

This ONTAPI call does not have an equivalent REST API call.

storage-bridge-config-dump-delete

This ONTAPI call does not have an equivalent REST API call.

storage-bridge-config-dump-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-bridge-coredump-collect

This ONTAPI call does not have an equivalent REST API call.

storage-bridge-coredump-delete

This ONTAPI call does not have an equivalent REST API call.

storage-bridge-coredump-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-bridge-firmware-firmware-update

This ONTAPI call does not have an equivalent REST API call.

storage-bridge-get

GET /api/storage/bridges/{wwn}

ONTAPI attribute

REST attribute

Comment

address

ip_address

chassis-throughput-status

chassis_throughput_state

dram-single-bit-error-count

dram_single_bit_error_count

firmware-version

firmware_version

is-being-monitored

monitoring_enabled

is-bridge-secure

security_enabled

last-reboot-reason

last_reboot.reason

last-reboot-time

last_reboot.time

managed-by

managed_by

model

model

name

name

serial-number

serial_number

status

state

storage-bridge-connectivity-list

paths

storage-bridge-cooling-info

temperature_sensor

storage-bridge-error-list

errors

storage-bridge-fc-port-list

fc_ports

storage-bridge-fc-port-sfp-list

fc_ports.sfp

storage-bridge-fc-port-statistics-list

NO REST EQUIVALENT

storage-bridge-mini-sas-hd-list

sas_ports.cable

storage-bridge-power-supply-list

power_supply_units

storage-bridge-sas-port-list

sas_ports

storage-bridge-sas-port-qsfp-list

NO REST EQUIVALENT

storage-bridge-sas-port-statistics-list

NO REST EQUIVALENT

symbolic-name

symbolic_name

vendor

vendor

wwn

wwn

storage-bridge-get-iter

GET /api/storage/bridges

ONTAPI attribute

REST attribute

Comment

address

ip_address

chassis-throughput-status

chassis_throughput_state

dram-single-bit-error-count

dram_single_bit_error_count

firmware-version

firmware_version

is-being-monitored

monitoring_enabled

is-bridge-secure

security_enabled

last-reboot-reason

last_reboot.reason

last-reboot-time

last_reboot.time

managed-by

managed_by

model

model

name

name

serial-number

serial_number

status

state

storage-bridge-connectivity-list

paths

storage-bridge-cooling-info

temperature_sensor

storage-bridge-error-list

errors

storage-bridge-fc-port-list

fc_ports

storage-bridge-fc-port-sfp-list

fc_ports.sfp

storage-bridge-fc-port-statistics-list

NO REST EQUIVALENT

storage-bridge-mini-sas-hd-list

sas_ports.cable

storage-bridge-power-supply-list

power_supply_units

storage-bridge-sas-port-list

sas_ports

storage-bridge-sas-port-qsfp-list

NO REST EQUIVALENT

storage-bridge-sas-port-statistics-list

NO REST EQUIVALENT

symbolic-name

symbolic_name

vendor

vendor

wwn

wwn

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: STORAGE-DISK-FIRMWARE

storage-disk-firmware-file-get-iter

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-DISK

storage-disk-get-iter

GET /api/storage/disks

ONTAPI attribute

REST attribute

Comment

disk-inventory-info

See comment column for details

bytes-per-sector → bytes_per_sector
capacity-sectors → sector_count
physical-size → physical_size
carrier-id → NA
carrier-serialno → NA
checksum-compatibility → NA
disk-class → class
disk-cluster-name → name
disk-type → type
disk-effective-type → effective-type
disk-uid → uid
drawer → drawer.id
drawer-slot → drawer.slot
firmware-revision → firmware_version
grown-defect-list-count → NA
health-monitor-time-interval → NA
hw-minimum-os → NA
is-dynamically-qualified → NA
is-foreign → NA
is-multidisk-carrier → NA
is-shared → container_type
location → NA
location-id → NA
media-scrub-count → NA
media-scrub-last-done-time-interval → NA
model → model
reservation-key → NA
reservation-type → NA
right-size-sectors → NA
rpm → rpm
serial-number → serial_number
shelf → NA
comment: shelf available as the "id" attribute under the URL returned by using the GET /api/storage/disks/{uuid}?fields=shelf endpoint
shelf-bay → bay
shelf-uid → shelf.uid
stack-id → NA
storage-sed-info.data-key-id → key_id.data
storage-sed-info.fips-key-id → key_id.fips
storage-sed-info.is-fips-sed → fips_certified
storage-sed-info.is-non-fips-sed → NA
storage-sed-info.is-power-on-lock-enabled → NA
storage-sed-info.is-sed → self_encrypting
storage-sed-info.protection-mode → protection_mode
storage-ssd-info.percent-rated-life-used → rated_life_used_percent
storage-ssd-info.percent-spares-consumed → NA
storage-ssd-info.percent-spares-consumed-limit → NA
vendor → vendor
virtual-machine-disk-info.vmdisk-adapter-device → NA
virtual-machine-disk-info.vmdisk-adapter-driver → NA
virtual-machine-disk-info.vmdisk-adapter-model → NA
virtual-machine-disk-info.vmdisk-adapter-pci → NA
virtual-machine-disk-info.vmdisk-container-name → virtual.container_name
virtual-machine-disk-info.vmdisk-lun-canonical-name → NA
virtual-machine-disk-info.vmdisk-lun-capacity → NA
virtual-machine-disk-info.vmdisk-lun-model → NA
virtual-machine-disk-info.vmdisk-lun-partition → NA
virtual-machine-disk-info.vmdisk-lun-vendor-name → NA
virtual-machine-disk-info.vmdisk-object-name → virtual.object_name
virtual-machine-disk-info.vmdisk-storage-account → virtual.storage_account
virtual-machine-disk-info.vmdisk-store-capacity → NA
virtual-machine-disk-info.vmdisk-store-nas-path → NA
virtual-machine-disk-info.vmdisk-store-type → NA
virtual-machine-disk-info.vmdisk-target-iscsi-address → NA
virtual-machine-disk-info.vmdisk-target-iscsi-name → NA
virtual-machine-disk-info.vmdisk-target-lun-id → NA
virtual-machine-disk-info.vmhost-error → NA
vmdisk-backing-info.vmdisk-backing-device-id → NA
vmdisk-backing-info.vmdisk-backing-disk-model → NA
vmdisk-backing-info.vmdisk-backing-serial-number → NA
vmdisk-backing-info.vmdisk-backing-vendor-id → NA
vmdisk-target-address → NA

disk-metrocluster-info

See comment column for details

is-local-attach → local

disk-name

name

disk-ownership-info

See comment column for details

data-home → NA
data-home-id → NA
data-owner → NA
data-owner-id → NA
data1-home → NA
data1-home-id → NA
data1-owner → NA
data1-owner-id → NA
data2-home → NA
data2-home-id → NA
data2-owner → NA
data2-owner-id → NA
disk-uid → uid
dr-home-node-id → NA
dr-home-node-name → dr_node.name
home-node-id → NA
home-node-name → home_node.name
is-failed → NA
owner-node-id → system.uuid
owner-node-name → node.name
pool → pool
reserved-by-node-id → NA
root-home → NA
root-home-id → NA
root-owner → NA
root-owner-id → NA

disk-paths

See comment column for details

initiator → paths.initiator
disk-port → paths.port_name
node → paths.node.name
disk-port-name → paths.port_type
comment: Port type is derived from disk-port-name
disk-target-wwnn → paths.wwnn
disk-target-wwpn → paths.wwpn
vmdisk-hypervisor-file-name → paths.vmdisk_hypervisor_file_name

disk-raid-info

See comment column for details

active-node-name → node.name
container-type → container_type
disk-aggregate-info.aggregate-name → aggregates.name
disk-aggregate-info.checksum-type → NA
disk-aggregate-info.copy-destination-cluster-name → NA
disk-aggregate-info.copy-destination-name → NA
disk-aggregate-info.copy-percent-complete → NA
disk-aggregate-info.is-media-scrubbing → NA
disk-aggregate-info.is-offline → NA
disk-aggregate-info.is-prefailed → NA
disk-aggregate-info.is-reconstructing → NA
disk-aggregate-info.is-replacing → NA
disk-aggregate-info.is-zeroed → NA
disk-aggregate-info.is-zeroing → NA
disk-aggregate-info.plex-name → NA
disk-aggregate-info.raid-group-name → NA
disk-aggregate-info.reconstruct-percent-complete → NA
disk-aggregate-info.zeroing-percent-complete → NA
disk-outage-info.is-in-fdr → outage.persistently_failed
disk-outage-info.reason → outage.reason
disk-shared-info.aggregate-list → aggregates.name
disk-shared-info.checksum-type → NA
disk-shared-info.copy-destination-cluster-name → NA
disk-shared-info.copy-destination-name → NA
disk-shared-info.copy-percent-complete → NA
disk-shared-info.is-media-scrubbing → NA
disk-shared-info.is-offline → NA
disk-shared-info.is-prefailed → NA
disk-shared-info.is-reconstructing → NA
disk-shared-info.is-replacing → NA
disk-shared-info.is-sparecore → NA
disk-shared-info.is-zeroed → NA
disk-shared-info.is-zeroing → NA
disk-shared-info.partitioning-type → NA
disk-shared-info.reconstruct-percent-complete → NA
disk-shared-info.storage-pool → storage_pool.name
disk-shared-info.zeroing-percent-complete → NA
disk-spare-info.is-media-scrubbing → NA
disk-spare-info.is-offline → NA
disk-spare-info.is-sparecore → NA
disk-spare-info.is-zeroed → NA
comment: We do not consider this attribute meaningful in ONTAP releases 9.4 and above.
disk-spare-info.is-zeroing → NA
comment: We do not consider this attribute meaningful in ONTAP releases 9.4 and above.
disk-spare-info.zeroing-percent-complete → NA
disk-uid → uid
effective-disk-type → effective_type
effective-rpm → NA
physical-blocks → NA
position → NA
spare-pool → pool
standard-disk-type → NA
used-blocks → usable_size
error-text-list → errors.reason
error-type → errors.type

disk-stats-info

See comment column for details

average-latency → stats.average_latency
bytes-per-sector → bytes_per_sector
disk-io-kbps → stats.throughput
comment: disk-io-kbps is changed to bytes per second in REST
disk-iops → stats.iops_total
disk-uid → uid
import-in=progress → NA
path-error-count → stats.path_error_count
power-on-time-interval → stats.power_on_hours
comment: power-on-time-interval is in seconds in ONTAPI, but not in REST
sectors-read → NA
sectors-written → NA

disk-uid

uid

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-disk-remove-reservation

This ONTAPI call does not have an equivalent REST API call.

storage-disk-set-foreign-lun

This ONTAPI call does not have an equivalent REST API call.

storage-disk-setstate

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-INITIATOR

storage-initiator-balance

This ONTAPI call does not have an equivalent REST API call.

storage-initiator-disk-path-list-info

This ONTAPI call does not have an equivalent REST API call.

storage-initiator-errors-list-info

This ONTAPI call does not have an equivalent REST API call.

storage-initiator-get-load

This ONTAPI call does not have an equivalent REST API call.

storage-initiator-path-list-info

This ONTAPI call does not have an equivalent REST API call.

storage-initiator-path-quiesce

This ONTAPI call does not have an equivalent REST API call.

storage-initiator-path-resume

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-ISCSI-INITIATOR

storage-iscsi-initiator-add-target

This ONTAPI call does not have an equivalent REST API call.

storage-iscsi-initiator-connect

This ONTAPI call does not have an equivalent REST API call.

storage-iscsi-initiator-disconnect

This ONTAPI call does not have an equivalent REST API call.

storage-iscsi-initiator-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-iscsi-initiator-remove-target

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-POOL

storage-pool-add

PATCH /api/storage/pools/{uuid}

ONTAPI attribute

REST attribute

Comment

auto-grow-aggregates

NO REST EQUIVALENT

This field is always true when invoked via REST.

disk-count

capacity.disk_count

disk-list

capacity.disks

nodes

nodes.name

simulate

NO REST EQUIVALENT

storage-pool

NO REST EQUIVALENT

Specify the storage pool uuid for this PATCH request.

storage-pool-aggregate-get-iter

GET /api/storage/pools

ONTAPI attribute

REST attribute

Comment

aggregate

capacity.used_allocation_units.aggregate.name

allocated-unit-count

capacity.used_allocation_units.count

node

capacity.used_allocation_units.node.name

original-owner

NO REST EQUIVALENT

storage-pool

name

used-capacity

capacity.used_allocation_units.current_usage

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-pool-available-capacity-get-iter

GET /api/storage/pools

ONTAPI attribute

REST attribute

Comment

allocation-unit-count

capacity.spare_allocation_units.count

allocation-unit-size

capacity.spare_allocation_units.size

available-size

capacity.spare_allocation_units.available_size

node

capacity.spare_allocation_units.node.name

storage-pool

name

storage-type

storage_type

syncmirror-pool

capacity.spare_allocation_units.syncmirror_pool

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-pool-create

POST /api/storage/pools

ONTAPI attribute

REST attribute

Comment

disk-count

capacity.disk_count

disk-list

disks

disk-size

disk_size

nodes

nodes.name

simulate

NO REST EQUIVALENT

storage-pool

name

storage-pool-delete

DELETE /api/storage/pools/{uuid}

ONTAPI attribute

REST attribute

Comment

storage-pool

NO REST EQUIVALENT

Specify the storage pool uuid for this DELETE request.

storage-pool-disk-get-iter

GET /api/storage/pools

ONTAPI attribute

REST attribute

Comment

disk

capacity.disks.disk.name

disk-total-size

capacity.disks.total_size

disk-type

NO REST EQUIVALENT

This field is insignificant since all cache disks are SSDs.

disk-usable-size

capacity.disks.usable_size

storage-pool

name

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-pool-get-iter

GET /api/storage/pools

ONTAPI attribute

REST attribute

Comment

allocation-unit-data-size-raid-dp

NO REST EQUIVALENT

allocation-unit-data-size-raid-tec

NO REST EQUIVALENT

allocation-unit-data-size-raid4

NO REST EQUIVALENT

allocation-unit-size

capacity.spare_allocation_units.size

current-operation-job-id

NO REST EQUIVALENT

disk-count

capacity.disk_count

is-healthy

health.is_healthy

nodes

nodes.name

pool-state

health.state

pool-total-size

capacity.total

pool-usable-size

capacity.remaining

storage-pool

name

storage-type

storage_type

unhealthy-reason

health.unhealthy_reason

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-pool-reassign

PATCH /api/storage/pools/{uuid}

ONTAPI attribute

REST attribute

Comment

allocation-units

capacity.spare_allocation_units[].count

from-node

capacity.spare_allocation_units[].node.name

storage-pool

NO REST EQUIVALENT

Specify the storage pool uuid for this PATCH request.

to-node

capacity.spare_allocation_units[].node.name

storage-pool-rename

PATCH /api/storage/pools

ONTAPI attribute

REST attribute

Comment

new-name

name

storage-pool

NO REST EQUIVALENT

Specify the storage pool uuid for this PATCH request.

Category: STORAGE-PORT

storage-port-disable

Set enabled to false to disable the port.

PATCH /api/storage/ports/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

force

force

node

node.name

port

name

storage-port-enable

Set enabled to true to enable the port.

PATCH /api/storage/ports/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

node

node.name

port

name

storage-port-info-get

GET /api/storage/ports/{node.uuid}/{name}

ONTAPI attribute

REST attribute

Comment

board-name

board_name

cable-end-id

NO REST EQUIVALENT

cable-identifier

cable.identifier

cable-length

cable.length

connection-mode

NO REST EQUIVALENT

connector-capabilities-array

NO REST EQUIVALENT

connector-part-number

cable.part_number

connector-serial-number

cable.serial_number

connector-technology

NO REST EQUIVALENT

connector-type

NO REST EQUIVALENT

connector-vendor

NO REST EQUIVALENT

corrective-action

error.corrective_action

date-code

NO REST EQUIVALENT

description

description

device-type

NO REST EQUIVALENT

error-severity

NO REST EQUIVALENT

error-text

error.message

error-type

NO REST EQUIVALENT

firmware-rev

firmware_version

is-dedicated

NO REST EQUIVALENT

mac-address

mac_address

mfg-part-number

NO REST EQUIVALENT

mode

mode

node

node.name

nvdata-rev

NO REST EQUIVALENT

part-number

part_number

phys

NO REST EQUIVALENT

port

name

port-speed

speed

port-type

type

ONTAPI port-type → REST API type
SAS → sas
FC → fc
ENET → enet

serial-number

serial_number

state

enabled

ONTAPI State → REST API Enabled
enabled → true
disabled → false

status

state

ONTAPI Status → REST API State
unknown → error
online → online
online_degraded → error
offline → offline
link_down → error

vlan-id

NO REST EQUIVALENT

wwn

wwn

wwn contains ":" in ONTAPI, but not in the REST API call.

wwnn

NO REST EQUIVALENT

wwpn

wwpn

wwpn contains ":" in ONTAPI, but not in the REST API call.

storage-port-info-get-iter

GET /api/storage/ports

ONTAPI attribute

REST attribute

Comment

board-name

board_name

cable-end-id

NO REST EQUIVALENT

cable-identifier

cable.identifier

cable-length

cable.length

connection-mode

NO REST EQUIVALENT

connector-capabilities-array

NO REST EQUIVALENT

connector-part-number

cable.part_number

connector-serial-number

cable.serial_number

connector-technology

NO REST EQUIVALENT

connector-type

NO REST EQUIVALENT

connector-vendor

NO REST EQUIVALENT

corrective-action

error.corrective_action

date-code

NO REST EQUIVALENT

description

description

device-type

NO REST EQUIVALENT

error-severity

NO REST EQUIVALENT

error-text

error.message

error-type

NO REST EQUIVALENT

firmware-rev

firmware_version

is-dedicated

NO REST EQUIVALENT

mac-address

mac_address

mfg-part-number

NO REST EQUIVALENT

mode

mode

node

node.name

nvdata-rev

NO REST EQUIVALENT

part-number

part_number

phys

NO REST EQUIVALENT

port

name

port-speed

speed

port-type

type

ONTAPI port-type → REST API type
SAS → sas
FC → fc
ENET → enet

serial-number

serial_number

state

enabled

ONTAPI State → REST API Enabled
enabled → true
disabled → false

status

state

ONTAPI Status → REST API State
unknown → error
online → online
online_degraded → error
offline → offline
link_down → error

vlan-id

NO REST EQUIVALENT

wwn

wwn

wwn contains ":" in ONTAPI, but not in the REST API call.

wwnn

NO REST EQUIVALENT

wwpn

wwpn

wwpn contains ":" in ONTAPI, but not in the REST API call.

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-port-rescan

This ONTAPI call does not have an equivalent REST API call.

storage-port-reset

This ONTAPI call does not have an equivalent REST API call.

storage-port-reset-device

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-SERVICE

storage-service-get-iter

Storage service is available by using an OPTIONS request on the endpoints that support the use of storage services.

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-SHELF-FIRMWARE

storage-shelf-firmware-file-get-iter

This ONTAPI call does not have an equivalent REST API call.

Category: STORAGE-SHELF

storage-shelf-acp-configure

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-firmware-update

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-firmware-update-info-get

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-firmware-update-info-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-get

GET /api/storage/shelves/{uid}?fields=acps,name

ONTAPI attribute

REST attribute

Comment

address

acps.address

channel

acps.channel

connection-status

acps.connection_state

corrective-action

NO REST EQUIVALENT

error-id

NO REST EQUIVALENT

error-severity

acps.error.severity

error-text

acps.error.reason.message

error-type

acps.error.type

is-enabled

acps.enabled

netmask

acps.netmask

node-name

acps.node.name

port

acps.port

subnet

acps.subnet

node-name

acps.node.name

storage-shelf-acp-module-get

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-acp-module-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-drawer-get

GET /api/storage/shelves/{uid}?fields=drawers,name

ONTAPI attribute

REST attribute

Comment

disk-count

drawers.disk_count

drawer

drawers.id

error

drawers.error

firmware-a

NO REST EQUIVALENT

firmware-b

NO REST EQUIVALENT

fru-type

NO REST EQUIVALENT

is-closed

drawers.closed

is-supported

NO REST EQUIVALENT

mfg-date

NO REST EQUIVALENT

node

NO REST EQUIVALENT

part-number

drawers.part_number

path-a

NO REST EQUIVALENT

path-b

NO REST EQUIVALENT

serial-number

drawers.serial_number

shelf

name

status-a

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

status-b

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

vendor-name

NO REST EQUIVALENT

storage-shelf-drawer-get-iter

GET /api/storage/shelves?fields=drawers,name

ONTAPI attribute

REST attribute

Comment

disk-count

drawers.disk_count

drawer

drawers.id

error

drawers.error

firmware-a

NO REST EQUIVALENT

firmware-b

NO REST EQUIVALENT

fru-type

NO REST EQUIVALENT

is-closed

drawers.closed

is-supported

NO REST EQUIVALENT

mfg-date

NO REST EQUIVALENT

node

NO REST EQUIVALENT

part-number

drawers.part_number

path-a

NO REST EQUIVALENT

path-b

NO REST EQUIVALENT

serial-number

drawers.serial_number

shelf

name

status-a

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

status-b

drawers.state

ONTAPI Status → REST API State
unknown → error
normal → ok
warning → error
error → error
critical → error

vendor-name

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-drawer-phy-get

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-drawer-phy-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-drawer-slot-get

GET /api/storage/shelves?fields=bays,name

ONTAPI attribute

REST attribute

Comment

bay

bays.id

drawer

bays.drawer.id

is-installed

bays.has_disk

shelf

name

slot

bays.drawer.slot

storage-shelf-drawer-slot-get-iter

GET /api/storage/shelves?fields=bays,name

ONTAPI attribute

REST attribute

Comment

bay

bays.id

drawer

bays.drawer.id

is-installed

bays.has_disk

shelf

name

slot

bays.drawer.slot

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-error-list-info

REST API only returns error-text field of ONTAPI

GET /api/storage/shelves

ONTAPI attribute

REST attribute

Comment

shelf-name

name

storage-shelf-firmware-update

This ONTAPI call does not have an equivalent REST API call.

storage-shelf-firmware-update-info-get

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

in-progress-count

nodes.firmware.shelf.in_progress_count

node

nodes.name

update-status

nodes.firmware.shelf.update_status

storage-shelf-firmware-update-info-get-iter

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

in-progress-count

nodes.firmware.shelf.in_progress_count

node

nodes.name

update-status

nodes.firmware.shelf.update_status

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-identify

PATCH /api/storage/shelves/{uid}

ONTAPI attribute

REST attribute

Comment

is-turn-led-on

location_led

ONTAPI is-turn-led-on → REST API location_led
true → on
false → off

shelf

name

Available for GET in the REST API endpoint. For PATCH, specify the shelf’s UID.

storage-shelf-info-get

GET /api/storage/shelves/{uid}

ONTAPI attribute

REST attribute

Comment

boot-devices

NO REST EQUIVALENT

coin-battery

NO REST EQUIVALENT

connection-type

connection_type

cooling-fans

fans

fan-id → fans.id
fan-location → fans.location
fan-rpm → fans.rpm
fan-op-status → fans.state
comment: fan-op-status is simplified to "ok" and "error" in REST

current-sensors

current_sensors

current-sensor-id → current_sensors.id
current-sensor-location → curent_sensors.location
current-sensor-reading → current_sensors.current
current-op-status → current_sensors.state
comment: current-op-status "normal" is changed to "ok" in REST

dimms

NO REST EQUIVALENT

disk-count

disk_count

fc-ports

NO REST EQUIVALENT

is-local-attach

local

module-type

module_type

nsm-ports

NO REST EQUIVALENT

op-status

state

ONTAPI op-status → REST API state
unknown → unknown
normal → ok
warning → error
error → error
critical → error
standby-power → error

paths

paths

controller → paths.node.name
controller-uuid → paths.node.uuid
initiator → paths.name
initiator-side-switch-port → NA
initiator-wwpn → NA
iops → NA
io-kbps → NA
port-speed → NA
target-port → NA
target-side-switch-port → NA
tpgn → NA

power-supply-units

frus

power-supply-units have frus.type of "psu"
psu-crest-factor → frus.psu.crest_factor
psu-fw-version → frus.firmware_version
psu-id → frus.id
psu-is-enabled → frus.installed
psu-location → NA
psu-op-status → frus.state
comment: psu-op-status is simplified to "ok" and "error" in REST
psu-part-number → frus.part_number
psu-power-drawn → frus.psu.power_drawn
psu-power-rating → frus.psu.power_rating
psu-reset-capable → NA
psu-serial-number → frus.serial_number
psu-type → frus.psu.model

sas-ports

NO REST EQUIVALENT

serial-number

serial_number

shelf

name

shelf-bays

bays

bay-id → bays.id
bay-has-disk → bays.has_disk
bay-op-status → bays.state
comment: bay-op-status "normal" is changed to "ok" in REST
bay-type → bays.type

shelf-errors

errors

error-id → NA
error-type → NA
error-severity → NA
shelf-component → NA
component-location → NA
error-text → errors.reason
corrective-action → NA

shelf-id

id

shelf-model

model

shelf-modules

frus

shelf-modules have frus.type of "module"
es-serial-number → frus.serial_number
is-sas-master-module → NA
is-monitor-active → NA
module-fru-id → NA
module-fw-progress → NA
module-fw-revision → frus.firmware_version
module-id → frus.id
comment: module-id ("A" or "B") is converted to 0 or 1 in REST
module-is-reporting-element → NA
module-latest-fw-revision → NA
module-location → NA
module-op-status → frus.state
comment: module-op-status is simplified to "ok" and "error" in REST
module-part-number → frus.part_number
module-swap-count → NA
module-type → NA

shelf-uid

NO REST EQUIVALENT

stack-id

NO REST EQUIVALENT

state

NO REST EQUIVALENT

temperature-sensors

temperature_sensors

temp-sensor-id → temperature_sensors.id
temp-sensor-location → temperature_sensors.location
temp-sensor-reading → temperature_sensors.temperature
temp-is-ambient → temperature_sensors.ambient
temp-high-critical-threshold → temperature_sensors.threshold.high.critical
temp-high-warning-threshold → temperature_sensors.threshold.high.warning
temp-low-critical-threshold → temperature_sensors.threshold.low.critical
temp-low-warning-threshold → temperature_sensors.threshold.low.warning
temp-op-status → temperature_sensors.state
comment: temp-op-status "normal" is changed to "ok" in REST

vendor-name

manufacturer.name

voltage-sensors

voltage_sensors

voltage-sensor-id → voltage_sensors.id
voltage-sensor-location → voltage_sensors.location
voltage-sensor-reading → voltage_sensors.voltage
voltage-op-status → voltage_sensors.state
comment: voltage-op-status "normal" is changed to "ok" in REST

storage-shelf-info-get-iter

GET /api/storage/shelves

ONTAPI attribute

REST attribute

Comment

boot-devices

NO REST EQUIVALENT

coin-battery

NO REST EQUIVALENT

connection-type

connection_type

cooling-fans

fans

fan-id → fans.id
fan-location → fans.location
fan-rpm → fans.rpm
fan-op-status → fans.state
comment: fan-op-status is simplified to "ok" and "error" in REST

current-sensors

current_sensors

current-sensor-id → current_sensors.id
current-sensor-location → curent_sensors.location
current-sensor-reading → current_sensors.current
current-op-status → current_sensors.state
comment: current-op-status "normal" is changed to "ok" in REST

dimms

NO REST EQUIVALENT

disk-count

disk_count

fc-ports

NO REST EQUIVALENT

is-local-attach

local

module-type

module_type

nsm-ports

NO REST EQUIVALENT

op-status

state

ONTAPI op-status → REST API state
unknown → unknown
normal → ok
warning → error
error → error
critical → error
standby-power → error

paths

paths

controller → paths.node.name
controller-uuid → paths.node.uuid
initiator → paths.name
initiator-side-switch-port → NA
initiator-wwpn → NA
iops → NA
io-kbps → NA
port-speed → NA
target-port → NA
target-side-switch-port → NA
tpgn → NA

power-supply-units

frus

power-supply-units have frus.type of "psu"
psu-crest-factor → frus.psu.crest_factor
psu-fw-version → frus.firmware_version
psu-id → frus.id
psu-is-enabled → frus.installed
psu-location → NA
psu-op-status → frus.state
comment: psu-op-status is simplified to "ok" and "error" in REST
psu-part-number → frus.part_number
psu-power-drawn → frus.psu.power_drawn
psu-power-rating → frus.psu.power_rating
psu-reset-capable → NA
psu-serial-number → frus.serial_number
psu-type → frus.psu.model

sas-ports

NO REST EQUIVALENT

serial-number

serial_number

shelf

name

shelf-bays

bays

bay-id → bays.id
bay-has-disk → bays.has_disk
bay-op-status → bays.state
comment: bay-op-status "normal" is changed to "ok" in REST
bay-type → bays.type

shelf-errors

errors

error-id → NA
error-type → NA
error-severity → NA
shelf-component → NA
component-location → NA
error-text → errors.reason
corrective-action → NA

shelf-id

id

shelf-model

model

shelf-modules

frus

shelf-modules have frus.type of "module"
es-serial-number → frus.serial_number
is-sas-master-module → NA
is-monitor-active → NA
module-fru-id → NA
module-fw-progress → NA
module-fw-revision → frus.firmware_version
module-id → frus.id
comment: module-id ("A" or "B") is converted to 0 or 1 in REST
module-is-reporting-element → NA
module-latest-fw-revision → NA
module-location → NA
module-op-status → frus.state
comment: module-op-status is simplified to "ok" and "error" in REST
module-part-number → frus.part_number
module-swap-count → NA
module-type → NA

shelf-uid

NO REST EQUIVALENT

stack-id

NO REST EQUIVALENT

state

NO REST EQUIVALENT

temperature-sensors

temperature_sensors

temp-sensor-id → temperature_sensors.id
temp-sensor-location → temperature_sensors.location
temp-sensor-reading → temperature_sensors.temperature
temp-is-ambient → temperature_sensors.ambient
temp-high-critical-threshold → temperature_sensors.threshold.high.critical
temp-high-warning-threshold → temperature_sensors.threshold.high.warning
temp-low-critical-threshold → temperature_sensors.threshold.low.critical
temp-low-warning-threshold → temperature_sensors.threshold.low.warning
temp-op-status → temperature_sensors.state
comment: temp-op-status "normal" is changed to "ok" in REST

vendor-name

manufacturer.name

voltage-sensors

voltage_sensors

voltage-sensor-id → voltage_sensors.id
voltage-sensor-location → voltage_sensors.location
voltage-sensor-reading → voltage_sensors.voltage
voltage-op-status → voltage_sensors.state
comment: voltage-op-status "normal" is changed to "ok" in REST

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-location-led-get

GET /api/storage/shelves/{uid}?fields=location_led,name,id

ONTAPI attribute

REST attribute

Comment

led-status

location_led

shelf-id

id

shelf-name

name

stack-id

NO REST EQUIVALENT

storage-shelf-location-led-get-iter

GET /api/storage/shelves?fields=location_led,name,id

ONTAPI attribute

REST attribute

Comment

led-status

location_led

shelf-id

id

shelf-name

name

stack-id

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

storage-shelf-location-led-modify

PATCH /api/storage/shelves/{uid}

ONTAPI attribute

REST attribute

Comment

led-status

location_led

shelf-name

name

Available for GET in the REST API endpoint. For PATCH, specify the shelf’s UID.

storage-shelf-location-led-modify-iter

PATCH /api/storage/shelves/{uid}

ONTAPI attribute

REST attribute

Comment

led-status

location_led

shelf-id

id

Available for GET in the REST API endpoint. For PATCH, specify the shelf’s UID.

shelf-name

name

Available for GET in the REST API endpoint. For PATCH, specify the shelf’s UID.

stack-id

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

storage-shelf-port-get-iter

GET /api/storage/shelves?fields=ports,name

ONTAPI attribute

REST attribute

Comment

cable-end

NO REST EQUIVALENT

cable-id

ports.cable.identifier

cable-length

ports.cable.length

cable-part-number

ports.cable.part_number

cable-technology

NO REST EQUIVALENT

cable-vendor

NO REST EQUIVALENT

connector-serial-number

ports.cable.serial_number

connector-state

ports.state

connector-type

NO REST EQUIVALENT

designator

ports.designator

ONTAPI designator → REST API designator
cir → circle
sqr → square
(other) → (no change)

id

ports.id

is-cable-connected

NO REST EQUIVALENT

is-error

NO REST EQUIVALENT

is-internal

ports.internal

location

NO REST EQUIVALENT

mac

ports.mac_address

module-id

ports.module_id

remote-chassis

ports.remote.chassis

remote-device

ports.remote.device

remote-mac

ports.remote.mac_address

remote-phy

ports.remote.phy

remote-port

ports.remote.port

remote-wwn

ports.remote.wwn

shelf

name

swap-count

NO REST EQUIVALENT

wwn

ports.wwn

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: STORAGE-SWITCH

storage-switch-get

GET /api/storage/switches/{name}

ONTAPI attribute

REST attribute

Comment

blades

blades

domain-id

domain_id

fabric-name

fabric_name

firmware-version

firmware_version

ip-address

ip_address

is-director-class

director_class

is-local-attach

local

is-monitoring-enabled

monitoring_enabled

model

model

name

name

role

role

status

state

storage-switch-connectivity-list

connections

storage-switch-error-list

errors

storage-switch-fan-list

fans

storage-switch-path-list

paths

storage-switch-port-list

ports

storage-switch-port-statistics-list

NO REST EQUIVALENT

storage-switch-power-supply-unit-list

power_supply_units

storage-switch-sfp-list

ports.sfp

storage-switch-temperature-sensor-list

temperature_sensors

storage-switch-vsan-list

vsans

storage-switch-zone-list

zones

symbolic-name

symbolic_name

vendor

vendor

wwn

wwn

storage-switch-get-iter

GET /api/storage/switches

ONTAPI attribute

REST attribute

Comment

blades

blades

domain-id

domain_id

fabric-name

fabric_name

firmware-version

firmware_version

ip-address

ip_address

is-director-class

director_class

is-local-attach

local

is-monitoring-enabled

monitoring_enabled

model

model

name

name

role

role

status

state

storage-switch-connectivity-list

connections

storage-switch-error-list

errors

storage-switch-fan-list

fans

storage-switch-path-list

paths

storage-switch-port-list

ports

storage-switch-port-statistics-list

NO REST EQUIVALENT

storage-switch-power-supply-unit-list

power_supply_units

storage-switch-sfp-list

ports.sfp

storage-switch-temperature-sensor-list

temperature_sensors

storage-switch-vsan-list

vsans

storage-switch-zone-list

zones

symbolic-name

symbolic_name

vendor

vendor

wwn

wwn

max-records

max_records

Specifies the maximum number of records to return before paging.

Category: STORAGE-TRANSITION

storage-transition-aggregates-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-transition-commit-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-transition-pre-commit-begin

This ONTAPI call does not have an equivalent REST API call.

storage-transition-pre-commit-end

This ONTAPI call does not have an equivalent REST API call.

storage-transition-pre-commit-get

This ONTAPI call does not have an equivalent REST API call.

storage-transition-pre-commit-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-transition-purge-info

This ONTAPI call does not have an equivalent REST API call.

storage-transition-revert-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-transition-volumes-get-iter

This ONTAPI call does not have an equivalent REST API call.

storage-transition-aggregates-start

This ONTAPI call does not have an equivalent REST API call.

storage-transition-volumes-start

This ONTAPI call does not have an equivalent REST API call.

storage-transition-commit-start

This ONTAPI call does not have an equivalent REST API call.

storage-transition-revert-start

This ONTAPI call does not have an equivalent REST API call.

Category: SYSTEM

external-cache-dumplog

This ONTAPI call does not have an equivalent REST API call.

external-cache-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

is-enabled

external_cache.is_enabled

is-hya-enabled

external_cache.is_hya_enabled

is-rewarm-enabled

external_cache.is_rewarm_enabled

node

name

pcs-size

external_cache.pcs_size

external-cache-modify

This ONTAPI call does not have an equivalent REST API call.

external-cache-reconstruct

This ONTAPI call does not have an equivalent REST API call.

external-cache-reset

This ONTAPI call does not have an equivalent REST API call.

external-cache-snapshot

This ONTAPI call does not have an equivalent REST API call.

system-api-change-get-iter

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-api-get-elements

This ONTAPI call does not have an equivalent REST API call.

system-api-list

This ONTAPI call does not have an equivalent REST API call.

system-api-list-types

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-disable

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-enable

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-get

This ONTAPI call does not have an equivalent REST API call.

system-cache-mirror-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-get-node-info-iter

Retrieve the nodes in the cluster.

GET /api/cluster/nodes

ONTAPI attribute

REST attribute

Comment

backplane-part-number

NO REST EQUIVALENT

backplane-revision

NO REST EQUIVALENT

backplane-serial-number

NO REST EQUIVALENT

board-speed

NO REST EQUIVALENT

board-type

controller.board

Type of the system board. This is defined by the vendor.

controller-address

NO REST EQUIVALENT

cpu-firmware-release

controller.cpu.firmware_release

Firmware release number. Defined by the CPU manufacturer.

cpu-microcode-version

NO REST EQUIVALENT

cpu-part-number

NO REST EQUIVALENT

cpu-processor-id

NO REST EQUIVALENT

cpu-processor-type

controller.cpu.processor

CPU type on the node.

cpu-revision

NO REST EQUIVALENT

cpu-serial-number

NO REST EQUIVALENT

maximum-aggregate-size

NO REST EQUIVALENT

maximum-flexible-volume-count

NO REST EQUIVALENT

maximum-flexible-volume-size

NO REST EQUIVALENT

memory-size

controller.memory_size

Memory available on the node, in bytes.

number-of-processors

controller.cpu.count

Number of CPUs on the node.

partner-system-id

ha.partners.uuid

Partner system-id

partner-system-name

ha.partners.name

Partner system-name

partner-system-serial-number

NO REST EQUIVALENT

prod-type

NO REST EQUIVALENT

storage-configuration

storage_configuration

supports-raid-array

NO REST EQUIVALENT

system-id

system_id

system-machine-type

system_machine_type

OEM system machine type.

system-model

model

system-name

name

system-revision

version

system-serial-number

serial_number

vendor-data1

vendor_serial_number

OEM vendor serial number.

vendor-data2

NO REST EQUIVALENT

vendor-data3

NO REST EQUIVALENT

vendor-id

NO REST EQUIVALENT

vm-system-disks

NO REST EQUIVALENT

vmhost-info

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

system-get-ontapi-version

This ONTAPI call does not have an equivalent REST API call.

system-get-vendor-info

This ONTAPI call does not have an equivalent REST API call.

system-get-version

GET /api/cluster/nodes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

build-timestamp

version.full

version

version.full

is-clustered

NO REST EQUIVALENT

node-version-details

version

node-version-detail-info.build-timestamp → version.full
node-version-detail-info.node-name → name
node-version-detail-info.node-uuid → uuid
node-version-detail-info.version → version.full

version-tuple

version

version → version.full
system-version-tuple.generation → version.generation
system-version-tuple.major → version.major
system-version-tuple.minor → version.minor

system-hypervisor-host-config-create

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-destroy

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-get

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-host-config-modify

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-create

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-destroy

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-get

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-hypervisor-snmpv3-config-modify

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

This ONTAPI call does not have an equivalent REST API call.

system-image-external-package-delete

This ONTAPI call does not have an equivalent REST API call.

system-image-external-package-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-image-fetch-package

This ONTAPI call does not have an equivalent REST API call.

system-image-get-iter

GET /api/cluster/software/packages

ONTAPI attribute

REST attribute

Comment

image

NO REST EQUIVALENT

install-time

NO REST EQUIVALENT

is-current

NO REST EQUIVALENT

is-default

NO REST EQUIVALENT

kernel-path

NO REST EQUIVALENT

node

NO REST EQUIVALENT

rootfs-path

NO REST EQUIVALENT

version

version

max-records

max_records

Specifies the maximum number of records to return before paging.

system-image-modify

This ONTAPI call does not have an equivalent REST API call.

system-image-package-delete

This ONTAPI call does not have an equivalent REST API call.

system-image-package-get-iter

GET /api/cluster/software

ONTAPI attribute

REST attribute

Comment

node

nodes.name

package

nodes.sw_images.package

max-records

max_records

Specifies the maximum number of records to return before paging.

system-image-update

This ONTAPI call does not have an equivalent REST API call.

system-image-update-get-abort

This ONTAPI call does not have an equivalent REST API call.

system-image-update-progress-get

This ONTAPI call does not have an equivalent REST API call.

system-netconsole-get

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-netconsole-modify

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-node-discovery-get-iter

A query for nodes with available membership returns the discovered nodes that are not included by default.

GET /api/cluster/nodes?membership=available

ONTAPI attribute

REST attribute

Comment

cluster-ip-addresses

cluster_interfaces.ip

cluster-name

NO REST EQUIVALENT

cluster-netmask

NO REST EQUIVALENT

cluster-uuid

NO REST EQUIVALENT

is-node-in-cluster

membership

node

name

node-model

model

node-nvram-id

nvram.id

Vendor specific NVRAM ID of the node.

node-serial-number

serial_number

partner-nvram-id

NO REST EQUIVALENT

version

version

max-records

NO REST EQUIVALENT

system-node-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

cpu-busytime

NO REST EQUIVALENT

cpu-firmware-release

controller.cpu.firmware_release

Firmware release number. Defined by the CPU manufacturer.

env-failed-fan-count

controller.failed_fan.count

Specifies a count of the number of chassis fans that are not operating within the recommended RPM range.

env-failed-fan-message

controller.failed_fan.message

Message describing the current condition of chassis fans. It is only of use when "failed_fan.count" is not zero.

env-failed-power-supply-count

controller.failed_power_supply.count

Number of failed power supply units.

env-failed-power-supply-message

controller.failed_power_supply.message

Message describing the state of any power supplies that are currently degraded. It is only of use when "failed_power_supply.count" is not zero.

env-over-temperature

controller.over_temperature

Specifies whether the hardware is currently operating outside of its recommended temperature range. The hardware shuts down if the temperature exceeds critical thresholds.

is-all-flash-optimized

is_all_flash_optimized

Specifies whether node is All-Flash Optimized.

is-all-flash-select-optimized

is_all_flash_select_optimized

Specifies whether node is All-Flash Select Optimized.

is-capacity-optimized

is_capacity_optimized

Specifies whether node is Capacity Optimized.

is-cloud-optimized

NO REST EQUIVALENT

is-diff-svcs

NO REST EQUIVALENT

is-epsilon-node

NO REST EQUIVALENT

is-node-cluster-eligible

NO REST EQUIVALENT

is-node-healthy

state

State of the node:
unknown - Node or its HA partner cannot be contacted and there is no information on the node’s state
down - Node has stopped or is dumping core
booting - Node is booting up
up - Node is up and operational
waiting_for_giveback - Node has been taken over by its HA partner and is waiting for the HA partner to giveback disks
taken_over - Node has been taken over by its HA partner and is not yet waiting for giveback
degraded - Node has one or more critical services offline

is-perf-optimized

is_performance_optimized

Specifies whether node is performance optimized

maximum-aggregate-size

NO REST EQUIVALENT

maximum-number-of-volumes

NO REST EQUIVALENT

maximum-volume-size

NO REST EQUIVALENT

node

name

node-asset-tag

NO REST EQUIVALENT

node-location

location

node-model

model

node-nvram-id

nvram.id

Vendor specific NVRAM ID of the node.

node-owner

owner

node-serial-number

serial_number

node-storage-configuration

storage_configuration

node-system-id

system_id

node-uptime

uptime

The total time, in seconds, that the node has been up.

node-uuid

uuid

node-vendor

NO REST EQUIVALENT

NA

nvram-battery-status

nvram.battery_state

product-version

version

sas2-sas3-mixed-stack-support

NO REST EQUIVALENT

vm-system-disks

NO REST EQUIVALENT

vmhost-info

vm.provider_type

The cloud provider where the VM is hosted.

system-node-get-iter

GET /api/cluster/nodes

ONTAPI attribute

REST attribute

Comment

cpu-busytime

NO REST EQUIVALENT

cpu-firmware-release

controller.cpu.firmware_release

Firmware release number. Defined by the CPU manufacturer.

env-failed-fan-count

controller.failed_fan.count

Specifies a count of the number of chassis fans that are not operating within the recommended RPM range.

env-failed-fan-message

controller.failed_fan.message

Message describing the current condition of chassis fans. It is only of use when "failed_fan.count" is not zero.

env-failed-power-supply-count

controller.failed_power_supply.count

Number of failed power supply units.

env-failed-power-supply-message

controller.failed_power_supply.message

Message describing the state of any power supplies that are currently degraded. It is only of use when "failed_power_supply.count" is not zero.

env-over-temperature

controller.over_temperature

Specifies whether the hardware is currently operating outside of its recommended temperature range. The hardware shuts down if the temperature exceeds critical thresholds.

is-all-flash-optimized

is_all_flash_optimized

Specifies whether node is All-Flash Optimized.

is-all-flash-select-optimized

is_all_flash_select_optimized

Specifies whether node is All-Flash Select Optimized.

is-capacity-optimized

is_capacity_optimized

Specifies whether node is Capacity Optimized.

is-cloud-optimized

NO REST EQUIVALENT

is-diff-svcs

NO REST EQUIVALENT

is-epsilon-node

NO REST EQUIVALENT

is-node-cluster-eligible

NO REST EQUIVALENT

is-node-healthy

state

State of the node:
unknown - Node or its HA partner cannot be contacted and there is no information on the node’s state
down - Node has stopped or is dumping core
booting - Node is booting up
up - Node is up and operational
waiting_for_giveback - Node has been taken over by its HA partner and is waiting for the HA partner to giveback disks
taken_over - Node has been taken over by its HA partner and is not yet waiting for giveback
degraded - Node has one or more critical services offline

is-perf-optimized

is_performance_optimized

Specifies whether node is performance optimized

maximum-aggregate-size

NO REST EQUIVALENT

maximum-number-of-volumes

NO REST EQUIVALENT

maximum-volume-size

NO REST EQUIVALENT

node

name

node-asset-tag

NO REST EQUIVALENT

node-location

location

node-model

model

node-nvram-id

nvram.id

node-owner

owner

node-serial-number

serial_number

node-storage-configuration

storage_configuration

node-system-id

system_id

node-uptime

uptime

The total time, in seconds, that the node has been up.

node-uuid

uuid

node-vendor

vendor_serial_number

OEM vendor serial number.

nvram-battery-status

nvram.battery_state

product-version

version

sas2-sas3-mixed-stack-support

NO REST EQUIVALENT

vm-system-disks

NO REST EQUIVALENT

vmhost-info

vm.provider_type

The cloud provider where the VM is hosted.

max-records

max_records

Specifies the maximum number of records to return before paging.

system-node-modify

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

is-diff-svcs

NO REST EQUIVALENT

node

name

node-asset-tag

NO REST EQUIVALENT

node-location

location

node-owner

owner

system-node-power-cycle

This ONTAPI call does not have an equivalent REST API call.

system-node-power-get

GET /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

node

name

The target node.

status

state

node

NO REST EQUIVALENT

The requesting node is the one that the GET call was made to.

system-node-power-off

Pass "power_off" to the "action" parameter to perform an SP assisted shutdown of the node.

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

node

name

system-node-power-on

Pass "power_on" to the "action" parameter to perform an SP assisted power on of the node.

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

node

name

system-node-reboot

Passing "reboot" to the "action" parameter, reboots the node and transfers storage control to its HA group if storage failover is enabled.

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

ignore-quorum-warnings

NO REST EQUIVALENT

ignore-strict-sync-warnings

NO REST EQUIVALENT

is-dump

NO REST EQUIVALENT

is-inhibit-takeover

allow_data_outage

This only applies when you provide an action of reboot or shutdown. It allows storage failover to be bypassed along with any failures related to maintaining quorum in the cluster.

is-skip-lif-migration-before-reboot

NO REST EQUIVALENT

node

uuid

reason

shutdown_reboot_reason

The reason for the reboot or shutdown. This only applies when you provide an action of reboot or shutdown.

system-node-rename

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

new-name

name

node

name

Part of the query: Ex. ?name=node1

system-node-reset

This ONTAPI call does not have an equivalent REST API call.

system-node-revert-to

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-node-shutdown

Passing "shutdown" to the "action" parameter, shuts the node down and transfers storage control to its HA group if storage failover is enabled.

PATCH /api/cluster/nodes/{uuid}

ONTAPI attribute

REST attribute

Comment

ignore-quorum-warnings

NO REST EQUIVALENT

ignore-strict-sync-warnings

NO REST EQUIVALENT

is-dump

NO REST EQUIVALENT

is-inhibit-takeover

allow_data_outage

This only applies when you provide an action of reboot or shutdown. It allows storage failover to be bypassed along with any failures related to maintaining quorum in the cluster.

is-skip-lif-migration-before-shutdown

NO REST EQUIVALENT

node

name

reason

shutdown_reboot_reason

The reason for the reboot or shutdown. This only applies when you provide an action of reboot or shutdown.

system-ontapi-limits-get

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-ontapi-limits-set

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-config-get

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-config-modify

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-delete-file

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-get

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-get-iter

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-get-total-records

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-services-web-file-uploads-move-file

This ONTAPI call does not have an equivalent REST API call.

system-services-web-get

GET /api/cluster/web

ONTAPI attribute

REST attribute

Comment

csrf-protection-enabled

csrf.protection_enabled

Indicates whether CSRF protection is enabled.

csrf-token-absolute-timeout

csrf.token.max_timeout

Time for which an unused CSRF token, regardless of usage is retained, in seconds.

csrf-token-concurrent-limit

csrf.token.concurrent_limit

Maximum number of concurrent CSRF tokens.

csrf-token-idle-timeout

csrf.token.idle_timeout

Time for which an unused CSRF token is retained, in seconds.

external

enabled

Indicates whether remote clients can connect to the web services.

http-enabled

http_enabled

Indicates whether HTTP is enabled.

http-port

http_port

HTTP port for cluster-level web services.

https-port

https_port

HTTPS port for cluster-level web services.

per-address-limit

per_address_limit

The number of connections that can be processed concurrently from the same remote address.

ssl-fips-enabled

NO REST EQUIVALENT

See "fips.enabled" in GET /api/security.

sslv3-enabled

NO REST EQUIVALENT

See "tls.protocol_versions" in GET /api/security.

status

state

State of the cluster-level web services.

tlsv1-enabled

NO REST EQUIVALENT

See "tls.protocol_versions" in GET /api/security.

wait-queue-capacity

wait_queue_capacity

The maximum size of the wait queue for connection exceeding the per-address-limit.

system-services-web-node-get

This ONTAPI call does not have an equivalent REST API call.

system-services-web-node-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-status-hypervisor-get

This ONTAPI call does not have an equivalent REST API call.

system-status-hypervisor-modify

This ONTAPI call does not have an equivalent REST API call.

system-status-restart-restart-service

This ONTAPI call does not have an equivalent REST API call.

system-status-service-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-user-capability-get-iter

This ONTAPI call does not have an equivalent REST API call.

system-zapi-quarantine-queue-stats-get

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-zapi-quarantine-queue-stats-get-iter

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-counts-get

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-counts-get-iter

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-times-get

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-zapi-queue-times-get-iter

This is an unsupported ONTAPI operation.

This ONTAPI call does not have an equivalent REST API call.

system-cli

This is a special generic call, where it can take any valid resource endpoint and method. Refer to the "Using the private CLI passthrough with the ONTAP REST API" section of the Swagger UI for more information. Example:
In order to see all the volumes: vol show using this API call:

curl -iku admin:<password> "https://<ip-address>/api/private/cli/volume"

GET|POST|PATCH|DELETE /api/private/cli/?

ONTAPI attribute

REST attribute

Comment

privilege_level

NO REST EQUIVALENT

The REST API privileges/login needed (for example, admin) — see example

args

NO REST EQUIVALENT

Arguments are passed into the REST API as part of the path or body depending on the verb — see the REST API documentation for clarification. The example shown is passing as part of the path.

Category: TAPE-MC-INFO

tape-mc-get

GET /api/storage/tape-devices/{node.uuid}/{device_id}

ONTAPI attribute

REST attribute

Comment

alias-mapping

aliases.mapping

alias-name

aliases.name

block-number

block_number

density-formats

formats

description

description

device-id

device_id

device-if-type

interface

device-names

device_names

device-state

device_state

device-type

type

error

NO REST EQUIVALENT

file-number

file_number

functional-status

NO REST EQUIVALENT

initiator

storage_port.name

residual-count

residual_count

resv-type

reservation_type

serial-number

serial_number

wwnn

wwnn

wwnn contains ":" in ONTAPI, but not in the REST API.

wwpn

wwpn

wwpn contains ":" in ONTAPI, but not in the REST API.

node-name

node.name

tape-mc-get-iter

GET /api/storage/tape-devices

ONTAPI attribute

REST attribute

Comment

alias-mapping

aliases.mapping

alias-name

aliases.name

block-number

block_number

density-formats

formats

description

description

device-id

device_id

device-if-type

interface

device-names

device_names

device-state

device_state

device-type

type

error

NO REST EQUIVALENT

file-number

file_number

functional-status

NO REST EQUIVALENT

initiator

storage_port.name

node-name

node.name

residual-count

residual_count

resv-type

reservation_type

serial-number

serial_number

wwnn

wwnn

wwnn contains ":" in ONTAPI, but not in the REST API.

wwpn

wwpn

wwpn contains ":" in ONTAPI, but not in the REST API.

max-records

max_records

Specifies the maximum number of records to return before paging.

tape-mc-info-alias-clear

PATCH /api/storage/tape-devices/{node.uuid}/{device_id}

ONTAPI attribute

REST attribute

Comment

clear-scope

NO REST EQUIVALENT

name

aliases.name

Remove the alias from aliases.name to clear it.

node-name

node.name

tape-mc-info-alias-set

PATCH /api/storage/tape-devices/{node.uuid}/{device_id}

ONTAPI attribute

REST attribute

Comment

mapping

NO REST EQUIVALENT

name

aliases.name

Add the alias to aliases.name.

node-name

node.name

tape-mc-info-offline

Set online to false to take the tape device offline.

PATCH /api/storage/tape-devices/{node.uuid}/{device_id}

ONTAPI attribute

REST attribute

Comment

device-id

device_id

device-name

NO REST EQUIVALENT

node-name

node.name

tape-mc-info-online

Set online to true to bring the tape device online.

PATCH /api/storage/tape-devices/{node.uuid}/{device_id}

ONTAPI attribute

REST attribute

Comment

device-id

device_id

device-name

NO REST EQUIVALENT

node-name

node.name

tape-mc-info-position

PATCH /api/storage/tape-devices/{node.uuid}/{device_id}

ONTAPI attribute

REST attribute

Comment

count

position.count

device-name

NO REST EQUIVALENT

The no-rewind device name with the current density is used.

node-name

node.name

operation

position.operation

tape-mc-info-reset

This ONTAPI call does not have an equivalent REST API call.

tape-mc-info-test-release

This ONTAPI call does not have an equivalent REST API call.

tape-mc-info-test-reserve

This ONTAPI call does not have an equivalent REST API call.

tape-mc-info-trace

This ONTAPI call does not have an equivalent REST API call.

Category: TEMPLATE-MANAGEMENT

template-management-choices-get

Available through the REST API by using the CLI passthrough.

GET /api/private/cli/template/get-choices

ONTAPI attribute

REST attribute

Comment

attribute

NO REST EQUIVALENT

choices

NO REST EQUIVALENT

default-val

NO REST EQUIVALENT

descriptions

NO REST EQUIVALENT

object

NO REST EQUIVALENT

object

NO REST EQUIVALENT

template-management-template-copy

This ONTAPI call does not have an equivalent REST API call.

template-management-template-delete

This ONTAPI call does not have an equivalent REST API call.

template-management-template-download

This ONTAPI call does not have an equivalent REST API call.

template-management-template-get

This ONTAPI call does not have an equivalent REST API call.

template-management-template-get-iter

Available through the REST API by using the CLI passthrough.

GET /api/private/cli/template

ONTAPI attribute

REST attribute

Comment

description

NO REST EQUIVALENT

missing-prerequisites

NO REST EQUIVALENT

name

NO REST EQUIVALENT

parent-template

NO REST EQUIVALENT

permission

NO REST EQUIVALENT

uuid

NO REST EQUIVALENT

version

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

template-management-template-parameter-get

This ONTAPI call does not have an equivalent REST API call.

template-management-template-parameter-get-iter

This ONTAPI call does not have an equivalent REST API call.

template-management-template-parameter-modify

This ONTAPI call does not have an equivalent REST API call.

template-management-template-parameter-modify-iter

This ONTAPI call does not have an equivalent REST API call.

template-management-template-provision

Create and configure the SVM with data access protocols, data and management interfaces, and service configurations using template provision.

POST /api/svm/svms

ONTAPI attribute

REST attribute

Comment

custom-inputs

NO REST EQUIVALENT

template

NO REST EQUIVALENT

template-management-template-provision-error-clean

Available through the REST API by using the CLI passthrough.

POST /api/private/cli/template/clean-error

ONTAPI attribute

REST attribute

Comment

jobid

NO REST EQUIVALENT

template-management-template-provision-error-get

Available through the REST API by using the CLI passthrough.

GET /api/private/cli/template/show-provision-error

ONTAPI attribute

REST attribute

Comment

failure-errornum

NO REST EQUIVALENT

failure-reason

NO REST EQUIVALENT

input-params

NO REST EQUIVALENT

jobid

NO REST EQUIVALENT

jobid

NO REST EQUIVALENT

template-management-template-read

This ONTAPI call does not have an equivalent REST API call.

template-management-template-refresh

This ONTAPI call does not have an equivalent REST API call.

template-management-template-rename

This ONTAPI call does not have an equivalent REST API call.

template-management-template-upload

This ONTAPI call does not have an equivalent REST API call.

Category: UCM

ucm-adapter-get

This ONTAPI call does not have an equivalent REST API call.

ucm-adapter-get-iter

This ONTAPI call does not have an equivalent REST API call.

ucm-adapter-modify

This ONTAPI call does not have an equivalent REST API call.

Category: VIRTUAL-MACHINE

virtual-machine-get-info

GET /api/cluster/nodes

ONTAPI attribute

REST attribute

Comment

account-id

NO REST EQUIVALENT

automatic-restart

NO REST EQUIVALENT

availability-zone

NO REST EQUIVALENT

cpu-platform

NO REST EQUIVALENT

fault-domain

NO REST EQUIVALENT

image-id

NO REST EQUIVALENT

instance-id

NO REST EQUIVALENT

instance-type

NO REST EQUIVALENT

node

NO REST EQUIVALENT

offer

NO REST EQUIVALENT

on-host-maintenance

NO REST EQUIVALENT

primary-ip

NO REST EQUIVALENT

provider

vm.provider_type

region

NO REST EQUIVALENT

resource-group-name

NO REST EQUIVALENT

sku

NO REST EQUIVALENT

sku-version

NO REST EQUIVALENT

update-domain

NO REST EQUIVALENT

version

NO REST EQUIVALENT

node

NO REST EQUIVALENT

virtual-machine-maintenance-event-acknowlege

This ONTAPI call does not have an equivalent REST API call.

virtual-machine-maintenance-event-get

This ONTAPI call does not have an equivalent REST API call.

virtual-machine-maintenance-event-get-iter

This ONTAPI call does not have an equivalent REST API call.

virtual-machine-system-disks-get-iter

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-create

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-destroy

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-dns-cache-create

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-dns-cache-destroy

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-dns-cache-get-iter

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-dns-cache-modify

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-get-iter

This ONTAPI call does not have an equivalent REST API call.

vm-disk-object-store-modify

This ONTAPI call does not have an equivalent REST API call.

vm-network-load-balancer-get-iter

This ONTAPI call does not have an equivalent REST API call.

Category: VMSERVICES

vmservices-vsphere-credential-check

This ONTAPI call does not have an equivalent REST API call.

vmservices-vsphere-credential-get

This ONTAPI call does not have an equivalent REST API call.

vmservices-vsphere-credential-modify

This ONTAPI call does not have an equivalent REST API call.

Category: VOLUME

volume-aggregate-vacate-async

This is a deprecated zapi.

This ONTAPI call does not have an equivalent REST API call.

volume-autobalance-get

This is a deprecated zapi.

This ONTAPI call does not have an equivalent REST API call.

volume-autobalance-get-iter

This is a deprecated zapi.

This ONTAPI call does not have an equivalent REST API call.

volume-autobalance-start

This is a deprecated zapi.

This ONTAPI call does not have an equivalent REST API call.

volume-autobalance-stop

This is a deprecated zapi.

This ONTAPI call does not have an equivalent REST API call.

volume-autosize-get

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

name

volume-autosize-set

PATCH /api/storage/volumes/{uuid} vicon.png

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} vicon.png

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 vicon.png

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

The URL uses volume instance-uuid

GET /api/storage/volumes/{uuid} vicon.png

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 vicon.png

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

NA

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

In the REST API, the result is mapped to clone.split_estimate in the response.

GET /api/storage/volumes?clone.is_flexclone=true&fields=clone vicon.png

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

Set the "clone.split_initiated" field to "true" to start the volume clone split operation. The URL uses volume instance-uuid.

PATCH /api/storage/volumes/{uuid} vicon.png

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

In the REST API, the result is mapped to clone.split_complete_percent in the response.

GET /api/storage/volumes?clone.is_flexclone=true&fields=clone vicon.png

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

Set the "clone.split_initiated" field to "false" to stop the volume clone split operation. The URL uses volume instance-uuid.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

vserver

NO REST EQUIVALENT

flexclone

NO REST EQUIVALENT

volume-container

The response from this REST API call will contain information about the aggregate.

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

name

volume-create

POST /api/storage/volumes vicon.png

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 vicon.png

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} vicon.png

ONTAPI attribute

REST attribute

Comment

name

name

unmount-and-offline

NO REST EQUIVALENT

volume-destroy-async

DELETE /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

unmount-and-offline

NO REST EQUIVALENT

volume-name

name

volume-encryption-conversion-get-iter

GET /api/storage/volumes vicon.png

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

Set the "encryption.enabled" field to "true" to start the encryption conversion operation.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

volume-encryption-rekey-get-iter

GET /api/storage/volumes vicon.png

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

Set the "encryption.rekey" field to "true" to start the encryption rekey operation.

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

volume-expand-async

For you to modify the size of the FlexGroup, the sizing_method query parameter must be set to "add_new_resources".

PATCH /api/storage/volumes/{uuid} vicon.png

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 vicon.png

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

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.

POST /api/storage/volumes vicon.png

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} vicon.png

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 vicon.png

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

The response from this REST API call will contain information about the language attribute.

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume

name

volume-get-root-name

GET /api/storage/volumes/{uuid} vicon.png

There are no attributes defined for this ONTAPI call.

volume-get-volume-path

GET /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-style-cifs

NO REST EQUIVALENT

volume

name

volume-modify-iter

PATCH /api/storage/volumes/{uuid} vicon.png

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} vicon.png

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} vicon.png

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

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

In the REST API, you can PATCH the "movement.state" property to "paused" to pause the volume move operation in progress.

PATCH /api/storage/volumes/{uuid}

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

volume-move-resume

In the REST API, you can PATCH the "movement.state" property to "replicating" to resume the paused volume move operation.

PATCH /api/storage/volumes/{uuid}

ONTAPI attribute

REST attribute

Comment

volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

volume-move-start

In the REST API, to start the volume move operation, PATCH the volume endpoint with the "movement" sub-object.

PATCH /api/storage/volumes/{uuid}

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

In the REST API, you can PATCH the "movement.state" property to "aborted" to abort the ongoing volume move operation.

PATCH /api/storage/volumes/{uuid}

ONTAPI attribute

REST attribute

Comment

source-volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

volume-move-trigger-cutover

In the REST API, you can PATCH the "movement.state" property to "cutover" to trigger cutover.

PATCH /api/storage/volumes/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

source-volume

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

volume-offline

In the REST API, you can update the state attribute to "state:offline" to set the volume state to "offline".

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

cifs-delay

NO REST EQUIVALENT

name

name

volume-offline-async

In the REST API, you can update the state attribute to "state:offline" to set the volume state to "offline".

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

volume-name

name

volume-online

In the REST API, you can update the state attribute to "state:online" to set the volume state to "online".

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

name

name

volume-online-async

In the REST API, you can update the state attribute to "state:online" to set the volume state to "online".

PATCH /api/storage/volumes/{uuid} vicon.png

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

Available through the REST API by using the CLI passthrough.

POST /api/private/cli/volume/rehost

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} vicon.png

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} vicon.png

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

In the REST API, you can update the state attribute to "state:restricted" to set the volume state to "restricted".

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

cifs-delay

NO REST EQUIVALENT

name

name

volume-restrict-async

In the REST API, you can update the state attribute to "state:restricted" to set the volume state to "restricted".

PATCH /api/storage/volumes/{uuid} vicon.png

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} vicon.png

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

requested-total-files

files.maximum

volume

name

volume-size

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

new-size

size

volume

name

volume-size-async

PATCH /api/storage/volumes/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

new-size

size

volume-name

name

volume-space-get-iter

GET /api/storage/volumes vicon.png

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

This is a deprecated zapi.

This ONTAPI call does not have an equivalent REST API call.

volume-storage-service-rename

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}

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

"nas.path" is an empty path in the REST API PATCH method which deactivates and unmounts the volume.

PATCH /api/storage/volumes/{uuid} vicon.png

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 vicon.png

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.

Category: VSCAN

vscan-active-scanner-pool-get-iter

This ONTAPI call does not have an equivalent REST API call.

vscan-connection-extended-stats-get-iter

This ONTAPI call does not have an equivalent REST API call.

vscan-connection-status-all-get-iter

GET /api/protocols/vscan/server-status vicon.png

ONTAPI attribute

REST attribute

Comment

connected-since

update_time

disconnect-reason

disconnected_reason

disconnected-since

update_time

lif

interface.ip.address

node

node.name

privileged-user

NO REST EQUIVALENT

server

ip

server-status

state

server-type

type

vendor

vendor

version

version

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

vscan-events-get-iter

GET /api/protocols/vscan/{svm.uuid}/events vicon.png

ONTAPI attribute

REST attribute

Comment

consecutive-occurrence-count

NO REST EQUIVALENT

disconnect-reason

disconnect_reason

event-time

event_time

event-type

type

file-path

file_path

lif

interface

node

node

scan-engine-status

NO REST EQUIVALENT

server

server

vendor

vendor

version

version

vserver

svm

max-records

max_records

Specifies the maximum number of records to return before paging.

vscan-on-access-policy-create

POST /api/protocols/vscan/{svm.uuid}/on-access-policies vicon.png

ONTAPI attribute

REST attribute

Comment

file-ext-to-exclude

scope.exclude_extensions

file-ext-to-include

scope.include_extensions

filters

NO REST EQUIVALENT

You can find filter options under scope.only_execute_access and scope.scan_readonly_volumes REST API options

is-scan-mandatory

mandatory

max-file-size

scope.max_file_size

paths-to-exclude

scope.exclude_paths

policy-name

name

protocol

NO REST EQUIVALENT

return-record

NO REST EQUIVALENT

scan-files-with-no-ext

scope.scan_without_extension

vscan-on-access-policy-delete

DELETE /api/protocols/vscan/{svm.uuid}/on-access-policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

name

vscan-on-access-policy-get-iter

GET /api/protocols/vscan/{svm.uuid}/on-access-policies vicon.png

ONTAPI attribute

REST attribute

Comment

admin-owner

NO REST EQUIVALENT

file-ext-to-exclude

scope.exclude_extensions

file-ext-to-include

scope.include_extensions

filters

NO REST EQUIVALENT

You can find filter options under scope.only_execute_access and scope.scan_readonly_volumes REST API options

is-policy-enabled

enabled

is-scan-mandatory

mandatory

max-file-size

scope.max_file_size

paths-to-exclude

scope.exclude_paths

policy-name

name

protocol

NO REST EQUIVALENT

scan-files-with-no-ext

scope.scan_without_extension

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

vscan-on-access-policy-modify

PATCH /api/protocols/vscan/{svm.uuid}/on-access-policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

file-ext-to-exclude

scope.exclude_extensions

file-ext-to-include

scope.include_extensions

filters

NO REST EQUIVALENT

You can find filter options under scope.only_execute_access and scope.scan_readonly_volumes REST API options

is-scan-mandatory

mandatory

max-file-size

scope.max_file_size

paths-to-exclude

scope.exclude_paths

policy-name

name

scan-files-with-no-ext

scope.scan_without_extension

vscan-on-access-policy-status-modify

PATCH /api/protocols/vscan/{svm.uuid}/on-access-policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

policy-name

name

policy-status

enabled

vscan-on-demand-report-delete

This ONTAPI call does not have an equivalent REST API call.

vscan-on-demand-report-get-iter

This ONTAPI call does not have an equivalent REST API call.

vscan-on-demand-task-create

POST /api/protocols/vscan/{svm.uuid}/on-demand-policies vicon.png

ONTAPI attribute

REST attribute

Comment

cross-junction

NO REST EQUIVALENT

directory-recursion

NO REST EQUIVALENT

file-ext-to-exclude

scope.exclude_extensions

file-ext-to-include

scope.include_extensions

max-file-size

scope.max_file_size

paths-to-exclude

scope.exclude_paths

report-directory

log_path

report-expiry-time

NO REST EQUIVALENT

report-log-level

NO REST EQUIVALENT

request-timeout

NO REST EQUIVALENT

return-record

NO REST EQUIVALENT

scan-files-with-no-ext

scope.scan_without_extension

scan-paths

scan_paths

scan-priority

NO REST EQUIVALENT

schedule

schedule.name

task-name

name

vscan-on-demand-task-delete

DELETE /api/protocols/vscan/{svm.uuid}/on-demand-policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

task-name

name

vscan-on-demand-task-get-iter

GET /api/protocols/vscan/{svm.uuid}/on-demand-policies vicon.png

ONTAPI attribute

REST attribute

Comment

cross-junction

NO REST EQUIVALENT

directory-recursion

NO REST EQUIVALENT

file-ext-to-exclude

scope.exclude_extensions

file-ext-to-include

scope.include_extensions

max-file-size

scope.max_file_size

paths-to-exclude

scope.exclude_paths

report-directory

log_path

report-expiry-time

NO REST EQUIVALENT

report-log-level

NO REST EQUIVALENT

request-timeout

NO REST EQUIVALENT

scan-files-with-no-ext

scope.scan_without_extension

scan-paths

scan_paths

scan-priority

NO REST EQUIVALENT

schedule

schedule.name

task-name

name

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

vscan-on-demand-task-modify

PATCH /api/protocols/vscan/{svm.uuid}/on-demand-policies/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

cross-junction

NO REST EQUIVALENT

directory-recursion

NO REST EQUIVALENT

file-ext-to-exclude

scope.exclude_extensions

file-ext-to-include

scope.include_extensions

max-file-size

scope.max_file_size

paths-to-exclude

scope.exclude_paths

report-directory

log_path

report-expiry-time

NO REST EQUIVALENT

report-log-level

NO REST EQUIVALENT

request-timeout

NO REST EQUIVALENT

scan-files-with-no-ext

scope.scan_without_extension

scan-paths

scan_paths

scan-priority

NO REST EQUIVALENT

schedule

schedule.name

task-name

name

vscan-on-demand-task-run

This ONTAPI call does not have an equivalent REST API call.

vscan-reset

PATCH /api/protocols/vscan/{svm.uuid} vicon.png

There are no attributes defined for this ONTAPI call.

vscan-resolve-hostnames

This ONTAPI call does not have an equivalent REST API call.

vscan-scanner-pool-apply-policy

PATCH /api/protocols/vscan/{svm.uuid}/scanner-pools/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

cluster

cluster.name

scanner-policy

role

scanner-pool

name

vscan-scanner-pool-create

POST /api/protocols/vscan/{svm.uuid}/scanner-pools vicon.png

ONTAPI attribute

REST attribute

Comment

hostnames

servers

max-session-setup-retries

NO REST EQUIVALENT

privileged-users

privileged_users

request-timeout

NO REST EQUIVALENT

return-record

NO REST EQUIVALENT

scan-queue-timeout

NO REST EQUIVALENT

scanner-pool

name

session-setup-timeout

NO REST EQUIVALENT

session-teardown-timeout

NO REST EQUIVALENT

vscan-scanner-pool-delete

DELETE /api/protocols/vscan/{svm.uuid}/scanner-pools/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

scanner-pool

name

vscan-scanner-pool-get-iter

GET /api/protocols/vscan/{svm.uuid}/scanner-pools vicon.png

ONTAPI attribute

REST attribute

Comment

admin-owner

NO REST EQUIVALENT

cluster

cluster.name

hostnames

servers

is-currently-active

NO REST EQUIVALENT

max-session-setup-retries

NO REST EQUIVALENT

privileged-users

privileged_users

request-timeout

NO REST EQUIVALENT

scan-queue-timeout

NO REST EQUIVALENT

scanner-policy

role

scanner-pool

name

servers

servers

session-setup-timeout

NO REST EQUIVALENT

session-teardown-timeout

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

vscan-scanner-pool-modify

PATCH /api/protocols/vscan/{svm.uuid}/scanner-pools/{name} vicon.png

ONTAPI attribute

REST attribute

Comment

hostnames

servers

max-session-setup-retries

NO REST EQUIVALENT

privileged-users

privileged_users

request-timeout

NO REST EQUIVALENT

scan-queue-timeout

NO REST EQUIVALENT

scanner-pool

name

session-setup-timeout

NO REST EQUIVALENT

session-teardown-timeout

NO REST EQUIVALENT

vscan-status-get-iter

GET /api/protocols/vscan vicon.png

ONTAPI attribute

REST attribute

Comment

is-vscan-enabled

enabled

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

vscan-status-modify

PATCH /api/protocols/vscan/{svm.uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-vscan-enabled

enabled

Category: VSERVER-MIGRATE

vserver-migrate-cleanup

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-cutover

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-debug-launch-check-job

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-get

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-get-iter

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-pause

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-resume

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-start

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-volume-get

This ONTAPI call does not have an equivalent REST API call.

vserver-migrate-volume-get-iter

This ONTAPI call does not have an equivalent REST API call.

Category: VSERVER-PEER-PERMISSION

vserver-peer-permission-remote-get

This ONTAPI call does not have an equivalent REST API call.

vserver-peer-permission-remote-get-iter

Lists the SVMs in peer cluster which has permission to peer with the local cluster’s SVMs. Available through the REST API by using the CLI passthrough.

GET /api/private/cli/vserver/peer/permission/remote-show/

ONTAPI attribute

REST attribute

Comment

applications

applications

Specifies the applications to be filtered.

vserver

vserver

Specifies the peer SVM name.

max-records

max_records

Specifies the maximum number of records to return before paging.

peer-cluster

peer-cluster

Specifies the peer cluster name.

Category: VSERVER-PEER-TRANSITION

vserver-peer-transition-create

This ONTAPI call does not have an equivalent REST API call.

vserver-peer-transition-destroy

This ONTAPI call does not have an equivalent REST API call.

vserver-peer-transition-destroy-iter

This ONTAPI call does not have an equivalent REST API call.

vserver-peer-transition-get

This ONTAPI call does not have an equivalent REST API call.

vserver-peer-transition-get-iter

This ONTAPI call does not have an equivalent REST API call.

vserver-peer-transition-modify

This ONTAPI call does not have an equivalent REST API call.

Category: VSERVER-PEER

vserver-peer-accept

PATCH /api/svm/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

local-name

name

peer-vserver

name

vserver

svm.name

vserver-peer-create

POST /api/svm/peers

ONTAPI attribute

REST attribute

Comment

applications

applications

local-name

name

peer-cluster

peer.cluster.name

peer-vserver

name

vserver

svm.name

vserver-peer-delete

DELETE /api/svm/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

peer-vserver

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

vserver-peer-get

GET /api/svm/peers/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

applications

applications

peer-cluster

peer.cluster.name

peer-state

state

peer-vserver

name

peer-vserver-uuid

peer.svm.uuid

remote-vserver-name

peer.svm.name

vserver

svm.name

vserver-uuid

svm.uuid

peer-vserver

name

vserver-peer-get-iter

GET /api/svm/peers vicon.png

ONTAPI attribute

REST attribute

Comment

applications

applications

peer-cluster

peer.cluster.name

peer-state

state

peer-vserver

name

peer-vserver-uuid

peer.svm.uuid

remote-vserver-name

peer.svm.name

vserver

svm.name

vserver-uuid

svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-peer-modify

PATCH /api/svm/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

applications

applications

peer-vserver

name

vserver

NO REST EQUIVALENT

vserver-peer-modify-local-name

PATCH /api/svm/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

new-name

name

peer-cluster

NO REST EQUIVALENT

peer-vserver

NO REST EQUIVALENT

vserver-peer-permission-create

POST /api/svm/peer-permissions

ONTAPI attribute

REST attribute

Comment

applications

applications

peer-cluster

cluster_peer.name

vserver

svm.name

vserver-peer-permission-delete

DELETE /api/svm/peer-permissions/{cluster_peer.uuid}/{svm.uuid}

ONTAPI attribute

REST attribute

Comment

peer-cluster

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

vserver-peer-permission-get

GET /api/svm/peer-permissions/{cluster_peer.uuid}/{svm.uuid}

ONTAPI attribute

REST attribute

Comment

applications

applications

peer-cluster

cluster_peer.name

vserver

svm.name

peer-cluster

cluster_peer.name

vserver

svm.name

vserver-peer-permission-get-iter

GET /api/svm/peer-permissions

ONTAPI attribute

REST attribute

Comment

applications

applications

peer-cluster

cluster_peer.name

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-peer-permission-modify

PATCH /api/svm/peer-permissions/{cluster_peer.uuid}/{svm.uuid}

ONTAPI attribute

REST attribute

Comment

applications

applications

peer-cluster

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

vserver-peer-reject

PATCH /api/svm/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

peer-vserver

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

vserver-peer-repair-peer-name

This ONTAPI call does not have an equivalent REST API call.

vserver-peer-resume

PATCH /api/svm/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

peer-vserver

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

vserver-peer-suspend

PATCH /api/svm/peers/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

peer-vserver

NO REST EQUIVALENT

vserver

NO REST EQUIVALENT

Category: VSERVER

vserver-add-aggregates

Set the object "aggregates" with the new list of aggregates.

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

To add one or more aggregates to the SVM aggregate list, provide the absolute list of aggregates along with the new aggregates in the REST API PATCH request.

vserver-name

NO REST EQUIVALENT

vserver-add-protocols

Add protocols to allowed-list for the SVM.

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

protocols

See comment column for details

cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed

Consider the protocol service allowed when the protocol’s allowed flag is set to "true".
SVM data access protocols are configurable using the protocol endpoint. For example, to start or stop NFS protocol service, use the endpoint /api/protocols/nfs/services/{svm.uuid}.

vserver-name

NO REST EQUIVALENT

vserver-config-diff-get

This ONTAPI call does not have an equivalent REST API call.

vserver-config-diff-get-iter

This ONTAPI call does not have an equivalent REST API call.

vserver-create

Create and configure the SVM with the data access protocols, data and management interfaces, and service configurations.

POST /api/svm/svms

ONTAPI attribute

REST attribute

Comment

antivirus-on-access-policy

NO REST EQUIVALENT

caching-policy

NO REST EQUIVALENT

comment

comment

ipspace

ipspace.name

is-repository-vserver

NO REST EQUIVALENT

is-space-enforcement-logical

NO REST EQUIVALENT

is-space-reporting-logical

NO REST EQUIVALENT

language

language

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

quota-policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

return-record

NO REST EQUIVALENT

root-volume

NO REST EQUIVALENT

Use REST endpoint "/api/storage/volumes" to manage SVM root volume information.

root-volume-aggregate

NO REST EQUIVALENT

root-volume-security-style

NO REST EQUIVALENT

Use REST endpoint "/api/storage/volumes" to manage SVM root volume security style information.

snapshot-policy

See comment column for details

Supply the following REST API properties:
snapshot_policy.name
snapshot_policy.uuid

vserver-name

name

vserver-subtype

subtype

vserver-create-async

This ONTAPI call does not have an equivalent REST API call.

vserver-data-policy-export

This ONTAPI call does not have an equivalent REST API call.

vserver-data-policy-import

This ONTAPI call does not have an equivalent REST API call.

vserver-data-policy-validation-get-error

This ONTAPI call does not have an equivalent REST API call.

vserver-destroy

DELETE /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

vserver-name

NO REST EQUIVALENT

vserver-destroy-async

This ONTAPI call does not have an equivalent REST API call.

vserver-get

GET /api/svm/svms/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

allowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service allowed when the protocol’s allowed flag is set to "true".
Consider the protocol service enabled when the protocol’s enabled flag is set to "true".

antivirus-on-access-policy

NO REST EQUIVALENT

caching-policy

NO REST EQUIVALENT

comment

comment

disallowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service not allowed when the protocol’s allowed flag is set to "false".
Consider the protocol service disabled when the protocol’s enabled flag is set to "false".

ipspace

ipspace.name

is-config-locked-for-changes

NO REST EQUIVALENT

is-repository-vserver

NO REST EQUIVALENT

is-space-enforcement-logical

NO REST EQUIVALENT

is-space-reporting-logical

NO REST EQUIVALENT

is-vserver-protected

See comment column for details

Supply the following REST API properties:
snapmirror.is_protected
snapmirror.protected_volumes_count

language

language

ldap-domain

ldap.ad_domain

max-volumes

max_volumes

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

nis-domain

See comment column for details

Supply the following REST API properties:
nis.domain
nis.enabled
nis.servers

operational-state

state

SVM "state" property is a combination of SVM’s administrative state and operational-state.

operational-state-stopped-reason

NO REST EQUIVALENT

qos-policy-group

See comment column for details

Supply the following REST API properties:
qos_policy.uuid
qos_policy.name
qos_policy.min_throughput_iops
qos_policy.min_throughput_mbps
qos_policy.max_throughput_iops
qos_policy.max_throughput_mbps

quota-policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

root-volume

NO REST EQUIVALENT

Use REST endpoint "/api/storage/volumes" to view SVM root volume information.

root-volume-aggregate

NO REST EQUIVALENT

root-volume-security-style

NO REST EQUIVALENT

Use REST endpoint "/api/storage/volumes" to view SVM root volume security style information.

snapshot-policy

See comment column for details

Supply the following REST API properties:
snapshot_policy.name
snapshot_policy.uuid

state

state

SVM "state" property is a combination of SVM’s administrative state and operational-state.

uuid

uuid

volume-delete-retention-hours

NO REST EQUIVALENT

vserver-aggr-info-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

vserver-name

name

vserver-subtype

subtype

vserver-type

NO REST EQUIVALENT

SVM REST APIs allow management of data SVMs only.

vserver-get-iter

GET /api/svm/svms vicon.png

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

allowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service allowed when the protocol’s allowed flag is set to "true".
Consider the protocol service enabled when the protocol’s enabled flag is set to "true".

antivirus-on-access-policy

NO REST EQUIVALENT

caching-policy

NO REST EQUIVALENT

comment

comment

disallowed-protocols

See comment column for details

Supply the following REST API properties:
cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed
cifs.enabled
fcp.enabled
iscsi.enabled
nfs.enabled
nvme.enabled
s3.enabled

Consider the protocol service not allowed when the protocol’s allowed flag is set to "false".
Consider the protocol service disabled when the protocol’s enabled flag is set to "false".

ipspace

ipspace

is-config-locked-for-changes

NO REST EQUIVALENT

is-repository-vserver

NO REST EQUIVALENT

is-space-enforcement-logical

NO REST EQUIVALENT

is-space-reporting-logical

NO REST EQUIVALENT

is-vserver-protected

See comment column for details

Supply the following REST API properties:
snapmirror.is_protected
snapmirror.protected_volumes_count

language

language

ldap-domain

ldap.ad_domain

max-volumes

max_volumes

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

nis-domain

See comment column for details

Supply the following REST API properties:
nis.domain
nis.enabled
nis.servers

operational-state

state

SVM "state" property is a combination of SVM’s administrative state and operational-state.

operational-state-stopped-reason

NO REST EQUIVALENT

qos-policy-group

See comment column for details

Supply the following REST API properties:
qos_policy.uuid
qos_policy.name
qos_policy.min_throughput_iops
qos_policy.min_throughput_mbps
qos_policy.max_throughput_iops
qos_policy.max_throughput_mbps

quota-policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

root-volume

NO REST EQUIVALENT

Use REST endpoint "/api/storage/volumes" to view SVM root volume information.

root-volume-aggregate

NO REST EQUIVALENT

root-volume-security-style

NO REST EQUIVALENT

Use REST endpoint "/api/storage/volumes" to view SVM root volume security style information.

snapshot-policy

See comment column for details

Supply the following REST API properties:
snapshot_policy.name
snapshot_policy.uuid

state

state

SVM "state" property is a combination of SVM’s administrative state and operational-state.

uuid

uuid

volume-delete-retention-hours

NO REST EQUIVALENT

vserver-aggr-info-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

vserver-name

name

vserver-subtype

subtype

vserver-type

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-http-proxy-create

You can create the HTTP proxy configuration either for a particular SVM or for a particular IPspace.

POST /api/network/http-proxy vicon.png

ONTAPI attribute

REST attribute

Comment

ipspace

See comment column for details

Supply the following REST API properties:
ipspace.name
ipspace.uuid

password

NO REST EQUIVALENT

port

port

server

server

skip-config-validation

NO REST EQUIVALENT

username

NO REST EQUIVALENT

vserver

See comment column for details

Supply the following REST API properties:
svm.name
svm.uuid

vserver-http-proxy-delete

DELETE /api/network/http-proxy/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ipspace

NO REST EQUIVALENT

vserver

uuid

vserver-http-proxy-get

In addition to the ONTAPI attributes captured here, the REST API attribute "scope" identifies whether a proxy is owned by an SVM or cluster.

GET /api/network/http-proxy/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ipspace

See comment column for details

Supply the following REST API properties:
ipspace.name
ipspace.uuid

password

NO REST EQUIVALENT

port

port

server

server

username

NO REST EQUIVALENT

vserver

See comment column for details

Supply the following REST API properties:
svm.name
svm.uuid
uuid

ipspace

NO REST EQUIVALENT

vserver-http-proxy-get-iter

In addition to the ONTAPI attributes captured here, the REST API attribute "scope" identifies whether a proxy is owned by an SVM or cluster.

GET /api/network/http-proxy vicon.png

ONTAPI attribute

REST attribute

Comment

ipspace

See comment column for details

Supply the following REST API properties:
ipspace.name
ipspace.uuid

password

NO REST EQUIVALENT

port

port

server

server

username

NO REST EQUIVALENT

vserver

See comment column for details

Supply the following REST API properties:
svm.name
svm.uuid

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-http-proxy-modify

PATCH /api/network/http-proxy/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

ipspace

NO REST EQUIVALENT

password

NO REST EQUIVALENT

port

port

server

server

skip-config-validation

NO REST EQUIVALENT

username

NO REST EQUIVALENT

vserver

uuid

vserver-lock

This ONTAPI call does not have an equivalent REST API call.

vserver-login-banner-get

GET /api/security/login/messages/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

message

banner

vserver

svm.name

vserver-login-banner-get-iter

GET /api/security/login/messages vicon.png

ONTAPI attribute

REST attribute

Comment

message

banner

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-login-banner-modify

PATCH /api/security/login/messages/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

message

banner

vserver-login-banner-modify-iter

PATCH /api/security/login/messages vicon.png

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

message

banner

vserver

svm.name

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

vserver-modify

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

allowed-protocols

NO REST EQUIVALENT

antivirus-on-access-policy

NO REST EQUIVALENT

caching-policy

NO REST EQUIVALENT

comment

comment

disallowed-protocols

NO REST EQUIVALENT

is-space-enforcement-logical

NO REST EQUIVALENT

is-space-reporting-logical

NO REST EQUIVALENT

language

language

max-volumes

max_volumes

name-mapping-switch

nsswitch.namemap

name-server-switch

See comment column for details

Supply the following REST API properties:
nsswitch.group
nsswitch.netgroup
nsswitch.passwd

qos-policy-group

See comment column for details

Supply the following REST API properties:
qos_policy.uuid
qos_policy.name

quota-policy

NO REST EQUIVALENT

Multiple alternative quota policies (active and backup) are not supported in REST. Use REST endpoint "/api/storage/quota/rules" to manage the quota rules of the active policy.

snapshot-policy

NO REST EQUIVALENT

state

state

volume-delete-retention-hours

NO REST EQUIVALENT

vserver-name

name

vserver-modify-iter

This ONTAPI call does not have an equivalent REST API call.

vserver-motd-get

GET /api/security/login/messages/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

message

message

vserver

svm.name

vserver-motd-get-iter

GET /api/security/login/messages vicon.png

ONTAPI attribute

REST attribute

Comment

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

message

message

vserver

svm.name

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver-motd-modify

PATCH /api/security/login/messages/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

message

message

vserver-motd-modify-iter

PATCH /api/security/login/messages vicon.png

ONTAPI attribute

REST attribute

Comment

continue-on-failure

continue_on_failure

is-cluster-message-enabled

show_cluster_message

This field is only modifiable by the cluster administrator

max-failure-count

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

message

message

vserver

svm.name

return-failure-list

NO REST EQUIVALENT

return-success-list

NO REST EQUIVALENT

vserver-protect-precheck

This ONTAPI call does not have an equivalent REST API call.

vserver-protect-precheck-dp-support

This ONTAPI call does not have an equivalent REST API call.

vserver-protect-precheck-network

This ONTAPI call does not have an equivalent REST API call.

vserver-protect-precheck-vge-support

This ONTAPI call does not have an equivalent REST API call.

vserver-remove-aggregates

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

aggr-list

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

To remove one or more aggregates from the SVM aggregate list, provide the absolute list of aggregates, without specifying the aggregates to be removed, in the REST API PATCH request.

vserver-name

NO REST EQUIVALENT

vserver-remove-protocols

Add protocols to disallowed-list for the SVM.

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

protocols

See comment column for details

cifs.allowed
fcp.allowed
iscsi.allowed
nfs.allowed
nvme.allowed
ndmp.allowed

Consider the protocol service not allowed when the protocol’s allowed flag is set to "false".
SVM data access protocols are configurable using the protocol endpoint. For example, to start or stop NFS protocol service, use the endpoint /api/protocols/nfs/services/{svm.uuid}.

vserver-name

NO REST EQUIVALENT

vserver-rename

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

new-name

name

vserver-name

NO REST EQUIVALENT

vserver-rename-async

This ONTAPI call does not have an equivalent REST API call.

vserver-san-purge

This ONTAPI call does not have an equivalent REST API call.

vserver-san-purge-verify

This ONTAPI call does not have an equivalent REST API call.

vserver-saninit

This ONTAPI call does not have an equivalent REST API call.

vserver-show-aggr-get-iter

GET /api/svm/svms/{uuid} vicon.png

ONTAPI attribute

REST attribute

Comment

aggregate-name

See comment column for details

Supply the following REST API properties:
aggregates.name
aggregates.uuid

aggregate-type

NO REST EQUIVALENT

available-size

NO REST EQUIVALENT

is-nve-capable

NO REST EQUIVALENT

snaplock-type

NO REST EQUIVALENT

vserver-name

NO REST EQUIVALENT

max-records

max_records

Specifies the maximum number of records to return before paging.

vserver

name

vserver-start

Set the "state" to "running" to start the SVM.

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

force

NO REST EQUIVALENT

vserver-name

NO REST EQUIVALENT

vserver-stop

Set the "state" to "stopped" to stop the SVM.

PATCH /api/svm/svms/{uuid}

ONTAPI attribute

REST attribute

Comment

vserver-name

NO REST EQUIVALENT

vserver-unlock

This ONTAPI call does not have an equivalent REST API call.

volume-clone-create-async

This ONTAPI call does not have an equivalent REST API call.

Category: VVOL

vvol-clone-create

This ONTAPI call does not have an equivalent REST API call.

vvol-create

This ONTAPI call does not have an equivalent REST API call.

vvol-delete

This ONTAPI call does not have an equivalent REST API call.

vvol-get-iter

This ONTAPI call does not have an equivalent REST API call.

vvol-get-op-status

This ONTAPI call does not have an equivalent REST API call.

vvol-mapping-create

This ONTAPI call does not have an equivalent REST API call.

vvol-perf-policy-modify

This ONTAPI call does not have an equivalent REST API call.

Category: WAFL

wafl-get-sync-status

This API is not supported in the REST API. It is potentially detrimental to node performance.

This ONTAPI call does not have an equivalent REST API call.

wafl-sync

This API is not supported in the REST API. It is potentially detrimental to node performance.

This ONTAPI call does not have an equivalent REST API call.

Copyright, trademarks, and feedback

Copyright © 2022 NetApp, Inc. All Rights Reserved. Printed in the U.S.

No part of this document covered by copyright may be reproduced in any form or by any means—graphic, electronic, or mechanical, including photocopying, recording, taping, or storage in an electronic retrieval system—without prior written permission of the copyright owner.

Software derived from copyrighted NetApp material is subject to the following license and disclaimer:

THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

NetApp reserves the right to change any products described herein at any time, and without notice. NetApp assumes no responsibility or liability arising from the use of products described herein, except as expressly agreed to in writing by NetApp. The use or purchase of this product does not convey a license under any patent rights, trademark rights, or any other intellectual property rights of NetApp. The product described in this manual may be protected by one or more U.S. patents, foreign patents, or pending applications.

RESTRICTED RIGHTS LEGEND: Use, duplication,or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).

Trademark information

NETAPP, the NETAPP logo, and the marks listed on the NetApp Trademarks page are trademarks of NetApp, Inc. Other company and product names may be trademarks of their respective owners. http://www.netapp.com/us/legal/netapptmlist.aspx

Feedback

If you have questions about the library, suggestions, or find a bug, you may contact by email.

ng-ontap-rest-python-lib@netapp.com

You can help us to improve the quality of our documentation by sending us your feedback. If you have suggestions for improving this document, send us your comments by email.

doccomments@netapp.com

To help us direct your comments to the correct division, include in the subject line the product name, version, and operating system.

If you want to be notified automatically when production-level documentation is released or important changes are made to existing production-level documents, follow Twitter account @NetAppDoc.

You can also contact us in the following ways:

NetApp, Inc., 1395 Crossman Ave, Sunnyvale, CA 94089 U.S.

Telephone: +1 (408) 822-6000

Fax: +1 (408) 822-4501

Support telephone: +1 (888) 463-8277