Delete Storage Path

The Delete Storage Path operation deletes a storage path.

HTTP method and URI

DELETE /api/storage-control-units/{storage-control-unit-id}/storage-paths/{storage-path-id}
In this request, the URI variable {storage-control-unit-id} is the object ID of the Storage Control Unit object and the URI variable {storage-path-id} is the element ID of the Storage Path element object to delete.

Description

This operation deletes a storage path. An Inventory Change notification and a Property Change notification on the parent storage control unit’s storage-path-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, or if the element ID {storage-path-id} does not identify a storage path in the storage control unit.

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 path is deleted from the parent storage control unit’s storage-path-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. Delete Storage Path: 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.
5 A storage path with element-id {storage-path-id} does not exist for the storage control unit.
409 (Conflict) 2 The storage control unit object with the object-id {storage-control-unit-id} was busy and the request timed out.
446 The parent storage control unit with the object-id {storage-control-unit-id} is mapped to one or more volumes in a storage group.
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. Delete Storage Path: Request
DELETE /api/storage-control-units/69bf384a-94d5-11e8-8ffe-fa163e27d492/storage-paths/
  8746e9c8-94d8-11e8-a5c5-fa163e3fe47d HTTP/1.1
x-api-session: 6a7jbbd1iipk5mayxii3p742ujjzawofuthw3yyadlonn33gip
Figure 2. Delete Storage Path: Response
204 No Content
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Tue, 31 Jul 2018 15:40:41 GMT

<No response body>