diff --git a/v1/api/swagger/components/schemas/HostState.yaml b/v1/api/swagger/components/schemas/HostState.yaml index 23ca7ad0..e544a4c5 100644 --- a/v1/api/swagger/components/schemas/HostState.yaml +++ b/v1/api/swagger/components/schemas/HostState.yaml @@ -11,6 +11,7 @@ enum: - Connecting - Booting - Ready + - Reimaging Prep - Replacing - Releasing - Allocating diff --git a/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml b/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml new file mode 100644 index 00000000..89cae440 --- /dev/null +++ b/v1/api/swagger/paths/hosts@{hostId}@reimage.yaml @@ -0,0 +1,32 @@ +summary: Reimage a specific host +post: + tags: + - hosts + summary: Reimage Host by ID + description: >- + Re-deploys a host to the same machine. + Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. + The host must be powered off. The host must also be in the Ready state. + operationId: reimage + parameters: + - name: hostId + in: path + description: ID of Host to reimage + required: true + schema: + type: string + responses: + '200': + description: success + content: + application/json: + schema: + $ref: ../components/schemas/Host.yaml + '400': + $ref: ../components/responses/InvalidContent.yaml + '401': + $ref: ../components/responses/Unauthorized.yaml + '404': + $ref: ../components/responses/NotFound.yaml + '500': + $ref: ../components/responses/InternalError.yaml diff --git a/v1/api/swagger/swagger.yaml b/v1/api/swagger/swagger.yaml index 742ccac3..e944c052 100644 --- a/v1/api/swagger/swagger.yaml +++ b/v1/api/swagger/swagger.yaml @@ -118,6 +118,8 @@ paths: $ref: paths/hosts@{hostId}@bootpxe.yaml /hosts/{hostId}/boothdd: $ref: paths/hosts@{hostId}@boothdd.yaml + /hosts/{hostId}/reimage: + $ref: paths/hosts@{hostId}@reimage.yaml /hosts/{hostId}/replace: $ref: paths/hosts@{hostId}@replace.yaml /available-resources: diff --git a/v1/html/index.html b/v1/html/index.html index 822e7be2..657d1572 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -2216,7 +2216,7 @@ -
API docs by Redocly
API docs by Redocly
Deleted
boolean

True if the Host has been deleted.

PortalCommOkay
boolean

Describes if the portal is in active communication to the device

PowerStatus
string (HostPowerState)
Enum: "ON" "OFF" "UNKNOWN"

Current power status of the underlaying physical server (machine)

-
State
string (HostState)
Enum: "New" "Deleting" "Deleted" "Failed" "Force Deleting" "Updating Connections" "Imaging" "Imaging Prep" "Connecting" "Booting" "Ready" "Replacing" "Releasing" "Allocating" "Maintenance"

Overall host state

+
State
string (HostState)
Enum: "New" "Deleting" "Deleted" "Failed" "Force Deleting" "Updating Connections" "Imaging" "Imaging Prep" "Connecting" "Booting" "Ready" "Reimaging Prep" "Replacing" "Releasing" "Allocating" "Maintenance"

Overall host state

Substate
string (HostSubstate)
Enum: "" "Abort Deploy" "Allocate" "Attaching Volumes" "Boot Service-OS" "Clear Log" "Complete" "Confirm Post Complete" "Connect" "Connect Provisioning" "DNS Add" "DNS Add Init" "DNS Delete" "Deploy" "Detach Volumes" "Error Recovery" "Fail Cleanup" "Failed" "In Maintenance" "In OS Prep" "Init" "Init Attach Volumes" "Init Maintenance" "Init OS Prep" "Init Off" "Isolate" "Power Off" "Power On" "Release" "Release With Problem" "Set Boot Disk" "Snap Log" "Snap Log of Failure" "Update"

Host substate within HostState

StateTime
string <date-time>
SubstateTime
string <date-time>
Progress
integer <int64> [ 0 .. 100 ]
Alert
boolean
Array of objects (HostAlertInfo)
Workflow
string

The current workflow the host is in

SummaryStatus
string (HealthStatus)
Enum: "OK" "Warning" "Critical" "Unknown"
object

The map of label name to label value for the host.

