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}

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

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

Aggregate UUID

disk_size

integer

query

False

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

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 belongs after disaster recovery. The value for this field might differ from the 'node' field during switchover.

home_node

home_node

Node where the aggregate belongs after giveback. The value for this field might differ from the value of the 'node' field during takeover.

name

string

Aggregate name

node

node

Node where the aggregate currently resides.

snaplock_type

string

SnapLock type

space

space

state

string

Operational state of the aggregate

uuid

string

Aggregate UUID
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "block_storage": {
    "hybrid_cache": {
      "disk_count": 6,
      "raid_type": "raid_dp",
      "size": 1612709888,
      "used": 26501122
    },
    "mirror": {
      "enabled": "",
      "state": "unmirrored"
    },
    "plexes": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "plex0"
    },
    "primary": {
      "checksum_style": "block",
      "disk_class": "performance",
      "disk_count": 8,
      "raid_size": 16,
      "raid_type": "raid_dp"
    }
  },
  "cloud_storage": {
    "stores": {
      "cloud_store": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "store1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "used": 0
    }
  },
  "create_time": "2018-01-01 12:00:00 -0400",
  "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"
  },
  "name": "node1_aggr_1",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "snaplock_type": "non_snaplock",
  "space": {
    "block_storage": {
      "available": 10156560384,
      "full_threshold_percent": 0,
      "inactive_user_data": 304448,
      "size": 10156769280,
      "used": 2088960
    },
    "cloud_storage": {
      "used": 402743264
    },
    "efficiency": {
      "logical_used": 0,
      "ratio": 0,
      "savings": 0
    },
    "efficiency_without_snapshots": {
      "logical_used": 0,
      "ratio": 0,
      "savings": 0
    },
    "footprint": 608896
  },
  "state": "online",
  "uuid": "string"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

787092

The target field cannot be specified for this operation.

787169

Only one field can be modified per operation.

786439

An aggregate already uses the specified name.

786468

VLDB is offline.

786771

Aggregate does not exist.

786458

Failed to rename aggregate.

786435

Internal Error. Failed to create a communication handle.

786867

Specified aggregate resides on the remote cluster.

786472

Node that hosts the aggregate is offline.

786434

Cannot connect to node where the aggregate resides.

786730

Internal Error

786911

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

787170

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

786965

Spare Selection in userspace failed.

786456

Failed to add disks to aggregate.

787046

Mirroring of a FabricPool is not allowed.

786808

Aggregate mirror failed.

786479

Cannot find node ID for the node.

787144

Aggregate is not a FabricPool.

786787

Aggregate is not online.

787156

Modifying the attributes of mirror object store is not allowed.

786923

This operation is disallowed during pre-commit phase of 7-mode to clustered Data ONTAP transition.

786924

Internal Error for an aggregate that is in 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.

786447

Failed to modify aggregate.

787178

Unmirroring an aggregate with a PATCH operation is not supported.

460777

Failed to get information on the job.

2425736

No matching node found for the UUID provided.

26542101

Unable to contact source node.

26542102

Unable to contact destination node.

26542084

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

26542083

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

26542120

A Vserver 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.

26542097

Unable to get D-blade ID of destination.

262247

The value is invalid for the field.

13108106

Cannot run aggregate relocation because volume expand is in progress.
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

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

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

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

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.

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.

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.

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

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

Aggregate uses self-encrypting drives with data protection enabled.

software_encryption_enabled

boolean

NetApp Aggregate Encryption enabled. All data in the aggregate is encrypted.

dr_home_node

Node where the aggregate belongs 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 belongs 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

node

Node where the aggregate currently resides.

Name Type Description

_links

_links

name

string

uuid

string

block_storage

Name Type Description

available

integer

Space available in bytes

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

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.

cloud_storage

Name Type Description

used

integer

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

efficiency

Storage efficiency

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

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)

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

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

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 belongs after disaster recovery. The value for this field might differ from the 'node' field during switchover.

home_node

home_node

Node where the aggregate belongs after giveback. The value for this field might differ from the value of the 'node' field during takeover.

name

string

Aggregate name

node

node

Node where the aggregate currently resides.

snaplock_type

string

SnapLock type

space

space

state

string

Operational state of the aggregate

uuid

string

Aggregate UUID
Name Type Description

_links

_links

uuid

string

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

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.