Skip to main content
A newer release of this product is available.

aggr

Contributors
Suggest changes
PDFs

aggr-add

PATCH /api/storage/aggregates/{uuid}

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

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

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

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

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

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

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

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}

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

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

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

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

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

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

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

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

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

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}

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

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}

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

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

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

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

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

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}

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

ONTAPI attribute REST attribute Comment

object-store-name

No REST Equivalent

aggr-object-store-config-get

GET /api/cloud/targets/{uuid}

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

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

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

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}

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

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

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

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}

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

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}

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

ONTAPI attribute REST attribute Comment

aggregate

No REST Equivalent

force-tiering-on-metrocluster

No REST Equivalent

mirror-type

primary

object-store-name

target.name

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}

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

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

PATCH /api/storage/aggregates/{uuid}

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

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

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

PATCH /api/storage/aggregates/{uuid}

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

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

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

Note: 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

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

ONTAPI attribute REST attribute Comment

uuid

No REST Equivalent

aggr-recommendation-create

GET /api/storage/aggregates?recommend=true

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

ONTAPI attribute REST attribute Comment

nodes

No REST Equivalent

aggr-recommendation-details-get

GET /api/storage/aggregates

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

ONTAPI attribute REST attribute Comment

nodes

No REST Equivalent

aggr-recommendation-get

GET /api/storage/aggregates?recommend=true

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

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}

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

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}

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

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

PATCH /api/storage/aggregates/{uuid}

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

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

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}

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

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

GET /api/storage/aggregates?show_spares=true

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

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

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

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

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

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

Note: To retrieve all plexes specify "*" for aggregate uuid

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

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

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

Note: 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.