Skip to main content

Delete an aggregate

Contributors netapp-ranuk

You can delete an existing disk aggregate. Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Delete aggregate for single node

You can use this workflow to delete an aggregate for a single node working environment.

Step 1. Select the working environment to use

Perform the workflow Get working environments and choose the publicId value for the workingEnvironmentId path parameter.

Step 2. Select the aggregate to delete

Perform the workflow Get aggregates and choose the name value of the required for the aggregateName path parameter.

Step 3. Delete the aggregate

You can issue a REST API call to delete an aggregate.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

DELETE

/occm/api/vsa/aggregates/{workingEnvironmentId}/{aggregateName}
Curl example
curl --request DELETE
--location "https://cloudmanager.cloud.netapp.com/occm/api/vsa/aggregates/<WORKING_ENV_ID>/<AGGR_NAME>"
--header "Content-Type: application/json"
--header "x-agent-id: <AGENT_ID>"
--header "Authorization: Bearer <ACCESS_TOKEN>"
Additional input parameters

The JSON input example includes the minimum list of parameters.

Parameter Type Required Description

<AGGR_NAME> (aggregateName)

Query

No

Identifies the aggregate

workingEnvironmentId <WORKING_ENV_ID>

Path

Yes

Identifies the working environment ID
Output

None

Delete aggregate for high availability pair

You can use this workflow to delete an aggregate for an HA working environment.

Step 1. Select the working environment to use

Perform the workflow Get working environments and choose the publicId value for the workingEnvironmentId path parameter.

Step 2. Select the aggregate to delete

Perform the workflow Get aggregates and choose the name value of the required for the aggregateName path parameter.

Step 3. Delete the aggregate

You can issue a REST API call to delete an aggregate.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

DELETE

/occm/api/aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}
Curl example
curl --request DELETE
--location "https://cloudmanager.cloud.netapp.com/occm/api/aws/ha/aggregates/<WORKING_ENV_ID>/<AGGR_NAME>"
--header "Content-Type: application/json"
--header "x-agent-id: <AGENT_ID>"
--header "Authorization: Bearer <ACCESS_TOKEN>"
Additional input parameters

The JSON input example includes the minimum list of parameters.

Parameter Type Required Description

<AGGR_NAME> (aggregateName)

Query

No

Identifies the aggregate

workingEnvironmentId <WORKING_ENV_ID>

Path

Yes

Identifies the working environment ID
Output

None