diff --git a/v1/api/swagger/components/schemas/Host.yaml b/v1/api/swagger/components/schemas/Host.yaml index a06c01f..5d32c09 100644 --- a/v1/api/swagger/components/schemas/Host.yaml +++ b/v1/api/swagger/components/schemas/Host.yaml @@ -39,6 +39,7 @@ allOf: - FWBaselineVersion - AvailableFWBaselineID - AvailableFWBaselineVersion + - SerialNumber properties: Description: type: string @@ -224,3 +225,7 @@ allOf: description: >- The version of the firmware baseline that is available for the host. This field is only populated when there is a new firmware baseline available. + SerialNumber: + type: string + description: >- + The serial number of the host. diff --git a/v1/html/index.html b/v1/html/index.html index 407d484..f7af4ff 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -2498,7 +2498,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Host

Creates a new host object which kicks off the provisioning of a physical server in accordance to the attributes provided for the Host object. Most values for these options must be selected from the set of options provided by the get available-resources API call. +

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

Response samples

Content type
application/json
[
  • {
    }
]

Create a new Host

Creates a new host object which kicks off the provisioning of a physical server in accordance to the attributes provided for the Host object. Most values for these options must be selected from the set of options provided by the get available-resources API call. The SvcFlavor, SvcVersion, LocationID, SSHKeyIDs, and Network attribute must all be set with appropriate ID values from the available-resources call. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

@@ -2527,7 +2527,7 @@

Option 2: Getting the token directly from UI

Request samples

Content type
application/json
{
  • "Name": "NewHostName",
  • "Description": "Description of new Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "SSHKeyIDs": [
    ],
  • "NetworkIDs": [
    ],
  • "PreAllocatedIPs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "VolumeIDs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "NewVolumes": [
    ],
  • "UserData": "string",
  • "NodeID": "Node21",
  • "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 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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Retrieve Host by ID

Returns a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

Request samples

Content type
application/json
{
  • "Name": "NewHostName",
  • "Description": "Description of new Host",
  • "ServiceID": "20dd558b-b106-40bc-a8e7-d364ec5db710",
  • "LocationID": "58e992d9-6663-492c-8c5b-ecf0b1b3bfe1",
  • "MachineSizeID": "6e87f64f-b099-4286-9101-bee60a1afa2e",
  • "SSHKeyIDs": [
    ],
  • "NetworkIDs": [
    ],
  • "PreAllocatedIPs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "VolumeIDs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "NewVolumes": [
    ],
  • "UserData": "string",
  • "NodeID": "Node21",
  • "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 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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Retrieve Host by ID

Returns a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to return

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -2537,7 +2537,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Update an existing Host

Updates the Host with the matching ID. Update is permitted only if the host is in the 'Ready' or 'Connection Updating Failed' state. Only the Host 'Description', 'Networks', 'NetworkForDefaultRoute', 'NetworkUntagged' and 'ISCSIConfig:InitiatorName' can be updated. 'ISCSIConfig:InitiatorName' can be updated only if the host has no volumes attached. +

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

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Update an existing Host

Updates the Host with the matching ID. Update is permitted only if the host is in the 'Ready' or 'Connection Updating Failed' state. Only the Host 'Description', 'Networks', 'NetworkForDefaultRoute', 'NetworkUntagged' and 'ISCSIConfig:InitiatorName' can be updated. 'ISCSIConfig:InitiatorName' can be updated only if the host has no volumes attached. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of host to update

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

@@ -2562,7 +2562,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",
  • "Description": "Description of Host",
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "ISCSIConfig": {
    },
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "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 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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Delete a Host

Deletes the Host with the matching ID. A host in the 'Ready' state must first be powered-off before a delete will be permitted. Deletes to hosts in other states is permitted regardless of the power state. +

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

Request samples

Content type
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "ETag": "a8a0a8d9-d35b-45c6-840f-2b3694efc394",
  • "Name": "My Object Name",
  • "Description": "Description of Host",
  • "NetworkIDs": [
    ],
  • "NetworkForDefaultRoute": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  • "NetworkUntagged": "046b6c7f-0b8a-43b9-b35d-6489e6daee92",
  • "ISCSIConfig": {
    },
  • "PreAllocatedIPs": [
    ],
  • "ServiceNetsProviderMAC": {
    },
  • "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 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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Delete a Host

Deletes the Host with the matching ID. A host in the 'Ready' state must first be powered-off before a delete will be permitted. Deletes to hosts in other states is permitted regardless of the power state. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to delete

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

@@ -2584,7 +2584,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Power on Host by ID

Powers on a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Power on Host by ID

Powers on a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to power on

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -2594,7 +2594,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Power off Host by ID

Powers off a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Power off Host by ID

Powers off a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to power off

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -2604,7 +2604,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Reset Host by ID

Resets a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Reset Host by ID

Resets a single Host with matching ID. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to reset

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -2614,7 +2614,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Set PXE boot order on Host by ID

Sets a single Host with matching ID to attempt PXE boot when next booting. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Set PXE boot order on Host by ID

Sets a single Host with matching ID to attempt PXE boot when next booting. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to set to PXE boot

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -2624,7 +2624,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Set HDD boot order on Host by ID

Sets a single Host with matching ID to attempt HDD booting. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Set HDD boot order on Host by ID

Sets a single Host with matching ID to attempt HDD booting. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to set to HDD boot

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -2634,7 +2634,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Reimage Host by ID

Re-deploys a host to the same machine. WARNING -- all drives will be erased! 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. +

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Reimage Host by ID

Re-deploys a host to the same machine. WARNING -- all drives will be erased! 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. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to reimage

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

@@ -2645,7 +2645,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

Replace Host by ID

Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! 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}/reimage

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

Replace Host by ID

Re-deploys a host with a new machine that satisfies the current host settings. WARNING -- all drives will be erased! 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. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

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

ID of Host to replace

header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

@@ -2656,7 +2656,7 @@

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string"
}

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": {
    },
  • "WWPNs": [
    ],
  • "FWBaselineID": "4b91cc3c-8af7-49d8-b378-866e8fc7a851",
  • "FWBaselineVersion": "string",
  • "AvailableFWBaselineID": "ae853754-e976-4937-aec0-b4e41985605e",
  • "AvailableFWBaselineVersion": "string",
  • "SerialNumber": "string"
}

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. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -3058,7 +3058,7 @@

Option 2: Getting the token directly from UI

Response samples

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