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

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

List all servers

Request

Retrieve data for all Servers

Servers without a valid subscription will not return the following:

  • hardware.health
  • hardware.memoryMb
  • hardware.formFactor
  • hardware.bmc
  • hardware.platform
  • hardware.powerState
  • hardware.indicatorLed
  • firmwareInventory
  • softwareInventory
  • lastFirmwareUpdate
  • host
  • firmwareBundleUri
  • tags
  • originIp
  • biosFamily
  • storageInventory
  • processorVendor
  • autoIloFwupdate
  • serverGeneration
  • connectionType
  • oneview
Security
Bearer
Query
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.

Example: limit=10
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

Servers can be filtered by:

  • biosFamily
  • createdAt
  • firmwareBundleUri
  • hardware and all nested properties
  • host and all nested properties
  • id
  • name †
  • oneview and all nested properties
  • platformFamily
  • processorVendor
  • resourceUri
  • state and all nested properties

† When searching for a server using the name filter, you must supply the serial number of the server, not the hostname. To filter by hostname use host/hostname instead of name

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

Examples:

Return servers where a property equals a value. <property> eq <value>

filter=host/hostname eq 'myServer'

Return servers where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=state/managed eq 'true'

Return servers where a property equals a value, using a url. <property>%20eq%20%27<value>

filter=id%20eq%20%27497f6eca-6276-4993-bfeb-53cbbbba6f08

Return servers where a property does not equal a value not <property> eq <value>

filter=not name eq 'MXQ89990RR'

Return servers with populated property. not <property> eq null

filter=not name eq null

Return servers where property contains a value. contains(<property>, <value>)

filter=contains(createdAt,'2019')

Return servers where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not name eq null and contains(createdAt,'2019')

Return servers where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)

filter=state/managed in ('true','false')
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/servers \
  -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(productId+serialNumber)required

Primary identifier for the server given by the system

items[].​typestringrequired

Type of the resource

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

Monotonically increasing update counter

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

Time of server creation

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

Time of the last server update

items[].​namestring

Name given to resource

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

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

Example: "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB"
items[].​platformFamilynull or string
One of:

No Platform family

null

No Platform family

items[].​serverGenerationstring

Server Hardware Generation

Enum"GEN_10""GEN_11""UNKNOWN"
items[].​hardwareobject(hardware)

Server hardware details

items[].​stateobject(state)

Server connectivity state

items[].​firmwareInventoryArray of objects or null(firmwareInventoryItem-v1)

Firmware Inventory

items[].​softwareInventoryArray of objects or null(softwareInventoryItem-v1)

Software Inventory

items[].​firmwareBundleUristring or null
items[].​lastFirmwareUpdateobject or null

Details of the last firmware update

items[].​tagsobject or null

Extra identifiers a server

Example: {"location":"San Jose"}
items[].​processorVendorstring or null

Type and brand of processor

Example: "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz"
items[].​biosFamilystring or null

Bios version

items[].​hostobject or null(host)

host details

items[].​autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

items[].​oneviewobject or null

Details of the OneView managed server

items[].​lastFullInventoryCollectionAtstring or null
Any of:

Last complete inventory collection time

string(date-time)

Last complete inventory collection time

items[].​lastFullInventoryCollectionPowerStatestring

Power state of the server when the complete inventory is collected

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": [ {} ] }

Patch multiple servers

Request

Update multiple server(s) specified by the id(s). The operation is atomic (either fully successful or failing without modifying any servers).

Security
Bearer
Query
idArray of strings(productId+serialNumber (percent-encoded))required
Examples:
id=177751-Y66%2B8899177751666258
id=177751-Y66%2B8899177751666258&id=320888-H80%2B8899320888180208
Headers
Content-Typestringrequired

Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.

Value "application/merge-patch+json"
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.

Bodyapplication/merge-patch+jsonrequired
autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

Default true
curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/servers?id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful Response

Response
No content

Get a server

Request

Retrieve data for a Server specified by its id

Servers without a valid subscription will not return the following:

  • hardware.health
  • hardware.memoryMb
  • hardware.formFactor
  • hardware.bmc
  • hardware.platform
  • hardware.powerState
  • hardware.indicatorLed
  • firmwareInventory
  • softwareInventory
  • lastFirmwareUpdate
  • host
  • firmwareBundleUri
  • tags
  • originIp
  • biosFamily
  • storageInventory
  • processorVendor
  • autoIloFwupdate
  • serverGeneration
  • connectionType
  • oneview
