Skip to content
/storage-systems

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

Get all HPE Alletra Storage MP B10000 storage systems

Request

Get all HPE Alletra Storage MP B10000 storage systems

Security
bearer
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 systems by Key.

Example: filter=name eq VEGA_CB1507_8400_2N_150
sortstring

Query to sort the response with specified key and order

Example: sort=id asc,name 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 \
  -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(DeviceType4StorageSystemDetailList)required
items[].​idstringrequired

SystemWWN/UUID string uniquely identifying the storage system object. Filter

Example: "7CE751P312"
items[].​typestringrequired

type

Example: "string"
items[].​associatedLinksArray of objects or null(DeviceType4AssociatedLinks)
items[].​brandingInfoobject or null(DeviceType4brandingInfo)
items[].​centerplaneTypestring or null

Centerplane type

Example: "4 Node Centerplane"
items[].​chunkletSizeMiBinteger or null(Uint64)

Size of chunklet in MiB

Example: 1024
items[].​clusterLedstring or null

Cluster LED state

Enum"LED_UNKNOWN""LED_OFF""LED_GREEN"
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

Example: "string"
items[].​descriptorsobject or null(DeviceType4descriptors)
items[].​deviceIdinteger or null(Uint64)

Numeric ID of the resource Filter

Example: 101780
items[].​deviceTypeobject or null

device Type

items[].​displaynamestring or null(string)

Array Display name

Example: "System VEGA_CB1507_8400_2N_150"
items[].​domainstring or null

Domain that the resource belongs to

items[].​fileServiceInfoobject or null
items[].​fqdnstring or null

Fully qualified domain name of the system

Example: "s9.in.hpecorp.net"
items[].​generationinteger or null

generation Filter, Sort

Example: 0
items[].​inClusterNodesArray of integers or null(Uint64)

IDs of the nodes that are in cluster

Example: [0,1]
items[].​locateEnabledboolean or null

Indicates if the locate beacon is enabled or not

items[].​maintenanceModeArray of objects or null(DeviceType4maintenanceMode)
items[].​manufacturingobject or null(DeviceType4manufacturingSys)
items[].​masterNodeinteger or null(Uint64)

ID of the master node

Example: 4
items[].​minimumPasswordLengthinteger or null(int64)

Minimum length of password for users

Example: 6
items[].​namestring or null

Name of the resource Filter, Sort

Example: "VEGA_CB1507_8400_2N_150"
items[].​networkMasterNodeinteger or null(Uint32)

The Node ID of the current network master Filter, Sort

Example: 1
items[].​nodeMemorystring or null

Node memory size

Example: "16"
items[].​nodesCountinteger or null(Uint32)

Number of nodes in the system

Example: 2
items[].​nodesPresentArray of integers or null(Uint64)

IDs of the nodes that are present

Example: [0,1]
items[].​onlineNodesArray of integers or null(Uint64)

IDs of the nodes that are online

Example: [0,1]
items[].​overallStatestring or null

overallState state derived from enclosure, disk and node state For deviceType1 State derived from ports, enclosure, disk and node state. For deviceType2 state is state reported by deviceType2 array. For deviceType4 state is derived from ports,enclosures,disks,nodes and enclosure-cards.

Enum"NORMAL""DEGRADED"null
Example: "NORMAL"
items[].​overallStateDescriptionstring or null(string)

Information of hardware resources that are in degraded state.

Example: "Degraded Resources: disks, nodes"
items[].​resourceUristring or null

resourceUri for detailed storage object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312"
items[].​safeToRemoveboolean or null

Indicates if the component is safe to remove

items[].​softwareVersionsobject or null(DeviceType4softwareVersions)
items[].​stateobject or null(DeviceType4systemState)
items[].​sysLogStatusobject or null(DeviceType4sysLogStatus)
items[].​systemDateinteger or null(Uint64)

Current date of the system

Example: 1597918380
items[].​systemHeadroomobject(systemHeadroom)
items[].​systemWwnstring or null

WWN of the array Filter, Sort

Example: "2FF70002AC018D94"
items[].​timezonestring or null

Current timezone of the system

Example: "Asia/Calcutta"
items[].​uptimeobject or null(DeviceType4uptime)
items[].​versionobject or null(DeviceType4version)
totalinteger

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

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

Get HPE Alletra Storage MP B10000 object identified by {id}

Request

Get HPE Alletra Storage MP B10000 object identified by {id}

Security
bearer
Path
idstringrequired

Serial number of the device-type4 storage system

Example: SGH029VBHV
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/SGH029VBHV \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

SerialNumber/UUID string uniquely identifying the storage system object.

Example: "7CE751P312"
typestringrequired

type

Example: "string"
associatedLinksArray of objects or null(DeviceType4AssociatedLinks)
brandingInfoobject or null(DeviceType4brandingInfo)
centerplaneTypestring or null

Centerplane type

Example: "4 Node Centerplane"
chunkletSizeMiBinteger or null(Uint64)

Size of chunklet in MiB

Example: 1024
clusterLedstring

Cluster LED state

Enum"LED_UNKNOWN""LED_OFF""LED_GREEN"
commonResourceAttributesobject or null(commonResourceAttributes)
customerIdstring or null

customerId

Example: "string"
descriptorsobject or null(DeviceType4descriptors)
deviceIdinteger or null(Uint64)

Numeric ID of the resource

Example: 101780
deviceTypeobject or null

device Type

displaynamestring or null(string)

Array Display name

Example: "System VEGA_CB1507_8400_2N_150"
domainstring or null

Domain that the resource belongs to

fileServiceInfoobject or null
fqdnstring or null

Fully qualified domain name of the system

Example: "s9.in.hpecorp.net"
generationinteger or null

