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

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

alerts - v1

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

Operations

firmware-bundles - v1beta2

Operations

groups - v2beta1

Operations

List all groups

Request

Get the paged collection of all groups.

Security
Bearer
Query
nextstring(uuid)

The pagination cursor for the next page of resources.

Example: next=b4cf1a6f-1a1f-11ef-9856-20155d97c234
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.

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

Groups can be filtered by all properties except for type, generation, and URIs.

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

Examples:

Return groups for a specific device type. <property> eq <value>

filter=deviceType eq 'DIRECT_CONNECT_SERVER'

Return groups with specific auto-add tags. <property>/<nestedProperty> eq <value>

filter=autoAddTags/Department eq 'Finance'

Return groups with one of several health states. <property> in (<value>,<value>)

filter=healthStatus in ('WARNING','CRITICAL')

Return groups with names containing a substring. contains(<property>, <value>)

filter=contains(name,'Production')

Return groups that are not already compliant. not <property> <operator> <value>

filter=not complianceStatus in ('COMPLIANT','NOT_APPLICABLE')

Return server groups that still need remediation. <property> eq <value> and <property> eq <value>

filter=deviceType eq 'DIRECT_CONNECT_SERVER' and complianceStatus eq 'NOT_COMPLIANT'

Return groups with any settings entry that shows firmware is not compliant. <arrayProperty>/any(item: item/<nestedProperty> <operator> <value>)

filter=settings/any(item: item/category eq 'FIRMWARE' and item/complianceStatus eq 'NOT_COMPLIANT')

Return groups where every element in a list property matches a condition. <arrayProperty>/all(item: item/<nestedProperty> <operator> <value>)

filter=settings/all(item: item/complianceStatus in ('COMPLIANT','NOT_APPLICABLE'))
sortstring

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

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

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

Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
itemsArray of objects(group-v2beta1)read-onlyrequired
items[].​idstring(uuid)read-only

The unique identifier for the group.

Example: "0fe1cab7-6480-4ac1-841e-8607487b7df4"
items[].​typestringread-only

The group resource type.

Value "compute-ops-mgmt/group"
items[].​namestring

The display name of the group.

Example: "Production Group"
items[].​descriptionstring or null or string or null

A description of the group's purpose.

Example: "All production servers"
items[].​deviceTypestringread-only

The type of devices allowed in the group.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
items[].​deviceCountintegerread-only

The number of devices assigned to the group.

Example: 42
items[].​healthStatusstringread-only

The health status rollup of all devices in the group.

Enum"OK""WARNING""CRITICAL"
items[].​securityStatusstringread-only

The security status rollup of all devices in the group.

Enum"OK""IGNORED""RISK"
items[].​complianceStatusstringread-only

The compliance status rollup of all devices in the group.

Enum"COMPLIANT""NOT_COMPLIANT""NOT_APPLICABLE"
items[].​settingsArray of objects(groupSettings-v2beta1)

A list of settings to apply to devices in the group.

items[].​settingsCountintegerread-only

The number of settings assigned to the group.

Example: 2
items[].​policiesobject

The settings policy configuration for the group.

items[].​autoAddTagsobject or null or object or null

Case-insensitive device tags, matching devices will be assigned to the group.

Example: {"Department":"Development - Texas"}
items[].​devicesUristring(uri-reference)read-only

The URI of the device collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"
items[].​complianceUristring(uri-reference)read-only

The URI of the compliance collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c/compliance"
items[].​resourceUristring(uri-reference)read-only

The URI of this group resource.

Example: "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"
items[].​generationintegerread-only

The resource update counter.

Example: 3
items[].​createdAtstring(date-time)read-only

The date and time when the group was created.

Example: "2026-01-22T23:09:41.875102Z"
items[].​updatedAtstring(date-time)read-only

The date and time when the group was updated.

Example: "2026-01-23T05:54:15.689856Z"
offsetinteger>= 0

Zero-based resource offset

totalinteger>= 0

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

Example: 12
nextstring or nullread-only
Any of:

The pagination cursor for the next page of resources.

stringread-only
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ], "next": "string" }

Create a group

Request

Create a group.

Security
Bearer
Query
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
Headers
Content-Typestringrequired

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

Value "application/json"
Bodyapplication/jsonrequired
namestring[ 1 .. 100 ] charactersrequired

The display name of the group.

Example: "Production Group"
descriptionstring or null<= 10000 charactersrequired

A description of the group's purpose.

Example: "All production servers"
deviceTypestringrequired

The type of devices allowed in the group.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
settingsArray of objects(groupSettingsRequest-v2beta1)required

A list of settings to apply to devices in the group.

settings[].​settingsIdstring(uuid)required

The ID of a settings resource.

Example: "028652b0-7b8a-446d-828b-b064172d013c"
settings[].​categorystringrequired

The settings category.

