Skip to content

HPE Greenlake For Block Storage REST APIs. (1.1.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-public-v1alpha1/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

Get the list of hosts which have duplicates

Request

Get the list of hosts which have identical duplicates or are unique across different systems.

Security
bearer
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiator-merge-candidates \
  -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(BulkMergeCandidatesObject)required
items[].​idstringrequired

Identifier for duplicate host.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​duplicateIdsArray of strings or null

host ids of all avialable duplicates

items[].​membersArray of strings or null

initiator addresses of all initiaors

items[].​namestring or null

Name of the host.

Example: "host1"
items[].​systemsArray of strings or null

system IDs to which the host belongs to.

totalinteger

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

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

Get the list of hosts

Request

Get the list of hosts

Security
bearer
Query
filterstring

oData query to filter hostservice by Key.

Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817
sortstring

oData query to sort hostservice by Key.

Example: sort=name desc
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
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Headers
ETagstring

List of Hosts

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(HostObject)required
items[].​idstringrequired

Identifier for host. Filter

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

The type of resource.

Example: "host-initiator"
items[].​associatedLinksArray of objects or null(scAssociatedLinks)
items[].​associatedSystemsArray of strings or null

The system IDs the host is associated with. Filter

items[].​commentstring or null

Comment

Example: "a sample host comment"
items[].​contactstring or null

Contact information

Example: "sanjay@hpe.com"
items[].​customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"
items[].​editStatusstring or null

Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success. Filter

Example: "Delete_Failed"
items[].​fqdnstring or null

Fully qualified domain name of the host.

Example: "host1.hpe.com"
items[].​generationinteger(int64)

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

Example: 1627534116
items[].​hostGroupsArray of objects or null(HostGroupSummaryObject)

Host group to which the host belongs to. Filter by hostGroupId. Sort by count.

items[].​initiatorsArray of objects or null(InitiatorSummary)

Host initiator list this host is associated with. Filter by initiatorId. Sort by count.

items[].​ipAddressstring or null

IP address of the host.

Example: "15.212.100.100"
items[].​isMergableboolean or null

Indicates whether host has a duplicate. This field is applicable only when isMergable Filter is set to true on the GET All else will be set to false always. Sort

Example: true
items[].​isVvolHostboolean or null

Indicates if this host is created with NVMe initiator to be used by VASA vvol or not

Example: true
items[].​locationstring or null

location.

Example: "India"
items[].​markedForDeleteboolean or null

Indicates whether host is marked for deletion or not

Example: true
items[].​modelstring or null

Model

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

Name of the host. Filter, Sort

Example: "host1"
items[].​operatingSystemstring or null

Host operating system. Filter

Example: "Windows"
items[].​personastring or null

Host persona details.

Example: "AIX-Legacy"
items[].​subnetstring or null

subnet.

Example: "255.255.255.0"
items[].​systemsArray of strings or null

system IDs to which the host belongs to. Filter. Sort by count.To filter hosts based on domain, "domain" as a filter can be used along with "system" as a filter. When using this domain filter, only single system id in the request is allowed.

items[].​userCreatedboolean or null

Indicates whether user created host or discovered host. Filter

Example: true
totalinteger

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

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

Create a host

Request

Create a host with same protocol initiators

Security
bearer
Bodyapplication/jsonrequired
namestring or nullrequired

Name of the host.

Example: "host1"
operatingSystemstring or nullrequired

Host operating system. Possible Values are: - AIX - Apple - Citrix Hypervisor(XenServer) - HP-UX - IBM VIO Server - InForm - NetApp/ONTAP - OE Linux UEK - OpenVMS - Oracle VM x86 - RHE Linux - RHE Virtualization - Solaris - SuSE Linux - SuSE Virtualization - Ubuntu - VMware (ESXi) - Windows Server

Enum"AIX""Apple""Citrix Hypervisor(XenServer)"
Example: "Windows Server"
commentstring or null

Comment

Example: "comment1"
contactstring or null

Contact information

Example: "sanjay@hpe.com"
fqdnstring or null

Fully qualified domain name of the host.

Example: "host1.hpe.com"
hostGroupIdsArray of strings or null

List of hostgroup IDs

initiatorIdsArray of strings or null

List of ids of existing initiators

initiatorsToCreateArray of objects or null(InitiatorInput)

List of initiators to be created and added to this host

ipAddressstring or null

IP address of the host.

Example: "15.212.100.100"
locationstring or null

location.

Example: "India"
modelstring or null

Model

Example: "model1"
personastring or null

Host persona details.

Example: "AIX-Legacy"
subnetstring or null

subnet.

Example: "255.255.255.0"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "host1",
    "operatingSystem": "Windows Server"
  }'

Responses

Created

Bodyapplication/json
idstringrequired

Identifier for host.

Example: "6848ef683c27403e96caa51816ddc72c"
typestringrequired

The type of resource.

Example: "host-initiator"
associatedLinksArray of objects or null(scAssociatedLinks)
associatedSystemsArray of strings or null

system IDs to which the host belongs to.

commentstring or null

Comment

Example: "a sample host comment"
contactstring or null

Contact information

Example: "sanjay@hpe.com"
customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"
editStatusstring or null

Host Update or Delete progress status. Possible status are: Update_In_Progress,Update_Success,Update_Failed,Delete_In_Progress,Delete_Failed,Not_Applicable,Merge_Success,Merge_In_Progress,Merge_Failed,Convert_In_Progress,Convert_Failed,Convert_Success.

Example: "Delete_Failed"
fqdnstring or null

Fully qualified domain name of the host.

Example: "host1.hpe.com"
generationinteger(int64)

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

Example: 1627534116
hostGroupsArray of objects or null(HostGroupSummaryObjectDetails)

Host group to which the host belongs to.

initiatorsArray of objects or null(InitiatorObjectDetails)

Host initiator list this host is associated with.

ipAddressstring or null

IP address of the host.

Example: "15.212.100.100"
isMergableboolean or null

Indicates whether host has a duplicate. This field is applicable only when isMergable Filter is set to true on the GET All else will be set to false always.

Example: true
isVvolHostboolean or null

Indicates if this host is created with NVMe initiator to be used by VASA vvol or not

Example: true
locationstring or null

location.

Example: "India"
markedForDeleteboolean or null

Indicates whether host is marked for deletion or not

Example: true
modelstring or null

Model

Example: "model1"
namestring or null

Name of the host.

Example: "host1"
operatingSystemstring or null

Host operating system.

Example: "Windows"
personastring or null

Host persona details.

Example: "AIX-Legacy"
subnetstring or null

subnet.

Example: "255.255.255.0"
systemsArray of strings or null

system IDs to which the host belongs to.

userCreatedboolean or null

Indicates whether user created host or discovered host

Example: true
Response
application/json
{
  "associatedLinks": [
    { … }
  ],
  "associatedSystems": [
    "string"
  ],
  "comment": "a sample host comment",
  "contact": "sanjay@hpe.com",
  "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  "editStatus": "Delete_Failed",
  "fqdn": "host1.hpe.com",
  "generation": 1627534116,
  "hostGroups": [
    { … }
  ],
  "id": "6848ef683c27403e96caa51816ddc72c",
  "initiators": [
    { … }
  ],
  "ipAddress": "15.212.100.100",
  "isMergable": true,
  "isVvolHost": true,
  "location": "India",
  "markedForDelete": true,
  "model": "model1",
  "name": "host1",
  "operatingSystem": "Windows",
  "persona": "AIX-Legacy",
  "subnet": "255.255.255.0",
  "systems": [
    "string"
  ],
  "type": "host-initiator",
  "userCreated": true
}

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

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