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

Update an aggregate specified by the UUID

Contributors
PDFs

PATCH /storage/aggregates/{uuid}

Introduced In: 9.6

Updates the aggregate specified by the UUID with the properties in the body. This request starts a job and returns a link to that job.

  • storage aggregate add-disks

  • storage aggregate mirror

  • storage aggregate modify

  • storage aggregate relocation start

  • storage aggregate rename

Parameters

Name Type In Required Description

uuid

string

path

True

Aggregate UUID

auto_provision_policy

string

query

False

If set to expand, the PATCH operation runs the recommended expansion of the aggregate.

  • Introduced in: 9.8

simulate

boolean

query

False

If set to true, the PATCH operation runs a simulated aggregate expansion with the provided input disk count and returns the proposed size of the new aggregate along with any associated warnings.

  • Introduced in: 9.8

disk_size

integer

query

False

If set, PATCH only selects disks of the specified size.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

_links

_links

block_storage

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.

cloud_storage

cloud_storage

Configuration information for the cloud storage portion of the aggregate. This is referred to as the capacity tier.

create_time

string

Timestamp of aggregate creation.

data_encryption

data_encryption

dr_home_node

dr_home_node

Node where the aggregate resides after disaster recovery. The value for this field might differ from the 'node' field during switchover.

home_node

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.

inactive_data_reporting

inactive_data_reporting

inode_attributes

inode_attributes

is_spare_low

boolean

Specifies whether the aggregate is in a spares low condition on any of the RAID groups. This is an advanced property; there is an added computational 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 **.

metric

metric

The most recent sample of I/O metrics for the aggregate.

name

string

Aggregate name.

node

node

Node where the aggregate currently resides.

recommendation_spares

array[aggregate_spare]

Information on the aggregate's remaining hot spare disks.

sidl_enabled

boolean

Specifies whether or not SIDL is enabled on the aggregate.

snaplock_type

string

SnapLock type.

snapshot

snapshot

space

space

state

string

Operational state of the aggregate.

statistics

statistics

The real time I/O statistics for the aggregate.

uuid

string

Aggregate UUID.

volume-count

integer