Enum"FIRMWARE""BIOS""ILO_SETTINGS"
Example: "FIRMWARE"
policiesobject(groupPoliciesRequest-v2beta1)required
policies.​firmwareUpdateboolean or null
Default null
Any of:

Apply firmware settings when a server is added to a group.

boolean
Default null
policies.​firmwareDowngradeboolean or null
Default null
Any of:

Allow or forbid downgrade of firmware when firmware update is performed.

boolean
Default null
policies.​firmwarePowerOffboolean or null
Default null
Any of:

Power off server when firmware update is performed, otherwise leave server power on.

boolean
Default null
policies.​biosApplySettingsboolean or null
Default null
Any of:

Apply BIOS settings when a server is added to a group.

boolean
Default null
policies.​biosFactoryResetboolean or null
Default null
Any of:

Reset the server BIOS to its factory default configuration when applying BIOS settings.

boolean
Default null
policies.​iloApplySettingsboolean or null
Default null
Any of:

Apply iLO settings when a server is added to a group.

boolean
Default null
policies.​storageConfigurationboolean or null
Default null
Any of:

Apply storage settings when a server is added to a group.

boolean
Default null
policies.​storageVolumeDeletionboolean or null
Default null
Any of:

Delete existing storage volumes when applying storage settings.

boolean
Default null
policies.​storageVolumesArray of objects or null
Default null
Any of:

Storage volume names to use when applying storage settings.

policies.​osInstallboolean or null
Default null
Any of:

Install an operating system when a server is added to a group.

boolean
Default null
policies.​osCompletionTimeoutMininteger or null
Default null
Example: 240
Any of:

The timeout period for OS install to complete.

integer
Default null
policies.​externalStorageConfigurationboolean or null
Default null
Any of:

Configure external storage when a server is added to a group.

boolean
Default null
autoAddTagsobjectrequired

A case-insensitive tag that can be associated with a group to automatically add devices to the group. A group can have a maximum of one tag, and multiple groups cannot have the same tag. When a device is onboarded or its tags change, the device's tags are checked against the group's autoAddTags. If at least one of the device tags matches one group's autoAddTags, the device is placed into the associated group. Once a device has been connected, it becomes ineligible for automatically being placed into groups, even if it is later disconnected. If a device's tags match more than one group, it will not be assigned to any group. If a device is in a group, any further tag changes will not move it to another group. If the device was added to a group but has been removed, is not in any group, and still has not been activated, changing the device tags will automatically assign it to the matching group. Tags can contain any alphanumeric characters, spaces, and the following characters: _ . : = + - @.

Example: {"Department":"Development - Texas"}
autoAddTags.​property name*string<= 256 charactersadditional property
curl -i -X POST \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Production Group",
    "description": "All production servers",
    "deviceType": "DIRECT_CONNECT_SERVER",
    "settings": [
      {
        "settingsId": "028652b0-7b8a-446d-828b-b064172d013c",
        "category": "FIRMWARE"
      }
    ],
    "policies": {},
    "autoAddTags": {
      "Department": "Development - Texas"
    }
  }'

Responses

Successful response

Headers
Locationstring(uri-reference)

The URI of the group that was created.

Example: "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"
Bodyapplication/json
idstring(uuid)read-only

The unique identifier for the group.

Example: "0fe1cab7-6480-4ac1-841e-8607487b7df4"
typestringread-only

The group resource type.

Value "compute-ops-mgmt/group"
namestring

The display name of the group.

Example: "Production Group"
descriptionstring or null

A description of the group's purpose.

Example: "All production servers"
deviceTypestringread-only

The type of devices allowed in the group.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
deviceCountintegerread-only

The number of devices assigned to the group.

Example: 42
healthStatusstringread-only

The health status rollup of all devices in the group.

Enum"OK""WARNING""CRITICAL"
securityStatusstringread-only

The security status rollup of all devices in the group.

Enum"OK""IGNORED""RISK"
complianceStatusstringread-only

The compliance status rollup of all devices in the group.

Enum"COMPLIANT""NOT_COMPLIANT""NOT_APPLICABLE"
settingsArray of objects(groupSettings-v2beta1)

A list of settings to apply to devices in the group.

settingsCountintegerread-only

The number of settings assigned to the group.

Example: 2
policiesobject(groupPolicies-v2beta1)
autoAddTagsobject or null

Case-insensitive device tags, matching devices will be assigned to the group.

Example: {"Department":"Development - Texas"}
devicesUristring(uri-reference)read-only

The URI of the device collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"
complianceUristring(uri-reference)read-only

The URI of the compliance collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c/compliance"
resourceUristring(uri-reference)read-only

The URI of this group resource.

Example: "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"
generationintegerread-only

The resource update counter.

Example: 3
createdAtstring(date-time)read-only

The date and time when the group was created.

Example: "2026-01-22T23:09:41.875102Z"
updatedAtstring(date-time)read-only

The date and time when the group was updated.

