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

aggr

Contributors
Suggest changes
PDFs

aggr-add

PATCH /api/storage/aggregates/{uuid}

ONTAPI attribute REST attribute Comment

actual-disk-type

No REST Equivalent

aggregate

name

allocation-units

No REST Equivalent

allow-mixed-rpm

No REST Equivalent

allow-same-carrier

No REST Equivalent

cache-raid-group-size

No REST Equivalent

cache-raid-type

No REST Equivalent

checksum-style

No REST Equivalent

disk-class

No REST Equivalent

disk-count

block_storage.primary.disk_count

disk-size

disk_size

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 PATCH with the simulate parameter will return pre-check warnings

raid-group

No REST Equivalent

simulate

simulate

so-aggr

No REST Equivalent

storage-pool

No REST Equivalent

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

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

aggr-cluster-space-details-get

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

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

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

Query parameter only

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

Plex deletion is not supported via REST

aggr-efficiency-cumulated-get

GET /api/storage/cluster

ONTAPI attribute REST attribute Comment

aggregates

No REST Equivalent

It is the key to get cumulative efficiency details of aggregates(list of aggregate).

nodes

No REST Equivalent

It is the key to get 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

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

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

No REST Equivalent

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

No REST Equivalent

aggr-ownership-attributes

No REST Equivalent

cluster → NA
dr-home-id → NA
dr-home-name → block_storage.dr_home_node.name
home-id → NA
home-name → block_storage.home_node.name
owner-id → NA
owner-name → block_storage.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, via a separate GET call.

aggr-performance-attributes

No REST Equivalent

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

aggr-raid-attributes

No REST Equivalent

aggregate-type → NA
cache-raid-group-size → NA
checksum-status → NA
checksum-style → block_storage.primary.checksum_style + REST doesn't report the checksum style of the SSD cache tier in a hybrid aggregate
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 + Presence of the cloud_storage attribute indicates a composite aggregate
is-fabricpool-mirrored → NA
is-hybrid → NA + Presence of the hybrid_cache attribute indicates a hybrid aggregate
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 + The REST enum is a simplified variant of the ONTAPI enum
mount-state → NA
plex-count → NA
plexes → block_storage.plexes + Following attributes will need a separate GET on /api/storage/aggregates/{uuid}/plexes/
is-online → online
is-resyncing → resync.active
plex-name → name
plex-resync-pct-with-precision → NA
plex-status → state + status string is distilled down to "failed", "normal" or "out-of-date"
pool → pool
raidgroups
checksum-style → NA
is-cache-tier → raidgroups.cache_tier
is-recomputing-parity → raidgroups.recomputing_parity.active
is-reconstructing → raidgroups.reconstruct.active
raidgroup-name → raidgroups.name
recomputing-parity-percentage → raidgroups.recomputing_parity.percent
reconstruction-percentage → raidgroups.reconstruct.percent
resync-level → resync.level
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 → NA

aggr-snaplock-attributes

No REST Equivalent

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

aggr-snapmirror-attributes

No REST Equivalent

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

aggr-snapshot-attributes

No REST Equivalent

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

aggr-space-attributes

space

aggregate-metadata → NA
capacity-tier-used → space.cloud_storage.used
data-compacted-count → NA
data-compaction-space-saved → NA
data-compaction-space-saved-percent → NA
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 → NA
physical-used → space.block_storage.used
physical-used-percent → NA
sis-shared-count → NA
sis-space-saved → NA
sis-space-saved-percent → NA
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 → NA
volume-footprints → space.footprint
aggregate-size → space.block_storage.size
snapshot-reserve-unusable-percent → NA
tier-name → NA
used-including-snapshot-reserve-percent → NA
volume-footprints-percent → NA
aggregate-metadata-percent → NA
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 → NA
snap-size-total → NA
snapshot-reserve-unusable → NA

aggr-striping-attributes

No REST Equivalent

member-count→NA

aggr-volume-count-attributes

No REST Equivalent

It might be better to derive these fields from the volume endpoint, with a query set on the aggregate uuid
flexvol-count → NA
flexvol-count-collective → NA
flexvol-count-not-online → NA
flexvol-count-quiesced → NA
flexvol-count-striped → NA

aggr-wafliron-attributes

No REST Equivalent

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

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

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

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

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

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

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

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

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

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

aggr-online

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

aggr-options-list-info

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

PATCH /api/storage/aggregates/{uuid}

Note: The only options that can be modified via REST are raidtype and raidsize, under block_storage.primary

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

No REST Equivalent

aggregate-metadata-percent

No REST Equivalent

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

No REST Equivalent

physical-used

space.block_storage.used

physical-used-percent

No REST Equivalent

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

No REST Equivalent

used-including-snapshot-reserve-percent

No REST Equivalent

volume-footprints

space.footprint

volume-footprints-percent

No REST Equivalent

max-records

max_records

The maximum number of records to return before paging

aggr-spare-get-iter

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

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

Default raidtype is the entry in layout_requirements that has 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

The maximum number of records to return before paging

aggr-status-get-iter

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

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: Better to get this info from the nested raidgroups array in /api/storage/aggregates/{uuid}/plexes/{name}

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.