Update Storage Switch Properties
The Update Storage Switch Properties operation updates one or more of the writable properties of a storage switch.
HTTP method and URI
POST /api/storage-switches/{storage-switch-id}
In this request, the URI variable {storage-switch-id} is the object ID of the Storage Switch object.
Request body contents
The request body is expected to contain a JSON object that provides the new value 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 in the Data model. 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 switch's properties with the values specified.
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-switch-id} does not identify a Storage Switch object on the HMC. If the containing storage fabric already contains a storage switch with the specified domain-id or the port-count field value does not allow for the currently configured ports, a 409 (Conflict) status code is returned.
If the request body fails to validate, a 400 (Bad Request) status code is returned. This could be because another storage switch with the specified name exists within the same FICON® configuration in which the containing storage site and storage fabric exist.
If the request body contents are valid, the storage switch'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
- 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.
Otherwise, 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.
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. |
8 | A storage switch with the name specified in the request body already exists within the FICON configuration in which the containing storage site and storage fabric exist. | |
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 | The storage switch with the object-id {storage-switch-id} does not exist on the HMC. |
409 (Conflict) | 2 | The storage switch object with the object-id {storage-switch-id} was busy and the request timed out. |
441 | The value of the port-count field does not allow for the currently configured ports on the Storage Switch object with the object-id {storage-switch-id}. | |
445 | A storage switch with the domain-id specified in the request body already exists within its associated storage fabric. | |
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.