Create a host

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

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
}

Delete a host by {hostId}

Request

Delete a host by {hostId}

Security

bearer

Path

hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3

Query

forceboolean

Forceful delete option

Example: force=true

delete-associated-empty-hgboolean

Delete the resulting empty host group associated to this host option

Example: delete-associated-empty-hg=true

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

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 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": [
    { … }
  ]
}

Update Host CHAP by {hostId}

Request

CHAP can be updated only on iSCSI host on HPE GreenLake for Block Storage 10.4.0 or later and NVMe/TCP host on HPE GreenLake for Block Storage 10.5.0 or later.

Security

bearer

Path

hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3

Bodyapplication/jsonrequired

itemsArray of objects or null or null(HostChapInputObject)

curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/chap \
  -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"
}

Generate a DH-HMAC-CHAP host key usable for NVMe In-Band Authentication for Host by {hostId}

Request

CHAP key can be generated only on NVMe/TCP host on HPE GreenLake for Block Storage 10.5.0 and later system OS versions.

Security

bearer

Path

hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3

Bodyapplication/jsonrequired

systemstringrequired

system to which NVMe/TCP initiator has connectivity

Example: "15.212.100.100"

typestringrequired

type for generate CHAP key. Allowed values are INITIATOR | TARGET.

Enum"INITIATOR""TARGET"

Example: "INITIATOR"

secretstringrequired

secret (in hexadecimal characters) to be used to initialize the key. Length of secret should be one of 64 | 96 | 128 based on hmacNum. (hmacNum, Length of secret): (NONE, 64) | (SHA256, 64) | (SHA384, 96) | (SHA512, 128)

Example: "DB174528097951E0CCF41D92476FCA228E77717F1AE82AB380FCA07A2A91ABCD"

hmacNumstring or null

HMAC function to use for key transformation. Expected values are NONE | SHA256 | SHA384 | SHA512. Default value is NONE.

Enum"NONE""SHA256""SHA384"

Example: "SHA512"

curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/chapkey \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "secret": "DB174528097951E0CCF41D92476FCA228E77717F1AE82AB380FCA07A2A91ABCD",
    "system": "15.212.100.100",
    "type": "INITIATOR"
  }'

Responses

Success

Bodyapplication/json

chapkeystring

Generated CHAP key for NVMe/TCP initiator

Example: "DHHC-1:00:2xdFKAl5UeDM9B2SR2/KIo53cX8a6CqzgPygeiqRq83MSNuW:"

Response

application/json

{
  "chapkey": "DHHC-1:00:2xdFKAl5UeDM9B2SR2/KIo53cX8a6CqzgPygeiqRq83MSNuW:"
}

Get details of a host identified by {hostId} across its associated systems

Request

Get details of a host identified by {hostId} across its associated systems

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/mapped-devices \
  -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(MappedDevice)required

items[].idstringrequired

Identifier for an host/hostgroup.

Example: "d548ef683c27403e96caa51816ddc72c"

items[].typestringrequired

The type of resource.

Example: "initiator"

items[].customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"

items[].mappedDevicesArray of objects or null(MappedDeviceDetails)

items[].namestring

Name of the host/hostgroup.

Example: "init1"

totalinteger

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

Response

application/json

