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
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/

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/

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

List all appliance firmware bundles

Request

Retrieve the list of appliance firmware bundles

Security
Bearer
Query
offsetinteger>= 0

Zero-based resource offset to start the response from

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

The maximum number of records to return.

Example: limit=10
sortstring

The order in which to return the resources in the collection.

The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.

Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
filterstring

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, or, not

Appliance firmware can be filtered by:

  • applianceVersion
  • applianceType

The following examples are not an exhaustive list of all possible filtering options.

Examples:

Returns appliance firmware where a property equals a value. eq(<property>,<value>)

filter=eq(applianceType,'VM')

Returns appliance firmware where combination of properties are filtered.

filter=and(eq(applianceType,'VM'),eq(applianceVersion,'8.70.00'))
displayAppliancesboolean

Populate the applicableAppliances list in the response with all appliances which are eligible to be upgraded to that appliance firmware. This behavior is supported only when the request is provided with applianceType filter and limited to one appliance firmware bundle.

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/appliance-firmware-bundles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

totalinteger>= 0required

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
itemsArray of objectsrequired
items[].​idstringrequired

Primary identifier for the appliance firmware bundle given by the system

items[].​typestringrequired

Type of the resource

Value "compute-ops-mgmt/appliance-firmware-bundle"
items[].​applianceVersionstringrequired

Version of the OV appliance

items[].​applianceTypestringrequired

Type of appliance

items[].​supportedUpgradesArray of stringsrequired

Supported list of upgrades for the current OV appliance

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

Time of firmware bundle creation

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

Time of the last firmware bundle update

items[].​rdaBundlePathstring

Path where the bundle is stored in the RDA server

Example: "/depot/volume/pub/OliveComputeUpdate/Ov8_50"
items[].​ovaFileNamestring

Name of tha OVA file

Example: "Update.bin"
items[].​resourceUristring(uri-reference)

URI to the firmware bundle itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta1/appliance-firmware-bundles/427275fcefef11ebaeaea25b204e9317"
items[].​releaseDatestring

Date of release of the selected firmware bundle

items[].​milestoneboolean

Flag that tells if the selected firmware version is a milestone version or not

items[].​namestring

Name of the appliance firmware bundle

items[].​statestring

State of the appliance firmware bundle

items[].​releaseNotesstring

A HPE SW Center Page link which describes how the bundle can be downloaded and installed in the customer environment

items[].​sizeinteger

Size of the appliance firmware bundle

items[].​languagesArray of strings

The list of languages that are supported

items[].​synergyReleaseInfostring(uri-reference)

URI to the release information

items[].​featuresArray of strings

The list of features of the appliance firmware bundle

items[].​applicableAppliancesArray of objects

The list of appliances that can be updated to the latest firmware. This list will only be populated if the displayAppliances query parameter is set to true and the response is limited to one appliance firmware bundle.

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

Get an appliance firmware bundle by ID

Request

Retrieve the appliance firmware bundle details by its id

Security
Bearer
Path
idstringrequired

Unique Appliance firmware bundle identifier

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/appliance-firmware-bundles/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstringrequired

Primary identifier for the appliance firmware bundle given by the system

typestringrequired

Type of the resource

Value "compute-ops-mgmt/appliance-firmware-bundle"
applianceVersionstringrequired

Version of the OV appliance

applianceTypestringrequired

Type of appliance

supportedUpgradesArray of stringsrequired

Supported list of upgrades for the current OV appliance

createdAtstring(date-time)required

Time of firmware bundle creation

updatedAtstring(date-time)required

Time of the last firmware bundle update

rdaBundlePathstring

Path where the bundle is stored in the RDA server

Example: "/depot/volume/pub/OliveComputeUpdate/Ov8_50"
ovaFileNamestring

Name of tha OVA file

Example: "Update.bin"
resourceUristring(uri-reference)

URI to the firmware bundle itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1beta1/appliance-firmware-bundles/427275fcefef11ebaeaea25b204e9317"
releaseDatestring

Date of release of the selected firmware bundle

milestoneboolean

Flag that tells if the selected firmware version is a milestone version or not

namestring

Name of the appliance firmware bundle

statestring

State of the appliance firmware bundle

releaseNotesstring

A HPE SW Center Page link which describes how the bundle can be downloaded and installed in the customer environment

sizeinteger

Size of the appliance firmware bundle

languagesArray of strings

The list of languages that are supported

synergyReleaseInfostring(uri-reference)

URI to the release information

featuresArray of strings

The list of features of the appliance firmware bundle

applicableAppliancesArray of objects

The list of appliances that can be updated to the latest firmware. This list will only be populated if the displayAppliances query parameter is set to true and the response is limited to one appliance firmware bundle.

Response
application/json
{ "id": "string", "type": "compute-ops-mgmt/appliance-firmware-bundle", "rdaBundlePath": "/depot/volume/pub/OliveComputeUpdate/Ov8_50", "ovaFileName": "Update.bin", "resourceUri": "/compute-ops-mgmt/v1beta1/appliance-firmware-bundles/427275fcefef11ebaeaea25b204e9317", "applianceVersion": "string", "applianceType": "string", "releaseDate": "string", "milestone": true, "name": "string", "state": "string", "releaseNotes": "string", "size": 0, "languages": [ "string" ], "synergyReleaseInfo": "../dictionary", "features": [ "string" ], "supportedUpgrades": [ "string" ], "applicableAppliances": [ {} ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

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 - 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

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

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