Example: "2026-01-23T05:54:15.689856Z"
Response
application/json
{ "id": "0fe1cab7-6480-4ac1-841e-8607487b7df4", "type": "compute-ops-mgmt/group", "name": "Production Group", "description": "All production servers", "deviceType": "DIRECT_CONNECT_SERVER", "deviceCount": 42, "healthStatus": "OK", "securityStatus": "OK", "complianceStatus": "COMPLIANT", "settings": [ { … } ], "settingsCount": 2, "policies": { "firmwareUpdate": true, "firmwareDowngrade": true, "firmwarePowerOff": true, "biosApplySettings": true, "biosFactoryReset": true, "iloApplySettings": true, "storageConfiguration": true, "storageVolumeDeletion": true, "storageVolumes": [ … ], "osInstall": true, "osCompletionTimeoutMin": 240, "externalStorageConfiguration": true }, "autoAddTags": { "Department": "Development - Texas" }, "devicesUri": "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices", "complianceUri": "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c/compliance", "resourceUri": "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d", "generation": 3, "createdAt": "2026-01-22T23:09:41.875102Z", "updatedAt": "2026-01-23T05:54:15.689856Z" }

Get a group

Request

Get a group by group ID.

Security
Bearer
Path
group_idstring(uuid)required
Query
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
idstring(uuid)read-only

The unique identifier for the group.

Example: "0fe1cab7-6480-4ac1-841e-8607487b7df4"
typestringread-only

The group resource type.

Value "compute-ops-mgmt/group"
namestring

The display name of the group.

Example: "Production Group"
descriptionstring or null

A description of the group's purpose.

Example: "All production servers"
deviceTypestringread-only

The type of devices allowed in the group.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
deviceCountintegerread-only

The number of devices assigned to the group.

Example: 42
healthStatusstringread-only

The health status rollup of all devices in the group.

Enum"OK""WARNING""CRITICAL"
securityStatusstringread-only

The security status rollup of all devices in the group.

Enum"OK""IGNORED""RISK"
complianceStatusstringread-only

The compliance status rollup of all devices in the group.

Enum"COMPLIANT""NOT_COMPLIANT""NOT_APPLICABLE"
settingsArray of objects(groupSettings-v2beta1)

A list of settings to apply to devices in the group.

settingsCountintegerread-only

The number of settings assigned to the group.

Example: 2
policiesobject(groupPolicies-v2beta1)
autoAddTagsobject or null

Case-insensitive device tags, matching devices will be assigned to the group.

Example: {"Department":"Development - Texas"}
devicesUristring(uri-reference)read-only

The URI of the device collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"
complianceUristring(uri-reference)read-only

The URI of the compliance collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c/compliance"
resourceUristring(uri-reference)read-only

The URI of this group resource.

Example: "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"
generationintegerread-only

The resource update counter.

Example: 3
createdAtstring(date-time)read-only

The date and time when the group was created.

Example: "2026-01-22T23:09:41.875102Z"
updatedAtstring(date-time)read-only

The date and time when the group was updated.

Example: "2026-01-23T05:54:15.689856Z"
Response
application/json
{ "id": "0fe1cab7-6480-4ac1-841e-8607487b7df4", "type": "compute-ops-mgmt/group", "name": "Production Group", "description": "All production servers", "deviceType": "DIRECT_CONNECT_SERVER", "deviceCount": 42, "healthStatus": "OK", "securityStatus": "OK", "complianceStatus": "COMPLIANT", "settings": [ { … } ], "settingsCount": 2, "policies": { "firmwareUpdate": true, "firmwareDowngrade": true, "firmwarePowerOff": true, "biosApplySettings": true, "biosFactoryReset": true, "iloApplySettings": true, "storageConfiguration": true, "storageVolumeDeletion": true, "storageVolumes": [ … ], "osInstall": true, "osCompletionTimeoutMin": 240, "externalStorageConfiguration": true }, "autoAddTags": { "Department": "Development - Texas" }, "devicesUri": "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices", "complianceUri": "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c/compliance", "resourceUri": "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d", "generation": 3, "createdAt": "2026-01-22T23:09:41.875102Z", "updatedAt": "2026-01-23T05:54:15.689856Z" }

Update a group

Request

Patch a group by group ID.

Security
Bearer
Path
group_idstring(uuid)required
Query
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
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"
Bodyapplication/merge-patch+jsonrequired
namestring or null[ 1 .. 100 ] characters

The display name of the group.

Default null
Example: "Production Group"
descriptionstring or null<= 10000 characters

A description of the group's purpose.

Default null
Example: "All production servers"
settingsArray of groupSettingsRequest-v2beta1 (objects) or null
Default null
Any of:

A list of settings to apply to devices in the group.

policiesgroupPoliciesRequest-v2beta1 (object) or null
Default null
Any of:

The settings policy configuration for the group.

object groupPoliciesRequest-v2beta1 Recursive
autoAddTagsobject or null