Security
Bearer
Path
idstringrequired

Unique Server 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/servers/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server Data

Bodyapplication/json
idstring(productId+serialNumber)required

Primary identifier for the server given by the system

typestringrequired

Type of the resource

Value "compute-ops-mgmt/server"
generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of server creation

updatedAtstring(date-time)required

Time of the last server update

namestring

Name given to resource

Example: "myServer"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB"
platformFamilynull or string
One of:

No Platform family

null

No Platform family

serverGenerationstring

Server Hardware Generation

Enum"GEN_10""GEN_11""UNKNOWN"
hardwareobject(hardware)

Server hardware details

stateobject(state)

Server connectivity state

firmwareInventoryArray of objects or null(firmwareInventoryItem-v1)

Firmware Inventory

softwareInventoryArray of objects or null(softwareInventoryItem-v1)

Software Inventory

firmwareBundleUristring or null
lastFirmwareUpdateobject or null

Details of the last firmware update

tagsobject or null

Extra identifiers a server

Example: {"location":"San Jose"}
processorVendorstring or null

Type and brand of processor

Example: "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz"
biosFamilystring or null

Bios version

hostobject or null(host)

host details

autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

oneviewobject or null

Details of the OneView managed server

lastFullInventoryCollectionAtstring or null
Any of:

Last complete inventory collection time

string(date-time)

Last complete inventory collection time

lastFullInventoryCollectionPowerStatestring

Power state of the server when the complete inventory is collected

Response
application/json
{ "id": "string", "name": "myServer", "type": "compute-ops-mgmt/server", "resourceUri": "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB", "generation": 1, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "platformFamily": {}, "serverGeneration": "GEN_10", "hardware": { "serialNumber": "string", "model": "string", "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "productId": "string", "powerState": "UNKNOWN", "indicatorLed": "UNKNOWN", "health": {}, "platform": "string", "formFactor": "string", "bmc": {}, "memoryMb": {} }, "state": { "managed": true, "connected": true, "connectedModifiedAt": "2019-08-24T14:15:22Z", "subscriptionState": "REQUIRED", "subscriptionTier": "ENHANCED", "subscriptionExpiresAt": "2019-08-24T14:15:22Z" }, "firmwareInventory": [ {} ], "softwareInventory": [ {} ], "firmwareBundleUri": "string", "lastFirmwareUpdate": { "status": "OK", "attemptedAt": "2019-08-24T14:15:22Z", "firmwareInventoryUpdates": [] }, "tags": { "location": "San Jose" }, "processorVendor": "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz", "biosFamily": "string", "host": { "osName": "string", "osVersion": "string", "hostname": "string", "osDescription": "string", "osType": 0 }, "autoIloFwUpdate": true, "oneview": { "applianceUri": "string", "maintenanceMode": true, "name": "string", "state": "string" }, "lastFullInventoryCollectionAt": "2019-08-24T14:15:22Z", "lastFullInventoryCollectionPowerState": "string" }

Patch a server

Request

Partially update a Server specified by its id

Servers without a valid subscription will not return the following:

  • hardware.health
  • hardware.memoryMb
  • hardware.formFactor
  • hardware.bmc
  • hardware.platform
  • hardware.powerState
  • hardware.indicatorLed
  • firmwareInventory
  • softwareInventory
  • lastFirmwareUpdate
  • host
  • firmwareBundleUri
  • tags
  • originIp
  • biosFamily
  • storageInventory
  • processorVendor
  • autoIloFwupdate
  • serverGeneration
  • connectionType
  • oneview
Security
Bearer
Path
idstringrequired

Unique Server identifier

Headers
Content-Typestringrequired

Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.

Value "application/merge-patch+json"
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.

Bodyapplication/merge-patch+jsonrequired
autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

Default true
curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/servers/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json
idstring(productId+serialNumber)required

Primary identifier for the server given by the system

typestringrequired

Type of the resource

Value "compute-ops-mgmt/server"
generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of server creation

updatedAtstring(date-time)required

Time of the last server update

namestring

Name given to resource

Example: "myServer"
resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB"
platformFamilynull or string
One of:

No Platform family

null

No Platform family

serverGenerationstring

Server Hardware Generation

Enum"GEN_10""GEN_11""UNKNOWN"
hardwareobject(hardware)

Server hardware details

stateobject(state)

Server connectivity state

firmwareInventoryArray of objects or null(firmwareInventoryItem-v1)

Firmware Inventory

softwareInventoryArray of objects or null(softwareInventoryItem-v1)

Software Inventory

firmwareBundleUristring or null
lastFirmwareUpdateobject or null

Details of the last firmware update

tagsobject or null

Extra identifiers a server

Example: {"location":"San Jose"}
processorVendorstring or null

Type and brand of processor

Example: "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz"
biosFamilystring or null

Bios version

hostobject or null(host)

host details

autoIloFwUpdateboolean

To opt in for automatic iLO-only firmware update

oneviewobject or null

Details of the OneView managed server

lastFullInventoryCollectionAtstring or null
Any of:

Last complete inventory collection time

string(date-time)

Last complete inventory collection time

lastFullInventoryCollectionPowerStatestring

Power state of the server when the complete inventory is collected

Response
application/json
{ "id": "string", "name": "myServer", "type": "compute-ops-mgmt/server", "resourceUri": "/compute-ops-mgmt/v1/servers/875765-S01+1M512501AB", "generation": 1, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "platformFamily": {}, "serverGeneration": "GEN_10", "hardware": { "serialNumber": "string", "model": "string", "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "productId": "string", "powerState": "UNKNOWN", "indicatorLed": "UNKNOWN", "health": {}, "platform": "string", "formFactor": "string", "bmc": {}, "memoryMb": {} }, "state": { "managed": true, "connected": true, "connectedModifiedAt": "2019-08-24T14:15:22Z", "subscriptionState": "REQUIRED", "subscriptionTier": "ENHANCED", "subscriptionExpiresAt": "2019-08-24T14:15:22Z" }, "firmwareInventory": [ {} ], "softwareInventory": [ {} ], "firmwareBundleUri": "string", "lastFirmwareUpdate": { "status": "OK", "attemptedAt": "2019-08-24T14:15:22Z", "firmwareInventoryUpdates": [] }, "tags": { "location": "San Jose" }, "processorVendor": "Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz", "biosFamily": "string", "host": { "osName": "string", "osVersion": "string", "hostname": "string", "osDescription": "string", "osType": 0 }, "autoIloFwUpdate": true, "oneview": { "applianceUri": "string", "maintenanceMode": true, "name": "string", "state": "string" }, "lastFullInventoryCollectionAt": "2019-08-24T14:15:22Z", "lastFullInventoryCollectionPowerState": "string" }

List all alerts for a server

Request

Retrieve alert data for a Server specified by the id of the server

Security
Bearer
Path
idstringrequired

Unique Server identifier

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

Servers can be filtered by:

  • biosFamily
  • createdAt
  • firmwareBundleUri
  • hardware and all nested properties
  • host and all nested properties
  • id
  • name †
  • oneview and all nested properties
  • platformFamily
  • processorVendor
  • resourceUri
  • state and all nested properties

† When searching for a server using the name filter, you must supply the serial number of the server, not the hostname. To filter by hostname use host/hostname instead of name

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

Examples:

Return servers where a property equals a value. <property> eq <value>

filter=host/hostname eq 'myServer'

Return servers where a nested property equals a value. <property>/<nestedProperty> eq <value>

filter=state/managed eq 'true'

Return servers where a property equals a value, using a url. <property>%20eq%20%27<value>

filter=id%20eq%20%27497f6eca-6276-4993-bfeb-53cbbbba6f08

Return servers where a property does not equal a value not <property> eq <value>

filter=not name eq 'MXQ89990RR'

Return servers with populated property. not <property> eq null

filter=not name eq null

Return servers where property contains a value. contains(<property>, <value>)

filter=contains(createdAt,'2019')

Return servers where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not name eq null and contains(createdAt,'2019')

Return servers where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)

filter=state/managed in ('true','false')
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/servers/{id}/alerts' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server's Alert Data

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired
items[].​idstring(uuid)required

Primary identifier for the alert given by the system

items[].​typestringrequired

Type of the resource

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

Monotonically increasing update counter

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

Time of alert creation

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

Time of the last alert update

items[].​serverIdstring

ID of the server to which this alert is associated

items[].​severitystring
Enum"OK""WARNING""CRITICAL"
items[].​descriptionstring
items[].​resolutionstring
items[].​messagestring
items[].​timestampstring(date-time)
items[].​categorystring
items[].​serviceEventboolean
items[].​serviceNowIncidentobject(serviceNowIncident-v1)

ServiceNow incident details. This data will only be available when a ServiceNow incident is created for a service event.

items[].​caseIdinteger

ID of the automatically created HPE Support Case. This will be available only when a HPE Support Case is created for a service event.

Example: 9815373940
items[].​caseUrlstring

URL of the automatically created HPE Support Case. This will be available only when a HPE Support Case is created for a service event.

Example: "https://example.hpe.com/portal/site/hpsc/scm/caseDetails?caseID=9815373940"
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": [ {} ] }

Clear power utilization alerts for a server

Request

Clear power utilization alerts for a server

Security
Bearer
Path
idstring(productId+serialNumber)required

Unique Server identifier

Example: P43990-121+SYN1002J11
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.

Bodyapplication/jsonrequired
alertsArray of objects(clearAlertData-v1)required

Alerts resources for power utilization alerts

alerts[].​serverIdstring(productId+serialNumber)

Primary identifier for the server given by the system.

Example: "P43990-121+SYN1002J11"
alerts[].​messageIdstring

Unique identifier assigned to alert messages.

Example: "Utilization.1.0.ProjectedCriticalPowerUtilExceeded"
alerts[].​originOfConditionstring

Property within the alert event data that indicates the source or origin of the condition that triggered the alert

Example: "/api/powerutilization/P39886-B21+MXQ1480B03"
curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/servers/P43990-121+SYN1002J11/clear-alert' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "alerts": [
      {}
    ]
  }'

Responses

Successful Response

Response
No content

Analyze server configuration for operating system installation

Request

Validate the presence of storage volume for the server specified by the id for operating system installation. The request body is empty.

Security
Bearer
Path
idstring(productId+serialNumber)required

Unique Server identifier

Example: P43990-121+SYN1002J11
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 POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/servers/P43990-121+SYN1002J11/analyze-os-install' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
serverHasStorageVolumeboolean

Returns true, if the storage volume is present in the server

Response
application/json
{ "serverHasStorageVolume": true }

Get external storage details

Request

Retrieves external storage hosts and volume details for a server specified by the server id

Security
Bearer
Path
idstringrequired

Unique server 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/servers/{id}/external-storage-details' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success (Server's external storage details)

Bodyapplication/json
serverIdstring(uuid)

The server id for the volume details

createdAtstring(date-time)

Time the volume details were gathered

updatedAtstring(date-time)

The last time the volume details were updated

generationinteger>= 1

Monotonically increasing update counter

volumeDetailsArray of objects

Details of the volumes attached to the server

hostNamestring

Name of the host

hostOsstring(externalStorageHostOS)

An enumeration.

Enum"UNKNOWN""AIX""APPLE"
hostGroupsArray of objects

Host groups to which the host belongs

Response
application/json
{ "serverId": "10d2345a-e43d-463d-830e-4f5b19b60d41", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "generation": 1, "volumeDetails": [ {} ], "hostName": "string", "hostOs": "UNKNOWN", "hostGroups": [ {} ] }

List inventories for a server

Request

Retrieve firmware, software, storage inventories, PCI devices and smart update tool settings for a server specified by the id of the server

Security
Bearer
Path
idstringrequired

Unique Server 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/servers/{id}/inventory' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server's inventory Data

Bodyapplication/json
idstringrequired

Primary identifier for the device given by the system

typestringrequired

Type of the resource

Value "compute-ops-mgmt/server/inventory"
serialstring
productIdstring
lastFullInventoryCollectionAtstring or null
Any of:

Last complete inventory collection time

string(date-time)

Last complete inventory collection time

lastFullInventoryCollectionPowerStatestring

Power state of the server when the complete inventory is collected

firmwareobject

Firmware Inventory

softwareobject

Software Inventory

storageobject

Storage Inventory

smartStorageobject

Smart Storage Inventory

deviceobject

Device Inventory

smartUpdateToolInventoryobject

Smart Update Tool Settings Inventory

chassisobject

Chassis Inventory

memoryobject

Memory Inventory

networkAdapterobject

Network Adapter Inventory

processorobject

Processor Inventory

powerSupplyobject

Power Supply Inventory

thermalobject

Thermal Inventory