{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Get the volume performance history data associated with a host identified by {uid}

Request

Get the volume performance history data associated with a host identified by {uid}

Security

bearer

Path

hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3

Query

selectstring

Query to select only the required parameters, separated by . if nested

Example: select=latencyMetricsDataMs

rangestring

range will define start and end time in which query has to be made.

Example: range=startTime eq 1605063600 and endTime eq 1605186000

time-interval-mininteger

It defines granularity in minutes.

Enum5601440

Example: time-interval-min=1440

top-volumes-countinteger

The number of top volumes to return. Defaults to 5.

Example: top-volumes-count=5

curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/storage-performance-history \
  -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(hostStoragePerformanceHistory)required

items[].idstringrequired

ID of the resource

Example: "e66ed5ce8d35961481a48b4f78bb06b4"

items[].typestringrequired

type

Example: "Type of the resource"

items[].customerIdstring or null

customerId

Example: "string"

items[].hostVolumePerfTrendDataobject or null(hostHistoryData)

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 volumes associated with a host identified by {uid}

Request

Get details of volumes associated with a host identified by {uid}

Security

bearer

Path

hostIdstringrequired

Id of the Host.

Example: 2b09e744496246859fde6c132b2091d3

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/v1alpha1/host-initiators/2b09e744496246859fde6c132b2091d3/volumes \
  -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(hostVolumes)required

items[].idstringrequired

ID of the resource

Example: "e66ed5ce8d35961481a48b4f78bb06b4"

items[].typestringrequired

type

Example: "Type of the resource"

items[].commonResourceAttributesobject or null(commonResourceAttributes)

items[].customerIdstring

customerId

Example: "fc5f41652a53497e88cdcebc715cc1cf"

items[].intrinsicResourcestring or null

type of volume

Example: "vvol"

items[].iopsnumber or null(float64)

IOPS

Example: 4702

items[].latencyMsnumber or null(float64)

Latency in ms

Example: 1.2

items[].lunIdinteger or null(int64)

lunid

Example: 0

items[].pathCountinteger or null

The number of connections from that volume

Example: 2

items[].readLatencynumber or null(float64)

Latency in ms

Example: 1.2

items[].resourceUristring or null

resourceUri of the volume

Example: "/storage-fleet/v1alpha1/devtype1-storage-systems/7CE738P06J/volumes/e1839c72fef8784f2c77194efb8b2620"

items[].systemIdstring or null

SystemUid of the system associated with the volume

Example: "7CE751P312"

items[].targetNqnstring or null

Subsystem NQN id for the NVMe host to which the volume is exported

Example: "nqn.2021-04.com.hpe:volume-1"

items[].throughputKbpsnumber or null(float64)

The throughput in kbps

Example: 477219.2

items[].volumeNamestring or null

The name of the volume

Example: "test-vv"

items[].writeLatencynumber or null(float64)

Latency in ms

Example: 1.2

items[].wwnstring or null

Volume wwn.

Example: "60002AC0000000000000006B0001FFEB"

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 initiators

Request

Get the list of initiators

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

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

Responses

Success

Headers

ETagstring

List of Host initiators

Bodyapplication/json

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(Initiator)required

items[].idstringrequired

Identifier for an initiator.

Example: "d548ef683c27403e96caa51816ddc72c"

items[].typestringrequired

The type of resource.

Example: "initiator"

items[].addressstring or null

Address of the initiator. Filter

Example: "100008F1EABFE61C"

items[].associatedLinksArray of objects or null(scAssociatedLinks)

items[].customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"

items[].driverVersionstring or null

Driver version of the host initiator.

Example: "4.1"

items[].firmwareVersionstring or null

Firmware version of the host initiator.

Example: "10.0"

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[].hbaModelstring or null

Host bus adaptor model of the host initiator

Example: "myobject-5"

items[].hostSpeedinteger or null(int64)

Host speed

Example: 1000

items[].hostsArray of objects or null(HostSummaryForInitiatorObject)

List of hosts.

items[].ipAddressstring or null

IP address of the initiator.

Example: "15.212.100.100"

items[].namestring or null

Name of the initiator.

Example: "init1"

items[].pathTypestring or null

Transport type of the protocol. Valid values are FC, iSCSI ,NVMe/FC and NVMe/TCP.

items[].protocolstring or null

protocol supported are : FC ,iSCSI or NVMe

Example: "FC"

items[].systemsArray of strings or null

System IDs associated with the host initiator

items[].vendorstring or null

Vendor of the host initiator

Example: "hpe"

totalinteger

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

Response

application/json

{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Create initiator

Request

Create initiator

Security

bearer

Bodyapplication/jsonrequired

addressstring or nullrequired

Address of the initiator.

Example: "iqn.1998-01.com.vmware:61f7c688-3e93-d360-8043-70106f7a7e18-0cba0054"

protocolstring or nullrequired

protocol supported are : FC, iSCSI or NVMe

Example: "iSCSI"

driverVersionstring or null

Driver version of the host initiator.

Example: "4.1"

firmwareVersionstring or null

Firmware version of the host initiator.

Example: "10.0"

hbaModelstring or null

Host bus adaptor model of the host initiator

Example: "model-5"

hostSpeedinteger or null(int64)

Host speed

Example: 1000

ipAddressstring or null

IP address of the initiator. Supported only for iSCSI and NVMe protocols

Example: "15.212.100.100"

namestring or null

Name of the initiator.

Example: "init1"

vendorstring or null

Vendor of the host initiator

Example: "hpe"

curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/initiators \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "iqn.1998-01.com.vmware:61f7c688-3e93-d360-8043-70106f7a7e18-0cba0054",
    "protocol": "iSCSI"
  }'

Responses

Created

Bodyapplication/json

idstringrequired

Identifier for an initiator.

Example: "d548ef683c27403e96caa51816ddc72c"

typestringrequired

The type of resource.

Example: "initiator"

addressstring or null

Address of the initiator.

Example: "100008F1EABFE61C"

associatedLinksArray of objects or null(scAssociatedLinks)

customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"

driverVersionstring or null

Driver version of the host initiator.

Example: "4.1"

firmwareVersionstring or null

Firmware version of the host initiator.

Example: "10.0"

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

hbaModelstring or null

Host bus adaptor model of the host initiator

Example: "myobject-5"

hostSpeedinteger or null(int64)

Host speed

Example: 1000

hostsArray of objects or null(HostSummaryForInitiatorObjectDetails)

List of hosts.

ipAddressstring or null

IP address of the initiator.

Example: "15.212.100.100"

namestring or null

Name of the initiator.

Example: "init1"

protocolstring or null

protocol supported are : FC ,iSCSI or NVMe

Example: "FC"

systemsArray of strings or null

System IDs associated with the host initiator

vendorstring or null

Vendor of the host initiator

Example: "hpe"

Response

application/json

{
  "address": "100008F1EABFE61C",
  "associatedLinks": [
    { … }
  ],
  "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  "driverVersion": "4.1",
  "firmwareVersion": "10.0",
  "generation": 1627534116,
  "hbaModel": "myobject-5",
  "hostSpeed": 1000,
  "hosts": [
    { … }
  ],
  "id": "d548ef683c27403e96caa51816ddc72c",
  "ipAddress": "15.212.100.100",
  "name": "init1",
  "protocol": "FC",
  "systems": [
    "string"
  ],
  "type": "initiator",
  "vendor": "hpe"
}

Delete initiator by {initiatorId}

Request

Delete initiator by {initiatorId}

Security

bearer

Path

initiatorIdstringrequired

UID of Initiator.

Example: e789e756496246859fde6c132b2091d3

curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/initiators/e789e756496246859fde6c132b2091d3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers

Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json

deleteInitiatorboolean or null

Response

application/json

{
  "deleteInitiator": true
}

Get the initiator details by {initiatorId}

Request

Get the initiator details by {initiatorId}

Security

bearer

Path

initiatorIdstringrequired

UID of Initiator.

Example: e789e756496246859fde6c132b2091d3

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

Responses

Success

Headers

ETagstring

Host initiator details

Bodyapplication/json

idstringrequired

Identifier for an initiator.

Example: "e748ef683c27403e96caa51816ddc72c"

typestringrequired

The type of resource.

Example: "initiator"

addressstring or null

Address of the initiator.

Example: "100008F1EABFE61C"

associatedLinksArray of objects or null(scAssociatedLinks)

customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"

driverVersionstring or null

Driver version of the host initiator.

Example: "4.1"

firmwareVersionstring or null

Firmware version of the host initiator.

Example: "10.0"

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

hbaModelstring or null

Host bus adaptor model of the host initiator

Example: "myobject-5"

hostSpeedinteger or null(int64)

Host speed

Example: 1000

hostsArray of objects or null(HostSummaryForInitiatorObjectDetails)

List of hosts. Filter by hostId.

ipAddressstring or null

IP address of the initiator.

Example: "15.212.100.100"

namestring or null

Name of the initiator.

Example: "init1"

pathTypestring or null

Transport type of the protocol. Valid values are FC, iSCSI, NVMe/FC and NVMe/TCP.

Example: "FC"

protocolstring or null

protocol supported are : FC ,iSCSI or NVMe

Example: "FC"

systemsArray of strings or null

System IDs associated with the host initiator

vendorstring or null

Vendor of the host initiator

Example: "hpe"

Response

application/json

{
  "address": "100008F1EABFE61C",
  "associatedLinks": [
    { … }
  ],
  "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  "driverVersion": "4.1",
  "firmwareVersion": "10.0",
  "generation": 1627534116,
  "hbaModel": "myobject-5",
  "hostSpeed": 1000,
  "hosts": [
    { … }
  ],
  "id": "e748ef683c27403e96caa51816ddc72c",
  "ipAddress": "15.212.100.100",
  "name": "init1",
  "pathType": "FC",
  "protocol": "FC",
  "systems": [
    "string"
  ],
  "type": "initiator",
  "vendor": "hpe"
}

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

HPE Greenlake For Block Storage REST APIs. (1.0.0)

host-initiator-groups

host-initiators

Get the list of hosts

Request

Responses

Was this helpful?

Create a host

RequestExpand all

Responses

Was this helpful?

Delete a host by {hostId}

Request

Responses

Was this helpful?

Get the host details by {hostId}

Request

Responses

Was this helpful?

Update Host by {hostId}

RequestExpand all

Responses

Was this helpful?

Get Host CHAP details by {hostId}

Request

Responses

Was this helpful?

Update Host CHAP by {hostId}

RequestExpand all

Responses

Was this helpful?

Generate a DH-HMAC-CHAP host key usable for NVMe In-Band Authentication for Host by {hostId}

Request

Responses

Was this helpful?

Get details of a host identified by {hostId} across its associated systems

Request

Responses

Was this helpful?

Get the volume performance history data associated with a host identified by {uid}

Request

Responses

Was this helpful?

Get details of volumes associated with a host identified by {uid}

Request

Responses

Was this helpful?

Get the list of initiators

Request

Responses

Was this helpful?

Create initiator

Request

Responses

Was this helpful?

Delete initiator by {initiatorId}

Request

Responses

Was this helpful?

Get the initiator details by {initiatorId}

Request

Responses

Was this helpful?

host-paths

host-sets

hosts

storage-pools

storage-systems

volume-sets

volumes

snapshots

Request

Request

Request