Skip to content
/switches

Storage Fleet REST APIs (1.0.0)

Storage Fleet REST APIs

Download OpenAPI description
storage-fleet-api.json
storage-fleet-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers

https://eu1.data.cloud.hpe.com/

https://us1.data.cloud.hpe.com/

https://jp1.data.cloud.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/storage-fleet/public/openapi/storage-fleet-public-v1alpha1/storage-fleet-api/

enclosures

The Enclosure API provides endpoints for managing and configuring enclosures.

Operations

jbofioms

The JBOF IOM API provides endpoints for managing and configuring JBOF IOMs.

Operations

storage-nodes

The Storage Node API provides endpoints for managing and configuring storage nodes.

Operations

storage-systems

The storage-systems API allows the management of storage device.

Operations

switches

The Switch API provides endpoints for managing and configuring switches.

Operations

Get all switches of a HPE Alletra Storage X10000 system

Request

Get all switches of a HPE Alletra Storage X10000 system

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
Query
limitinteger[ 0 .. 5000 ]

Number of items to return at a time

Default 100
Example: limit=10
offsetinteger[ 0 .. 100000 ]

The offset of the first item in the collection to return

Default 0
Example: offset=5
selectstring

Query to select only the required parameters, separated by . if nested

Example: select=id
filterstring

Lucene query to filter Switches by Key.

Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004007
sortstring

Data query to sort Switch resource by Key.

Example: sort=id desc
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/switches \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
itemsArray of objects or nullrequired
items[].​idstringrequired

Identifier of the Storage system Switch. Filter, Sort

Example: "default.switch-0"
items[].​typestringrequired

Type of the resource.

Example: "switch"
items[].​apiVersionstring or null

API version of the resource.

Example: "sc.hpe.com/v1"
items[].​associatedLinksArray of objects or null or null(homefleetAssociatedLinks)
items[].​clusterIdstring or null

The unique identifier of the Storage system to which the Switch belongs.

Example: "123abcd4-5e67-890f-g123-4hi5j67kl8m9"
items[].​clusterRefstring or null

The URI of the Storage system to which the Switch belongs.

Example: "/api/sc.hpe.com/v1/default/switch/switch-1"
items[].​commonResourceAttributesobject or null(commonResourceAttrs)
items[].​customerIdstring or null

Customer ID for the Storage system Switch. Filter, Sort

Example: "ab1c23456d78901e23fghijk456lm7no"
items[].​generationinteger or null(int64)

Generation. Filter, Sort

Example: 1692945579
items[].​kindstring or null

Kind of the resource.

Example: "Switch"
items[].​numberOfPortsinteger or null(int64)

Number of ports in the Switch.

Example: 32
items[].​partNumberstring or null

Part number of the Switch. Filter

Example: "AB123C"
items[].​resourceUristring or null(homefleetResourceUri)
items[].​serialNumberstring or null

Serial number of the Switch. Filter, Sort

Example: "AB1234C5D6"
items[].​statusobject or null(HomefleetSwitchStatus)
items[].​systemIdstring or null

Identifier of the Storage system to which the Switch belongs. Filter, Sort

Example: "1AB234CDEF"
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0,
  "offset": 0,
  "total": 0
}

Get Switch of a HPE Alletra Storage X10000 system identified by switchID

Request

Get Switch of a HPE Alletra Storage X10000 system identified by switchID

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
switchIdstringrequired

Identifier of Switch. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004007
Query
selectstring

Query to select only the required parameters, separated by . if nested

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/switches/2a0df0fe6f7dc7bb16000000000000000000004007 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
object or null(HomefleetSwitchDetail)
Response
application/json
{
  "customerId": "ab1c23456d78901e23fghijk456lm7no",
  "generation": 1692945579,
  "id": "default.switch-0",
  "partNumber": "AB123C",
  "serialNumber": "AB1234C5D6",
  "status": {
    "macAddress": "00:00:5e:00:53:00",
    "conditions": [ … ],
    "fanState": "Ok",
    "firmwareVersion": "MOCK.1.0",
    "internalNtpEnabledState": "",
    "internalNtpServer": "",
    "lastModifiedTime": "2023-08-24T07:14:33Z",
    "locatorLedState": "Off",
    "managementIpAddress": "192.168.1.1",
    "observedGeneration": 3,
    "operationalState": "Good",
    "powerSupplyOneState": "Ok",
    "powerSupplyZeroState": "Ok",
    "ready": true,
    "switchFans": [ … ],
    "switchId": "sw1",
    "switchPorts": [ … ],
    "temperatureState": "Normal",
    "usage": "internal"
  },
  "systemId": "1AB234CDEF",
  "apiVersion": "sc.hpe.com/v1",
  "associatedLinks": [
    { … }
  ],
  "clusterId": "123abcd4-5e67-890f-g123-4hi5j67kl8m9",
  "clusterRef": "/api/sc.hpe.com/v1/default/switch/switch-1",
  "commonResourceAttributes": {
    "cloudState": "CONNECTED",
    "errCode": "E01",
    "errMessage": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests."
  },
  "kind": "Switch",
  "numberOfPorts": 32,
  "resourceUri": "/storage-fleet/v1alpha1/devtype7-storage-systems/4UN042PTDW",
  "type": "switch"
}

Edit HPE Alletra Storage X10000 system Switch identified by {switchId}

Request

Edit HPE Alletra Storage X10000 system Switch identified by {switchId}

Security
bearer
Path
systemIdstringrequired

ID of the storage system

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
switchIdstringrequired

Identifier of Switch. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004007
Bodyapplication/jsonrequired
internalNtpServerstring or null

Internal NTP server details

Example: "172.190.10.12"
locatorLedStatestring

The desired state of the locator LED on the Switch. Possible Values are 'On', 'Off'

Example: "On"
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype7-storage-systems/2a0df0fe6f7dc7bb16000000000000000000004817/switches/2a0df0fe6f7dc7bb16000000000000000000004007 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
application/json
{
  "message": "Successfully submitted",
  "status": "SUBMITTED",
  "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}