A case-insensitive tag that can be associated with a group to automatically add devices to the group. A group can have a maximum of one tag, and multiple groups cannot have the same tag. When a device is onboarded or its tags change, the device's tags are checked against the group's autoAddTags. If at least one of the device tags matches one group's autoAddTags, the device is placed into the associated group. Once a device has been connected, it becomes ineligible for automatically being placed into groups, even if it is later disconnected. If a device's tags match more than one group, it will not be assigned to any group. If a device is in a group, any further tag changes will not move it to another group. If the device was added to a group but has been removed, is not in any group, and still has not been activated, changing the device tags will automatically assign it to the matching group. Tags can contain any alphanumeric characters, spaces, and the following characters: _ . : = + - @.

Default null
Example: {"Department":"Development - Texas"}
curl -i -X PATCH \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful response

Bodyapplication/json
idstring(uuid)read-only

The unique identifier for the group.

Example: "0fe1cab7-6480-4ac1-841e-8607487b7df4"
typestringread-only

The group resource type.

Value "compute-ops-mgmt/group"
namestring

The display name of the group.

Example: "Production Group"
descriptionstring or null

A description of the group's purpose.

Example: "All production servers"
deviceTypestringread-only

The type of devices allowed in the group.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
deviceCountintegerread-only

The number of devices assigned to the group.

Example: 42
healthStatusstringread-only

The health status rollup of all devices in the group.

Enum"OK""WARNING""CRITICAL"
securityStatusstringread-only

The security status rollup of all devices in the group.

Enum"OK""IGNORED""RISK"
complianceStatusstringread-only

The compliance status rollup of all devices in the group.

Enum"COMPLIANT""NOT_COMPLIANT""NOT_APPLICABLE"
settingsArray of objects(groupSettings-v2beta1)

A list of settings to apply to devices in the group.

settingsCountintegerread-only

The number of settings assigned to the group.

Example: 2
policiesobject(groupPolicies-v2beta1)
autoAddTagsobject or null

Case-insensitive device tags, matching devices will be assigned to the group.

Example: {"Department":"Development - Texas"}
devicesUristring(uri-reference)read-only

The URI of the device collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"
complianceUristring(uri-reference)read-only

The URI of the compliance collection for the group.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c/compliance"
resourceUristring(uri-reference)read-only

The URI of this group resource.

Example: "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"
generationintegerread-only

The resource update counter.

Example: 3
createdAtstring(date-time)read-only

The date and time when the group was created.

Example: "2026-01-22T23:09:41.875102Z"
updatedAtstring(date-time)read-only

The date and time when the group was updated.

Example: "2026-01-23T05:54:15.689856Z"
Response
application/json
{ "id": "0fe1cab7-6480-4ac1-841e-8607487b7df4", "type": "compute-ops-mgmt/group", "name": "Production Group", "description": "All production servers", "deviceType": "DIRECT_CONNECT_SERVER", "deviceCount": 42, "healthStatus": "OK", "securityStatus": "OK", "complianceStatus": "COMPLIANT", "settings": [ { … } ], "settingsCount": 2, "policies": { "firmwareUpdate": true, "firmwareDowngrade": true, "firmwarePowerOff": true, "biosApplySettings": true, "biosFactoryReset": true, "iloApplySettings": true, "storageConfiguration": true, "storageVolumeDeletion": true, "storageVolumes": [ … ], "osInstall": true, "osCompletionTimeoutMin": 240, "externalStorageConfiguration": true }, "autoAddTags": { "Department": "Development - Texas" }, "devicesUri": "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices", "complianceUri": "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c/compliance", "resourceUri": "/compute-ops-mgmt/v2beta1/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d", "generation": 3, "createdAt": "2026-01-22T23:09:41.875102Z", "updatedAt": "2026-01-23T05:54:15.689856Z" }

Delete a group

Request

Delete a group by group ID.

Security
Bearer
Path
group_idstring(uuid)required
Query
forceboolean

If force=true, unassign all devices then delete the group. Without force, a conflict error will be returned if devices are assigned to the group.

Default false
curl -i -X DELETE \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Response
No content

List all devices across groups

Request

Get the paged collection of devices across all groups.

Security
Bearer
Query
nextstring(uuid)

The pagination cursor for the next page of resources.

Example: next=b4cf1a6f-1a1f-11ef-9856-20155d97c234
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.

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

Devices in a group can be filtered by all properties except for type, generation, and URIs.

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

Examples:

Return only devices that are servers. <property> eq <value>

filter=deviceType eq 'DIRECT_CONNECT_SERVER'

Return devices with one of several health states. <property> in (<value>,<value>)

filter=healthStatus in ('WARNING','CRITICAL')

Return devices with a matching serial number substring. contains(<property>, <value>)

filter=contains(deviceId,'WKQ82425HD')

Return devices that are not currently healthy. not <property> eq <value>

filter=not healthStatus eq 'OK'

Return devices that have both health and security issues. <property> eq <value> and <property> eq <value>

