aggr
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 |
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 |
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 |
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
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
This ONTAPI call does not have an equivalent REST API call.
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: |
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 |
No REST Equivalent |
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 |
No REST Equivalent |
|
aggr-ownership-attributes |
See comment column for details |
cluster → NA |
aggr-performance-attributes |
See comment column for details |
free-space-realloc → NA |
aggr-raid-attributes |
See comment column for details |
aggregate-type → NA |
aggr-snaplock-attributes |
See comment column for details |
is-snaplock → \{snaplock-type == non_snaplock? false: true\} |
aggr-snapmirror-attributes |
See comment column for details |
dp-snapmirror-destinations → NA |
aggr-snapshot-attributes |
See comment column for details |
files-total → snapshot.files-total |
aggr-space-attributes |
space |
aggregate-metadata → space.block_storage.aggregate_metadata |
aggr-striping-attributes |
See comment column for details |
member-count→NA |
aggr-volume-count-attributes |
See comment column for details |
flexvol-count → NA |
aggr-wafliron-attributes |
See comment column for details |
last-start-errno → 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. |
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. |
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
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
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 only options that you can modify in the REST API are raidtype and raidsize, under block_storage.primary.
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
This ONTAPI call does not have an equivalent REST API call.
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: 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.