List Storage Fabrics

The List Storage Fabrics operation lists the storage fabrics known to the target Console.

HTTP method and URI

GET /api/storage-fabrics

Query parameters:

Name	Type	Rqd/Opt	Description
`cpc-uri`	String/ URI	Optional	Filter string to limit returned objects to those that have a matching cpc-uri property.
`name`	String	Optional	Filter pattern (regular expression) to limit returned objects to those that have a matching name property.

Response body contents

On successful completion, the response body is a JSON object with the following fields:

Field name	Type	Description
`storage-fabrics`	Array of storage-fabric-info objects	Array of storage-fabric-info objects, described in the next table. The returned array may be empty.

Each nested storage-fabric-info object contains the following fields:

Field name	Type	Description
`object-uri`	String/ URI	Canonical URI path (object-uri) of the Storage Fabric object.
`name`	String	The name property of the Storage Fabric object.
`cpc-uri`	String/ URI	The cpc-uri property of the Storage Fabric object.

Description

This operation lists the storage fabrics that are known to the target Console. The object URI, name, and CPC URI are provided for each.

If the name query parameter is specified, the returned list is limited to those storage fabrics that have a name property matching the specified filter pattern. If the name parameter is omitted, this filtering is not done.

If the cpc-uri query parameter is specified, the returned list is limited to those storage fabrics that have a matching cpc-uri property. If the cpc-uri parameter is omitted, this filtering is not done.

A storage fabric is included in the list only if the API user has task permission for the Configure Storage – System Programmer or Configure Storage – Storage Administrator tasks. If the API user does not have permission to a storage fabric, that object is simply omitted from the list but no error status code results.

If no storage fabrics are to be included in the results due to filtering or lack of task permission, an empty list is provided and the operation completes successfully.

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 200 (OK) is returned and the response body is provided as described in Response body contents.

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 any associated error message.

Table 1. List Storage Fabrics: 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.

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

Example HTTP interaction

Figure 1. List Storage Fabrics: Request

GET /api/storage-fabrics HTTP/1.1
x-api-session: 3tmygsxg76gvwqr4bgf2kpm2aj7z8nrbjb9ffiw6hhxfmjpm9b

Figure 2. List Storage Fabrics: Response

200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Mon, 30 Jul 2018 20:22:26 GMT
content-type: application/json;charset=UTF-8
content-length: 325
{
   "storage-fabrics":[
      {
         "cpc-uri":"/api/cpcs/e4f159ce-82a2-32a9-b8f2-de66c9b02e7e",
         "name":"Fabric B",
         "object-uri":"/api/storage-fabrics/24c1b2a8-9436-11e8-9c43-fa163e27d492"
      },
      {
         "cpc-uri":"/api/cpcs/e4f159ce-82a2-32a9-b8f2-de66c9b02e7e",
         "name":"Fabric A",
         "object-uri":"/api/storage-fabrics/08ad557c-9436-11e8-9c43-fa163e27d492"
      }
   ]
}