filter=healthStatus eq 'WARNING' and securityStatus eq 'RISK'
sortstring

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

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

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

Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/group-devices \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
itemsArray of objects(device-v2beta1)read-onlyrequired
items[].​idstring(uuid)read-only

The unique identifier for the device.

Example: "0dc95df2-636e-4bde-ba4f-e9ec9127471b"
items[].​typestringread-only

The device resource type.

Value "compute-ops-mgmt/group/device"
items[].​namestringread-only

The device display name, commonly the hostname or serial number.

Example: "data-3"
items[].​groupIdstring(uuid)read-only

The ID of the group that the device is assigned to.

Example: "35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​groupUristring(uri-reference)read-only

The URI of the group that the device is assigned to.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​deviceIdstringread-only

The ID of the assigned device resource.

Example: "873357-P04+WKQ82425HD"
items[].​deviceUristring(uri-reference)read-only

The URI of the assigned device resource. The URI version may change over time.

Example: "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD"
items[].​deviceTypestringread-only

The type of the device.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
items[].​healthStatusstringread-only

The health status of the device.

Enum"OK""WARNING""CRITICAL"
items[].​securityStatusstringread-only

The security status of the device.

Enum"OK""IGNORED""RISK"
items[].​resourceUristring(uri-reference)read-only

The URI of this device resource.

Example: "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices/0dc95df2-636e-4bde-ba4f-e9ec9127471b"
items[].​generationintegerread-only

The resource update counter.

Example: 3
items[].​createdAtstring(date-time)read-only

The date and time when the device was assigned.

Example: "2026-01-22T23:09:41.875102Z"
items[].​updatedAtstring(date-time)read-only

The date and time when the device was updated.

Example: "2026-01-23T05:54:15.689856Z"
offsetinteger>= 0

Zero-based resource offset

totalinteger>= 0

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

Example: 12
nextstring or nullread-only
Any of:

The pagination cursor for the next page of resources.

stringread-only
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ], "next": "string" }

List all devices in a group

Request

Get the paged collection of all devices in a group.

Security
Bearer
Path
group_idstring(uuid)required
Query
nextstring(uuid)

The pagination cursor for the next page of resources.

Example: next=b4cf1a6f-1a1f-11ef-9856-20155d97c234
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.

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

Devices in a group can be filtered by all properties except for type, generation, and URIs.

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

Examples:

Return only devices that are servers. <property> eq <value>

filter=deviceType eq 'DIRECT_CONNECT_SERVER'

Return devices with one of several health states. <property> in (<value>,<value>)

filter=healthStatus in ('WARNING','CRITICAL')

Return devices with a matching serial number substring. contains(<property>, <value>)

filter=contains(deviceId,'WKQ82425HD')

Return devices that are not currently healthy. not <property> eq <value>

filter=not healthStatus eq 'OK'

Return devices that have both health and security issues. <property> eq <value> and <property> eq <value>

filter=healthStatus eq 'WARNING' and securityStatus eq 'RISK'
sortstring

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

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

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

Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}/devices' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
itemsArray of objects(device-v2beta1)read-onlyrequired
items[].​idstring(uuid)read-only

The unique identifier for the device.

Example: "0dc95df2-636e-4bde-ba4f-e9ec9127471b"
items[].​typestringread-only

The device resource type.

Value "compute-ops-mgmt/group/device"
items[].​namestringread-only

The device display name, commonly the hostname or serial number.

Example: "data-3"
items[].​groupIdstring(uuid)read-only

The ID of the group that the device is assigned to.

Example: "35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​groupUristring(uri-reference)read-only

The URI of the group that the device is assigned to.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​deviceIdstringread-only

The ID of the assigned device resource.

Example: "873357-P04+WKQ82425HD"
items[].​deviceUristring(uri-reference)read-only

The URI of the assigned device resource. The URI version may change over time.

Example: "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD"
items[].​deviceTypestringread-only

The type of the device.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
items[].​healthStatusstringread-only

The health status of the device.

Enum"OK""WARNING""CRITICAL"
items[].​securityStatusstringread-only

The security status of the device.

Enum"OK""IGNORED""RISK"
items[].​resourceUristring(uri-reference)read-only

The URI of this device resource.

Example: "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices/0dc95df2-636e-4bde-ba4f-e9ec9127471b"
items[].​generationintegerread-only

The resource update counter.

Example: 3
items[].​createdAtstring(date-time)read-only

The date and time when the device was assigned.

Example: "2026-01-22T23:09:41.875102Z"
items[].​updatedAtstring(date-time)read-only

The date and time when the device was updated.

Example: "2026-01-23T05:54:15.689856Z"
offsetinteger>= 0

Zero-based resource offset

totalinteger>= 0

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

Example: 12
nextstring or nullread-only
Any of:

The pagination cursor for the next page of resources.

stringread-only
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ], "next": "string" }

Get a device

Request

Get a device by group ID and device ID.

Security
Bearer
Path
group_idstring(uuid)required
device_idstring(uuid)required
Query
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}/devices/{device_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
idstring(uuid)read-only

The unique identifier for the device.

Example: "0dc95df2-636e-4bde-ba4f-e9ec9127471b"
typestringread-only

The device resource type.

Value "compute-ops-mgmt/group/device"
namestringread-only

The device display name, commonly the hostname or serial number.

Example: "data-3"
groupIdstring(uuid)read-only

The ID of the group that the device is assigned to.

Example: "35559e7c-b632-4b03-9fdd-1edea78a2d2c"
groupUristring(uri-reference)read-only

The URI of the group that the device is assigned to.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c"
deviceIdstringread-only

The ID of the assigned device resource.

Example: "873357-P04+WKQ82425HD"
deviceUristring(uri-reference)read-only

The URI of the assigned device resource. The URI version may change over time.

Example: "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD"
deviceTypestringread-only

The type of the device.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"
healthStatusstringread-only

The health status of the device.

Enum"OK""WARNING""CRITICAL"
securityStatusstringread-only

The security status of the device.

Enum"OK""IGNORED""RISK"
resourceUristring(uri-reference)read-only

The URI of this device resource.

Example: "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices/0dc95df2-636e-4bde-ba4f-e9ec9127471b"
generationintegerread-only

The resource update counter.

Example: 3
createdAtstring(date-time)read-only

The date and time when the device was assigned.

Example: "2026-01-22T23:09:41.875102Z"
updatedAtstring(date-time)read-only

The date and time when the device was updated.

Example: "2026-01-23T05:54:15.689856Z"
Response
application/json
{ "id": "0dc95df2-636e-4bde-ba4f-e9ec9127471b", "type": "compute-ops-mgmt/group/device", "name": "data-3", "groupId": "35559e7c-b632-4b03-9fdd-1edea78a2d2c", "groupUri": "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c", "deviceId": "873357-P04+WKQ82425HD", "deviceUri": "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD", "deviceType": "DIRECT_CONNECT_SERVER", "healthStatus": "OK", "securityStatus": "OK", "resourceUri": "/compute-ops-mgmt/v2beta1/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices/0dc95df2-636e-4bde-ba4f-e9ec9127471b", "generation": 3, "createdAt": "2026-01-22T23:09:41.875102Z", "updatedAt": "2026-01-23T05:54:15.689856Z" }

Assign device(s) to a group

Request

Assign device(s) to a group using an asynchronous operation. On a successful request this endpoint will return a 202 Accepted response with a Location header that contains the resource URI of the operation. That resource URI can then be used to monitor the asynchronous operation's status.

Security
Bearer
Path
group_idstring(uuid)required
Headers
Content-Typestringrequired

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

Value "application/json"
Bodyapplication/jsonrequired
itemsArray of objects[ 1 .. 1024 ] itemsrequired

A list of device assign/unassign requests.

items[].​deviceIdstringrequired

The ID of the assigned device resource.

Example: "873357-P04+WKQ82425HD"
curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}/assign-devices' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "deviceId": "873357-P04+WKQ82425HD"
      }
    ]
  }'

Responses

Successful response

Headers
Locationstring(uri-reference)required

The URI of the asynchronous operation to track.

Example: "/compute-ops-mgmt/v1/async-operations/3921751d-1949-11ef-a4f9-20155d97c234"
Response
No content

Unassign device(s) from a group

Request

Unassign device(s) from a group using an asynchronous operation. On a successful request this endpoint will return a 202 Accepted response with a Location header that contains the resource URI of the operation. That resource URI can then be used to monitor the asynchronous operation's status.

Security
Bearer
Path
group_idstring(uuid)required
Query
reset-subsystemsArray of strings

After the device is removed from its group, this option initiates a job to factory reset the specified Redfish subsystem(s). This option is only valid for DIRECT_CONNECT_SERVER devices and "BIOS" is the only supported subsystem.

Default []
Headers
Content-Typestringrequired

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

Value "application/json"
Bodyapplication/jsonrequired
itemsArray of objects[ 1 .. 1024 ] itemsrequired

A list of device assign/unassign requests.

items[].​deviceIdstringrequired

The ID of the assigned device resource.

Example: "873357-P04+WKQ82425HD"
curl -i -X POST \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}/unassign-devices' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "deviceId": "873357-P04+WKQ82425HD"
      }
    ]
  }'

Responses

Successful response

Headers
Locationstring(uri-reference)required

The URI of the asynchronous operation to track.

Example: "/compute-ops-mgmt/v1/async-operations/3921751d-1949-11ef-a4f9-20155d97c234"
Response
No content

List all device compliance across groups

Request

Get the paged collection of device compliance across all groups.

Security
Bearer
Query
nextstring(uuid)

The pagination cursor for the next page of resources.

Example: next=b4cf1a6f-1a1f-11ef-9856-20155d97c234
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.

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

Group compliance can be filtered by all properties except for type, generation, and URIs.

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

