Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
firmware-bundles - v1

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
index.json
index.yaml
Overview
License

HPE End User License Agreement

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

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

List all firmware bundles

Request

Retrieve the list of 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.

Default 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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/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

itemsArray of objectsrequired
items[].​idstring

Primary identifier for the firmware bundle given by the system

Example: "275a59f78916400a761e4bf8c6958934"
items[].​typestring

Type of the resource

Value "compute-ops-mgmt/firmware-bundle"
items[].​generationinteger>= 1

Monotonically increasing update counter

items[].​namestring

Name given to the bundle usually based on the bundle type

Example: "Gen10 Service Pack for ProLiant"
items[].​resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1/firmware-bundles/275a59f78916400a761e4bf8c6958934"
items[].​descriptionstring

A brief description of the bundle

Example: "Gen10/Gen10 Plus Service Pack for ProLiant (SPP) is a comprehensive systems software and firmware update solution"
items[].​createdAtstring(date-time)

Time of firmware bundle creation

Example: "2023-08-24T02:08:58.675535Z"
items[].​updatedAtstring(date-time)

Time of the last firmware bundle update

Example: "2023-08-24T02:08:58.675535Z"
items[].​releaseDatestring(full-date-rfc3339)

The date on which bundle is published to the web

Example: "2023-09-12T00:00:00+00:00"
items[].​summarystring

Gives the information about the issue that will be addressed by the bundle

Example: "Gen10/Gen10 Plus SPP 2023.09.00.00 release supersedes Gen10/Gen10 Plus SPP 2023.03.00.00 and includes support for Red Hat Enterprise Linux 9.2, RHEL 8.8 and SLES15 SP5."
items[].​bundleTypestring

Bundle Type assigned based on the servers for which it is built for

Enum"BASE""PATCH""HOTFIX"
items[].​platformFamilystring

Platform family of the server

Value"PROLIANT"
Example: "PROLIANT"
items[].​baseBundleUristring or null

URI of the base bundle

Example: null
items[].​releaseVersionstring

Latest version which got released

Example: "2023.09.00.00"
items[].​enhancementsstring

A HPE SW Center Page link which describes the enhancements included in this bundle

Example: "Gen10/Gen10 Plus SPP 2023.09.00.00 includes support for the following OS Versions Red Hat Enterprise Linux 8.8 Red Hat Enterprise Linux 9.2 SUSE Linux Enterprise Server 15 SP5"
items[].​advisoriesstring

The link to all the customer advisories released for this bundle

Example: "http://auth-essn-pro-sitebuilder.its.hpecorp.net/us/en/enterprise/servers/products/service_pack/spp_test/index.aspx?version=gen10.2023.09.00.00"
items[].​supportedOsListArray of strings

The list of operating systems that this bundle supports

Example: "Microsoft Windows Server 2022, Red Hat Enterprise Linux 9, VMware ESXi 8.0"
items[].​isActiveboolean

Indicates the status of bundle is active or not

items[].​releaseNotesstring

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

Example: "Gen10/Gen10 Plus SPP 2023.09.00.00 includes support."
items[].​supportUrlstring

An URL which points to HPE SW Center Page for this bundle

Example: "http://auth-essn-pro-sitebuilder.its.hpecorp.net/us/en/enterprise/servers/products/service_pack/spp_test/index.aspx?version=gen10.2023.09.00.00"
items[].​displayNamestring

SPP bundle name

Example: "SPP 2023.09.00.00 (12 Sep 2023)"
items[].​vmwareAddonInfoArray of objects or null(JSON)(vmwareAddonInfoItem-v1)

Details about vmware addon and the location of the vmware addon in RDA

items[].​bundleNameFormatstring

Indicates the format of the bundle name

Example: "BUNDLE_4OCTET"
items[].​bundleGenerationstring

Server generations that the bundle has support for

Example: "BUNDLE_GEN_10"
totalinteger>= 0required

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

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

Get a firmware bundle by ID

Request

Retrieve the firmware bundle details by its id

Security
Bearer
Path
idstringrequired

Unique Firmware bundle identifier

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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/firmware-bundles/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring

Primary identifier for the firmware bundle given by the system

Example: "275a59f78916400a761e4bf8c6958934"
typestring

Type of the resource

Value "compute-ops-mgmt/firmware-bundle"
generationinteger>= 1

Monotonically increasing update counter

namestring

Name given to the bundle usually based on the bundle type

Example: "Gen10 Service Pack for ProLiant"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1/firmware-bundles/275a59f78916400a761e4bf8c6958934"
descriptionstring

A brief description of the bundle

Example: "Gen10/Gen10 Plus Service Pack for ProLiant (SPP) is a comprehensive systems software and firmware update solution"
createdAtstring(date-time)

Time of firmware bundle creation

Example: "2023-08-24T02:08:58.675535Z"
updatedAtstring(date-time)

Time of the last firmware bundle update

