Skip to main content

Delete a system

Contributors netapp-aoife

You can delete an existing Azure Cloud Volumes ONTAP system.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Delete a system for a single node

You can use this workflow to delete a single node system.

Step 1. Create the system

Perform the workflow Create Azure single node system and choose the publicId value of the system for the workingEnvironmentId path parameter.

Step 2. Delete the system

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

DELETE

/occm/api/azure/vsa/working-environments/{workingEnvironmentId}
Curl example
curl --request DELETE \
--location DELETE "https://api.bluexp.netapp.com/occm/api/azure/vsa/working-environments/<WORKING_ENV_ID>" \
--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.

  • Path parameter <WORKING_ENV_ID> (workingEnvironmentId) string

  • (Optional) Query parameters:

    • localDelete boolean

      If true, the Cloud Volumes ONTAP instance in the cloud is not terminated, but the NetApp Console no longer manages it (default is false).

    • forceDelete boolean

      If true the system is deleted even if it is part of one or more SnapMirror relationships (default is false).

Output

None

Delete a system for a high availability pair

You can use this workflow to delete an HA system.

Step 1. Create the system

Perform the workflow Create Azure HA system and choose the publicId value of the system for the workingEnvironmentId path parameter.

Step 2. Delete the system

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

DELETE

/occm/api/azure/ha/working-environments/{workingEnvironmentId}
Curl example
curl --request DELETE \
--location "https://api.bluexp.netapp.com/occm/api/azure/ha/working-environments/<WORKING_ENV_ID>" \
--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.

Path parameter <WORKING_ENV_ID> (workingEnvironmentId) string

(Optional) Query parameters:

  • localDelete boolean

    If true, the Cloud Volumes ONTAP instance in the cloud is not terminated, but the Console no longer manages it (default is false).

  • forceDelete boolean

    If true the system is deleted even if it is part of one or more SnapMirror relationships (default is false).

Output

None