@@ -2606,7 +2606,15 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    }
}

Replace Host by ID

Re-deploys a host with a new machine that satisfies the current host settings. Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/boothdd

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    }
}

Reimage Host by ID

Re-deploys a host to the same machine. Only the Host OS is reinstalled, IP addresses, volumes, etc are not changed. The host must be powered off. The host must also be in the Ready state.

+
Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to reimage

+

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    }
}

Replace Host by ID

Re-deploys a host with a new machine that satisfies the current host settings. Only the machine is replaced, IP addresses, volumes, etc are not changed. The host must be powered off. The host must also be in the Ready state or in the Failed state and in the Replace or Maintenace workflow.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
hostId
required
string

ID of Host to replace

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    }
}

volumes

Operations related to Volumes. A Volume is an external storage volume that persists independent of the associated host.

+
https://client.greenlake.hpe.com{basePath}/hosts/{hostId}/replace

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "ServiceFlavor": "ubuntu",
  • "ServiceVersion": "18.04-20190807",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeName": "HPE Large",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "MachineID": "d96dbf89-2a07-42f9-817d-2d6c42351827",
  • "SSHKeyIDs": [
    ],
  • "SSHAuthorizedKeys": [
    ],
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "UserData": "string",
  • "NodeID": "Node21",
  • "ISCSIConfig": {
    },
  • "Connections": [
    ],
  • "Deleted": true,
  • "PortalCommOkay": true,
  • "PowerStatus": "ON",
  • "State": "Ready",
  • "Substate": "Complete",
  • "StateTime": "2019-08-24T14:15:22Z",
  • "SubstateTime": "2019-08-24T14:15:22Z",
  • "Progress": 100,
  • "Alert": true,
  • "AlertInfo": [
    ],
  • "Workflow": "string",
  • "SummaryStatus": "OK",
  • "Labels": {
    }
}

volumes

Operations related to Volumes. A Volume is an external storage volume that persists independent of the associated host.

List all volumes in project

Returns an array of all volumes defined within the project.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new volume

Adds a new volume to the project. Volumes may be created separately and then referenced in the create Host call; or volumes may be created directly within the create Host call.

+
https://client.greenlake.hpe.com{basePath}/volumes

Response samples

Content type
application/json
[
  • {
    }
]

Add a new volume

Adds a new volume to the project. Volumes may be created separately and then referenced in the create Host call; or volumes may be created directly within the create Host call.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
Request Body schema: application/json

Volume that is to be added to the project

Name
required
string
Description
string
FlavorID
required
string <uuid>

Adds a new volume to the project. This object requires the LocationID and is used when a new volume is created independently from the host creation therefore requiring a specified location.

Capacity
required
integer <int64> >= 0

The size of the volume in GiB

@@ -2633,7 +2641,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "NewVolumeName",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Retrieve volume by ID

Returns a single volume with matching ID

+
https://client.greenlake.hpe.com{basePath}/volumes

Request samples

Content type
application/json
{
  • "Name": "NewVolumeName",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Labels": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Retrieve volume by ID

Returns a single volume with matching ID

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to return

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Update an existing volume

Updates volume with matching ID. Update is permitted only when volume is in 'Allocated' or 'Visible' state. Only the Volume 'Capacity' can be updated with a value greater than the existing one to expand the volume.

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Update an existing volume

Updates volume with matching ID. Update is permitted only when volume is in 'Allocated' or 'Visible' state. Only the Volume 'Capacity' can be updated with a value greater than the existing one to expand the volume.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
Request Body schema: application/json

Volume object with its ID and Capacity in GiB indicating the expanded size to be specified.

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2664,7 +2672,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Delete a volume

Deletes the volume with the matching ID

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of New Volume",
  • "FlavorID": "69d82b9f-19a6-47cd-bcb3-7f4b437e8e51",
  • "Capacity": 10485760,
  • "Shareable": true,
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "State": "new",
  • "SubState": "idle",
  • "Status": "ok",
  • "Labels": {
    },
  • "WWN": "string"
}

Delete a volume

Deletes the volume with the matching ID

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to delete

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

Attach existing volume to Host

Attaches the indicated volume to a host identified in the requestBody. This attachment will create a VolumeAttachment object that contains details about the connection of the volume and will update the Host with iSCSI configuration information.

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

