Get Storage Switch Properties

The Get Storage Switch Properties operation retrieves the properties of a single Storage Switch object.

HTTP method and URI

GET /api/storage-switches/{storage-switch-id}

In this request, the URI variable {storage-switch-id} is the object ID of the storage switch object.

Response body contents

On successful completion, the response body is a JSON object that provides the current values of the properties for the Storage Switch object as defined in the Data model. Field names and data types in the JSON object are the same as the property names and data types defined in the data model.

Description

Returns the current values of the properties for the Storage Switch object as defined in the Data model.

If the API user does not have action/task permission to the Configure Storage – System Programmer, Configure Storage – Storage Administrator , Create Partition Link, or Partition Link Details tasks, a 403 (Forbidden) status code is returned. If the object ID {storage-switch-id} does not identify a storage switch object on the HMC, a 404 (Not Found) status code is returned. [Updated by feature dpm-smcd-partition-link-management]

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission to the Configure Storage – System Programmer, Configure Storage – Storage Administrator , Create Partition Link, or Partition Link Details tasks. [Updated by feature dpm-smcd-partition-link-management]

HTTP status and reason codes

On success, the HTTP status code 200 (OK) is returned and the response body is provided as described in the Response body contents.

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.

Table 1. Get Storage Switch 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 The API user does not have action/task permission to the Configure Storage – System Programmer, Configure Storage – Storage Administrator , Create Partition Link, or Partition Link Details tasks.

[Added by feature dpm-smcd-partition-link-management]

404 (Not Found) 1 A storage switch with object-id {storage-switch-id} does not exist on the HMC.

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

Example HTTP interaction

Figure 1. Get Storage Switch Properties: Request
GET /api/storage-switches/90204662-9437-11e8-9c43-fa163e27d492 HTTP/1.1
x-api-session: 5067e2d7z01ujz4o5j106jy255f01248enx0p5wlnr8ti98xld
Figure 2. Get Storage Switch Properties: Response
200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Mon, 30 Jul 2018 20:55:23 GMT
content-type: application/json;charset=UTF-8
content-length: 411
{
   "class":"storage-switch",
   "description":"",
   "domain-id":"10",
   "name":"Storage switch 10",
   "object-id":"90204662-9437-11e8-9c43-fa163e27d492",
   "object-uri":"/api/storage-switches/90204662-9437-11e8-9c43-fa163e27d492",
   "parent":"/api/console",
   "port-count":256,
   "storage-fabric-uri":"/api/storage-fabrics/08ad557c-9436-11e8-9c43-fa163e27d492",
   "storage-site-uri":"/api/storage-sites/13ff101c-941f-11e8-a0c0-fa163e27d492"
}