Retrieve a collection of aggregates for an entire cluster
GET /storage/aggregates
Introduced In: 9.6
Retrieves the collection of aggregates for the entire cluster.
Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields
query parameter. See Requesting specific fields to learn more.
-
metric.*
-
space.block_storage.inactive_user_data
-
space.block_storage.inactive_user_data_percent
-
space.footprint
-
is_spare_low
-
statistics.*
Related ONTAP commands
-
storage aggregate show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
recommend |
boolean |
query |
False |
If set to 'true', it queries the system for the recommended optimal layout for creating new aggregates. The default setting is 'false'. |
show_spares |
boolean |
query |
False |
If set to 'true', the spares object is returned instead of records to show the spare groups in the cluster. The default setting is 'false'. |
recommendation_spares.checksum_style |
string |
query |
False |
Filter by recommendation_spares.checksum_style
|
recommendation_spares.is_partition |
boolean |
query |
False |
Filter by recommendation_spares.is_partition
|
recommendation_spares.disk_class |
string |
query |
False |
Filter by recommendation_spares.disk_class
|
recommendation_spares.layout_requirements.aggregate_min_disks |
integer |
query |
False |
Filter by recommendation_spares.layout_requirements.aggregate_min_disks
|
recommendation_spares.layout_requirements.default |
boolean |
query |
False |
Filter by recommendation_spares.layout_requirements.default
|
recommendation_spares.layout_requirements.raid_group.max |
integer |
query |
False |
Filter by recommendation_spares.layout_requirements.raid_group.max
|
recommendation_spares.layout_requirements.raid_group.default |
integer |
query |
False |
Filter by recommendation_spares.layout_requirements.raid_group.default
|
recommendation_spares.layout_requirements.raid_group.min |
integer |
query |
False |
Filter by recommendation_spares.layout_requirements.raid_group.min
|
recommendation_spares.layout_requirements.raid_type |
string |
query |
False |
Filter by recommendation_spares.layout_requirements.raid_type
|
recommendation_spares.disk_type |
string |
query |
False |
Filter by recommendation_spares.disk_type
|
recommendation_spares.node.uuid |
string |
query |
False |
Filter by recommendation_spares.node.uuid
|
recommendation_spares.node.name |
string |
query |
False |
Filter by recommendation_spares.node.name
|
recommendation_spares.total |
integer |
query |
False |
Filter by recommendation_spares.total
|
recommendation_spares.size |
integer |
query |
False |
Filter by recommendation_spares.size
|
recommendation_spares.usable |
integer |
query |
False |
Filter by recommendation_spares.usable
|
recommendation_spares.syncmirror_pool |
string |
query |
False |
Filter by recommendation_spares.syncmirror_pool
|
inactive_data_reporting.start_time |
string |
query |
False |
Filter by inactive_data_reporting.start_time
|
inactive_data_reporting.enabled |
boolean |
query |
False |
Filter by inactive_data_reporting.enabled
|
uuid |
string |
query |
False |
Filter by uuid |
node.uuid |
string |
query |
False |
Filter by node.uuid |
node.name |
string |
query |
False |
Filter by node.name |
volume-count |
integer |
query |
False |
Filter by volume-count
|
sidl_enabled |
boolean |
query |
False |
Filter by sidl_enabled
|
create_time |
string |
query |
False |
Filter by create_time |
statistics.timestamp |
string |
query |
False |
Filter by statistics.timestamp
|
statistics.iops_raw.other |
integer |
query |
False |
Filter by statistics.iops_raw.other
|
statistics.iops_raw.read |
integer |
query |
False |
Filter by statistics.iops_raw.read
|
statistics.iops_raw.write |
integer |
query |
False |
Filter by statistics.iops_raw.write
|
statistics.iops_raw.total |
integer |
query |
False |
Filter by statistics.iops_raw.total
|
statistics.status |
string |
query |
False |
Filter by statistics.status
|
statistics.latency_raw.other |
integer |
query |
False |
Filter by statistics.latency_raw.other
|
statistics.latency_raw.read |
integer |
query |
False |
Filter by statistics.latency_raw.read
|
statistics.latency_raw.write |
integer |
query |
False |
Filter by statistics.latency_raw.write
|
statistics.latency_raw.total |
integer |
query |
False |
Filter by statistics.latency_raw.total
|
statistics.throughput_raw.other |
integer |
query |
False |
Filter by statistics.throughput_raw.other
|
statistics.throughput_raw.read |
integer |
query |
False |
Filter by statistics.throughput_raw.read
|
statistics.throughput_raw.write |
integer |
query |
False |
Filter by statistics.throughput_raw.write
|
statistics.throughput_raw.total |
integer |
query |
False |
Filter by statistics.throughput_raw.total
|
name |
string |
query |
False |
Filter by name |
metric.iops.other |
integer |
query |
False |
Filter by metric.iops.other
|
metric.iops.read |
integer |
query |
False |
Filter by metric.iops.read
|
metric.iops.write |
integer |
query |
False |
Filter by metric.iops.write
|
metric.iops.total |
integer |
query |
False |
Filter by metric.iops.total
|
metric.timestamp |
string |
query |
False |
Filter by metric.timestamp
|
metric.latency.other |
integer |
query |
False |
Filter by metric.latency.other
|
metric.latency.read |
integer |
query |
False |
Filter by metric.latency.read
|
metric.latency.write |
integer |
query |
False |
Filter by metric.latency.write
|
metric.latency.total |
integer |
query |
False |
Filter by metric.latency.total
|
metric.duration |
string |
query |
False |
Filter by metric.duration
|
metric.status |
string |
query |
False |
Filter by metric.status
|
metric.throughput.other |
integer |
query |
False |
Filter by metric.throughput.other
|
metric.throughput.read |
integer |
query |
False |
Filter by metric.throughput.read
|
metric.throughput.write |
integer |
query |
False |
Filter by metric.throughput.write
|
metric.throughput.total |
integer |
query |
False |
Filter by metric.throughput.total
|
snapshot.max_files_available |
integer |
query |
False |
Filter by snapshot.max_files_available
|
snapshot.max_files_used |
integer |
query |
False |
Filter by snapshot.max_files_used
|
snapshot.files_used |
integer |
query |
False |
Filter by snapshot.files_used
|
snapshot.files_total |
integer |
query |
False |
Filter by snapshot.files_total
|
home_node.uuid |
string |
query |
False |
Filter by home_node.uuid |
home_node.name |
string |
query |
False |
Filter by home_node.name |
is_spare_low |
boolean |
query |
False |
Filter by is_spare_low
|
inode_attributes.max_files_possible |
integer |
query |
False |
Filter by inode_attributes.max_files_possible
|
inode_attributes.files_private_used |
integer |
query |
False |
Filter by inode_attributes.files_private_used
|
inode_attributes.files_total |
integer |
query |
False |
Filter by inode_attributes.files_total
|
inode_attributes.used_percent |
integer |
query |
False |
Filter by inode_attributes.used_percent
|
inode_attributes.version |
integer |
query |
False |
Filter by inode_attributes.version
|
inode_attributes.max_files_available |
integer |
query |
False |
Filter by inode_attributes.max_files_available
|
inode_attributes.file_private_capacity |
integer |
query |
False |
Filter by inode_attributes.file_private_capacity
|
inode_attributes.files_used |
integer |
query |
False |
Filter by inode_attributes.files_used
|
inode_attributes.max_files_used |
integer |
query |
False |
Filter by inode_attributes.max_files_used
|
inode_attributes.file_public_capacity |
integer |
query |
False |
Filter by inode_attributes.file_public_capacity
|
dr_home_node.name |
string |
query |
False |
Filter by dr_home_node.name |
dr_home_node.uuid |
string |
query |
False |
Filter by dr_home_node.uuid |
space.efficiency.logical_used |
integer |
query |
False |
Filter by space.efficiency.logical_used |
space.efficiency.savings |
integer |
query |
False |
Filter by space.efficiency.savings |
space.efficiency.ratio |
number |
query |
False |
Filter by space.efficiency.ratio |
space.snapshot.reserve_percent |
integer |
query |
False |
Filter by space.snapshot.reserve_percent
|
space.snapshot.available |
integer |
query |
False |
Filter by space.snapshot.available
|
space.snapshot.used_percent |
integer |
query |
False |
Filter by space.snapshot.used_percent
|
space.snapshot.used |
integer |
query |
False |
Filter by space.snapshot.used
|
space.snapshot.total |
integer |
query |
False |
Filter by space.snapshot.total
|
space.footprint |
integer |
query |
False |
Filter by space.footprint |
space.efficiency_without_snapshots.logical_used |
integer |
query |
False |
Filter by space.efficiency_without_snapshots.logical_used |
space.efficiency_without_snapshots.savings |
integer |
query |
False |
Filter by space.efficiency_without_snapshots.savings |
space.efficiency_without_snapshots.ratio |
number |
query |
False |
Filter by space.efficiency_without_snapshots.ratio |
space.cloud_storage.used |
integer |
query |
False |
Filter by space.cloud_storage.used |
space.efficiency_without_snapshots_flexclones.logical_used |
integer |
query |
False |
Filter by space.efficiency_without_snapshots_flexclones.logical_used
|
space.efficiency_without_snapshots_flexclones.savings |
integer |
query |
False |
Filter by space.efficiency_without_snapshots_flexclones.savings
|
space.efficiency_without_snapshots_flexclones.ratio |
number |
query |
False |
Filter by space.efficiency_without_snapshots_flexclones.ratio
|
space.block_storage.data_compaction_space_saved_percent |
integer |
query |
False |
Filter by space.block_storage.data_compaction_space_saved_percent
|
space.block_storage.size |
integer |
query |
False |
Filter by space.block_storage.size |
space.block_storage.volume_deduplication_space_saved_percent |
integer |
query |
False |
Filter by space.block_storage.volume_deduplication_space_saved_percent
|
space.block_storage.used |
integer |
query |
False |
Filter by space.block_storage.used |
space.block_storage.data_compacted_count |
integer |
query |
False |
Filter by space.block_storage.data_compacted_count
|
space.block_storage.data_compaction_space_saved |
integer |
query |
False |
Filter by space.block_storage.data_compaction_space_saved
|
space.block_storage.volume_deduplication_shared_count |
integer |
query |
False |
Filter by space.block_storage.volume_deduplication_shared_count
|
space.block_storage.physical_used |
integer |
query |
False |
Filter by space.block_storage.physical_used
|
space.block_storage.inactive_user_data_percent |
integer |
query |
False |
Filter by space.block_storage.inactive_user_data_percent
|
space.block_storage.volume_deduplication_space_saved |
integer |
query |
False |
Filter by space.block_storage.volume_deduplication_space_saved
|
space.block_storage.aggregate_metadata_percent |
integer |
query |
False |
Filter by space.block_storage.aggregate_metadata_percent
|
space.block_storage.aggregate_metadata |
integer |
query |
False |
Filter by space.block_storage.aggregate_metadata
|
space.block_storage.available |
integer |
query |
False |
Filter by space.block_storage.available |
space.block_storage.physical_used_percent |
integer |
query |
False |
Filter by space.block_storage.physical_used_percent
|
space.block_storage.inactive_user_data |
integer |
query |
False |
Filter by space.block_storage.inactive_user_data |
space.block_storage.used_including_snapshot_reserve |
integer |
query |
False |
Filter by space.block_storage.used_including_snapshot_reserve
|
space.block_storage.full_threshold_percent |
integer |
query |
False |
Filter by space.block_storage.full_threshold_percent |
space.block_storage.used_including_snapshot_reserve_percent |
integer |
query |
False |
Filter by space.block_storage.used_including_snapshot_reserve_percent
|
space.block_storage.volume_footprints_percent |
integer |
query |
False |
Filter by space.block_storage.volume_footprints_percent
|
state |
string |
query |
False |
Filter by state |
block_storage.uses_partitions |
boolean |
query |
False |
Filter by block_storage.uses_partitions
|
block_storage.plexes.name |
string |
query |
False |
Filter by block_storage.plexes.name |
block_storage.mirror.state |
string |
query |
False |
Filter by block_storage.mirror.state |
block_storage.mirror.enabled |
boolean |
query |
False |
Filter by block_storage.mirror.enabled |
block_storage.hybrid_cache.storage_pools.allocation_units_count |
integer |
query |
False |
Filter by block_storage.hybrid_cache.storage_pools.allocation_units_count
|
block_storage.hybrid_cache.storage_pools.storage_pool.name |
string |
query |
False |
Filter by block_storage.hybrid_cache.storage_pools.storage_pool.name
|
block_storage.hybrid_cache.storage_pools.storage_pool.uuid |
string |
query |
False |
Filter by block_storage.hybrid_cache.storage_pools.storage_pool.uuid
|
block_storage.hybrid_cache.disk_count |
integer |
query |
False |
Filter by block_storage.hybrid_cache.disk_count |
block_storage.hybrid_cache.raid_type |
string |
query |
False |
Filter by block_storage.hybrid_cache.raid_type |
block_storage.hybrid_cache.enabled |
boolean |
query |
False |
Filter by block_storage.hybrid_cache.enabled |
block_storage.hybrid_cache.size |
integer |
query |
False |
Filter by block_storage.hybrid_cache.size |
block_storage.hybrid_cache.used |
integer |
query |
False |
Filter by block_storage.hybrid_cache.used |
block_storage.primary.disk_type |
string |
query |
False |
Filter by block_storage.primary.disk_type
|
block_storage.primary.raid_size |
integer |
query |
False |
Filter by block_storage.primary.raid_size |
block_storage.primary.simulated_raid_groups.usable_size |
integer |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.usable_size
|
block_storage.primary.simulated_raid_groups.existing_data_disk_count |
integer |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.existing_data_disk_count
|
block_storage.primary.simulated_raid_groups.raid_type |
string |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.raid_type
|
block_storage.primary.simulated_raid_groups.existing_parity_disk_count |
integer |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.existing_parity_disk_count
|
block_storage.primary.simulated_raid_groups.name |
string |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.name
|
block_storage.primary.simulated_raid_groups.added_parity_disk_count |
integer |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.added_parity_disk_count
|
block_storage.primary.simulated_raid_groups.is_partition |
boolean |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.is_partition
|
block_storage.primary.simulated_raid_groups.added_data_disk_count |
integer |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.added_data_disk_count
|
block_storage.primary.simulated_raid_groups.parity_disk_count |
integer |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.parity_disk_count
|
block_storage.primary.simulated_raid_groups.data_disk_count |
integer |
query |
False |
Filter by block_storage.primary.simulated_raid_groups.data_disk_count
|
block_storage.primary.disk_class |
string |
query |
False |
Filter by block_storage.primary.disk_class |
block_storage.primary.raid_type |
string |
query |
False |
Filter by block_storage.primary.raid_type |
block_storage.primary.disk_count |
integer |
query |
False |
Filter by block_storage.primary.disk_count |
block_storage.primary.checksum_style |
string |
query |
False |
Filter by block_storage.primary.checksum_style |
block_storage.storage_type |
string |
query |
False |
Filter by block_storage.storage_type
|
data_encryption.drive_protection_enabled |
boolean |
query |
False |
Filter by data_encryption.drive_protection_enabled |
data_encryption.software_encryption_enabled |
boolean |
query |
False |
Filter by data_encryption.software_encryption_enabled |
snaplock_type |
string |
query |
False |
Filter by snaplock_type |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
error |
||
num_records |
integer |
Number of records |
records |
array[aggregate] |
|
spares |
array[aggregate_spare] |
|
warnings |
array[aggregate_warning] |
List of warnings and remediation advice for the aggregate recommendation. |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
},
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"block_storage": {
"hybrid_cache": {
"disk_count": 6,
"raid_type": "string",
"size": 1612709888,
"storage_pools": [
{
"storage_pool": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "storage_pool_1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}
],
"used": 26501122
},
"mirror": {
"enabled": "",
"state": "string"
},
"plexes": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "plex0"
}
],
"primary": {
"checksum_style": "string",
"disk_class": "performance",
"disk_count": 8,
"disk_type": "string",
"raid_size": 16,
"raid_type": "string",
"simulated_raid_groups": [
{
"name": "string",
"raid_type": "string"
}
]
},
"storage_type": "string"
},
"cloud_storage": {
"stores": [
{
"cloud_store": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "store1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"used": 0
}
]
},
"create_time": "2018-01-01T12:00:00-04:00",
"dr_home_node": {
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"home_node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"inactive_data_reporting": {
"start_time": "2019-12-12T12:00:00-04:00"
},
"inode_attributes": {
"file_private_capacity": 31136,
"file_public_capacity": 31136,
"files_private_used": 502,
"files_total": 31136,
"files_used": 97,
"max_files_available": 31136,
"max_files_possible": 2844525,
"max_files_used": 97,
"used_percent": 5,
"version": 4
},
"is_spare_low": "",
"metric": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"duration": "PT15S",
"iops": {
"read": 200,
"total": 1000,
"write": 100
},
"latency": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25T11:20:13Z"
},
"name": "node1_aggr_1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"recommendation_spares": [
{
"checksum_style": "string",
"disk_class": "solid_state",
"disk_type": "string",
"is_partition": 1,
"layout_requirements": [
{
"aggregate_min_disks": 6,
"raid_group": {
"default": 16,
"max": 28,
"min": 5
},
"raid_type": "string"
}
],
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"size": 10156769280,
"syncmirror_pool": "string",
"total": 10,
"usable": 9
}
],
"snaplock_type": "string",
"snapshot": {
"files_total": 10,
"files_used": 3,
"max_files_available": 5,
"max_files_used": 50
},
"space": {
"block_storage": {
"aggregate_metadata": 2655,
"aggregate_metadata_percent": 8,
"available": 10156560384,
"data_compacted_count": 1990000,
"data_compaction_space_saved": 1996000,
"data_compaction_space_saved_percent": 27,
"full_threshold_percent": 0,
"inactive_user_data": 304448,
"inactive_user_data_percent": 0,
"physical_used": 2461696,
"physical_used_percent": 50,
"size": 10156769280,
"used": 2088960,
"used_including_snapshot_reserve": 674685,
"used_including_snapshot_reserve_percent": 35,
"volume_deduplication_shared_count": 1990000,
"volume_deduplication_space_saved": 1996000,
"volume_deduplication_space_saved_percent": 27,
"volume_footprints_percent": 14
},
"cloud_storage": {
"used": 402743264
},
"efficiency": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"efficiency_without_snapshots": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"efficiency_without_snapshots_flexclones": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"footprint": 608896,
"snapshot": {
"available": 2000,
"reserve_percent": 20,
"total": 5000,
"used": 3000,
"used_percent": 45
}
},
"state": "string",
"statistics": {
"iops_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"latency_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25T11:20:13Z"
},
"uuid": "string",
"volume-count": 0
}
],
"spares": [
{
"checksum_style": "string",
"disk_class": "solid_state",
"disk_type": "string",
"is_partition": 1,
"layout_requirements": [
{
"aggregate_min_disks": 6,
"raid_group": {
"default": 16,
"max": 28,
"min": 5
},
"raid_type": "string"
}
],
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"size": 10156769280,
"syncmirror_pool": "string",
"total": 10,
"usable": 9
}
],
"warnings": [
{
"action": {
"arguments": [
"string"
],
"message": "string"
},
"name": "string",
"warning": {
"arguments": [
"string"
],
"message": "string"
}
}
]
}
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
787092 |
The target field cannot be specified for this operation. |
918138 |
Internal error. Failed to get encryption operation status. |
8586225 |
Encountered unexpected error in retrieving metrics and statistics for an aggregate. |
19726341 |
Not enough eligible spare disks are available on the node. |
19726344 |
No recommendation can be made for this cluster. |
19726357 |
Aggregate recommendations are not supported on MetroCluster with Fibre Channel (FC). |
19726358 |
Aggregate recommendations are not supported on ONTAP Cloud. |
19726382 |
Another provisioning operation is in progress on this cluster. Wait a few minutes, and try the operation again. |
19726386 |
Encountered an error when retrieving licensing information on this cluster. |
19726387 |
No recommendation can be provided for this cluster within the license capacity. |
19726401 |
Aggregate recommendations are not supported when the DR group is not in the "normal" state. |
19726402 |
Internal error. Unable to determine the MetroCluster configuration state. |
19726403 |
Aggregate recommendation is not supported when there are no healthy target connections to remote storage. |
19726404 |
The recommended mirrored aggregate couldn't use all the attached capacity in one of the SyncMirror pools. Make sure that the remote and local storage is symmetrically wired. |
19726405 |
Not all local and remote disks attached to the node have been auto-partitioned. |
19726406 |
Aggregate recommendations are not supported on this node because remote and local storage is not symmetrically wired. |
19726540 |
The next tag is not supported for recommended aggregates. Retry the operation with a higher "return_timeout" value. |
196608055 |
Aggregate recommendation is not supported on this node because it does not support NetApp Aggregate Encryption (NAE). |
196608206 |
Internal error. Failed to get encryption operation status. |
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |
_links
Name | Type | Description |
---|---|---|
self |
storage_pool_reference
Shared Storage Pool
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
storage_pools
Name | Type | Description |
---|---|---|
allocation_units_count |
integer |
Allocation count of storage pool. |
storage_pool |
Shared Storage Pool |
hybrid_cache
Contains the configuration for the hybrid cache. The hybrid cache is made up of either whole SSDs or storage pool SSDs.
Name | Type | Description |
---|---|---|
disk_count |
integer |
Number of disks used in the cache tier of the aggregate. Only provided when hybrid_cache.enabled is 'true'. |
enabled |
boolean |
Specifies whether the aggregate uses HDDs with SSDs as a cache. |
raid_type |
string |
RAID type for SSD cache of the aggregate. Only provided when hybrid_cache.enabled is 'true'. |
size |
integer |
Total usable space in bytes of SSD cache. Only provided when hybrid_cache.enabled is 'true'. |
storage_pools |
array[storage_pools] |
List of storage pool properties and allocation_units_count for aggregate. |
used |
integer |
Space used in bytes of SSD cache. Only provided when hybrid_cache.enabled is 'true'. |
mirror
Name | Type | Description |
---|---|---|
enabled |
boolean |
Aggregate is SyncMirror protected |
state |
string |
plex_reference
Plex
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
simulated_raid_groups
Name | Type | Description |
---|---|---|
added_data_disk_count |
integer |
Number of added data disks in RAID group. |
added_parity_disk_count |
integer |
Number of added parity disks in RAID group. |
data_disk_count |
integer |
Number of data disks in RAID group. |
existing_data_disk_count |
integer |
Number of existing data disks in the RAID group. |
existing_parity_disk_count |
integer |
Number of existing parity disks in the RAID group. |
is_partition |
boolean |
Indicates whether the disk is partitioned (true) or whole (false). |
name |
string |
Name of the raid group. |
parity_disk_count |
integer |
Number of parity disks in RAID group. |
raid_type |
string |
RAID type of the aggregate. |
usable_size |
integer |
Usable size of each disk, in bytes. |
primary
Configuration information for the primary storage portion of the aggregate. This excludes the hybrid cache details.
Name | Type | Description |
---|---|---|
checksum_style |
string |
The checksum style used by the aggregate. |
disk_class |
string |
The class of disks being used by the aggregate. |
disk_count |
integer |
Number of disks used in the aggregate. This includes parity disks, but excludes disks in the hybrid cache. |
disk_type |
string |
The type of disk being used by the aggregate. |
raid_size |
integer |
Option to specify the maximum number of disks that can be included in a RAID group. |
raid_type |
string |
RAID type of the aggregate. |
simulated_raid_groups |
array[simulated_raid_groups] |
block_storage
Configuration information for the locally attached portion of the aggregate. When a cloud store is also used by this aggregate, this is referred to as the performance tier.
Name | Type | Description |
---|---|---|
hybrid_cache |
Contains the configuration for the hybrid cache. The hybrid cache is made up of either whole SSDs or storage pool SSDs. |
|
mirror |
||
plexes |
array[plex_reference] |
Plex reference for each plex in the aggregate. |
primary |
Configuration information for the primary storage portion of the aggregate. This excludes the hybrid cache details. |
|
storage_type |
string |
Type of aggregate. |
uses_partitions |
boolean |
If true, aggregate is using shared disks. |
cloud_store
Cloud store
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
cloud_storage_tier
Name | Type | Description |
---|---|---|
cloud_store |
Cloud store |
|
used |
integer |
Capacity used in bytes in the cloud store by this aggregate. This is a cached value calculated every 5 minutes. |
cloud_storage
Configuration information for the cloud storage portion of the aggregate. This is referred to as the capacity tier.
Name | Type | Description |
---|---|---|
attach_eligible |
boolean |
Specifies whether the aggregate is eligible for a cloud store to be attached. |
stores |
array[cloud_storage_tier] |
Configuration information for each cloud storage portion of the aggregate. |
tiering_fullness_threshold |
integer |
The percentage of space in the performance tier that must be used before data is tiered out to the cloud store. Only valid for PATCH operations. |
data_encryption
Name | Type | Description |
---|---|---|
drive_protection_enabled |
boolean |
Specifies whether the aggregate uses self-encrypting drives with data protection enabled. |
software_encryption_enabled |
boolean |
Specifies whether NetApp aggregate encryption is enabled. All data in the aggregate is encrypted. |
dr_home_node
Node where the aggregate resides after disaster recovery. The value for this field might differ from the 'node' field during switchover.
Name | Type | Description |
---|---|---|
name |
string |
|
uuid |
string |
home_node
Node where the aggregate resides after giveback. The value for this field might differ from the value of the 'node' field during takeover.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
inactive_data_reporting
Name | Type | Description |
---|---|---|
enabled |
boolean |
Specifes whether or not inactive data reporting is enabled on the aggregate. |
start_time |
string |
Timestamp at which inactive data reporting was enabled on the aggregate. |
inode_attributes
Name | Type | Description |
---|---|---|
file_private_capacity |
integer |
Number of files that can currently be stored on disk for system metadata files. This number will dynamically increase as more system files are created. This is an advanced property; there is an added cost to retrieving its value. The field is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter containing either footprint or **. |
file_public_capacity |
integer |
Number of files that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. This is an advanced property; there is an added cost to retrieving its value. The field is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter containing either footprint or **. |
files_private_used |
integer |
Number of system metadata files used. If the referenced file system is rest |