Skip to content
/shelves

HPE Greenlake For Storage Fleet REST APIs (1.0.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-latest/v1/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

migrations

The Migrations API allows the management of data migration from source storage systems.

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

Get details of HPE Alletra Storage MP B10000 Enclosure Cards identified by {systemId}

Request

Get details of HPE Alletra Storage MP B10000 Enclosure Cards identified by {systemId}

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 enclosure resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort enclosure 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/v1/devtype4-storage-systems/7CE751P312/enclosure-cards \
  -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(DeviceType4enclosureCardList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

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

type

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

customerId

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

Enclosure Display name

items[].​domainstring or null

Domain that the resource belongs to

Example: null
items[].​elementStatusCodestring or null

Enclosure status code

items[].​enclosureCardIdinteger or null(int64)

ID of enclosure card.

Example: 0
items[].​enclosureIdinteger or null
Example: 1
items[].​enclosureNamestring or null

Name of the enclosure. Filter, Sort

items[].​enclosureTypestring(DeviceType4enclosureTypeSingle)
Enum"ENCLOSURE_UNKNOWN""ENCLOSURE_DC0""ENCLOSURE_DC1"
items[].​enclosureUidstring or null

Parent UID of the resource. Filter

Example: "9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​failIndicatorboolean or null
Example: false
items[].​generationinteger or null

generation Filter, Sort

Example: 0
items[].​isNodeCardboolean or null
Example: false
items[].​locateEnabledboolean or null

Indicates if the locate beacon is enabled or not

Example: false
items[].​locateSevenSegDisplaystring or null

Seven segment display on enclosure card when locate is on

items[].​loopAboolean or null
Example: false
items[].​loopBboolean or null
Example: false
items[].​manufacturingobject or null(DeviceType4manufacturing)
items[].​namestring or null<= 255 characters

Name of the resource. Filter, Sort

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

resourceUri for detailed enclosure card object

Example: "/storage-fleet/v1/devtype4-storage-systems/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac"
items[].​safeToRemoveboolean or null
Example: false
items[].​sevenSegDisplaystring or null

Seven segment display

items[].​stateobject or null(DeviceType4State)
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 Enclosure Connectors

Request

Get details of HPE Alletra Storage MP B10000 Enclosure Connectors

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 enclosure resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort enclosure 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/v1/devtype4-storage-systems/7CE751P312/enclosure-connectors \
  -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(DeviceType4enclosureConnectorsList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

Example: "id"
items[].​typestringrequired

Resource Type for the enclosure connector

Example: "type1"
items[].​associatedLinksArray of objects or null or null(DeviceType4ecrAssociatedLinks)
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​connectorinteger or null(int64)

Connector on slot on IOM in Cage for connection

Example: 0
items[].​currentSpeedstring or null

Current speed of connection

Example: "currentSpeed"
items[].​customerIdstring or null

customerId

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

Disabled for connection

Example: "disabled"
items[].​displaynamestring or null

Name to be used for display purposes

Example: "display name"
items[].​domainstring or null

Domain that the resource belongs to

items[].​elementStatusCodeobject or null(DeviceType4ElementStatusCode)
items[].​enclosureCardIdinteger or null(int64)

ID of the enclosure card

Example: 0
items[].​enclosureCardPciUidstring or null

UID of the enclosure card PCI card

Example: "PCIUID"
items[].​enclosureCardUidstring or null

Unique Identifier of the enclosure card

Example: "CardUID"
items[].​enclosureIdinteger or null(int64)

ID of the enclosure

Example: 0
items[].​enclosureNamestring or null

Name of the enclosure.

Example: "name"
items[].​enclosureUidstring or null

Unique Identifier of the enclosure

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

generation Filter, Sort

Example: 0
items[].​ipv4Addressstring or null

ip v4 address of connection

Example: "ipv4"
items[].​ipv6Addressstring or null

ip v6 address of connection

Example: "ipv6"
items[].​labelstring or null

Connection label

Example: "label"
items[].​linkSpeedstring or null

Link speed for connection

Example: "speed"
items[].​locatestring or null

Locate for connection

Example: "locate"
items[].​macAddressstring or null

mac address of connection

Example: "mac"
items[].​nodePortobject or null

It includes node number, slot number, and port number

items[].​resourceUristring or null

resourceUri for detailed enclosure connector object

Example: "/storage-fleet/v1/devtype4-storage-systems/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-connectors/8621946048c1cb24bdfc57e9b3b460ac"
items[].​slotinteger or null(int64)

Slot on IOM in Cage for connection

Example: 0
items[].​systemIdstring

Id of the array

Example: "4UW0004156"
items[].​typeConnectionstring or null

Type of connection

Example: "External"
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 Enclosures

Request

Get details of HPE Alletra Storage MP B10000 Enclosures

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 enclosure resource by Key.

Example: filter=systemWWN eq 2FF70002AC018D94
sortstring

oData query to sort enclosure 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/v1/devtype4-storage-systems/7CE751P312/enclosures \
  -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(DeviceType4enclosuresList)required
items[].​idstringrequired

Unique Identifier of the resource. Filter

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

type

Example: "string"
items[].​associatedLinksArray of objects or null(DeviceType4encAssociatedLinks)
items[].​chainPosLoopAinteger or null
Example: 0
items[].​chainPosLoopBinteger or null
Example: 0
items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​customerIdstring or null

customerId

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

Enclosure Display name

items[].​domainstring or null

Domain that the resource belongs to

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

Numeric ID of the resource

Example: 0
items[].​enclosureTypestring(DeviceType4enclosureTypeSingle)
Enum"ENCLOSURE_UNKNOWN""ENCLOSURE_DC0""ENCLOSURE_DC1"
items[].​errorsArray of objects or null or null(DeviceType4errors)
items[].​failIndicatorboolean or null
Example: false
items[].​failRequestedboolean or null
Example: false
items[].​formFactorstring or null
Example: "SFF"
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[].​locationstring or null

Location of the resource

items[].​loopSplitboolean or null
Example: true
items[].​manufacturingobject or null(DeviceType4ManufacturingSingle)
items[].​namestring or null<= 255 characters

Name of the resource. Filter, Sort

Example: "cage1"
items[].​nodeWwnstring or null

WWn of the node resource

Example: "50050CC106233428"
items[].​resourceUristring

resourceUri for detailed enclosure object

Example: "/storage-fleet/v1/devtype4-storage-systems/7CE751P312/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f"
items[].​stateobject or null(DeviceType4State)
items[].​subTypestring or null

Enclosure sub type

items[].​systemIdstring or null

SystemUid/Serial Number of the array.

Example: "7CE751P312"
items[].​warnIndicatorboolean or null
Example: false
items[].​warnRequestedboolean or null
Example: false
totalinteger

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

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

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

system-settings

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

Operations

vvolscs

Operations