Attach existing volume to Host

Attaches the indicated volume to a host identified in the requestBody. This attachment will create a VolumeAttachment object that contains details about the connection of the volume and will update the Host with iSCSI configuration information.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to attach

Request Body schema: application/json

Unique ID of the Host to which the volume will be attached

HostID
required
string <uuid>

Unique ID of the Host to attach or detach volume

@@ -2682,7 +2690,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    }
}

Detach existing volume from Host

Detaches the indicated volume from the host identified in the requestBody. This detachment will delete the VolumeAttachment object that contains details about the connection of the volume and will update the Host to remove selected iSCSI configuration information. +

https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}/attach

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    }
}

Detach existing volume from Host

Detaches the indicated volume from the host identified in the requestBody. This detachment will delete the VolumeAttachment object that contains details about the connection of the volume and will update the Host to remove selected iSCSI configuration information. Note that the HostID is required in the body of the request to ensure that the operation is well understood and that a volume is not accidently being removed from the wrong host.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
volumeId
required
string

ID of volume to attach

Request Body schema: application/json

Unique ID of the Host from which a volume will be detached

@@ -2693,13 +2701,13 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

volume-attachments

Operations related to VolumeAttachments that describe how a host is connected to a volume.

+
https://client.greenlake.hpe.com{basePath}/volumes/{volumeId}/detach

Request samples

Content type
application/json
{
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

volume-attachments

Operations related to VolumeAttachments that describe how a host is connected to a volume.

List all volume attachments in project

Returns an array of all VolumeAttachments defined within the project.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new VolumeAttachment

Adds a new VolumeAttachment which enables a machine to use a volume. Note that this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API.

+
https://client.greenlake.hpe.com{basePath}/volume-attachments

Response samples

Content type
application/json
[
  • {
    }
]

Create a new VolumeAttachment

Adds a new VolumeAttachment which enables a machine to use a volume. Note that this API is for creation of a VolumeAttachment for non-Hosts. A VolumeAttachment resource must be deleted using the 'DELETE /volume-attachments/{attachmentId}' API. For regular hosts, a VolumeAttachment is created via the 'POST /volumes/{volumeId}/attach' API.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
Request Body schema: application/json

NewVolumeAttachement parameters to create a new VolumeAttachment.

Name
string

Name for the volume attachment. Must be 128 or fewer printable characters

VolumeID
required
string <uuid>

Unique ID of the volume attached to the host

@@ -2709,7 +2717,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "My Object Name",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "Protocol": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    }
}

Retrieve volume attachment by ID

Returns a single volume attachment with matching ID

+
https://client.greenlake.hpe.com{basePath}/volume-attachments

Request samples

Content type
application/json
{
  • "Name": "My Object Name",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "Protocol": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    }
}

Retrieve volume attachment by ID

Returns a single volume attachment with matching ID

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
attachmentId
required
string

ID of volume attachment to return

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    }
}

Delete a VolumeAttachment

Deletes the VolumeAttachment with the matching ID

+
https://client.greenlake.hpe.com{basePath}/volume-attachments/{attachmentId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "VolumeID": "6a9f9b5e-05e4-4f5d-a302-ef4819ffdcf8",
  • "HostID": "22c71c70-ebdd-4620-b802-6650e1973329",
  • "HostIPAddress": "192.168.0.1",
  • "IQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "CHAPSecret": "string",
  • "CHAPUserName": "string",
  • "LUN": 0,
  • "VolumeTargetIQN": "iqn.yyyy-mm.naming-authority:unique name",
  • "VolumeTargetIPAddress": "192.168.0.1",
  • "State": "new",
  • "FSConfig": {
    }
}

Delete a VolumeAttachment

Deletes the VolumeAttachment with the matching ID

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
attachmentId
required
string

ID of VolumeAttachment to delete

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

networks

Operations related to Networks.

+
https://client.greenlake.hpe.com{basePath}/volume-attachments/{attachmentId}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

networks

Operations related to Networks.

List all networks in project

Returns an array of all network objects defined within the project.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new network

Adds a new network that can be referenced when creating a Host

+
https://client.greenlake.hpe.com{basePath}/networks

Response samples

Content type
application/json
[
  • {
    }
]

Add a new network

Adds a new network that can be referenced when creating a Host

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
Request Body schema: application/json

Network that is to be added to the project

Name
required
string

Name of the network

LocationID
required
string <uuid> (LocationID)

The location ID is the data center location of the resource. The LocationID must be one of those provided by the LocationInfo array returned as part of the get /available-resources call. The locations are typically described by country, region, and data center.

@@ -2743,7 +2751,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "Private2",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "NewIPPool": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Retrieve network by ID

Returns a single network with matching ID

+
https://client.greenlake.hpe.com{basePath}/networks

Request samples

Content type
application/json
{
  • "Name": "Private2",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "NewIPPool": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Retrieve network by ID

Returns a single network with matching ID

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
networkId
required
string

ID of network to return

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Update an existing network.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
networkId
required
string

ID of network to update

+
https://client.greenlake.hpe.com{basePath}/networks/{networkId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Update an existing network.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
networkId
required
string

ID of network to update

Request Body schema: application/json

Updated network

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

ETag
required
string <uuid>

Used to determine whether the DB entry has changed since it was last read. This value is updated each time the resource is updated. Client must send this value unchanged for any update operation.

@@ -2771,7 +2779,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Delete a network

Deletes the network with the matching ID

+
https://client.greenlake.hpe.com{basePath}/networks/{networkId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "Description": "Private network for intra-cluster communication",
  • "HostUse": "Default",
  • "Purpose": "Storage",
  • "IPPoolID": "string",
  • "VLAN": 0,
  • "VNI": 0
}

Delete a network

Deletes the network with the matching ID

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
networkId
required
string

ID of network to delete

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

available-resources

Operations related to listing information that is needed to construct create host and create volume calls. This provides a detailed information about the OS imaging options, the machine size (a.k.a. Compute Instance Type) options, the storage volume options, data center locations, and such that are needed when creating hosts and volumes.

+
https://client.greenlake.hpe.com{basePath}/networks/{networkId}

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}

available-resources

Operations related to listing information that is needed to construct create host and create volume calls. This provides a detailed information about the OS imaging options, the machine size (a.k.a. Compute Instance Type) options, the storage volume options, data center locations, and such that are needed when creating hosts and volumes.

Get lists of available resources for creating hosts and volumes

Used to get lists of options that are used when creating hosts and volumes. A get /available-resources will return an object that includes the following arrays:

  • Images - A list of image service IDs along with their category (Linux), @@ -2815,7 +2823,7 @@

    Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "Images": [
    ],
  • "Locations": [
    ],
  • "Networks": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Volumes": [
    ],
  • "MachineInventory": [
    ],
  • "StorageInventory": [
    ],
  • "SSHKeys": [
    ]
}

usage-reports

Operations related to retrieving information about resource usage within the project.

+
https://client.greenlake.hpe.com{basePath}/available-resources

Response samples

Content type
application/json
{
  • "Images": [
    ],
  • "Locations": [
    ],
  • "Networks": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Volumes": [
    ],
  • "MachineInventory": [
    ],
  • "StorageInventory": [
    ],
  • "SSHKeys": [
    ]
}

usage-reports

Operations related to retrieving information about resource usage within the project.

Get a usage report

Creates and returns a usage report based on the parameters passed in the request body

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
query Parameters
start
required
string

Start of the billing period

end
string

End of the billing period, default to now if omitted

@@ -2825,7 +2833,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "Hosts": [
    ],
  • "Volumes": [
    ]
}

projects-info

Operations related to listing information related to projects.

+
https://client.greenlake.hpe.com{basePath}/usage-reports

Response samples

Content type
application/json
{
  • "Hosts": [
    ],
  • "Volumes": [
    ]
}

projects-info

Operations related to listing information related to projects.

List of all projects info within an organization or cluster for which user is authorized.

Returns an object with information on projects, machine sizes, and volume flavors. The 'Projects' list includes projects authorized for a user, and the 'MachineSizes' and 'VolumeFlavors' list include only those machine sizes and volume flavors permitted for projects.

When GreenLake IAM issued token is used for authentication, it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored.