Examples:

Return compliance results for a specific settings category. <property> eq <value>

filter=category eq 'FIRMWARE'

Return compliance results for one of several settings categories. <property> in (<value>,<value>)

filter=category in ('FIRMWARE','ILO_SETTINGS')

Return compliance results for devices with a matching serial number substring. contains(<property>, <value>)

filter=contains(deviceId,'WKQ82425HD')

Return compliance results that are not already compliant. not <property> eq <value>

filter=not complianceStatus eq 'COMPLIANT'

Return firmware results with less than 70% match. <property> eq <value> and <property> lt <value>

filter=category eq 'FIRMWARE' and percentMatch lt 70
sortstring

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

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

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

Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/group-compliance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
itemsArray of objects(deviceCompliance-v2beta1)read-onlyrequired
items[].​idstring(uuid)read-only

The unique identifier for the device compliance.

Example: "f07b39e9-f01d-4778-bc13-c5aa5308d50d"
items[].​typestringread-only

The device compliance resource type.

Value "compute-ops-mgmt/group/compliance"
items[].​groupIdstring(uuid)read-only

The ID of the group that the device is assigned to.

Example: "35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​groupUristring(uri-reference)read-only

The URI of the group that the device is assigned to.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​deviceIdstringread-only

The ID of the assigned device that compliance was computed for.

Example: "873357-P04+WKQ82425HD"
items[].​deviceUristring(uri-reference)read-only

The URI of the assigned device resource. The URI version may change over time.

Example: "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD"
items[].​categorystringread-only

The settings category that compliance was computed for.

Enum"FIRMWARE""BIOS""ILO_SETTINGS"
items[].​complianceStatusstringread-only

The compliance status for the device and settings category.

Enum"COMPLIANT""NOT_COMPLIANT""NOT_APPLICABLE"
items[].​percentMatchintegerread-only

The percent match to the defined settings.

Example: 100
items[].​deviationsArray of objectsread-only

A list of deviations from the defined settings.

items[].​remediationobject or nullread-only
Any of:

Remediation instructions to reach compliance with the defined settings.

items[].​errorReasonstring or nullread-only
Any of:

The reason device compliance could not be computed.

stringread-only
items[].​resourceUristring(uri-reference)read-only

The URI of this compliance resource.

Example: "/compute-ops-mgmt/v2beta1/groups/c26e618b-4048-4aee-8e75-fbc984897a51/compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3"
items[].​generationintegerread-only

The resource update counter.

items[].​createdAtstring(date-time)read-only

The date and time when the device compliance was created.

items[].​updatedAtstring(date-time)read-only

The date and time when the device compliance was updated.

offsetinteger>= 0

Zero-based resource offset

totalinteger>= 0

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

Example: 12
nextstring or nullread-only
Any of:

The pagination cursor for the next page of resources.

stringread-only
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ], "next": "string" }

List all device compliance for a group

Request

Get the paged collection of device compliance for a group.

Security
Bearer
Path
group_idstring(uuid)required
Query
nextstring(uuid)

The pagination cursor for the next page of resources.

Example: next=b4cf1a6f-1a1f-11ef-9856-20155d97c234
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.

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

Group compliance can be filtered by all properties except for type, generation, and URIs.

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

Examples:

Return compliance results for a specific settings category. <property> eq <value>

filter=category eq 'FIRMWARE'

Return compliance results for one of several settings categories. <property> in (<value>,<value>)

filter=category in ('FIRMWARE','ILO_SETTINGS')

Return compliance results for devices with a matching serial number substring. contains(<property>, <value>)

filter=contains(deviceId,'WKQ82425HD')

Return compliance results that are not already compliant. not <property> eq <value>

filter=not complianceStatus eq 'COMPLIANT'

Return firmware results with less than 70% match. <property> eq <value> and <property> lt <value>

filter=category eq 'FIRMWARE' and percentMatch lt 70
sortstring

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

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

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

Examples:

Order resources ascending by name

sort=name asc

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}/compliance' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
itemsArray of objects(deviceCompliance-v2beta1)read-onlyrequired
items[].​idstring(uuid)read-only

The unique identifier for the device compliance.

Example: "f07b39e9-f01d-4778-bc13-c5aa5308d50d"
items[].​typestringread-only

The device compliance resource type.

Value "compute-ops-mgmt/group/compliance"
items[].​groupIdstring(uuid)read-only

The ID of the group that the device is assigned to.

Example: "35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​groupUristring(uri-reference)read-only

The URI of the group that the device is assigned to.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c"
items[].​deviceIdstringread-only

The ID of the assigned device that compliance was computed for.

Example: "873357-P04+WKQ82425HD"
items[].​deviceUristring(uri-reference)read-only

The URI of the assigned device resource. The URI version may change over time.

Example: "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD"
items[].​categorystringread-only

The settings category that compliance was computed for.

Enum"FIRMWARE""BIOS""ILO_SETTINGS"
items[].​complianceStatusstringread-only

