Update Storage Port Properties

The Update Storage Port Properties operation updates one or more of the writable properties of a storage port. This operation only supports configured adapters whose type is "fcp".

HTTP method and URI

POST /api/adapters/{adapter-id}/storage-ports/{storage-port-id}

In this request, the URI variable {adapter-id} is the object ID of the Adapter object and the URI variable {storage-port-id} is the element ID of the Storage Port object.

Request body contents

The request body is expected to contain a JSON object that provides the new values of any writable property that is to be updated by this operation. Field names and data types in this JSON object are expected to match the corresponding property names and data types defined by the data model for this object type. The JSON object can and should omit fields for properties whose values are not to be changed by this operation.

Description

This operation updates a storage port's properties with the values specified.

If the API user does not have action/task permission to the Adapter Details task, a 403 (Forbidden) status code is returned. A 404 (Not Found) status code is returned if the object-id {adapter-id} does not identify an adapter object to which the API user has object-access permission or if the element-id {storage-port-id} does not identify a storage port in the adapter. If the adapter type is not "fcp", a 404 (Not Found) status code is returned.

If the request body fails to validate, a 400 (Bad Request) status code is returned. This may occur because the document defines a field that is not supported.

If the connection-endpoint-uri field references a storage subsystem when one or more storage fabrics are defined, or if the connection-endpoint-uri field references a storage switch or storage subsystem that does not reside in the same CPC as the target storage port, a 409 (Conflict) status code is returned.

If the request body contents are valid, the storage port's properties are updated to their corresponding request body content's field's values. All fields are optional and may be excluded from the request body; if a field is not found in the request body, its property's value will not be modified.

If the update changes the value of any property for which property-change notifications are due, those notifications are emitted asynchronously to this operation.

Authorization requirements

This operation has the following authorization requirements:
  • Object-access permission to the adapter whose object ID is {adapter-id}.
  • Action/task permission to the Adapter Details task.

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. The response body is a standard error response body providing the reason code indicated and associated error message.

Table 1. Update Storage Port Properties: 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 API user does not have action/task permission to the Adapter Details task.
404 (Not Found) 1 An adapter with the object ID {adapter-id} does not exist on the HMC or the API user does not have object-access permission for it.
4 The operation does not support an adapter of the given type or the Adapter's parent CPC is not enabled for DPM.
5 A storage port with element-id of {storage-port-id} does not exist for the adapter on the HMC.
409 (Conflict) 2 Adapter object with the ID {adapter-id} was busy and the request timed out
441 The storage switch or storage subsystem referenced by the connection-endpoint-uri field resides in a different CPC than the targeted storage adapter port.
455 A direct endpoint connection cannot be made to a storage subsystem when storage fabrics are defined.
503 (Service Unavailable) 1 The request could not be processed because the HMC is not currently communicating with an 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. Update Storage Port Properties: Request
POST /api/adapters/d71902a4-c930-11e5-a978-020000000338/storage-ports/0
x-api-session: 4sw8s1089cczsejp5vzonbleyrvwsmx6edkqdudskevrcp0bvf
content-type: application/json
content-length: 30
{
  "description":"My FCP port"
}
Figure 2. Update Storage Port Properties: Response
204 No Content
"server":"zSeries management console API web server / 2.0",
"cache-control":"no-cache",
"date":"Wed, 10 Feb 2016 19:50:05 GMT",

<no response body>