Skip to content
/switches

HPE Greenlake For Storage Fleet REST APIs (1.2.0)

HPE Greenlake For 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/

certificates

The Certificate API provides endpoints for managing and configuring certificates.

Operations

controllers

The controllers API allows the management of controller fleet.

Operations

enclosures

The Enclosure API provides endpoints for managing and configuring enclosures.

Operations

encryption

The encryption API allows the actions on encryption.

Operations

jbofioms

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

Operations

object-notification-clients

The Object Notification Client API provides endpoints for managing and configuring object notification clients.

Operations

ports

The ports API allows the management of ports.

Operations

shelves

The shelves API allows the management of shelves.

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 details of HPE Alletra Storage MP B10000 Switch ports

Request

Get details of HPE Alletra Storage MP B10000 Switch ports

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
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
filterstring

oData query to filter switch resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort switch resource by Key.

Example: sort=systemWWN desc
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/devtype4-storage-systems/7CE751P312/switch-ports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4SwitchPortList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​typestringrequired

type

Example: "string"
items[].​associatedLinksArray of objects or null or null(DeviceType4PortAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​devicestring or null

Device (either node or IOM) to which the switch port is connected to

Example: "node1"
items[].​devicePortstring or null

Port on device that the switch port is connected to

Example: "2:2"
items[].​displaynamestring or null(string)

Name to be used for display purposes

Example: "Switch sw1 port 14"
items[].​domainstring or null(string)

Domain that the resource belongs to

Example: "switch"
items[].​enclosurestring or null(string)

Enclosure (cage) to which the switch port is connected to

Example: "cage1"
items[].​generationinteger or null
Example: 0
items[].​ipAddressstring or null(string)

Switch port IP Address

Example: "16.1.9.2"
items[].​macAddressstring or null(string)

MAC address of the switch port

Example: "90:20:c2:c2:35:00"
items[].​portDescriptionstring or null(string)

Switch port description

Example: "eth14"
items[].​resourceUristring or null

resourceUri for detailed switch port object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switch-port/8621946048c1cb24bdfc57e9b3b460ac"
items[].​sfpobject or null(SwitchPortSfp)
items[].​stateobject or null(DeviceType4State)
items[].​switchNamestring or null

Switch name.

Example: "sw1"
items[].​switchPortIdinteger or null(int64)

ID of the resource

Example: 1
items[].​switchUidstring or null(string)

Switch UID

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
totalinteger

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

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

Get details of HPE Alletra Storage MP B10000 Switches

Request

Get details of HPE Alletra Storage MP B10000 Switches

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
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
filterstring

oData query to filter switch resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort switch resource by Key.

Example: sort=systemWWN desc
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/devtype4-storage-systems/7CE751P312/switches \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4SwitchList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​typestringrequired

type

Example: "string"
items[].​activeIpAddressstring or null

Switch active IP Address

Example: "16.1.9.251"
items[].​associatedLinksArray of objects or null or null(DeviceType4SwitchAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​dhcpServersArray of objects or null or null(SwitchDeviceDHCPServer)
items[].​displaynamestring or null(string)

Name to be used for display purposes

Example: "Switch sw2"
items[].​domainstring or null(string)

Domain that the resource belongs to

Example: "switch"
items[].​fanStateobject or null(DeviceType4State)
items[].​fwVersionstring or null(string)

Switch firmware version

Example: "GL.10.11.0001"
items[].​generationinteger or null

generation Filter, Sort

Example: 0
items[].​locateEnabledboolean or null

Indicates if the locate beacon is enabled or not

Example: false
items[].​macAddressstring or null(string)

MAC address of the switch

Example: "90:20:c2:c2:35:00"
items[].​manufacturingobject or null(DeviceType4manufacturing)
items[].​modestring or null(string)

Switch mode

Example: "online"
items[].​namestring or null

Name of the resource. Filter

Example: "sw1"
items[].​primaryPathstring or null(string)

Switch primary path state

Example: "Active"
items[].​ps1Stateobject or null(DeviceType4State)
items[].​ps2Stateobject or null(DeviceType4State)
items[].​resourceUristring or null

resourceUri for detailed switch object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/8621946048c1cb24bdfc57e9b3b460ac"
items[].​secondaryPathstring or null(string)

Switch secondary path state

Example: "Inactive"
items[].​stateobject or null(DeviceType4State)
items[].​switchIdinteger or null(int64)

ID of the resource

Example: 1
items[].​systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
items[].​temperatureDetailstring or null(string)

Switch mode

Example: "online"
items[].​temperatureStateobject or null(DeviceType4State)
items[].​vlansArray of objects or null or null(SwitchDeviceVlan)
totalinteger

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

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

Get details of HPE Alletra Storage MP B10000 Switch identified by {id}

Request

Get details of HPE Alletra Storage MP B10000 Switch identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource.

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
typestringrequired

type

Example: "string"
activeIpAddressstring or null

Switch active IP Address

Example: "16.1.9.251"
associatedLinksArray of objects or null or null(DeviceType4SwitchAssociatedLinks)
commonResourceAttributesobject or null(commonResourceAttributes)
customerIdstring or null

customerId

Example: "string"
dhcpServersArray of objects or null or null(SwitchDeviceDHCPServer)
displaynamestring or null(string)

Name to be used for display purposes

Example: "Switch sw2"
domainstring or null(string)

Domain that the resource belongs to

Example: "switch"
fanStateobject or null(DeviceType4State)
fwVersionstring or null(string)

Switch firmware version

Example: "GL.10.11.0001"
generationinteger or null

generation

Example: 0
locateEnabledboolean or null

Indicates if the locate beacon is enabled or not

Example: false
macAddressstring or null(string)

MAC address of the switch

Example: "90:20:c2:c2:35:00"
manufacturingobject or null(DeviceType4manufacturing)
modestring or null(string)

Switch mode

Example: "online"
namestring or null

Name of the resource.

Example: "sw1"
primaryPathstring or null(string)

Switch primary path state

Example: "Active"
ps1Stateobject or null(DeviceType4State)
ps2Stateobject or null(DeviceType4State)
resourceUristring or null

resourceUri for detailed enclosure object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac"
secondaryPathstring or null(string)

Switch secondary path state

Example: "Inactive"
stateobject or null(DeviceType4State)
switchFansobject or null
switchIdinteger or null(int64)

ID of the resource

Example: 1
switchPortobject or null
switchPowerSuppliesobject or null
systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
temperatureDetailstring or null(string)

Switch mode

Example: "online"
temperatureStateobject or null(DeviceType4State)
vlansArray of objects or null or null(SwitchDeviceVlan)
Response
application/json
{
  "activeIpAddress": "16.1.9.251",
  "associatedLinks": [
    { … }
  ],
  "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."
  },
  "customerId": "string",
  "dhcpServers": [
    { … }
  ],
  "displayname": "Switch sw2",
  "domain": "switch",
  "fanState": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "fwVersion": "GL.10.11.0001",
  "generation": 0,
  "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  "locateEnabled": false,
  "macAddress": "90:20:c2:c2:35:00",
  "manufacturing": {
    "assemblyRev": "002*",
    "checkSum": "--",
    "hpeModelName": "HPE 3PAR 600 2S Node",
    "manufacturer": "XYRATEX",
    "model": "0974244-06",
    "saleablePartNumber": "0974244-06",
    "saleableSerialNumber": "4UW0002941",
    "serialNumber": "PMW0974244G4T88",
    "sparePartNumber": "P04031-001"
  },
  "mode": "online",
  "name": "sw1",
  "primaryPath": "Active",
  "ps1State": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "ps2State": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  "secondaryPath": "Inactive",
  "state": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "switchFans": {
    "items": [ … ]
  },
  "switchId": 1,
  "switchPort": {
    "items": [ … ]
  },
  "switchPowerSupplies": {
    "items": [ … ]
  },
  "systemId": "7CE751P312",
  "temperatureDetail": "online",
  "temperatureState": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "type": "string",
  "vlans": [
    { … }
  ]
}

Locate switch of HPE Alletra Storage MP B10000 identified by {id}

Request

Locate switch of HPE Alletra Storage MP B10000 identified by {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
Bodyapplication/jsonrequired
locateboolean

Indicates if the locate beacon should be enabled or not

Example: true
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5 \
  -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"
}

Get details of HPE Alletra Storage MP B10000 Switch Fans identified by switch id

Request

Get details of HPE Alletra Storage MP B10000 Switch Fans identified by switch id

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
switchIdstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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
filterstring

oData query to filter switch resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort switch resource by Key.

Example: sort=systemWWN desc
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/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5/switch-fans \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4SwitchFanList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​typestringrequired

type

Example: "string"
items[].​associatedLinksArray of objects or null or null(DeviceType4SwitchFanAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​displaynamestring or null(string)

Name to be used for display purposes

Example: "Fan 5"
items[].​domainstring or null(string)

Domain that the resource belongs to

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

generation Filter, Sort

Example: 0
items[].​localizedSpeedAobject or null

Switch fan localized speed

items[].​localizedSpeedBobject or null

Switch fan localized speed

items[].​manufacturingobject or null(DeviceType4manufacturing)
items[].​namestring or null

Name of the resource.

Example: "Tray-1/5/1"
items[].​resourceUristring or null

resourceUri for detailed switch fan object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/8621946048c1cb24bdfc57e9b3b460ac/switch-fans"
items[].​speedAstring or null(string)

Switch fan speed

Example: "normal"
items[].​speedBstring or null(string)

Switch fan speed

Example: "normal"
items[].​stateobject or null(DeviceType4State)
items[].​stateAobject or null(DeviceType4State)
items[].​stateBobject or null(DeviceType4State)
items[].​switchFanIdinteger or null(int64)

ID of the resource

Example: 1
items[].​switchNamestring or null(string)

Switch name

Example: "sw1"
items[].​switchUidstring or null(string)

Switch UID Filter

Example: "2bc9220b01fae89ef88f10994394b180"
items[].​systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
totalinteger

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

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

Get details of HPE Alletra Storage MP B10000 Switch Fan identified by switchId} and Fan id

Request

Get details of HPE Alletra Storage MP B10000 Switch Fan identified by switchId and Fan id

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
switchIdstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
idstringrequired

UID of the switch fan

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5/switch-fans/e9d353bf98fc1a6bdb90b824e3ca14b5 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource.

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
typestringrequired

type

Example: "string"
associatedLinksArray of objects or null or null(DeviceType4SwitchFanAssociatedLinks)
commonResourceAttributesobject or null(commonResourceAttributes)
customerIdstring or null

customerId

Example: "string"
displaynamestring or null(string)

Name to be used for display purposes

Example: "Fan 5"
domainstring or null(string)

Domain that the resource belongs to

Example: "switch"
generationinteger or null

generation

Example: 0
localizedSpeedAobject or null

Switch fan localized speed

localizedSpeedBobject or null

Switch fan localized speed

manufacturingobject or null(DeviceType4manufacturing)
namestring or null

Name of the resource.

Example: "Tray-1/5/1"
resourceUristring or null

resourceUri for detailed enclosure object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-fans/8621946048c1cb24bdfc57e9b3b460ac"
speedAstring or null(string)

Switch fan speed

Example: "normal"
speedBstring or null(string)

Switch fan speed

Example: "normal"
stateobject or null(DeviceType4State)
stateAobject or null(DeviceType4State)
stateBobject or null(DeviceType4State)
switchFanIdinteger or null(int64)

ID of the resource

Example: 1
switchNamestring or null(string)

Switch name

Example: "sw1"
switchUidstring or null(string)

Switch UID

Example: "2bc9220b01fae89ef88f10994394b180"
systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
Response
application/json
{
  "associatedLinks": [
    { … },
    { … }
  ],
  "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."
  },
  "customerId": "string",
  "displayname": "Fan 5",
  "domain": "switch",
  "generation": 0,
  "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  "localizedSpeedA": {
    "default": "Normal",
    "key": "SWITCH_FAN_SPEED_NORMAL"
  },
  "localizedSpeedB": {
    "default": "Normal",
    "key": "SWITCH_FAN_SPEED_NORMAL"
  },
  "manufacturing": {
    "assemblyRev": "002*",
    "checkSum": "--",
    "hpeModelName": "HPE 3PAR 600 2S Node",
    "manufacturer": "XYRATEX",
    "model": "0974244-06",
    "saleablePartNumber": "0974244-06",
    "saleableSerialNumber": "4UW0002941",
    "serialNumber": "PMW0974244G4T88",
    "sparePartNumber": "P04031-001"
  },
  "name": "Tray-1/5/1",
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-fans/8621946048c1cb24bdfc57e9b3b460ac",
  "speedA": "normal",
  "speedB": "normal",
  "state": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "stateA": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "stateB": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "switchFanId": 1,
  "switchName": "sw1",
  "switchUid": "2bc9220b01fae89ef88f10994394b180",
  "systemId": "7CE751P312",
  "type": "string"
}

