Skip to content
/hosts

HPE Greenlake For Block Storage REST APIs (1.0.0)

HPE Greenlake For Block Storage REST APIs

Download OpenAPI description
block-storage-api.json
block-storage-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/block-storage/public/openapi/block-storage-latest/v1/block-storage-api/

host-initiator-groups

The Host service API allows the management of Host Group

Operations

host-initiators

The Host service API allows the management of Host, initiators

Operations

host-paths

The ports API allows the management of host-paths

Operations

host-sets

The ports API allows the management of host-sets

Operations

hosts

The ports API allows the management of hosts

Operations

Get details of HPE Alletra Storage MP B10000 Hosts

Request

Get details of HPE Alletra Storage MP B10000 Hosts

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

Lucene query to filter host by Key.

Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817
sortstring

oData query to sort host resource by Key.

Example: sort=HostSpeed 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/block-storage/v1/devtype4-storage-systems/7CE751P312/hosts \
  -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(DeviceType4HostListObj)required
items[].​idstringrequired

Host Resource UID Filter

Example: "132b493352ca3141456333edf403be0c"
items[].​typestringrequired

type of the resource

items[].​agentobject or null(DeviceType4HostAgent)
items[].​associatedLinksArray of objects or null

Associated Links Details

items[].​commonResourceAttributesobject or null(commonResourceAttributesDeviceType4Host)
items[].​descriptorsobject or null(DeviceType4HostDescriptors)
items[].​displaynamestring or null

Name to be used for display purposes

Example: "Drive 0.SIDE_NONE.2.0"
items[].​domainstring or null

Domain name of the Host

Example: "slt"
items[].​generationinteger(Uint64)

Generation Time of the Resource Filter, Sort

Example: 1652172502
items[].​hostIdinteger or null(Uint64)

Numeric ID of the resource

Example: 101780
items[].​initiatorChapEnabledboolean or null

Indicates if the Initiator Chap is enabled or not

items[].​initiatorChapNamestring or null

Initiator Chap Name

Example: "chapName"
items[].​initiatorEncryptedChapSecretstring or null

Initiator Encrypted Chap Secret

Example: "secret"
items[].​isNvmfStretchedboolean or null

Indicates if this host is NVMe stretched.

items[].​isVvolHostboolean or null

Indicates if this host is used to export VASA vVol over NVMe Protocol.

items[].​minLunIdinteger or null(Uint64)

LUN Id of the host

Example: 10
items[].​namestring or null

Host Name Filter, Sort

Example: "test-host"
items[].​personaobject or null(DeviceType4Persona)
items[].​resourceUristring or null

Resoure Uri of the Host

Example: "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a"
items[].​scHostIdstring or null

Host Service Host Id Filter

Example: "132b493352ca3141456333edf403be0c"
items[].​stateobject or null(DeviceType4HostState)
items[].​stateDescriptionArray of strings or null or null
items[].​stateValinteger or null(Uint64)

Health Status of the Host

Example: 1
items[].​systemUidstring

Serial Number of the system Filter

Example: "swK21"
items[].​systemWwnstring

System wwn Filter, Sort

Example: "swK21"
items[].​targetChapEnabledboolean or null

Indicates if the Target Chap is enabled or not

items[].​targetChapNamestring or null

Target Chap Name

Example: "sltest1"
items[].​targetEncryptedChapSecretstring or null

Target Encrypted Chap Secret

Example: "Target Encrypted Chap Secret"
items[].​uaRepLunboolean or null

Indicates if the UaRepLun is enabled or not

items[].​uristring or null

Resoure Uri of the Host

Example: "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a"
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 Host identified by {HostId}

Request

