Skip to content

HPE Compute Ops Management API (latest)

HPE Compute Operations Management provides a Restful API to customers who want to manage their devices programmatically or through a command line. The API enables customers to invoke operations or tasks such as list devices, see device details, device health, and manage their device's firmware.

UPDATED API ENDPOINTS

Compute Ops Management now supports the HPE GreenLake API endpoints (<region>.api.greenlake.hpe.com). The Guide contains more information about this change.

Download OpenAPI description
Languages
Servers
API endpoint for US West

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

API endpoint for EU Central

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

API endpoint for AP Northeast

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

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

alerts - v1

Operations

secure-gateway-appliances - v1beta2

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

approval-policy - v1beta2

Operations

approval-request - v1beta2

Operations

async-operations - v1

Operations

async-operations - v1beta1

Operations

energy-over-time - v1beta1

Operations

energy-by-entity - v1beta1

Operations

external-services - v1beta1

Operations

filters - v1beta1

Operations

firmware-bundles - v1

Operations

firmware-bundles-details - v1

Operations

firmware-bundles - v1beta2

Operations

groups - v1

Operations

groups - v1beta3

Operations

groups - v1beta2

Operations

job-templates - v1beta2

Operations

jobs - v1

Operations

jobs - v1beta3

Operations

jobs - v1beta2

Operations

metrics-configurations - v1

Operations

metrics-collection-requests - v1beta1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-hardware-inventory-report - v1beta1

Operations

Retrieve server hardware inventory report

Request

Retrieve server hardware inventory report data for servers matched by the provided resource-uri or filter-tags.

The items response structure depends on the value of the group-by query parameter.

Security
Bearer
Query
group-bystringrequired

Aggregation level for server hardware inventory report data.

Enum"SERVER""SERVER_MODEL""SERVER_GENERATION"
Example: group-by=SERVER
sortstring

Sort expression in the form <attribute> asc|desc.

Supported attributes for each group-by type:

  • SERVER: name, id, model, processor, management, serverGeneration, memoryGiB, processorCount, deviceCount, powerSupplyCount, fanCount, driveCount, formFactor
  • SERVER_MODEL: model, count
  • SERVER_GENERATION: serverGeneration, count
  • SERVER_PROCESSOR: processor, count
  • SERVER_MEMORY: memoryGiB, count
  • SERVER_MANAGEMENT: management, count
  • DEVICES: deviceName, partNumber, assemblyNumber, technology, linkLanes, deviceCount, serverCount
  • DEVICE_DETAIL: deviceName, deviceSerialNumber, location, firmwareVersion, serverId, serverName
  • DEVICE_AND_SERVER: serverId, serverName, deviceName, deviceCount
  • DRIVES: driveModel, driveName, protocol, mediaType, capacityGB, speedGbps, driveCount, serverCount
  • DRIVE_DETAIL: serverId, serverName, driveModel, driveName, driveSerialNumber, location, driveEnclosure, firmware, failurePredicted, predictedMediaLifeLeftPercent
  • DRIVE_AND_SERVER: serverId, serverName, driveModel, driveName, driveCount
  • DRIVE_LIFE_PERCENTAGE: remainingDriveLifeRange, driveCount, serverCount
  • DRIVE_LIFE_DETAIL: serverId, serverName, driveSerialNumber, remainingDriveLifeRange, location, driveEnclosure, failurePredicted, predictedMediaLifeLeftPercent
  • DRIVE_LIFE_AND_SERVER: serverId, serverName, remainingDriveLifeRange, driveCount
Examples:
sort=name asc
sort=driveCount desc
filterstring

Filter expression in the form <attribute> eq '\<value>'.

Supported attributes for each group-by type:

  • SERVER: model, processor, management, serverGeneration, memoryGiB
  • DEVICES, DEVICE_DETAIL, DEVICE_AND_SERVER: deviceName
  • DRIVES, DRIVE_DETAIL, DRIVE_AND_SERVER: driveModel
  • DRIVE_LIFE_PERCENTAGE, DRIVE_LIFE_DETAIL, DRIVE_LIFE_AND_SERVER: remainingDriveLifeRange
Examples:
filter=model eq 'ProLiant DL360 Gen10'
filter=remainingDriveLifeRange eq 'RANGE_50_100'
filter-tagsstring

Limit the resources operated on by tags or return only the subset of resources that match all the filter tags.

Examples:
filter-tags=('Rack' eq 'Rack1')
filter-tags=(('Rack' eq 'Rack1') AND ('Row' eq 'Row1'))
resource-uristring

URI of the resource for which server hardware inventory report data is to be retrieved. This can be a server, filter or group URI.

Default "/compute-ops-mgmt/v1beta1/filters/e7cef8e6-a3f6-4490-b669-136e3ca40617"
Examples:
resource-uri=/compute-ops-mgmt/v1beta1/filters/f4a8b2c9-7d5e-4321-9876-1a2b3c4d5e6f
resource-uri=/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB
resource-uri=/compute-ops-mgmt/v1/groups/420372b6-af2e-464d-970d-e9339abfc74f
excluded-serversboolean

When set to true, the response contains details for servers that do not have inventory data available.

When excluded-servers=true, sort and filter query parameters are not supported.

Default false
Example: excluded-servers=true
offsetinteger>= 0

Zero-based resource offset to start the response from

Default 0
Example: offset=10
limitinteger[ 0 .. 100 ]

The maximum number of records to return.

Default 10
Example: limit=10
Headers
Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta1/server-hardware-inventory-report?group-by=SERVER' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countintegerrequired

Number of records returned in the current page.

Example: 10
itemsArray of item-server (object) or item-server-model (object) or item-server-generation (object) or item-server-processor (object) or item-server-memory (object) or item-server-management (object) or item-devices (object) or item-device-detail (object) or item-device-and-server (object) or item-drives (object) or item-drive-detail (object) or item-drive-and-server (object) or item-drive-life-percentage (object) or item-drive-life-detail (object) or item-drive-life-and-server (object)required

Data rows for the selected group-by value.

One of:

Item shape for group-by=SERVER.

object item-server Recursive
offsetinteger

Zero-based page offset.

Example: 0
totalinteger

Total number of records matching the request.

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

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations