Zero-based resource offset to start the response from
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.
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/
https://us-west.api.greenlake.hpe.com/
https://eu-central.api.greenlake.hpe.com/
https://ap-northeast.api.greenlake.hpe.com/
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
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
CLASS | EXAMPLES |
---|---|
Types | integer, decimal, timestamp, string, boolean, null |
Operations | eq, ne, gt, ge, lt, le, in |
Logic | and, 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.
Return servers where a property equals a value. <property> eq <value>
Return servers where a nested property equals a value. <property>/<nestedProperty> eq <value>
Return servers where a property equals a value, using a url. <property>%20eq%20%27<value>
Return servers where a property does not equal a value not <property> eq <value>
Return servers with populated property. not <property> eq null
Return servers where property contains a value. contains(<property>, <value>)
Return servers where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
Return servers where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
OK
Primary identifier for the server given by the system
URI to the server itself (i.e. a self link)
Type and brand of processor
Last complete inventory collection time
Last complete inventory collection time
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ] }
Request
Update multiple server(s) specified by the id
(s). The operation is atomic (either fully successful or failing without modifying any servers).
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers?id=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/merge-patch+json' \
-d '{}'
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
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Server Data
URI to the server itself (i.e. a self link)
Type and brand of processor
Last complete inventory collection time
Last complete inventory collection time
{ "id": "string", "name": "myServer", "type": "compute-ops-mgmt/server", "resourceUri": "/compute-ops-mgmt/v1beta2/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" }
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
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/merge-patch+json' \
-d '{}'
Successful Response
URI to the server itself (i.e. a self link)
Type and brand of processor
Last complete inventory collection time
Last complete inventory collection time
{ "id": "string", "name": "myServer", "type": "compute-ops-mgmt/server", "resourceUri": "/compute-ops-mgmt/v1beta2/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" }
Request
Retrieve alert data for a Server specified by the id of the server
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
CLASS | EXAMPLES |
---|---|
Types | integer, decimal, timestamp, string, boolean, null |
Operations | eq, ne, gt, ge, lt, le, in |
Logic | and, 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.
Return servers where a property equals a value. <property> eq <value>
Return servers where a nested property equals a value. <property>/<nestedProperty> eq <value>
Return servers where a property equals a value, using a url. <property>%20eq%20%27<value>
Return servers where a property does not equal a value not <property> eq <value>
Return servers with populated property. not <property> eq null
Return servers where property contains a value. contains(<property>, <value>)
Return servers where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
Return servers where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/alerts
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/alerts
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/alerts
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/alerts
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}/alerts' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Server's Alert Data
ServiceNow incident details. This data will only be available when a ServiceNow incident is created for a service event.
ID of the automatically created HPE Support Case. This will be available only when a HPE Support Case is created for a service event.
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ] }
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.
Alerts resources for power utilization alerts
Primary identifier for the server given by the system.
Unique identifier assigned to alert messages.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/clear-alert
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/clear-alert
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/clear-alert
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/clear-alert
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/P43990-121+SYN1002J11/clear-alert' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"alerts": [
{}
]
}'
Request
Validate the presence of storage volume for the server specified by the id
for operating system installation. The request body is empty.
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/analyze-os-install
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/analyze-os-install
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/analyze-os-install
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/analyze-os-install
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/P43990-121+SYN1002J11/analyze-os-install' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "serverHasStorageVolume": true }
Request
Retrieves external storage hosts and volume details for a server specified by the server id
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/external-storage-details
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/external-storage-details
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/external-storage-details
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/external-storage-details
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}/external-storage-details' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "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": [ { … } ] }
Request
Retrieve firmware, software, storage inventories, PCI devices and smart update tool settings for a server specified by the id of the server
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}/inventory' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "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" } }
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.
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
Content-Type header must designate 'application/json' in order for the request to be performed.
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.
Below is an example payload for fetching chassis and processor inventory which is a subset.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/inventory
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/P43990-121+SYN1002J11/inventory?format=json' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'
{ "chassis": { "data": [ … ] }, "processor": { "data": [ … ] } }
Request
Purpose
Retrieves the current values of the event and health notification options.
- For
criticalNotification
a notification will be sent if the value istrue
, 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
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}/notifications' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "serverId": "string", "criticalNotification": true, "criticalNonServiceNotification": true, "warningNotification": true, "healthNotification": true }
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
criticalNotification | criticalNonServiceNotification | warningNotification |
---|---|---|
False | False | False |
True | False | False |
True | True | False |
True | True | True |
Initial values
All values are initially false with the result being that no notifications will be sent.
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/notifications
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}/notifications' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"criticalNotification": true
}'
{ "serverId": "string", "criticalNotification": true, "criticalNonServiceNotification": true, "warningNotification": true, "healthNotification": true }
Request
Retrieve a list of security parameters for a server specified by the id of the server
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/security-parameters
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/security-parameters
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/security-parameters
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/security-parameters
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}/security-parameters' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "id": "string", "overallSecurityStatus": "OK", "iloSecurityParams": [ { … } ], "type": "compute-ops-mgmt/server/security-parameter", "resourceUri": "string" }
Request
Retrieve network connectivity of adapter port to connected switch port for a server specified by the id of the server
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/tor-port-mappings
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/tor-port-mappings
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/tor-port-mappings
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/tor-port-mappings
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/P06760-B21+2M212504P8/tor-port-mappings' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Server's network connectivity Data
MAC learning status on switch for server port macaddress
No client state
No client state
Date and time at which the active traffic was observed last time
Switch port connectivity discovered state
No port connectivity state
No port connectivity state
No switch port administrative state
No switch port administrative state
No switch port link state
No switch port link state
Switch connection state
No switch connection state
No switch connection state
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ] }
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.
URI PATH PREFIX RENAME
This API now supports the URI path prefix /compute-ops-mgmt
which used to be /compute-ops
. The /compute-ops
prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.
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.
- Mock server
https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta2/servers/{id}/raw-inventory
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/raw-inventory
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/raw-inventory
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/servers/{id}/raw-inventory
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
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/v1beta2/servers/{id}/raw-inventory' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "id": "string", "type": "compute-ops-mgmt/server/raw-inventory", "serial": "string", "productId": "string", "firmwareInventory": [ { … } ], "softwareInventory": [ { … } ], "storageInventory": { "property1": [], "property2": [] }, "pciDevices": [ { … } ], "smartUpdateTool": { "property1": [], "property2": [] } }