Response
application/json
{ "id": "string", "type": "compute-ops-mgmt/server/inventory", "serial": "string", "productId": "string", "lastFullInventoryCollectionAt": "2019-08-24T14:15:22Z", "lastFullInventoryCollectionPowerState": "string", "firmware": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "software": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "storage": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "smartStorage": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "device": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "smartUpdateToolInventory": { "modified": "2019-08-24T14:15:22Z", "data": [] }, "chassis": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "memory": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "networkAdapter": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "processor": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "powerSupply": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" }, "thermal": { "modified": "2019-08-24T14:15:22Z", "data": [], "collectionState": "string" } }

List subset of a Server Inventory

Request

Lists the subset of the server hardware inventory. The request body can either specify a subset of attributes, or can be empty, and a subset of attributes or the full inventory response is returned.

Security
Bearer
Path
idstring(productId+serialNumber)required

Unique Server identifier

Example: P43990-121+SYN1002J11
Query
formatstring(json)required

Format for subset inventory response

Example: format=json
Headers
Content-Typestringrequired

Content-Type header must designate 'application/json' in order for the request to be performed.

Value "application/json"
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.

Bodyapplication/jsonrequired

Below is an example payload for fetching chassis and processor inventory which is a subset.

chassisobject

Chassis Inventory

processorobject

Processor Inventory

curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/servers/P43990-121+SYN1002J11/inventory?format=json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Subset of a Server Inventory

Bodyapplication/json
chassisobject

Chassis Inventory

processorobject

Processor Inventory

Response
application/json
{ "chassis": { "data": [] }, "processor": { "data": [] } }

Get the event and health notification status for a server

Request

Purpose

Retrieves the current values of the event and health notification options.

  • For criticalNotification a notification will be sent if the value is true, and no notification will be sent if the value is false.
  • For the following properties a notification will be sent if the value is true. No notification will be sent if the value is null or false.
    • criticalNonServiceNotification
    • warningNotification
    • healthNotification
Security
Bearer
Path
idstringrequired
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/servers/{id}/notifications' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
serverIdstring
criticalNotificationboolean
criticalNonServiceNotificationboolean or null
warningNotificationboolean or null
healthNotificationboolean or null
Response
application/json
{ "serverId": "string", "criticalNotification": true, "criticalNonServiceNotification": true, "warningNotification": true, "healthNotification": true }

Update event and health notifications for a server

Request

Purpose

When a server is added to Compute Ops Management, these attributes will be used to set the initial email notification subscription choices for event and daily health email notifications.

Event notification selections are made such that each selection increases the scope of the set of events that will be included. The order of event selections from minimum to maximum scope are

  • criticalNotification - Events that are marked as service events. These events may have severity levels of 'warning' or 'critical'
  • criticalNonServiceNotification - Events that are not service events but have a severity level of 'critical'
  • warningNotification - Events that are not service events but have a severity level of 'warning'

Note that healthNotification is not part of the event notification set and may be set independently.

Since each selection builds on the previous one, there exists a hierarchy between selections that must be maintained. The table below shows which notification combinations are valid. All other combinations will result in an HTTP 400 error

criticalNotificationcriticalNonServiceNotificationwarningNotification
FalseFalseFalse
TrueFalseFalse
TrueTrueFalse
TrueTrueTrue

Initial values

All values are initially false with the result being that no notifications will be sent.

Security
Bearer
Path
idstringrequired
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.

Bodyapplication/jsonrequired
criticalNotificationbooleanrequired
criticalNonServiceNotificationboolean or null
warningNotificationboolean or null
healthNotificationboolean or null
curl -i -X PUT \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/servers/{id}/notifications' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "criticalNotification": true
  }'

Responses

Successful Response

Bodyapplication/json
serverIdstring
criticalNotificationboolean
criticalNonServiceNotificationboolean or null
warningNotificationboolean or null
healthNotificationboolean or null
Response
application/json
{ "serverId": "string", "criticalNotification": true, "criticalNonServiceNotification": true, "warningNotification": true, "healthNotification": true }

Get security parameters for a server

Request

Retrieve a list of security parameters for a server specified by the id of the server

Security
Bearer
Path
idstringrequired

Unique Server 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/servers/{id}/security-parameters' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server's security parameters Data

Bodyapplication/json
idstring
overallSecurityStatusstring

a enum describing the overall security status of the server

Enum"OK""RISK""IGNORE"
iloSecurityParamsArray of securityParameter-v1 (objects) or null
One of:
typestring

