ONTAP 9.11.1 ONTAPI to REST API mapping information

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.

: 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

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

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

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}

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

GET /api/protocols/cifs/domains

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

GET /api/protocols/cifs/domains

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

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

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}

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

GET /api/protocols/cifs/domains

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}

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

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}

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}

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}

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}

ONTAPI attribute	REST attribute	Comment
path	NO REST EQUIVALENT
to-position	new_index

cifs-local-group-create

POST /api/protocols/cifs/local-groups

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}

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

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

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

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

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}

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}

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

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}

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

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

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}

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}

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}

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

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

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}

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

ONTAPI attribute	REST attribute	Comment
privileges	privileges
user-or-group-name	name

cifs-privilege-get-iter

GET /api/protocols/cifs/users-and-groups/privileges

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}

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}

ONTAPI attribute	REST attribute	Comment
user-or-group-name	name

cifs-security-get-iter

GET /api/protocols/cifs/services

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}

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}

ONTAPI attribute	REST attribute	Comment
netbios-aliases	netbios.aliases

cifs-server-create

POST /api/protocols/cifs/services

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}

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}

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}

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}

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}

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}

There are no attributes defined for this ONTAPI call.

cifs-session-close

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

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}

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

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

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}

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}

ONTAPI attribute	REST attribute	Comment
storage-shadow-copy-set-id	uuid

cifs-shadowcopy-restore-dir

PATCH /api/protocols/cifs/shadow-copies

ONTAPI attribute	REST attribute	Comment
dst-dir	destination_dir
src-dir	source_dir
volume	volume
with-content	with_content

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

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

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

ONTAPI attribute	REST attribute	Comment
share	share
user-group-type	type
user-or-group	user_or_group

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

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.

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

ONTAPI attribute	REST attribute	Comment
permission	permission
share	share
user-group-type	type
user-or-group	user_or_group
winsid	NO REST EQUIVALENT

POST /api/protocols/cifs/shares

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

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

ONTAPI attribute	REST attribute	Comment
share-name	name

GET /api/protocols/cifs/shares

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.

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

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

cifs-symlink-create

POST /api/protocols/cifs/unix-symlink-mapping

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

cifs-symlink-delete

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

ONTAPI attribute	REST attribute	Comment
unix-path	unix_path

cifs-symlink-get-iter

GET /api/protocols/cifs/unix-symlink-mapping

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.

cifs-symlink-modify

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

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

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

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}

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}

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

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

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}

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}

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

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

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}

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}

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}

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

ONTAPI attribute	REST attribute	Comment
volume-name	volume.name

clone-token-create

POST /api/storage/file/clone/tokens

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}

ONTAPI attribute	REST attribute	Comment
node	node.name
token-uuid	uuid

clone-token-get

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

ONTAPI attribute	REST attribute	Comment
node	node.uuid
token-uuid	uuid

clone-token-get-iter

GET /api/storage/file/clone/tokens

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}

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

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}

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

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

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}

ONTAPI attribute	REST attribute	Comment
record-name	name
record-value	value
vserver	owner.uuid

cluster-application-record-modify-iter

PATCH /api/private/cluster/notes

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

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

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

ONTAPI attribute	REST attribute	Comment
policy-name	name
return-record	return_records

export-policy-destroy

DELETE /api/protocols/nfs/export-policies/{id}

ONTAPI attribute	REST attribute	Comment
policy-name	NO REST EQUIVALENT

export-policy-get

GET /api/protocols/nfs/export-policies/{id}

ONTAPI attribute	REST attribute	Comment
policy-id	id
policy-name	name
vserver	svm.name

export-policy-get-iter

GET /api/protocols/nfs/export-policies

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}

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

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

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}

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}

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}

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

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}

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}

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}

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

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

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

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

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

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

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

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

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

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}

There are no attributes defined for this ONTAPI call.

fcp-service-get-iter

GET /api/protocols/san/fcp/services

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}

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}

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}

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

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}

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

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

fcport-get-link-state

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}

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}

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}

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

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}

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}

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}

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}

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

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}

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}

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}

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}

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}

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

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}

ONTAPI attribute	REST attribute	Comment
path	path
perm	unix_permissions

file-create-symlink

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

ONTAPI attribute	REST attribute	Comment
path	path
symlink	target

file-delete-directory

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

ONTAPI attribute	REST attribute	Comment
path	path

file-delete-file

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

ONTAPI attribute	REST attribute	Comment
is-clone-file	NO REST EQUIVALENT
path	path

file-fingerprint-abort

DELETE /api/storage/snaplock/file-fingerprints/{id}

ONTAPI attribute	REST attribute	Comment
session-id	id

file-fingerprint-dump

GET /api/storage/snaplock/file-fingerprints/{id}

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

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

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

ONTAPI attribute	REST attribute	Comment
path	path

file-get-space-reservation-info

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

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}

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

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

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}

ONTAPI attribute	REST attribute	Comment
length	NO REST EQUIVALENT
offset	byte_offset
path	path
stream-name	stream_name

file-read-symlink

GET /api/storage/volumes/{volume.uuid}/files/{path}?return_metadata=true

ONTAPI attribute	REST attribute	Comment
path	path

file-rename-file

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

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}

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}

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}

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

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}

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

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}

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}

There are no attributes defined for this ONTAPI call.

fileservice-audit-enable

PATCH /api/protocols/audit/{svm.uuid}

ONTAPI attribute	REST attribute	Comment
force	NO REST EQUIVALENT

fileservice-audit-remove

DELETE /api/protocols/audit/{svm.uuid}

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}

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

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

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}

ONTAPI attribute	REST attribute	Comment
volume	NO REST EQUIVALENT

flexcache-get-iter

GET /api/storage/flexcache/flexcaches

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

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}

ONTAPI attribute	REST attribute	Comment
policy-name	name

fpolicy-enable-policy

PATCH /api/protocols/fpolicy/{svm.uuid}/policies/{name}

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

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

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}

ONTAPI attribute	REST attribute	Comment
policy-name	name

fpolicy-policy-event-create

POST /api/protocols/fpolicy/{svm.uuid}/events

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}

ONTAPI attribute	REST attribute	Comment
event-name	name

fpolicy-policy-event-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/events

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}

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

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}

ONTAPI attribute	REST attribute	Comment
engine-name	name

fpolicy-policy-external-engine-get-iter

GET /api/protocols/fpolicy/{svm.uuid}/engines

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}

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}

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}

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

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