Authorizations:
(BearerAuthMembership) BearerAuth
query Parameters
siteid
string
Example: siteid=95688cf9-82ff-4e32-80fc-2b0b41648dab

GreenLake site ID

@@ -2835,13 +2843,13 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "Projects": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Summary": {
    }
}

ippools

Operations related to IP pools.

+
https://client.greenlake.hpe.com{basePath}/projects-info

Response samples

Content type
application/json
{
  • "Projects": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Summary": {
    }
}

ippools

Operations related to IP pools.

List all ip pools in project

Returns an array of all ip pool objects defined within the project.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve IP pool by ID

Returns a single ip pool with matching ID

+
https://client.greenlake.hpe.com{basePath}/ippools

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve IP pool by ID

Returns a single ip pool with matching ID

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to return

Responses

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Update IP pool by ID

Update a single ip pool with matching ID. 'DefaultRoute' can only be updated if ip pool is not currently in-use.

+
https://client.greenlake.hpe.com{basePath}/ippools/{ippoolId}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Update IP pool by ID

Update a single ip pool with matching ID. 'DefaultRoute' can only be updated if ip pool is not currently in-use.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to update

Request Body schema: application/json

Update IPPool

ID
required
string <uuid>

Unique ID for the resource instance as generated by the Metal service

@@ -2872,7 +2880,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Allocate IPs from the pool

Allocate IPs from the pool

+
https://client.greenlake.hpe.com{basePath}/ippools/{ippoolId}

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Allocate IPs from the pool

Allocate IPs from the pool

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to allocate IPs

Request Body schema: application/json

IPs being requested starting from an optional base IP and their usage

Array
Base
required
string

An optional base address for the allocation, if not specified first available address from the pool will be the base

@@ -2884,7 +2892,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Return IPs to the pool

Return IPs to the pool

+
https://client.greenlake.hpe.com{basePath}/ippools/{ippoolId}/allocation

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

Return IPs to the pool

Return IPs to the pool

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
path Parameters
ippoolId
required
string

ID of IP pool to return IPs

Request Body schema: application/json

IP returned to the pool

Array
string

Responses

Request samples

Content type
application/json
[
  • "15.0.0.1"
]

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

allocation

Operations related to listing information about allocation by servers and storage.

+
https://client.greenlake.hpe.com{basePath}/ippools/{ippoolId}/return

Request samples

Content type
application/json
[
  • "15.0.0.1"
]

Response samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Created": "2019-06-27T22:59:01.661Z",
  • "Modified": "2020-02-27T18:28:02.863Z",
  • "Description": "Description of IP pool",
  • "IPVersion": "IPv4",
  • "NetworkID": "59047804-7c6d-4fea-bf89-08c54543dccc",
  • "BaseIP": "10.128.0.0",
  • "Netmask": "/8",
  • "DefaultRoute": "10.128.0.1",
  • "Sources": [
    ],
  • "UseRecords": [
    ],
  • "DNS": [
    ],
  • "Proxy": "http://proxy.firewall.com:8080/ or http://user:password@proxy.firewall.com:8080",
  • "NoProxy": "localhost,15.10.0.10,test.com",
  • "NTP": [
    ],
  • "Pool": {
    }
}

allocation

Operations related to listing information about allocation by servers and storage.

Get servers allocation

Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. If the 'siteID' query parameter is present, the information returned is specific to that site ID.

@@ -2902,7 +2910,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
[
  • {
    }
]

Get storage allocation

Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. +

https://client.greenlake.hpe.com{basePath}/allocation/servers

Response samples

Content type
application/json
[
  • {
    }
]

Get storage allocation

Returns an array of allocation information for each server instance type. Each instance type's allocation information is further grouped by service type. When using a Metal token, the value in the 'Membership' header determines the scope of the response, i.e., Project or Hoster. However, the default scope is Tenant/Hoster when using the GL IAM token. If the allocation data is needed for a specific project, then the 'Project' header must be present in the request. If the 'siteID' query parameter is present, the information returned is specific to that site ID.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
query Parameters
siteID
string

site ID

@@ -2910,9 +2918,9 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
[
  • {
    }
]
+
https://client.greenlake.hpe.com{basePath}/allocation/storage

Response samples

Content type
application/json
[
  • {
    }
]