Skip to content
Internal API Catalog
/
HPE GreenLake for Private Cloud Business Edition System APIs
/
API reference
/
servers

HPE GreenLake for Private Cloud Business Edition System APIs (1.1.0)

HPE GreenLake for Private Cloud Business Edition System APIs

Download OpenAPI description
private-cloud-business-api.json
private-cloud-business-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

configuration-analysis-reports

APIs to trigger and fetch configuration analysis rules execution results for system

Operations

systems

APIs for HPE GreenLake for Private Cloud Business Edition system operations.

Operations

vm-provisioning-policies

Virtual Machine Provisioning Policies operations

Operations

servers

Operations

Get information about the specified system's servers.

Request

Get server information by system id

Returns details about the servers for the specified system id. Retrieving all of the properties for all servers in a system can take a long time because the amount of data is large. Use the 'select' query parameter to choose only the properties you want to retrieve.

For example, to get the server id, name, serial number and hypervisor host, use ?select=id,name,serialNumber,hypervisorHost

Security
bearer
Path
idstring(uuid)required

Unique Identifier of the system, usually a UUID.

Query
selectstring

Query parameter listing the properties of Server information to fetch.

Example: select=id,name,serialNumber,hypervisorHost
offsetinteger

Use offset in conjunction with limit for paging, e.g.: offset=30&&limit=10. Offset is the number of items from the beginning of the result set to the first item included in the response.

Example: offset=30
limitinteger(int32)[ 10 .. 100 ]

Use limit in conjunction with offset for paging, e.g.: offset=30&&limit=10. Limit is the maximum number of items to include in the response.

Default 10
Example: limit=10
filterstring

The expression to filter responses.

Example: filter=health/overallHealth eq OK
sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending.

Example: sort=id desc,name asc
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/private-cloud-business/v1beta1/systems/{id}/servers' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
itemsArray of objects(ServerInfo)required
items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​healthobject(ServerHealth)

Server Health information

items[].​hypervisorHostobject(HypervisorHost)

id, URI to reference the hypervisor host.

items[].​iloFirmwareVersionstring

firmware version of iLO in the server.

Example: "iLO 5 v2.14"
items[].​iloNetworkInfoobject

ILO Network Information.

items[].​iloStatestring

state of the iLO in the server.

Example: "ENABLED"
items[].​iloStatusstring

status of the iLO in the server.

Example: "ON"
items[].​indicatorLedStatusstring

iLO LED indication.

Example: "OFF"
items[].​maintenanceModeboolean

Is the server in maintenance mode?

items[].​memoryGibstring

Memory of the server.

items[].​modelstring

The model of the server.

Example: "ProLiant DL325 Gen10"
items[].​ncmVersionstring

Version of NCM installed on the server.

Example: "7.0.2-650014"
items[].​powerStatestring

Server Power state.

Enum"ON""RESET""UNKNOWN"
items[].​processorCountstring

Number of processors in the server.

items[].​processorModelstring

Model of the processors in the server.

Example: "Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz"
items[].​serialNumberstring

Server's serial number.

Example: "MXQ02203VM"
items[].​systemIdstring(uuid)

Unique Identifier of the system, usually a UUID.

items[].​namestring

A system specified name for the resource.

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

totalinteger

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

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

Get information about a system's specific server.

Request

Get server details by system id and server id

Returns information about a specific server on a specific system. Retrieving all of the properties for a server can take a long time because the amount of data is large. Use the select query parameter to choose only the properties you want to retrieve.

For example, to get details of the server's id, name, serial number and hypervisor host, use ?select=id,name,serialNumber,hypervisorHost

Security
bearer
Path
systemIdstring(uuid)required

Unique Identifier of the system, usually a UUID.

serverIdstring(uuid)required

Unique Identifier of the Server, usually a UUID.

Query
selectstring

Query parameter listing the properties of Server information to fetch.

Example: select=id,name,serialNumber,hypervisorHost
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/private-cloud-business/public/openapi/private-cloud-business-public-v1beta1/private-cloud-business-api/private-cloud-business/v1beta1/systems/{systemId}/servers/{serverId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

healthobject(ServerHealth)

Server Health information

hypervisorHostobject(HypervisorHost)

id, URI to reference the hypervisor host.

iloFirmwareVersionstring

firmware version of iLO in the server.

Example: "iLO 5 v2.14"
iloNetworkInfoobject

ILO Network Information.

iloStatestring

state of the iLO in the server.

Example: "ENABLED"
iloStatusstring

status of the iLO in the server.

Example: "ON"
indicatorLedStatusstring

iLO LED indication.

Example: "OFF"
maintenanceModeboolean

Is the server in maintenance mode?

memoryGibstring

Memory of the server.

modelstring

The model of the server.

Example: "ProLiant DL325 Gen10"
ncmVersionstring

Version of NCM installed on the server.

Example: "7.0.2-650014"
powerStatestring

Server Power state.

Enum"ON""RESET""UNKNOWN"
processorCountstring

Number of processors in the server.

processorModelstring

Model of the processors in the server.

Example: "Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz"
serialNumberstring

Server's serial number.

Example: "MXQ02203VM"
systemIdstring(uuid)

Unique Identifier of the system, usually a UUID.

namestring

A system specified name for the resource.

Response
application/json
{
  "health": {
    "agentlessManagementService": "string",
    "biosOrHardwareHealth": "OK",
    "fanHealth": "OK",
    "fanRedundancy": "REDUNDANT",
    "hbLastUpdateTimestamp": "string",
    "memoryHealth": "OK",
    "networkHealth": "OK",
    "overallServerHealth": "OK",
    "powerState": "string",
    "powerSuppliesHealth": "OK",
    "powerSuppliesRedundancy": "REDUNDANT",
    "processorHealth": "OK",
    "smartStorageBatteryHealth": "OK",
    "storageHealth": "OK",
    "temperaturesHealth": "OK"
  },
  "hypervisorHost": {
    "hypervisorClusterId": "19414828-43e0-4fc0-9f77-960311303439",
    "hypervisorClusterName": "string",
    "hypervisorHostIp": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "hypervisor-host-name",
    "resourceUri": "string",
    "type": "hypervisor-host"
  },
  "iloFirmwareVersion": "iLO 5 v2.14",
  "iloNetworkInfo": {
    "gateway": "string",
    "iloHostname": "string",
    "iloIp": "string",
    "network": "string",
    "subnetMask": "string"
  },
  "iloState": "ENABLED",
  "iloStatus": "ON",
  "indicatorLedStatus": "OFF",
  "maintenanceMode": true,
  "memoryGib": "string",
  "model": "ProLiant DL325 Gen10",
  "ncmVersion": "7.0.2-650014",
  "powerState": "ON",
  "processorCount": "string",
  "processorModel": "Intel(R) Xeon(R) Gold 6130 CPU @ 2.10GHz",
  "serialNumber": "MXQ02203VM",
  "systemId": "4423a5f3-2691-4d92-a9ef-2418d2c205d8",
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}