Undefine Storage Control Unit

The Undefine Storage Control Unit operation removes a storage control unit definition.

HTTP method and URI

POST /api/storage-control-units/{storage-control-unit-id}/operations/undefine

In this request, the URI variable {storage-control-unit-id} is the object ID of the storage control unit to be removed.

Description

This operation removes a storage control unit definition. If the storage control unit contains storage paths or volume ranges, they will be removed as well. Inventory Change notifications on the removed storage control unit and each of its contained storage paths, and a Property Change notification on the parent storage subsystem’s storage-control-unit-uris property are emitted asynchronously to this operation.

If the API user does not have action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks, a 403 (Forbidden) status code is returned. A 404 (Not Found) status code is returned if the object ID {storage-control-unit-id} does not identify a storage control unit object on the HMC.

If the storage control unit is mapped to any storage volume, a 409 (Conflict) status code is returned.

If the request is valid, the identified storage control unit’s storage paths and volume ranges are deleted and its URI is removed from the parent storage subsystem’s storage-control-unit-uris list property.

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks.

HTTP status and reason codes

On success, HTTP status code 204 (No Content) is returned and no response body is provided.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code and associated error message.

Table 1. Undefine Storage Control Unit: HTTP status and reason codes
HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
403 (Forbidden) 1 The API user does not have action/task permission to the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks.
404 (Not Found) 1 A storage control unit with the object ID {storage-control-unit-id} does not exist on the HMC.
409 (Conflict) 2 The storage control unit with the object-id {storage-control-unit} was busy and the request timed out.
446 The storage control unit with the object-id {storage-control-unit-id} is mapped to one or more volumes in one or more storage groups.
503 (Service Unavailable) 1 The request could not be processed because the HMC is not currently communicating with the SE needed to perform the requested operation.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. Undefine Storage Control Unit: Request
POST /api/storage-control-units/69bf384a-94d5-11e8-8ffe-fa163e27d492/operations/
   undefine HTTP/1.1
x-api-session: 4er4rp2aw9y5mgokxtwb8wz37v1mx4nyyj2iqx5gct66ewhcb4
content-type: application/json
Figure 2. Undefine Storage Control Unit: Response
204 No Content
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Tue, 31 Jul 2018 15:20:54 GMT

<No response body>