Get details of HPE Alletra Storage MP B10000 Switch ports identified by {switchId}

Request

Get details of HPE Alletra Storage MP B10000 Switch ports identified by {switchId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
switchIdstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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
filterstring

oData query to filter switch resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort switch resource by Key.

Example: sort=systemWWN desc
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/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5/switch-ports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4SwitchPortList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​typestringrequired

type

Example: "string"
items[].​associatedLinksArray of objects or null or null(DeviceType4PortAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​devicestring or null

Device (either node or IOM) to which the switch port is connected to

Example: "node1"
items[].​devicePortstring or null

Port on device that the switch port is connected to

Example: "2:2"
items[].​displaynamestring or null(string)

Name to be used for display purposes

Example: "Switch sw1 port 14"
items[].​domainstring or null(string)

Domain that the resource belongs to

Example: "switch"
items[].​enclosurestring or null(string)

Enclosure (cage) to which the switch port is connected to

Example: "cage1"
items[].​generationinteger or null
Example: 0
items[].​ipAddressstring or null(string)

Switch port IP Address

Example: "16.1.9.2"
items[].​macAddressstring or null(string)

MAC address of the switch port

Example: "90:20:c2:c2:35:00"
items[].​portDescriptionstring or null(string)

Switch port description

Example: "eth14"
items[].​resourceUristring or null

resourceUri for detailed switch port object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switch-port/8621946048c1cb24bdfc57e9b3b460ac"
items[].​sfpobject or null(SwitchPortSfp)
items[].​stateobject or null(DeviceType4State)
items[].​switchNamestring or null

Switch name.

Example: "sw1"
items[].​switchPortIdinteger or null(int64)

ID of the resource

Example: 1
items[].​switchUidstring or null(string)

Switch UID

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
totalinteger

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

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

Get details of HPE Alletra Storage MP B10000 Switch Port identified by {switchId} and {id}

Request

Get details of HPE Alletra Storage MP B10000 Switch identified by {switchId} and {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
switchIdstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
idstringrequired

UID of the switch fan

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5/switch-ports/e9d353bf98fc1a6bdb90b824e3ca14b5 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource.

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
typestringrequired

type

Example: "string"
associatedLinksArray of objects or null or null(DeviceType4PortAssociatedLinks)
commonResourceAttributesobject or null(commonResourceAttributes)
customerIdstring or null

customerId

Example: "string"
devicestring or null

Device (either node or IOM) to which the switch port is connected to.

Example: "node1"
devicePortstring or null

Port on device that the switch port is connected to

Example: "2:2"
displaynamestring or null(string)

Name to be used for display purposes

Example: "Switch sw1 port 14"
domainstring or null(string)

Domain that the resource belongs to

Example: "switch"
enclosurestring or null(string)

Enclosure (cage) to which the switch port is connected to

Example: "cage1"
generationinteger or null

generation Filter, Sort

Example: 0
ipAddressstring or null(string)

Switch port IP Address

Example: "16.1.9.2"
macAddressstring or null(string)

MAC address of the switch port

Example: "90:20:c2:c2:35:00"
portDescriptionstring or null(string)

Switch port description

Example: "eth14"
resourceUristring or null

resourceUri for detailed enclosure object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-port/8621946048c1cb24bdfc57e9b3b460ac"
sfpobject or null(SwitchPortSfp)
stateobject or null(DeviceType4State)
switchNamestring or null

Switch name.

Example: "sw1"
switchPortIdinteger or null(int64)

ID of the resource

Example: 1
switchUidstring or null(string)

Switch UID

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
Response
application/json
{
  "associatedLinks": [
    { … }
  ],
  "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."
  },
  "customerId": "string",
  "device": "node1",
  "devicePort": "2:2",
  "displayname": "Switch sw1 port 14",
  "domain": "switch",
  "enclosure": "cage1",
  "generation": 0,
  "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  "ipAddress": "16.1.9.2",
  "macAddress": "90:20:c2:c2:35:00",
  "portDescription": "eth14",
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-port/8621946048c1cb24bdfc57e9b3b460ac",
  "sfp": {
    "cableLength": "2.00",
    "cableTechnology": "active",
    "connector": "QSFP28_AOC",
    "connectorStatus": "supported",
    "formFactor": "",
    "longXcvrDesc": "100G QSFP28 2m AOC",
    "maxSpeed": 100000,
    "propPartNumber": "5400-3937",
    "propProductNumber": "JL856A",
    "propSerialNumber": "CN26L1319D",
    "vendorName": "FINISAR CORP",
    "vendorOui": "00-90-65",
    "vendorPartNumber": "FCBN425QE2C02-PR",
    "vendorRevision": "A0",
    "vendorSerialNumber": "CN26L13023"
  },
  "state": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "switchName": "sw1",
  "switchPortId": 1,
  "switchUid": "9c3c4f29a82fd8d632ff379116fa0b8f",
  "systemId": "7CE751P312",
  "type": "string"
}

Get details of HPE Alletra Storage MP B10000 Switch power supplies identified by {switchId}

Request

Get details of HPE Alletra Storage MP B10000 Switch power supplies identified by {switchId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
switchIdstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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
filterstring

oData query to filter switch resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort switch resource by Key.

Example: sort=systemWWN desc
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/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5/switch-ps \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4SwitchPSList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​typestringrequired

type

Example: "string"
items[].​associatedLinksArray of objects or null or null(DeviceType4SwitchPSAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​displaynamestring or null(string)

Name to be used for display purposes

Example: "Fan 5"
items[].​domainstring or null(string)

Domain that the resource belongs to

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

generation Filter, Sort

Example: 0
items[].​manufacturingobject or null(DeviceType4manufacturing)
items[].​namestring or null

Name of the resource.

Example: "Tray-1/5/1"
items[].​resourceUristring or null

resourceUri for detailed switch ps object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/8621946048c1cb24bdfc57e9b3b460ac/switch-ps"
items[].​stateobject or null(DeviceType4State)
items[].​switchNamestring or null(string)

Switch name

Example: "sw1"
items[].​switchPsIdinteger or null(int64)

ID of the resource

Example: 1
items[].​switchUidstring or null(string)

Switch UID Filter

Example: "2bc9220b01fae89ef88f10994394b180"
items[].​systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
totalinteger

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

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

Get details of HPE Alletra Storage MP B10000 Switch Power Supplies identified by {switchId} and {id}

Request

Get details of HPE Alletra Storage MP B10000 Switch Power Supplies identified by {switchId} and {id}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
switchIdstringrequired

UID of the switch

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
idstringrequired

UID of the switch fan

Example: e9d353bf98fc1a6bdb90b824e3ca14b5
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/devtype4-storage-systems/7CE751P312/switches/e9d353bf98fc1a6bdb90b824e3ca14b5/switch-ps/e9d353bf98fc1a6bdb90b824e3ca14b5 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource.

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
typestringrequired

type

Example: "string"
associatedLinksArray of objects or null or null(DeviceType4SwitchPSAssociatedLinks)
commonResourceAttributesobject or null(commonResourceAttributes)
customerIdstring or null

customerId

Example: "string"
displaynamestring or null(string)

Name to be used for display purposes

Example: "Fan 5"
domainstring or null(string)

Domain that the resource belongs to

Example: "switch"
generationinteger or null

generation

Example: 0
manufacturingobject or null(DeviceType4manufacturing)
namestring or null

Name of the resource.

Example: "Tray-1/5/1"
resourceUristring or null

resourceUri for detailed enclosure object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-ps/8621946048c1cb24bdfc57e9b3b460ac"
stateobject or null(DeviceType4State)
switchNamestring or null(string)

Switch name

Example: "sw1"
switchPsIdinteger or null(int64)

ID of the resource

Example: 1
switchUidstring or null(string)

Switch UID

Example: "2bc9220b01fae89ef88f10994394b180"
systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
Response
application/json
{
  "associatedLinks": [
    { … },
    { … }
  ],
  "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."
  },
  "customerId": "string",
  "displayname": "Fan 5",
  "domain": "switch",
  "generation": 0,
  "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  "manufacturing": {
    "assemblyRev": "002*",
    "checkSum": "--",
    "hpeModelName": "HPE 3PAR 600 2S Node",
    "manufacturer": "XYRATEX",
    "model": "0974244-06",
    "saleablePartNumber": "0974244-06",
    "saleableSerialNumber": "4UW0002941",
    "serialNumber": "PMW0974244G4T88",
    "sparePartNumber": "P04031-001"
  },
  "name": "Tray-1/5/1",
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-ps/8621946048c1cb24bdfc57e9b3b460ac",
  "state": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "switchName": "sw1",
  "switchPsId": 1,
  "switchUid": "2bc9220b01fae89ef88f10994394b180",
  "systemId": "7CE751P312",
  "type": "string"
}

Get all switches of a HPE Alletra Storage MP X10000 system

Request

Get all switches of a HPE Alletra Storage MP 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 MP X10000 system identified by switchID

Request

Get Switch of a HPE Alletra Storage MP 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 MP X10000 system Switch identified by {switchId}

Request

Edit HPE Alletra Storage MP 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"
}

system-settings

The System Settings API allows the monitoring of System settings for the device.

Operations

vvolscs

Operations