Number of volumes in the aggregate.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "block_storage": {
    "hybrid_cache": {
      "disk_count": 6,
      "disk_type": "string",
      "raid_size": 24,
      "raid_type": "string",
      "simulated_raid_groups": [
        {
          "name": "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
}

Response

Status: 200, Ok
Name Type Description

job

job_link

num_records

integer

Number of records

records

array[aggregate]

warnings

array[aggregate_warning]

List of validation warnings and remediation advice for the aggregate simulate behavior.
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "block_storage": {
        "hybrid_cache": {
          "disk_count": 6,
          "disk_type": "string",
          "raid_size": 24,
          "raid_type": "string",
          "simulated_raid_groups": [
            {
              "name": "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
    }
  ],
  "warnings": [
    {
      "action": {
        "arguments": [
          "string"
        ],
        "message": "string"
      },
      "name": "string",
      "warning": {
        "arguments": [
          "string"
        ],
        "message": "string"
      }
    }
  ]
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

262247

The value is invalid for the field.

460777

Failed to get information on the job.

786434

Cannot connect to node where the aggregate resides.

786435

Internal Error. Failed to create a communication handle.

786439

An aggregate already uses the specified name.

786447

Failed to modify the aggregate.

786456

Failed to add disks to the aggregate.

786458

Failed to rename aggregate.

786465

Failed to take aggregate offline because of the reason outlined in the message.

786467

Failed to take aggregate online because of the reason outlined in the message.

786468

VLDB is offline.

786472

Node that hosts the aggregate is offline.

786479

Cannot find node ID for the node.

786491

Not enough spares on the node.

786730

Internal Error

786771

Aggregate does not exist.

786787

Aggregate is not online.

786808

Aggregate mirror failed.

786867

Specified aggregate resides on the remote cluster.

786911

Not every node in the cluster has the Data ONTAP version required for the feature.

786923

This operation is not allowed during the pre-commit phase of a 7-mode to clustered Data ONTAP transition.

786924

Internal error for an aggregate that is in the pre-commit phase of a 7-mode to clustered Data ONTAP transition.

786955

Modifying raidtype to raid_tec requires a minimum of six disks in the RAID Group.

786956

Modifying raidtype to raid_dp requires a minimum of four disks in the RAID Group.

786965

Spare Selection in userspace failed.

787046

Mirroring of a FabricPool is not allowed.

787092

The target field cannot be specified for this operation.

787144

Aggregate is not a FabricPool.

787156

Modifying the attributes of mirror object store is not allowed.

787169

Only one field can be modified per operation.

787170

Failed to patch the "block_storage.primary.disk_count" because the disk count specified is smaller than existing disk count.

787172

This query is only allowed during the modification of the specified field.

787178

Unmirroring an aggregate with a PATCH operation is not supported.

787187

Internal error. Failed to check if the aggregate is a FabricPool.

787266

Invalid aggregate state. This state is not supported for a PATCH operation.

787273

Allocation unit count is not valid.

787274

Raidtype is not valid.

787275

Patch request with multiple records is not valid.

787276

Storage pool name and uuid do not match.

787277

Storage pool name and uuid are empty.

787278

Incorrect storage pool name specified.

787279

Incorrect storage pool uuid specified.

787280

Allocation unit count specified is smaller than the existing allocation unit count.

787281

Cannot modify RAID type of aggregate hybrid cache tier.

787282

RAID group must be specified on a disk addition to an aggregate with mixed RAID types.

787283

RAID group must be specified on a disk addition to a Flash Pool aggregate.

787284

The specified RAID group uses capacity from one or more storage pools.

787287

Cannot add physical SSD cache because aggregate uses cache capacity from a storage pool.

787288

Cannot add storage pool units because aggregate uses physical SSD cache.

787289

Incorrect raid_group specified during first time addition of physical SSD cache to an aggregate.

787291

Cannot specify RAID group which is located on the aggregate primary tier.

787293

Cannot specify RAID group which is located on the aggregate cache tier.

787294

This query is only allowed during the modification of the specific fields.

787295

The storage pool allocation units count is required.

1258699

Cannot use all the disks specified for the requested operation.

1263500

Operation will lead to creation of new raid group.

1263501

Operation will exceed half of the maximum volume sizes allowed on the node.

1263502

One spare data partition from at least one of the chosen root-data1-data2 disks will not be used.

1263503

Operation will lead to downsizing of one or more disks.

1263504

Operation will lead to a spares low condition.

1263598

One or more selected disks will be partitioned.

1263624

Operation will lead to a no sparecore condition.

2425736

No matching node found for the UUID provided.

7208962

Aggregate in an inconsistent state.

7208993

Failed to offline as the volume is being used.

7209033

CIFS open files prevent operation.

7209049

Cannot perform the operation because the aggregate is currently expanding.

7209075

Cannot perform the operation because the volume size limit for this system type would be exceeded.

7209090

Inconsistent state.

7209183

Volume is a partial volume.

7209229

This version of ONTAP does not recognize the filesystem. It is probably from a later version of the software and is being left offline.

7209246

The specified operation could not be completed as the volume is currently busy.

7209247

The volume was not found.

7209263

Container has failed.

7209271

wafliron is currently active.

7209275

Container was created in an unclustered ONTAP deployment.

7209463

Nvfile replay pending.

7209966

Another online request is already in progress for aggregate. The previous online request is waiting on a response from the licensing manager.

11206666

Storage pool is not healthy.

11210659

Aggregate is not online.

11210662

Adding capacity from storage pool to a mirrored aggregate is not supported.

11210667

Storage pool does not have enough spare allocation units.

11210670

Cannot add capacity from storage pool to aggregate, because currently allocated capacity to the aggregate does not span across all disks belonging to the storage pool.

11210672

Cannot grow aggregate as no capacity is allocated to it from storage pool.

11210673

Mixing of physical SSDs and capacity from a storage pool is not allowed in same aggregate.

11210675

Capacity in storage pool belongs to different fault isolation domain than aggregate.

11210678

Storage pool does not have enough disks to create RAID groups of same raid type as that of already allocated cache tier.

11210679

Storage pool does not have enough disks to create RAID groups of type RAID-DP.

11210680

Storage pool does not have enough disks to create RAID groups of same raid type as that of the aggregate.

11210685

Storage pool does not have enough disks to create RAID groups of type RAID-TEC.

11210688

Capacity from storage pool cannot be added to an SSD aggregate and a Flash Pool.

13108106

Cannot run aggregate relocation because volume expand is in progress.

19726347

There are a number of unassigned disks visible to the node that owns this aggregate.

19726382

Another provisioning operation is in progress on this cluster. Wait a few minutes, and try the operation again.

19726390

Unable to automatically expand this aggregate.

19726391

Too many unassigned disks visible to the node that owns this aggregate.

19726392

Layout of this aggregate is not a supported configuration.

19726393

Failed to expand the aggregate. Aggregate expansion is not supported on this system.

19726394

Automatic aggregate expansion is not supported on systems with multiple data aggregates.

19726395

Automatic aggregate expansion is not supported when MetroCluster is not configured.

19726396

Automatic aggregate expansion is not supported when the DR group is not in a normal state.

19726397

Aggregates must contain disks with identical disk-types and disk-sizes.

19726402

Internal error. Unable to determine the MetroCluster configuration state.

19726538

Cannot perform the operation because the aggregate is not in a healthy state.

26542083

Destination node is at higher Data ONTAP version than source node.

26542084

Source node is at higher Data ONTAP version than destination node.

26542097

Unable to get D-blade ID of destination.

26542101

Unable to contact the source node.

26542102

Unable to contact the destination node.

26542120

An SVM migrate operation is in progress. When the migrate operation completes, try the operation again.

26542121

A MetroCluster disaster recovery operation is in progress. When the recovery operation completes, try the operation again.

196608334

Failed to modify the aggregate because it contains NAE volumes.

196608335

Failed to modify the aggregate because it contains non-encrypted volumes.
Name Type Description

error

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

self

href

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.

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.

usable_size

integer

Usable size of each disk, in bytes.

storage_pool_reference

Shared Storage Pool

Name Type Description

_links

_links

name

string

uuid

string

storage_pools

Name Type Description

allocation_units_count

integer

Allocation count of storage pool.

storage_pool

storage_pool_reference

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'.

disk_type

string

Type of disk being used by the aggregate's cache tier.

enabled

boolean

Specifies whether the aggregate uses HDDs with SSDs as a cache.

raid_size

integer

Option to specify the maximum number of disks that can be included in a RAID group.

raid_type

string

RAID type for SSD cache of the aggregate. Only provided when hybrid_cache.enabled is 'true'.

simulated_raid_groups

array[simulated_raid_groups]

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

_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

hybrid_cache

Contains the configuration for the hybrid cache. The hybrid cache is made up of either whole SSDs or storage pool SSDs.

mirror

mirror

plexes

array[plex_reference]

Plex reference for each plex in the aggregate.

primary

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

_links

name

string

uuid

string

cloud_storage_tier

Name Type Description

cloud_store

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.

migrate_threshold

integer

Specifies the minimum percentage of performance tier free space that must exist in order for migration of data from the capacity tier to performance tier to be allowed. Only valid for PATCH operations.

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

_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 computationl 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 computational 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 restricted or offline, a value of 0 is returned. This is an advanced property; there is an added computational 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_total

integer

Maximum number of user-visible files that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned.

files_used

integer

Number of user-visible files used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned.

max_files_available

integer

The count of the maximum number of user-visible files currently allowable on the referenced file system.

max_files_possible

integer

The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system.

max_files_used

integer

The number of user-visible files currently in use on the referenced file system.

used_percent

integer

The percentage of disk space currently in use based on user-visible file count on the referenced file system.

version

integer

The inofile-version of the aggregate. If the referenced file system is restricted or offline, a value of 0 is returned. This is an advanced property; there is an added computational 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 **.

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

metric

The most recent sample of I/O metrics for the aggregate.

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

node

Node where the aggregate currently resides.

Name Type Description

_links

_links

name

string

uuid

string

raid_group

Name Type Description

default

integer

Default number of disks in a RAID group.

max

integer

Maximum number of disks allowed in a RAID group.

min

integer

Minimum number of disks allowed in a RAID group.

layout_requirement

Name Type Description

aggregate_min_disks

integer

Minimum number of disks to create an aggregate.

default

boolean

Indicates if this RAID type is the default.

raid_group

raid_group

raid_type

string

RAID type.

node

Node where the spares are assigned.

Name Type Description

_links

_links

name

string

uuid

string

aggregate_spare

Name Type Description

checksum_style

string

The checksum type that has been assigned to the spares.

disk_class

string

Disk class of spares.

disk_type

string

Type of disk.

is_partition

boolean

Indicates whether a disk is partitioned (true) or whole (false)

layout_requirements

array[layout_requirement]

Available RAID protections and their restrictions.

node

node

Node where the spares are assigned.

size

integer

Usable size of each spare, in bytes.

syncmirror_pool

string

SyncMirror spare pool.

total

integer

Total number of spares in the bucket. The total spare count for each class of spares also includes reserved spare capacity recommended by ONTAP best practices.

  • example: 10

  • readOnly: 1

  • Introduced in: 9.11

usable

integer

Total number of usable spares in the bucket. The usable count for each class of spares does not include reserved spare capacity recommended by ONTAP best practices.

  • example: 9

  • readOnly: 1

  • Introduced in: 9.6

snapshot

Name Type Description

files_total

integer

Total files allowed in Snapshot copies

files_used

integer

Total files created in Snapshot copies

max_files_available

integer

Maximum files available for Snapshot copies

max_files_used

integer

Files in use by Snapshot copies

block_storage

Name Type Description

aggregate_metadata

integer

Space used by different metafiles and internal operations inside the aggregate, in bytes.

aggregate_metadata_percent

integer

Aggregate metadata as a percentage.

available

integer

Space available in bytes.

data_compacted_count

integer

Amount of compacted data in bytes.

data_compaction_space_saved

integer

Space saved in bytes by compacting the data.

data_compaction_space_saved_percent

integer

Percentage saved by compacting the data.

full_threshold_percent

integer

The aggregate used percentage at which 'monitor.volume.full' EMS is generated.

inactive_user_data

integer

The size that is physically used in the block storage and has a cold temperature, in bytes. This property is only supported if the aggregate is either attached to a cloud store or can be attached to a cloud store. This is an advanced property; there is an added computational 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 block_storage.inactive_user_data or **.

inactive_user_data_percent

integer

The percentage of inactive user data in the block storage. This property is only supported if the aggregate is either attached to a cloud store or can be attached to a cloud store. This is an advanced property; there is an added computational 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 block_storage.inactive_user_data_percent or **.

physical_used

integer

Total physical used size of an aggregate in bytes.

physical_used_percent

integer

Physical used percentage.

size

integer

Total usable space in bytes, not including WAFL reserve and aggregate Snapshot copy reserve.

used

integer

Space used or reserved in bytes. Includes volume guarantees and aggregate metadata.

used_including_snapshot_reserve

integer

Total used including the Snapshot copy reserve, in bytes.

used_including_snapshot_reserve_percent

integer

Total used including the Snapshot reserve as a percentage.

volume_deduplication_shared_count

integer

Amount of shared bytes counted by storage efficiency.

volume_deduplication_space_saved

integer

Amount of space saved in bytes by storage efficiency.

volume_deduplication_space_saved_percent

integer

Percentage of space saved by storage efficiency.

volume_footprints_percent

integer

A summation of volume footprints inside the aggregate, as a percentage. A volume's footprint is the amount of space being used for the volume in the aggregate.

cloud_storage

Name Type Description

used

integer

Used space in bytes in the cloud store. Only applicable for aggregates with a cloud store tier.

efficiency

Storage efficiency.

Name Type Description

auto_adaptive_compression_savings

boolean

Indicates whether or not aggregate has auto adaptive compression savings.

cross_volume_background_dedupe

boolean

Indicates whether or not cross volume background deduplication is enabled.

cross_volume_dedupe_savings

boolean

Indicates whether or not aggregate has cross volume deduplication savings.

cross_volume_inline_dedupe

boolean

Indicates whether or not cross volume inline deduplication is enabled.

logical_used

integer

Logical used

ratio

number

Data reduction ratio (logical_used / used)

savings

integer

Space saved by storage efficiencies (logical_used - used)

efficiency_without_snapshots

Storage efficiency that does not include the savings provided by Snapshot copies.

Name Type Description

logical_used

integer

Logical used

ratio

number

Data reduction ratio (logical_used / used)

savings

integer

Space saved by storage efficiencies (logical_used - used)

efficiency_without_snapshots_flexclones

Storage efficiency that does not include the savings provided by Snapshot copies and Flexclone volumes.

Name Type Description

logical_used

integer

Logical used

ratio

number

Data reduction ratio (logical_used / used)

savings

integer

Space saved by storage efficiencies (logical_used - used)

snapshot

Name Type Description

available

integer

Available space for Snapshot copies in bytes

reserve_percent

integer

Percentage of space reserved for Snapshot copies

total

integer

Total space for Snapshot copies in bytes

used

integer

Space used by Snapshot copies in bytes

used_percent

integer

Percentage of disk space used by Snapshot copies

space

Name Type Description

block_storage

block_storage

cloud_storage

cloud_storage

efficiency

efficiency

Storage efficiency.

efficiency_without_snapshots

efficiency_without_snapshots

Storage efficiency that does not include the savings provided by Snapshot copies.

efficiency_without_snapshots_flexclones

efficiency_without_snapshots_flexclones

Storage efficiency that does not include the savings provided by Snapshot copies and Flexclone volumes.

footprint

integer

A summation of volume footprints (including volume guarantees), in bytes. This includes all of the volume footprints in the block_storage tier and the cloud_storage tier. This is an advanced property; there is an added computational 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 **.

snapshot

snapshot

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency_raw

The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

statistics

The real time I/O statistics for the aggregate.

Name Type Description

iops_raw

iops_raw

The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.

latency_raw

latency_raw

The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput_raw

throughput_raw

Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.

timestamp

string

The timestamp of the performance data.

aggregate

Name Type Description

_links

_links

block_storage

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.

cloud_storage

cloud_storage

Configuration information for the cloud storage portion of the aggregate. This is referred to as the capacity tier.

create_time

string

Timestamp of aggregate creation.

data_encryption

data_encryption

dr_home_node

dr_home_node

Node where the aggregate resides after disaster recovery. The value for this field might differ from the 'node' field during switchover.

home_node

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.

inactive_data_reporting

inactive_data_reporting

inode_attributes

inode_attributes

is_spare_low

boolean

Specifies whether the aggregate is in a spares low condition on any of the RAID groups. This is an advanced property; there is an added computational 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 **.

metric

metric

The most recent sample of I/O metrics for the aggregate.

name

string

Aggregate name.

node

node

Node where the aggregate currently resides.

recommendation_spares

array[aggregate_spare]

Information on the aggregate's remaining hot spare disks.

sidl_enabled

boolean

Specifies whether or not SIDL is enabled on the aggregate.

snaplock_type

string

SnapLock type.

snapshot

snapshot

space

space

state

string

Operational state of the aggregate.

statistics

statistics

The real time I/O statistics for the aggregate.

uuid

string

Aggregate UUID.

volume-count

integer

Number of volumes in the aggregate.
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

action

Name Type Description

arguments

array[string]

Arguments present in the specified action message.

code

integer

Corrective action code of the specified action.

message

string

Specifies the corrective action to be taken to resolve the issue.

warning

Name Type Description

arguments

array[string]

Arguments present in the warning message encountered.

code

integer

Warning code of the warning encountered.

message

string

Details of the warning encountered by the aggregate simulate query.

aggregate_warning

Name Type Description

action

action

name

string

Name of the entity that returns the warning.

warning

warning

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.