Type of the resource

Value "compute-ops-mgmt/server/security-parameter"
resourceUristring

URI to the security parameter resource itself (i.e. a self link).

Response
application/json
{ "id": "string", "overallSecurityStatus": "OK", "iloSecurityParams": [ {} ], "type": "compute-ops-mgmt/server/security-parameter", "resourceUri": "string" }

List of adapter to switch port mappings for a server

Request

Retrieve network connectivity of adapter port to connected switch port for a server specified by the id of the server

Security
Bearer
Path
idstring(productId+serialNumber)required

Unique Server identifier

Example: P06760-B21+2M212504P8
Query
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.

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://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/servers/P06760-B21+2M212504P8/tor-port-mappings' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server's network connectivity Data

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired
items[].​idstring(uuid)required

Primary identifier for the port mapping data given by system

items[].​typestringrequired

Type of the resource

Value "compute-ops-mgmt/server/tor-port-mapping"
items[].​generationinteger>= 1required

Monotonically increasing update counter

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

Time of port connectivity information created

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

Time of port connectivity information updated

items[].​serverIdstring

ID of the server to which this port is associated

items[].​portMacstring

Server adapter port macaddress

items[].​clientStatenull or "ONLINE" (string) or "OFFLINE" (string) or "UNKNOWN" (string)

MAC learning status on switch for server port macaddress

One of:

No client state

null

No client state

items[].​portLastConnectedAtstring(date-time)

Date and time at which the active traffic was observed last time

items[].​portConnectivityStatenull or "CURRENT" (string) or "CACHED" (string) or "UNDETERMINED" (string) or "NOMAPPING" (string)

Switch port connectivity discovered state

One of:

No port connectivity state

null

No port connectivity state

items[].​switchPortAdminStatenull or string
One of:

No switch port administrative state

null

No switch port administrative state

items[].​switchPortLinkStatusnull or string
One of:

No switch port link state

null

No switch port link state

items[].​switchPortstring

Switch port where server adapter port is connected

items[].​switchPortSpeedstring

Speed configured on switch port

items[].​switchPortNativeVlanstring

Native vlan configured on switch port

items[].​switchPortVlansstring

Vlans configured on siwtch port

items[].​switchNamestring

Switch name

items[].​switchModelstring

Switch model

items[].​switchSerialNumberstring

Switch serial number

items[].​switchStatusnull or "UP" (string) or "DOWN" (string) or "UNKNOWN" (string)

Switch connection state

One of:

No switch connection state

null

No switch connection state

items[].​switchSitestring

Site name of the switch

items[].​switchGroupNamestring

Gorup name of the switch

items[].​switchFwVersionstring

Switch firmware version

items[].​switchIpAddressstring

Switch IP address

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": [ {} ] }

List raw inventories for a serverDeprecated

Request

Note: This path operation is going to be deprecated and sunset!

  • Deprecated at: Fri, 7 Nov 2024 23:59:59 GMT
  • Sunset at: Fri, 30 May 2025 23:59:59 GMT
  • Successor version: compute-ops-mgmt/v1/servers/{id}/inventory

Retrieve firmware, software, storage inventories, PCI devices and smart update tool settings for a server specified by the id of the server.

Security
Bearer
Path
idstringrequired

Unique Server 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/servers/{id}/raw-inventory' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Server's raw inventory Data

Bodyapplication/json
idstringrequired

Primary identifier for the device given by the system

typestringrequired

Type of the resource

Value "compute-ops-mgmt/server/raw-inventory"
serialstring
productIdstring
firmwareInventoryArray of objects(JSON)(serverRawInventoryItem-v1)

Firmware Inventory

softwareInventoryArray of objects(JSON)(serverRawInventoryItem-v1)

Software Inventory

storageInventoryobject(JSON)

JSON data that describes Storage Inventory

pciDevicesArray of objects(JSON)(serverRawInventoryItem-v1)

PCI devices

smartUpdateToolobject(JSON)

JSON data that describes Integrated Smart Update Tools settings

Response
application/json
{ "id": "string", "type": "compute-ops-mgmt/server/raw-inventory", "serial": "string", "productId": "string", "firmwareInventory": [ {} ], "softwareInventory": [ {} ], "storageInventory": { "property1": [], "property2": [] }, "pciDevices": [ {} ], "smartUpdateTool": { "property1": [], "property2": [] } }

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