Example: "2023-08-24T02:08:58.675535Z"
releaseDatestring(full-date-rfc3339)

The date on which bundle is published to the web

Example: "2023-09-12T00:00:00+00:00"
summarystring

Gives the information about the issue that will be addressed by the bundle

Example: "Gen10/Gen10 Plus SPP 2023.09.00.00 release supersedes Gen10/Gen10 Plus SPP 2023.03.00.00 and includes support for Red Hat Enterprise Linux 9.2, RHEL 8.8 and SLES15 SP5."
bundleTypestring

Bundle Type assigned based on the servers for which it is built for

Enum"BASE""PATCH""HOTFIX"
platformFamilystring

Platform family of the server

Value"PROLIANT"
Example: "PROLIANT"
baseBundleUristring or null

URI of the base bundle

Example: null
releaseVersionstring

Latest version which got released

Example: "2023.09.00.00"
enhancementsstring

A HPE SW Center Page link which describes the enhancements included in this bundle

Example: "Gen10/Gen10 Plus SPP 2023.09.00.00 includes support for the following OS Versions Red Hat Enterprise Linux 8.8 Red Hat Enterprise Linux 9.2 SUSE Linux Enterprise Server 15 SP5"
advisoriesstring

The link to all the customer advisories released for this bundle

Example: "http://auth-essn-pro-sitebuilder.its.hpecorp.net/us/en/enterprise/servers/products/service_pack/spp_test/index.aspx?version=gen10.2023.09.00.00"
supportedOsListArray of strings

The list of operating systems that this bundle supports

Example: "Microsoft Windows Server 2022, Red Hat Enterprise Linux 9, VMware ESXi 8.0"
isActiveboolean

Indicates the status of bundle is active or not

releaseNotesstring

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

Example: "Gen10/Gen10 Plus SPP 2023.09.00.00 includes support."
supportUrlstring

An URL which points to HPE SW Center Page for this bundle

Example: "http://auth-essn-pro-sitebuilder.its.hpecorp.net/us/en/enterprise/servers/products/service_pack/spp_test/index.aspx?version=gen10.2023.09.00.00"
displayNamestring

SPP bundle name

Example: "SPP 2023.09.00.00 (12 Sep 2023)"
vmwareAddonInfoArray of objects or null(JSON)(vmwareAddonInfoItem-v1)

Details about vmware addon and the location of the vmware addon in RDA

bundleNameFormatstring

Indicates the format of the bundle name

Example: "BUNDLE_4OCTET"
bundleGenerationstring

Server generations that the bundle has support for

Example: "BUNDLE_GEN_10"
Response
application/json
{
  "id": "275a59f78916400a761e4bf8c6958934",
  "type": "compute-ops-mgmt/firmware-bundle",
  "generation": 1,
  "name": "Gen10 Service Pack for ProLiant",
  "resourceUri": "/compute-ops-mgmt/v1/firmware-bundles/275a59f78916400a761e4bf8c6958934",
  "description": "Gen10/Gen10 Plus Service Pack for ProLiant (SPP) is a comprehensive systems software and firmware update solution",
  "createdAt": "2023-08-24T02:08:58.675535Z",
  "updatedAt": "2023-08-24T02:08:58.675535Z",
  "releaseDate": "2023-09-12T00:00:00+00:00",
  "summary": "Gen10/Gen10 Plus SPP 2023.09.00.00 release supersedes Gen10/Gen10 Plus SPP 2023.03.00.00 and includes support for Red Hat Enterprise Linux 9.2, RHEL 8.8 and SLES15 SP5.",
  "bundleType": "BASE",
  "platformFamily": "PROLIANT",
  "baseBundleUri": null,
  "releaseVersion": "2023.09.00.00",
  "enhancements": "Gen10/Gen10 Plus SPP 2023.09.00.00 includes support for the following OS Versions Red Hat Enterprise Linux 8.8 Red Hat Enterprise Linux 9.2 SUSE Linux Enterprise Server 15 SP5",
  "advisories": "http://auth-essn-pro-sitebuilder.its.hpecorp.net/us/en/enterprise/servers/products/service_pack/spp_test/index.aspx?version=gen10.2023.09.00.00",
  "supportedOsList": "Microsoft Windows Server 2022, Red Hat Enterprise Linux 9, VMware ESXi 8.0",
  "isActive": true,
  "releaseNotes": "Gen10/Gen10 Plus SPP 2023.09.00.00 includes support.",
  "supportUrl": "http://auth-essn-pro-sitebuilder.its.hpecorp.net/us/en/enterprise/servers/products/service_pack/spp_test/index.aspx?version=gen10.2023.09.00.00",
  "displayName": "SPP 2023.09.00.00 (12 Sep 2023)",
  "vmwareAddonInfo": [
    { … }
  ],
  "bundleNameFormat": "BUNDLE_4OCTET",
  "bundleGeneration": "BUNDLE_GEN_10"
}

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