generation

Example: 0
inClusterNodesArray of integers or null(Uint64)

IDs of the nodes that are in cluster

Example: [0,1]
locateEnabledboolean or null

Indicates if the locate beacon is enabled or not

maintenanceModeArray of objects or null(DeviceType4maintenanceMode)
manufacturingobject or null(DeviceType4ManufacturingSingle)
masterNodeinteger or null(Uint64)

ID of the master node

Example: 4
minimumPasswordLengthinteger or null(int64)

Minimum length of password for users

Example: 6
namestring or null

Name of the resource

Example: "VEGA_CB1507_8400_2N_150"
networkMasterNodeinteger or null(Uint32)

The Node ID of the current network master

Example: 1
nodeMemorystring or null

Node memory size

Example: "16"
nodesCountinteger or null(Uint32)

Number of nodes in the system

Example: 2
nodesPresentArray of integers or null(Uint64)

IDs of the nodes that are present

Example: [0,1]
onlineNodesArray of integers or null(Uint64)

IDs of the nodes that are online

Example: [0,1]
overallStatestring or null

overallState is derived from ports,enclosures,disks,nodes and enclosure-cards.

Enum"NORMAL""DEGRADED"null
Example: "NORMAL"
overallStateDescriptionstring or null(string)

Information of hardware resources that are in degraded state.

Example: "Degraded Resources: disks, nodes"
resourceUristring or null

resourceUri for detailed storage object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312"
safeToRemoveboolean or null

Indicates if the component is safe to remove

softwareVersionsobject or null(DeviceType4softwareVersionsSolo)
stateobject or null(DeviceType4systemState)
sysLogStatusobject or null(DeviceType4sysLogStatus)
systemDateinteger or null(Uint64)

Current date of the system

Example: 1597918380
systemHeadroomobject(systemHeadroom)
systemWwnstring or null

WWN of the array.

Example: "2FF70002AC018D94"
timezonestring or null

Current timezone of the system.

Example: "Asia/Calcutta"
uptimeobject or null(DeviceType4uptime)
versionobject or null(DeviceType4version)
Response
application/json
{
  "associatedLinks": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "brandingInfo": {
    "hwModel": "HPE Alletra Storage MP B10000",
    "hwProduct": "Alletra Storage MP B10000",
    "hwProductFull": "HPE Alletra Storage MP B10000",
    "osFull": "HPE Alletra Storage ArcusOS",
    "osName": "HPE Alletra Storage ArcusOS",
    "product": "Alletra Storage MP B10000",
    "productFull": "HPE Alletra Storage MP B10000",
    "productNoSpace": "HPE_Alletra_Storage",
    "softProduct": "Alletra Storage",
    "softProductFull": "HPE Alletra Storage",
    "uiName": "Alletra Storage UI",
    "uiNameFull": "HPE Alletra Storage ui",
    "vendor": "HPE"
  },
  "centerplaneType": "4 Node Centerplane",
  "chunkletSizeMiB": 1024,
  "clusterLed": "LED_UNKNOWN",
  "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",
  "descriptors": {
    "comment": "",
    "contact": "First Last, 12345678, prabhakar.jasiwal@hpe.com",
    "location": "",
    "owner": ""
  },
  "deviceId": 101780,
  "deviceType": {
    "default": "HPE_3PAR 8450",
    "key": "sys_type-41"
  },
  "displayname": "System VEGA_CB1507_8400_2N_150",
  "domain": "string",
  "fileServiceInfo": {
    "capacitySummary": { … },
    "defaultQoS": { … },
    "fileServiceId": "string",
    "isFileCapable": true,
    "isFileEnabled": true
  },
  "fqdn": "s9.in.hpecorp.net",
  "generation": 0,
  "id": "7CE751P312",
  "inClusterNodes": [
    0,
    1
  ],
  "locateEnabled": true,
  "maintenanceMode": [
    { … }
  ],
  "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"
  },
  "masterNode": 4,
  "minimumPasswordLength": 6,
  "name": "VEGA_CB1507_8400_2N_150",
  "networkMasterNode": 1,
  "nodeMemory": "16",
  "nodesCount": 2,
  "nodesPresent": [
    0,
    1
  ],
  "onlineNodes": [
    0,
    1
  ],
  "overallState": "NORMAL",
  "overallStateDescription": "Degraded Resources: disks, nodes",
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312",
  "safeToRemove": true,
  "softwareVersions": {
    "baseVersion": "4.2.0",
    "components": [ … ],
    "fullVersion": "4.2.0.48",
    "patches": "",
    "release": ""
  },
  "state": {
    "detailed": [ … ],
    "overall": "STATE_UNKNOWN"
  },
  "sysLogStatus": {
    "general": "None,None,None",
    "security": "None,None,None"
  },
  "systemDate": 1597918380,
  "systemHeadroom": {
    "performanceHeadroom": { … }
  },
  "systemWwn": "2FF70002AC018D94",
  "timezone": "Asia/Calcutta",
  "type": "string",
  "uptime": {
    "ms": 123423423,
    "tz": "IST"
  },
  "version": {
    "base": "4.2.0",
    "display": "4.2.0",
    "full": "4.2.0.48",
    "fullWithoutPatches": "4.2.0.48"
  }
}

Locate an HPE Alletra Storage MP B10000 system

Request

Locate an HPE Alletra Storage MP B10000 system

Security
bearer
Path
idstringrequired

Serial number of the device-type4 storage system

Example: SGH029VBHV
Bodyapplication/jsonrequired
locateEnabledboolean

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/SGH029VBHV \
  -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"
}

switches

The Switch API provides endpoints for managing and configuring switches.

Operations

system-settings

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

Operations

vvolscs

Operations