Skip to content
/
Get security parameters f...

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
API endpoint for US West

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

API endpoint for EU Central

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

API endpoint for AP Northeast

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

Mock server

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

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

secure-gateway-appliances - v1beta2

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

approval-policy - v1beta2

Operations

approval-request - v1beta2

Operations

async-operations - v1

Operations

async-operations - v1beta1

Operations

energy-over-time - v1beta1

Operations

energy-by-entity - v1beta1

Operations

external-services - v1beta1

Operations

filters - v1beta1

Operations

firmware-bundles - v1

Operations

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

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.

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.

Security
Bearer
Path
idstringrequired
Bodyapplication/jsonrequired
criticalNotificationbooleanrequired
criticalNonServiceNotificationboolean or null
warningNotificationboolean or null
healthNotificationboolean or null
curl -i -X PUT \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/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

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.

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://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/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-v1beta2 (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

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.

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://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1beta2/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 objects(tor-port-mappings-v1beta2)required
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[].​clientState((null or null) or null) or ("ONLINE" (string) or "OFFLINE" (string) or "UNKNOWN" (string)) or ("OFFLINE" (string) or "ONLINE" (string) or "UNKNOWN" (string)) or ("UNKNOWN" (string) or "ONLINE" (string) or "OFFLINE" (string))
One of:
One of:

MAC learning status on switch for server port macaddress

null or null
items[].​portLastConnectedAtstring(date-time)

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

items[].​portConnectivityState((null or null) or null) or ("CURRENT" (string) or "CACHED" (string) or "UNDETERMINED" (string) or "NOMAPPING" (string)) or ("CACHED" (string) or "CURRENT" (string) or "UNDETERMINED" (string) or "NOMAPPING" (string)) or ("UNDETERMINED" (string) or "CURRENT" (string) or "CACHED" (string) or "NOMAPPING" (string)) or ("NOMAPPING" (string) or "CURRENT" (string) or "CACHED" (string) or "UNDETERMINED" (string))
One of:
One of:

Switch port connectivity discovered state

null or null
items[].​switchPortAdminStatenull or string
One of:
One of:

No switch port administrative state

null
items[].​switchPortLinkStatusnull or string
One of:
One of:

No switch port link state

null
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[].​switchStatus((null or null) or null) or ("UP" (string) or "DOWN" (string) or "UNKNOWN" (string)) or ("DOWN" (string) or "UP" (string) or "UNKNOWN" (string)) or ("UNKNOWN" (string) or "UP" (string) or "DOWN" (string))
One of:
One of:

Switch connection state

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

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