Skip to content
/
Update Host by {hostId}

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 host details by {hostId}

Request

Get the host details by {hostId}

Security
bearer
Path
hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Headers
ETagstring

Host details

Bodyapplication/json
idstringrequired

Identifier for host.

Example: "d548ef683c27403e96caa51816ddc72c"
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: "comment1"
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(HostGroupSummaryObject)

Host group to which the host belongs to

initiatorsArray of objects or null(InitiatorSummary)

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 group 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": "comment1",
  "contact": "sanjay@hpe.com",
  "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  "editStatus": "Delete_Failed",
  "fqdn": "host1.hpe.com",
  "generation": 1627534116,
  "hostGroups": [
    { … }
  ],
  "id": "d548ef683c27403e96caa51816ddc72c",
  "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
}

Update Host by {hostId}

Request

Update host details by {hostId}. Host can only be updated with the same protocol initiators

Security
bearer
Path
hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3
Bodyapplication/jsonrequired
initiatorsToCreateArray of objects or null(InitiatorInput)

List of initiators to be created and added to this host

namestring or null

Name of the host.

Example: "host1"
updatedInitiatorsArray of strings or null

List of existing initiator IDs to be replaced to the host

curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3 \
  -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 Host CHAP details by {hostId}

Request

Get Host CHAP details by {hostId}

Security
bearer
Path
hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/chap \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Headers
ETagstring

Host Chap details

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

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

Identifier for duplicate host group.

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

type

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

Initiator CHAP enabled or disabled

Example: true
items[].​initiatorChapKeystring or null

Initiator CHAP key for NVMe/TCP host

Example: "DHHC-1:01:xvNDJvVLNeOi/fC808nmnw3JTYFxRcGMkEewhdzia2P9LM6Z:"
items[].​initiatorChapNamestring or null

Name of initiator CHAP set on iSCSI host

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

Encrypted Initiator CHAP secret set on iSCSI host

Example: "aa7164fee47c0723"
items[].​systemstring or null

Host CHAP details for a given system

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

Target CHAP enabled or disabled

Example: true
items[].​targetChapKeystring or null(string)

Target CHAP key for NVMe/TCP host

Example: "DHHC-1:01:xvNDJvVLNeOi/fC808nmnw3JTYFxRcGMkEewhdzia2P9LM6Z:"
items[].​targetChapNamestring or null

Name of target CHAP set on iSCSI host

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

Encrypted Target CHAP secret set on iSCSI host

Example: "aa7164fee47c0723"
totalinteger

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

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

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