Skip to content
API reference
/
/
Get details of a host gro...

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-public-v1alpha1/block-storage-api/

host-initiator-groups

The Host service API allows the management of Host Group

Operations

Get the list of host groups

Request

Get the list of host groups

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-initiator-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Headers
ETagstring

List of Host groups

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

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

Identifier for host group. Filter

Example: "d548ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

The type of resource.

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

system IDs to which the host group belongs to.

items[].​commentstring or null

Comment

Example: "host-group-comment"
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[].​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[].​hostsArray of objects or null(HostSummaryForHSObject)

List of hosts. Filter by hostId. Sort by count.

items[].​isMergableboolean or null

Indicates whether host group 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[].​markedForDeleteboolean or null

Indicates whether host group is marked for deletion or not

Example: true
items[].​namestring or null

Name of the host group. Filter, Sort

Example: "host-group1"
items[].​systemsArray of strings or null

system IDs to which the host group belongs to. Filter. Sort by count.

items[].​userCreatedboolean or null

Indicates whether user created host or discovered host

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 group

Request

Create a host group with hosts having same protocol initiators

Security
bearer
Bodyapplication/jsonrequired
namestring or nullrequired

Name of the host group. The maximum supported length is 251 characters. Host Group name length greater than 27 characters is supported only for HPE Alletra Storage MP B10000 systems with OS version 10.4.2 and later.

Example: "host-group1"
commentstring or null

Comment

Example: "host-group-comment"
hostIdsArray of strings or null

List of host ids of existing hosts

hostsToCreateArray of objects or null(CreateHostInput)

List of hosts to be created and added to this hostGroup

curl -i -X POST \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiator-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "host-group1"
  }'

Responses

Created

Bodyapplication/json
idstringrequired

Identifier for host group.

Example: "d548ef683c27403e96caa51816ddc72c"
typestringrequired

The type of resource.

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

system IDs to which the host group belongs to.

commentstring or null

Comment

Example: "host-group-comment"
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"
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
hostsArray of objects(HostSummaryForHSObjectDetails)

List of hosts.

isMergableboolean or null

Indicates whether host group 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
markedForDeleteboolean or null

Indicates whether host group is marked for deletion or not

Example: true
namestring or null

Name of the host group.

Example: "host-group1"
systemsArray of strings or null

system IDs to which the host group belongs to.

userCreatedboolean or null

Indicates whether user created host or discovered host

Example: true
Response
application/json
{
  "associatedLinks": [
    { … }
  ],
  "associatedSystems": [
    "string"
  ],
  "comment": "host-group-comment",
  "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  "editStatus": "Delete_Failed",
  "generation": 1627534116,
  "hosts": [
    { … }
  ],
  "id": "d548ef683c27403e96caa51816ddc72c",
  "isMergable": true,
  "markedForDelete": true,
  "name": "host-group1",
  "systems": [
    "string"
  ],
  "type": "host-initiator-group",
  "userCreated": true
}

Delete a host group by {hostGroupId}

Request

Delete a host group by {hostGroupId}

Security
bearer
Path
hostGroupIdstringrequired

Id of the host Group.

Example: e789e756496246859fde6c132b2091d3
Query
forceboolean

Forceful delete option

Example: force=true
curl -i -X DELETE \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiator-groups/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
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 group details by {hostGroupId}

Request

Get the host group details by {hostGroupId}

Security
bearer
Path
hostGroupIdstringrequired

Id of the host Group.

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

Responses

Success

Headers
ETagstring

Host group details

Bodyapplication/json
idstringrequired

Identifier for host group.

Example: "e987ef683c27403e96caa51816ddc72c"
typestringrequired

The type of resource.

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

system IDs to which the host group belongs to.

commentstring or null

Comment

Example: "host-group-comment"
customerIdstring

The customer application identifier

Example: "fc5f41652a53497e88cdcebc715cc1cf"
editStatusstring or null

Host group 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"
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
hostsArray of objects or null(HostSummaryForHSObjectDetail)

List of hosts.

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
markedForDeleteboolean or null

Indicates whether host group is marked for deletion or not

Example: true
namestring or null

Name of the host group

Example: "host-group1"
systemsArray of strings or null

system IDs to which the host group belongs to

userCreatedboolean or null

Idicates whether user created host or discovered host

Example: true
Response
application/json
{
  "associatedLinks": [
    { … }
  ],
  "associatedSystems": [
    "string"
  ],
  "comment": "host-group-comment",
  "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  "editStatus": "Delete_Failed",
  "generation": 1627534116,
  "hosts": [
    { … }
  ],
  "id": "e987ef683c27403e96caa51816ddc72c",
  "isMergable": true,
  "markedForDelete": true,
  "name": "host-group1",
  "systems": [
    "string"
  ],
  "type": "host-initiator-groups",
  "userCreated": true
}

Update host group by {hostGroupId}

Request

Update host group details by {hostGroupId}. Hostgroup can be updated with hosts containing same protocol initiators

Security
bearer
Path
hostGroupIdstringrequired

Id of the host Group.

Example: e789e756496246859fde6c132b2091d3
Bodyapplication/jsonrequired
hostProximityValuesArray of objects or null(HostProximityValue)

Change Proximity for list of hosts

hostsToCreateArray of objects or null(CreateHostInput)

List of hosts to be replaced to the group

namestring or null

Name of the host group. The maximum supported length is 251 characters. Host Group name length greater than 27 characters is supported only for HPE Alletra Storage MP B10000 systems with OS version 10.4.2 and later.

Example: "host-group1"
removedHostsArray of strings or null

List of host IDs to be removed from the group

updatedHostsArray of strings or null

List of host IDs to be added to the group

curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiator-groups/e789e756496246859fde6c132b2091d3 \
  -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 details of a host group identified by {hostGroupId} across its associated systems

Request

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

Security
bearer
Path
hostGroupIdstringrequired

Id of the host Group.

Example: e789e756496246859fde6c132b2091d3
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/block-storage/v1alpha1/host-initiator-groups/e789e756496246859fde6c132b2091d3/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": [
    { … }
  ]
}

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

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