The compliance status for the device and settings category.

Enum"COMPLIANT""NOT_COMPLIANT""NOT_APPLICABLE"
items[].​percentMatchintegerread-only

The percent match to the defined settings.

Example: 100
items[].​deviationsArray of objectsread-only

A list of deviations from the defined settings.

items[].​remediationobject or nullread-only
Any of:

Remediation instructions to reach compliance with the defined settings.

items[].​errorReasonstring or nullread-only
Any of:

The reason device compliance could not be computed.

stringread-only
items[].​resourceUristring(uri-reference)read-only

The URI of this compliance resource.

Example: "/compute-ops-mgmt/v2beta1/groups/c26e618b-4048-4aee-8e75-fbc984897a51/compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3"
items[].​generationintegerread-only

The resource update counter.

items[].​createdAtstring(date-time)read-only

The date and time when the device compliance was created.

items[].​updatedAtstring(date-time)read-only

The date and time when the device compliance was updated.

offsetinteger>= 0

Zero-based resource offset

totalinteger>= 0

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

Example: 12
nextstring or nullread-only
Any of:

The pagination cursor for the next page of resources.

stringread-only
Response
application/json
{ "offset": 0, "count": 1, "total": 12, "items": [ { … } ], "next": "string" }

Get device compliance

Request

Get a device compliance result by group ID and compliance ID.

Security
Bearer
Path
group_idstring(uuid)required
compliance_idstring(uuid)required
Query
selectstring

Limit the properties of the resource returned in a successful response. When applied to write operations, select controls only the properties that are returned, not which properties are operated on. All properties are returned if the select parameter is omitted.

The value of the select query parameter is a comma separated list of properties to include in the response. Nested properties use / as a separator, e.g. select=interfaces/name selects the name property within an interfaces object.

For operations that return paginated collections, select operates on the resources in the collection. The pagination properties like count and items are always included even when select is specified.

Examples:

Select only the id and name properties of the resource

select=id,name
curl -i -X GET \
  'https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v2beta1/groups/{group_id}/compliance/{compliance_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
idstring(uuid)read-only

The unique identifier for the device compliance.

Example: "f07b39e9-f01d-4778-bc13-c5aa5308d50d"
typestringread-only

The device compliance resource type.

Value "compute-ops-mgmt/group/compliance"
groupIdstring(uuid)read-only

The ID of the group that the device is assigned to.

Example: "35559e7c-b632-4b03-9fdd-1edea78a2d2c"
groupUristring(uri-reference)read-only

The URI of the group that the device is assigned to.

Example: "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c"
deviceIdstringread-only

The ID of the assigned device that compliance was computed for.

Example: "873357-P04+WKQ82425HD"
deviceUristring(uri-reference)read-only

The URI of the assigned device resource. The URI version may change over time.

Example: "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD"
categorystringread-only

The settings category that compliance was computed for.

Enum"FIRMWARE""BIOS""ILO_SETTINGS"
complianceStatusstringread-only

The compliance status for the device and settings category.

Enum"COMPLIANT""NOT_COMPLIANT""NOT_APPLICABLE"
percentMatchintegerread-only

The percent match to the defined settings.

Example: 100
deviationsArray of objectsread-only

A list of deviations from the defined settings.

remediationobject or nullread-only
Any of:

Remediation instructions to reach compliance with the defined settings.

errorReasonstring or nullread-only
Any of:

The reason device compliance could not be computed.

stringread-only
resourceUristring(uri-reference)read-only

The URI of this compliance resource.

Example: "/compute-ops-mgmt/v2beta1/groups/c26e618b-4048-4aee-8e75-fbc984897a51/compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3"
generationintegerread-only

The resource update counter.

createdAtstring(date-time)read-only

The date and time when the device compliance was created.

updatedAtstring(date-time)read-only

The date and time when the device compliance was updated.

Response
application/json
{ "id": "f07b39e9-f01d-4778-bc13-c5aa5308d50d", "type": "compute-ops-mgmt/group/compliance", "groupId": "35559e7c-b632-4b03-9fdd-1edea78a2d2c", "groupUri": "/compute-ops-mgmt/v2beta1/groups/35559e7c-b632-4b03-9fdd-1edea78a2d2c", "deviceId": "873357-P04+WKQ82425HD", "deviceUri": "/compute-ops-mgmt/v1/servers/873357-P04+WKQ82425HD", "category": "FIRMWARE", "complianceStatus": "COMPLIANT", "percentMatch": 100, "deviations": [ {} ], "remediation": {}, "errorReason": "string", "resourceUri": "/compute-ops-mgmt/v2beta1/groups/c26e618b-4048-4aee-8e75-fbc984897a51/compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3", "generation": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

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

metrics-collection-requests - v1beta1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-hardware-inventory-report - v1beta1

Operations

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

utilization-averages - v1beta1

Operations

webhooks - v1beta1

Operations