Get details of HPE Alletra Storage MP B10000 Host identified by {HostId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
hostIdstringrequired

ID of the HPE Alletra Storage MP B10000 Host Set. A 42 digit hexadecimal number.

Example: 2a0df0fe6f7dc7bb16000000000000000000004817
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/block-storage/v1/devtype4-storage-systems/7CE751P312/hosts/2a0df0fe6f7dc7bb16000000000000000000004817 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Host Resource UID

Example: "132b493352ca3141456333edf403be0c"
typestringrequired

Type of the resource

agentobject or null(DeviceType4HostAgent)
associatedLinksArray of objects or null

Associated Links Details

commonResourceAttributesobject or null(commonResourceAttributesDeviceType4Host)
descriptorsobject or null(DeviceType4HostDescriptors)
displaynamestring or null

Name to be used for display purposes

Example: "Drive 0.SIDE_NONE.2.0"
domainstring or null

Domain name of the Host

Example: "slt"
generationinteger(Uint64)

Generation Time of the Resource

Example: 1652172502
hostIdinteger or null(Uint64)

Numeric ID of the resource

Example: 101780
initiatorChapEnabledboolean or null

Indicates if the Initiator Chap is enabled or not

initiatorChapNamestring or null

Initiator Chap Name

Example: "chapName"
initiatorEncryptedChapSecretstring or null

Initiator Encrypted Chap Secret

Example: "secret"
isNvmfStretchedboolean or null

Indicates if this host is NVMe stretched.

isVvolHostboolean or null

Indicates if this host is used to export VASA vVol over NVMe Protocol.

minLunIdinteger or null(Uint64)

LUN Id of the host

Example: 10
namestring or null

Host Name

Example: "test-host"
personaobject or null(DeviceType4Persona)
resourceUristring or null

Resoure Uri of the Host

Example: "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a"
scHostIdstring or null

Host Service Host Id

Example: "132b493352ca3141456333edf403be0c"
stateobject or null(DeviceType4HostState)
stateDescriptionArray of strings or null or null
stateValinteger or null(Uint64)

Health Status of the Host

Example: 1
systemUidstring

Serial Number of the system

Example: "swK21"
systemWwnstring

System wwn

Example: "swK21"
targetChapEnabledboolean or null

Indicates if the Target Chap is enabled or not

targetChapNamestring or null

Target Chap Name

Example: "sltest1"
targetEncryptedChapSecretstring or null

Target Encrypted Chap Secret

Example: "Target Encrypted Chap Secret"
uaRepLunboolean or null

Indicates if the UaRepLun is enabled or not

uristring or null

Resoure Uri of the Host

Example: "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a"
Response
application/json
{
  "agent": {
    "architecture": "SAN",
    "bootFromSan": "yes",
    "clusterName": "SAN-cluster",
    "clusterSoftware": "Linux",
    "clusterVersion": "v1.0.0",
    "hostApps": "mysql",
    "ipAddr": "10.15.12.136",
    "lastUpdated": { … },
    "multiPathSoftware": "OS",
    "multiPathSoftwareVersion": "v1.0.0",
    "os": "Linux",
    "osPatch": "v1.0.0",
    "osVersion": "v1.0.0",
    "reportedName": "slvs"
  },
  "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."
  },
  "descriptors": {
    "comment": "Comments",
    "contact": "1234567788e",
    "ipAddr": "1.1.1.1",
    "location": "US",
    "model": "AIX",
    "os": "Linux"
  },
  "displayname": "Drive 0.SIDE_NONE.2.0",
  "domain": "slt",
  "generation": 1652172502,
  "hostId": 101780,
  "id": "132b493352ca3141456333edf403be0c",
  "initiatorChapEnabled": true,
  "initiatorChapName": "chapName",
  "initiatorEncryptedChapSecret": "secret",
  "isNvmfStretched": true,
  "isVvolHost": true,
  "minLunId": 10,
  "name": "test-host",
  "persona": {
    "capabilities": [ … ],
    "id": "string",
    "name": "test-host"
  },
  "resourceUri": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a",
  "scHostId": "132b493352ca3141456333edf403be0c",
  "state": {
    "detailed": { … },
    "overall": "NORMAL"
  },
  "stateDescription": [
    "string"
  ],
  "stateVal": 1,
  "systemUid": "swK21",
  "systemWwn": "swK21",
  "targetChapEnabled": true,
  "targetChapName": "sltest1",
  "targetEncryptedChapSecret": "Target Encrypted Chap Secret",
  "type": "string",
  "uaRepLun": true,
  "uri": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a"
}

storage-pools

The pools API allows the management of storage pools

Operations

storage-systems

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

Operations

volume-sets

The Volume-sets API allows the management of volume sets

Operations

volumes

The volumes API allows the management of volumes

Operations

snapshots

Operations