groups - v1beta2

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

async-operations - v1

Operations

async-operations - v1beta1

Operations

energy-over-time - v1beta1

Operations

energy-by-entity - v1beta1

Operations

external-services - v1beta1

Operations

filters - v1beta1

Operations

firmware-bundles - v1

Operations

firmware-bundles - v1beta2

Operations

groups - v1

Operations

groups - v1beta3

Operations

groups - v1beta2

Operations

List all groups

Request

Get the list of a user's groups.

Security

Bearer

Query

offsetinteger>= 0

Zero-based resource offset to start the response from

Default 0

Example: offset=10

limitinteger[ 0 .. 1000 ]

The maximum number of records to return.

Example: limit=10

filterstring

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS	EXAMPLES
Types	integer, decimal, timestamp, string, boolean, null
Operations	eq, ne, gt, ge, lt, le, in
Logic	and, or, not

Groups can be filtered by:

autoAddServerTags
autoFwUpdateOnAdd
createdAt
description
generation
groupComplianceStatus
id
name
platformFamily
serverPolicies
serverSettingsUris
updatedAt

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

Examples:

Filter with equality check

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

filter=name eq 'Production Group'

Filter with equality check on a nested attribute

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

filter=autoAddServerTags/Department eq 'Development - Texas'

Filter with url encoding applied to all reserved characters (example is fully URL encoded)

Return group where name == my+group

filter=name%20eq%20%27my%2Bgroup%27

Filter on an inverted query

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

filter=not autoAddServerTags/Department eq 'Development - Texas'

Filter that a property contains a value

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

filter=not name eq null

Filter that field value contains a specific substring

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

filter=contains(name,'Group')

Filter on multiple conditionals

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

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

Filter for a value to have one of multiple possibilities

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

filter=autoAddServerTags/Department in ('Development - Texas','Development - Colorado')

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:

ascending by name

Order resources ascending by name

sort=name asc

ascending by name and then by descending by createdAt

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

countinteger>= 0required

Number of items returned

Example: 1

offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired

items[].idstring(uuid)required

Primary identifier for the group given by the system

items[].typestringrequired

Type of the resource

Value "compute-ops/group"

items[].generationinteger>= 1required

Monotonically increasing update counter

items[].createdAtstring(date-time)required

Time of group creation

items[].updatedAtstring(date-time)required

Time of the last group update

items[].resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"

items[].namestring[ 1 .. 100 ] characters

Name for the group given by the user

Example: "Production Group"

items[].descriptionstring or null<= 10000 characters

Example: "All prod servers"

items[].autoFwUpdateOnAddboolean

Enabled automatic firmware updates to the configured baseline when a server is added to a group

items[].groupComplianceStatusstring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

items[].serverSettingsUrisArray of strings

URIs for group server settings

Default []

Example: ["/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"]

items[].platformFamilystring

Platform family of all servers in this group. There are no restrictions for groups and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in this group, regardless of the value passed in.

For management of OneView appliance groups, please use the v1beta3 API.

Default "ANY"

Enum"ANY""PROLIANT""OVE_APPLIANCE_SYNERGY"

Example: "ANY"

items[].devicesUristring

Example: "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"

items[].devicesArray of objects(deviceResponse-v1beta2)

Default []

items[].serverPoliciesobject

Stores policy settings for server group actions

items[].autoAddServerTagsobject or null

A case insensitive tag that can be associated with a group to automatically add servers to the group. A group can have a maximum of one tag and multiple groups can not have the same tag.

When a server is onboarded or has its tags changed, the server's tags will be checked against the group's autoAddServerTags. If at least one of the server tags matches one group's autoAddServerTags, the server will be placed into the associated group. Once a server has been connected, the server becomes ineligible for automatically being placed into groups, even if it is later disconnected.

If a server's tags match more than one group, it will not be put into any group.

If a server is in a group, any further tag changes will not move it to another group. If the server was added to a group but has been removed, is not in any group, and still has not been activated, changing the server tags will automatically assign it to the matching group.

Tags can contain any alphaneumeric characters, any Unicode space separators, and the following characters: _ . : = + - @. An example of one of these tags can be seen in the sample request on this page.

Example: {"Department":"Development - Texas"}

items[].groupMetanoSettingsMeta-v1beta2 (object) or settingsAppliedMeta-v1beta2 (object) or null

Any of:

items[].groupComplianceobject

Overall summary compliance state

totalinteger>= 0

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

Create a group

Request

Create a group for a specific user.

To create a OneView appliance group, please use the v1beta3 API.

Security

Bearer

Headers

Content-Typestringrequired

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

Value "application/json"

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Bodyapplication/jsonrequired

namestring[ 1 .. 100 ] charactersrequired

Example: "Production Group"

descriptionstring<= 10000 characters

Example: "All prod servers"

autoFwUpdateOnAddboolean

Enable automatic firmware updates to the configured baseline when a server is added to a group, This is equivalent to firmwareUpdate under serverPolicies. The value must be same if both are provided

Default false

platformFamilystring

Platform family of all servers in this group. There are no restrictions for groups and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in this group, regardless of the value passed in.

Default "ANY"

Enum"ANY""PROLIANT"

serverSettingsUrisArray of strings

URIs for group server settings

Default []

Example: ["/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"]

dataobject

Default {}

serverPoliciesobject

Stores policy settings for server group actions

autoAddServerTagsobject

A case insensitive tag that can be associated with a group to automatically add servers to the group. A group can have a maximum of one tag and multiple groups can not have the same tag.

When a server is onboarded or has its tags changed, the server's tags will be checked against the group's autoAddServerTags. If at least one of the server tags matches one group's autoAddServerTags, the server will be placed into the associated group. Once a server has been connected, the server becomes ineligible for automatically being placed into groups, even if it is later disconnected.

If a server's tags match more than one group, it will not be put into any group.

If a server is in a group, any further tag changes will not move it to another group. If the server was added to a group but has been removed, is not in any group, and still has not been activated, changing the server tags will automatically assign it to the matching group.

Tags can contain any alphaneumeric characters, any Unicode space separators, and the following characters: _ . : = + - @. An example of one of these tags can be seen in the sample request on this page.

Example: {"Department":"Development - Texas"}

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/v1beta2/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Production Group"
  }'

Responses

Successful Response

Headers

Locationstring(uri-reference)

Location for the group that was created

Example: "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"

Bodyapplication/json

idstring(uuid)required

Primary identifier for the group given by the system

typestringrequired

Type of the resource

Value "compute-ops/group"

generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of group creation

updatedAtstring(date-time)required

Time of the last group update

resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"

namestring[ 1 .. 100 ] characters

Name for the group given by the user

Example: "Production Group"

descriptionstring or null<= 10000 characters

Example: "All prod servers"

autoFwUpdateOnAddboolean

Enabled automatic firmware updates to the configured baseline when a server is added to a group

groupComplianceStatusstring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

serverSettingsUrisArray of strings

URIs for group server settings

Default []

Example: ["/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"]

platformFamilystring

Platform family of all servers in this group. There are no restrictions for groups and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in this group, regardless of the value passed in.

For management of OneView appliance groups, please use the v1beta3 API.

Default "ANY"

Enum"ANY""PROLIANT""OVE_APPLIANCE_SYNERGY"

Example: "ANY"

devicesUristring

Example: "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"

devicesArray of objects(deviceResponse-v1beta2)

Default []

serverPoliciesobject

Stores policy settings for server group actions

autoAddServerTagsobject or null

A case insensitive tag that can be associated with a group to automatically add servers to the group. A group can have a maximum of one tag and multiple groups can not have the same tag.

When a server is onboarded or has its tags changed, the server's tags will be checked against the group's autoAddServerTags. If at least one of the server tags matches one group's autoAddServerTags, the server will be placed into the associated group. Once a server has been connected, the server becomes ineligible for automatically being placed into groups, even if it is later disconnected.

If a server's tags match more than one group, it will not be put into any group.

If a server is in a group, any further tag changes will not move it to another group. If the server was added to a group but has been removed, is not in any group, and still has not been activated, changing the server tags will automatically assign it to the matching group.

Tags can contain any alphaneumeric characters, any Unicode space separators, and the following characters: _ . : = + - @. An example of one of these tags can be seen in the sample request on this page.

Example: {"Department":"Development - Texas"}

groupMetanoSettingsMeta-v1beta2 (object) or settingsAppliedMeta-v1beta2 (object) or null

Any of:

groupComplianceobject

Overall summary compliance state

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "compute-ops/group",
  "resourceUri": "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  "name": "Production Group",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "description": "All prod servers",
  "autoFwUpdateOnAdd": true,
  "groupComplianceStatus": "COMPLIANT",
  "serverSettingsUris": [
    "/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"
  ],
  "platformFamily": "ANY",
  "devicesUri": "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  "devices": [],
  "serverPolicies": {
    "onServerAdd": { … },
    "onSettingsApply": { … }
  },
  "autoAddServerTags": {
    "Department": "Development - Texas"
  },
  "groupMeta": {
    "noSettingsReason": "GROUP_HAS_NO_SETTINGS"
  },
  "groupCompliance": {
    "summary": "COMPLIANT",
    "firmware": { … },
    "iloSettings": { … }
  }
}

Get a group by ID

Request

Get a specific group by group id.

Security

Bearer

Path

group-idstring(uuid)required

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups/{group-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)required

Primary identifier for the group given by the system

typestringrequired

Type of the resource

Value "compute-ops/group"

generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of group creation

updatedAtstring(date-time)required

Time of the last group update

resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"

namestring[ 1 .. 100 ] characters

Name for the group given by the user

Example: "Production Group"

descriptionstring or null<= 10000 characters

Example: "All prod servers"

autoFwUpdateOnAddboolean

Enabled automatic firmware updates to the configured baseline when a server is added to a group

groupComplianceStatusstring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

serverSettingsUrisArray of strings

URIs for group server settings

Default []

Example: ["/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"]

platformFamilystring

Platform family of all servers in this group. There are no restrictions for groups and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in this group, regardless of the value passed in.

For management of OneView appliance groups, please use the v1beta3 API.

Default "ANY"

Enum"ANY""PROLIANT""OVE_APPLIANCE_SYNERGY"

Example: "ANY"

devicesUristring

Example: "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"

devicesArray of objects(deviceResponse-v1beta2)

Default []

serverPoliciesobject

Stores policy settings for server group actions

autoAddServerTagsobject or null

A case insensitive tag that can be associated with a group to automatically add servers to the group. A group can have a maximum of one tag and multiple groups can not have the same tag.

When a server is onboarded or has its tags changed, the server's tags will be checked against the group's autoAddServerTags. If at least one of the server tags matches one group's autoAddServerTags, the server will be placed into the associated group. Once a server has been connected, the server becomes ineligible for automatically being placed into groups, even if it is later disconnected.

If a server's tags match more than one group, it will not be put into any group.

If a server is in a group, any further tag changes will not move it to another group. If the server was added to a group but has been removed, is not in any group, and still has not been activated, changing the server tags will automatically assign it to the matching group.

Tags can contain any alphaneumeric characters, any Unicode space separators, and the following characters: _ . : = + - @. An example of one of these tags can be seen in the sample request on this page.

Example: {"Department":"Development - Texas"}

groupMetanoSettingsMeta-v1beta2 (object) or settingsAppliedMeta-v1beta2 (object) or null

Any of:

groupComplianceobject

Overall summary compliance state

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "compute-ops/group",
  "resourceUri": "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  "name": "Production Group",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "description": "All prod servers",
  "autoFwUpdateOnAdd": true,
  "groupComplianceStatus": "COMPLIANT",
  "serverSettingsUris": [
    "/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"
  ],
  "platformFamily": "ANY",
  "devicesUri": "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  "devices": [],
  "serverPolicies": {
    "onServerAdd": { … },
    "onSettingsApply": { … }
  },
  "autoAddServerTags": {
    "Department": "Development - Texas"
  },
  "groupMeta": {
    "noSettingsReason": "GROUP_HAS_NO_SETTINGS"
  },
  "groupCompliance": {
    "summary": "COMPLIANT",
    "firmware": { … },
    "iloSettings": { … }
  }
}

Delete a group

Request

Delete a group.

Security

Bearer

Path

group-idstring(uuid)required

Query

forceboolean

Default false

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups/{group-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response

No content

Patch a group

Request

Partially update a group.

Security

Bearer

Path

group-idstring(uuid)required

Headers

Content-Typestringrequired

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

Value "application/merge-patch+json"

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Bodyapplication/merge-patch+jsonrequired

namestring[ 1 .. 100 ] characters

Example: "Production Group"

descriptionstring<= 10000 characters

Example: "All prod servers"

serverSettingsUrisArray of strings(Serversettingsuris)

URIs for group server settings

Default []

Example: ["/api/compute/v1/server-settings/00000000-0000-0000-0000-800000000001"]

autoFwUpdateOnAddboolean

Enable automatic firmware updates to the configured baseline when a server is added to a group, This is equivalent to firmwareUpdate under serverPolicies. The value must be same if both are provided

Default false

serverPoliciesobject

Stores policy settings for server group actions

autoAddServerTagsobject

A case insensitive tag that can be associated with a group to automatically add servers to the group. A group can have a maximum of one tag and multiple groups can not have the same tag.

When a server is onboarded or has its tags changed, the server's tags will be checked against the group's autoAddServerTags. If at least one of the server tags matches one group's autoAddServerTags, the server will be placed into the associated group. Once a server has been connected, the server becomes ineligible for automatically being placed into groups, even if it is later disconnected.

If a server's tags match more than one group, it will not be put into any group.

If a server is in a group, any further tag changes will not move it to another group. If the server was added to a group but has been removed, is not in any group, and still has not been activated, changing the server tags will automatically assign it to the matching group.

Tags can contain any alphaneumeric characters, any Unicode space separators, and the following characters: _ . : = + - @. An example of one of these tags can be seen in the sample request on this page.

Example: {"Department":"Development - Texas"}

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/v1beta2/groups/{group-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)required

Primary identifier for the group given by the system

typestringrequired

Type of the resource

Value "compute-ops/group"

generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of group creation

updatedAtstring(date-time)required

Time of the last group update

resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d"

namestring[ 1 .. 100 ] characters

Name for the group given by the user

Example: "Production Group"

descriptionstring or null<= 10000 characters

Example: "All prod servers"

autoFwUpdateOnAddboolean

Enabled automatic firmware updates to the configured baseline when a server is added to a group

groupComplianceStatusstring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

serverSettingsUrisArray of strings

URIs for group server settings

Default []

Example: ["/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"]

platformFamilystring

Platform family of all servers in this group. There are no restrictions for groups and all supported server types are allowed. This optional attribute will be set to a default value of "ANY", to indicate that any server platform family can be in this group, regardless of the value passed in.

For management of OneView appliance groups, please use the v1beta3 API.

Default "ANY"

Enum"ANY""PROLIANT""OVE_APPLIANCE_SYNERGY"

Example: "ANY"

devicesUristring

Example: "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices"

devicesArray of objects(deviceResponse-v1beta2)

Default []

serverPoliciesobject

Stores policy settings for server group actions

autoAddServerTagsobject or null

A case insensitive tag that can be associated with a group to automatically add servers to the group. A group can have a maximum of one tag and multiple groups can not have the same tag.

When a server is onboarded or has its tags changed, the server's tags will be checked against the group's autoAddServerTags. If at least one of the server tags matches one group's autoAddServerTags, the server will be placed into the associated group. Once a server has been connected, the server becomes ineligible for automatically being placed into groups, even if it is later disconnected.

If a server's tags match more than one group, it will not be put into any group.

If a server is in a group, any further tag changes will not move it to another group. If the server was added to a group but has been removed, is not in any group, and still has not been activated, changing the server tags will automatically assign it to the matching group.

Tags can contain any alphaneumeric characters, any Unicode space separators, and the following characters: _ . : = + - @. An example of one of these tags can be seen in the sample request on this page.

Example: {"Department":"Development - Texas"}

groupMetanoSettingsMeta-v1beta2 (object) or settingsAppliedMeta-v1beta2 (object) or null

Any of:

groupComplianceobject

Overall summary compliance state

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "compute-ops/group",
  "resourceUri": "/compute-ops/v1beta2/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  "name": "Production Group",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "description": "All prod servers",
  "autoFwUpdateOnAdd": true,
  "groupComplianceStatus": "COMPLIANT",
  "serverSettingsUris": [
    "/compute-ops/v1beta1/server-settings/00000000-0000-0000-0000-800000000001"
  ],
  "platformFamily": "ANY",
  "devicesUri": "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  "devices": [],
  "serverPolicies": {
    "onServerAdd": { … },
    "onSettingsApply": { … }
  },
  "autoAddServerTags": {
    "Department": "Development - Texas"
  },
  "groupMeta": {
    "noSettingsReason": "GROUP_HAS_NO_SETTINGS"
  },
  "groupCompliance": {
    "summary": "COMPLIANT",
    "firmware": { … },
    "iloSettings": { … }
  }
}

List all devices compliance in a group

Request

List all the device's compliance detail

Security

Bearer

Path

group-idstring(uuid)required

Query

filterstring

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS	EXAMPLES
Types	integer, decimal, timestamp, string, boolean, null
Operations	eq, ne, gt, ge, lt, le, in
Logic	and, or, not

Groups can be filtered by:

autoAddServerTags
autoFwUpdateOnAdd
createdAt
description
generation
groupComplianceStatus
id
name
platformFamily
serverPolicies
serverSettingsUris
updatedAt

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

Examples:

Filter with equality check

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

filter=name eq 'Production Group'

Filter with equality check on a nested attribute

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

filter=autoAddServerTags/Department eq 'Development - Texas'

Filter with url encoding applied to all reserved characters (example is fully URL encoded)

Return group where name == my+group

filter=name%20eq%20%27my%2Bgroup%27

Filter on an inverted query

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

filter=not autoAddServerTags/Department eq 'Development - Texas'

Filter that a property contains a value

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

filter=not name eq null

Filter that field value contains a specific substring

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

filter=contains(name,'Group')

Filter on multiple conditionals

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

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

Filter for a value to have one of multiple possibilities

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

filter=autoAddServerTags/Department in ('Development - Texas','Development - Colorado')

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups/{group-id}/compliance' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

countinteger>= 0required

Number of items returned

Example: 1

offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired

items[].idstring(uuid)required

Primary identifier for the compliance given by the system

items[].typestringrequired

Type of the resource

Value "compute-ops/group/compliance"

items[].generationinteger>= 1required

Monotonically increasing update counter

items[].createdAtstring(date-time)required

Time of compliance entry creation

items[].updatedAtstring(date-time)required

This refers to when the firmware compliance was checked.

items[].resourceUristring(uri-reference)

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

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

items[].groupIdstring(uuid)

items[].serialstring

items[].productIdstring

items[].serverIdstring

items[].complianceStatusstring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

items[].deviationsArray of objects(deviceDeviation-v1beta2)

items[].errorReasonstring

It will have the reason for why the compliance state is UNKNOWN. for other compliance states it will be empty string.

items[].complianceCategoryany

This refers to the Compliance Category

Value "FIRMWARE"

totalinteger>= 0

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

Example: 12

startinteger>= 0

Zero-based resource offset, alias of offset

Response

application/json

{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ],
  "start": 0
}

Get a device compliance by compliance Id

Request

Get a specific device compliance detail of the group by passing group id and compliance id.

Security

Bearer

Path

group-idstring(uuid)required

compliance-idstring(uuid)required

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups/{group-id}/compliance/{compliance-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)required

Primary identifier for the compliance given by the system

typestringrequired

Type of the resource

Value "compute-ops/group/compliance"

generationinteger>= 1required

Monotonically increasing update counter

createdAtstring(date-time)required

Time of compliance entry creation

updatedAtstring(date-time)required

This refers to when the firmware compliance was checked.

resourceUristring(uri-reference)

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

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

groupIdstring(uuid)

serialstring

productIdstring

serverIdstring

complianceStatusstring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

deviationsArray of objects(deviceDeviation-v1beta2)

errorReasonstring

It will have the reason for why the compliance state is UNKNOWN. for other compliance states it will be empty string.

complianceCategoryany

This refers to the Compliance Category

Value "FIRMWARE"

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "compute-ops/group/compliance",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "resourceUri": "/compute-ops/v1beta2/groups/c26e618b-4048-4aee-8e75-fbc984897a51/compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3",
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "serial": "string",
  "productId": "string",
  "serverId": "string",
  "complianceStatus": "COMPLIANT",
  "deviations": [
    { … }
  ],
  "errorReason": "string",
  "complianceCategory": "FIRMWARE"
}

List all devices in a group

Request

List all devices in a group

Security

Bearer

Path

group-idstring(uuid)required

Query

filterstring

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS	EXAMPLES
Types	integer, decimal, timestamp, string, boolean, null
Operations	eq, ne, gt, ge, lt, le, in
Logic	and, or, not

Groups can be filtered by:

autoAddServerTags
autoFwUpdateOnAdd
createdAt
description
generation
groupComplianceStatus
id
name
platformFamily
serverPolicies
serverSettingsUris
updatedAt

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

Examples:

Filter with equality check

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

filter=name eq 'Production Group'

Filter with equality check on a nested attribute

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

filter=autoAddServerTags/Department eq 'Development - Texas'

Filter with url encoding applied to all reserved characters (example is fully URL encoded)

Return group where name == my+group

filter=name%20eq%20%27my%2Bgroup%27

Filter on an inverted query

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

filter=not autoAddServerTags/Department eq 'Development - Texas'

Filter that a property contains a value

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

filter=not name eq null

Filter that field value contains a specific substring

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

filter=contains(name,'Group')

Filter on multiple conditionals

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

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

Filter for a value to have one of multiple possibilities

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

filter=autoAddServerTags/Department in ('Development - Texas','Development - Colorado')

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups/{group-id}/devices' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

countinteger>= 0required

Number of items returned

Example: 1

offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired

items[].idstringrequired

Primary identifier for the device given by the system

items[].typestringrequired

Type of the resource

Value "compute-ops/group/device"

items[].resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices/873357-P04+WKQ82425HD"

items[].serialstring

items[].productIdstring

items[].eTagstring

items[].serverIdstring

items[].serverUristring

Example: "/api/compute/v1/servers/873357-P04+WKQ82425HD"

items[].statestring(deviceState)

An enumeration.

Enum"ASSIGNED""FAILED""ACTIVE"

items[].groupIdstring(uuid)

items[].subscriptionStatestring(subscriptionState)

Subscription state.

Enum"REQUIRED""SUBSCRIBED""EXPIRED"

items[].subscriptionTierstring(subscriptionTier)

Subscription tier.

Value"ENHANCED"

totalinteger>= 0

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

Assign a device to a group

Request

Assign a device to a group

Security

Bearer

Path

group-idstring(uuid)required

Query

dry-runboolean

When set to false, servers will be assigned or moved to the group specified by group-id barring any errors.

When set to true, servers will not be assigned or moved to the specified group. This dry-run request will return useful information about the servers involved in the request, such as the latest eTags.

Default false

Headers

Content-Typestringrequired

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

Value "application/json"

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Bodyapplication/jsonrequired

devicesArray of objects(deviceRequest-v1beta2)non-emptyrequired

devices[].serialstring

devices[].productIdstring

devices[].eTagstring

This property is required when a server is moved from one group to another. It is optional (and can be omitted) for all other requests.

When moving a server from one group to another, the latest eTag for that server must be specified. To find the latest eTag(s) associated with one or more servers, send this request specifying those servers and set the query parameter dry-run to true. A server's eTag will change as it moves between groups, so it is essential to use the latest eTag to avoid any errors when moving a server.

In the rare case that a request is made to assign a server to the group it is already in, the eTag check will not be performed. In other words, the device's assignment will have zero effect because the desired outcome has already been achieved.

devices[].serverIdstring

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/v1beta2/groups/{group-id}/devices' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "devices": [
      {}
    ]
  }'

Responses

Successful Response

Bodyapplication/json

devicesArray of objects(deviceResponse-v1beta2)non-emptyrequired

devices[].idstringrequired

Primary identifier for the device given by the system

devices[].typestringrequired

Type of the resource

Value "compute-ops/group/device"

devices[].resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices/873357-P04+WKQ82425HD"

devices[].serialstring

devices[].productIdstring

devices[].eTagstring

devices[].serverIdstring

devices[].serverUristring

Example: "/api/compute/v1/servers/873357-P04+WKQ82425HD"

devices[].statestring(deviceState)

An enumeration.

Enum"ASSIGNED""FAILED""ACTIVE"

devices[].groupIdstring(uuid)

devices[].subscriptionStatestring(subscriptionState)

Subscription state.

Enum"REQUIRED""SUBSCRIBED""EXPIRED"

devices[].subscriptionTierstring(subscriptionTier)

Subscription tier.

Value"ENHANCED"

Response

application/json

{
  "devices": [
    { … }
  ]
}

Bulk unassign devices from a group

Request

Bulk unassign devices from a group

Security

Bearer

Path

group-idstring(uuid)required

Query

idArray of strings

Default []

forceboolean

Default false

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 servers and "BIOS" is the only supported subsystem.

Default []

filterstring

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS	EXAMPLES
Types	integer, decimal, timestamp, string, boolean, null
Operations	eq, ne, gt, ge, lt, le, in
Logic	and, or, not

Groups can be filtered by:

autoAddServerTags
autoFwUpdateOnAdd
createdAt
description
generation
groupComplianceStatus
id
name
platformFamily
serverPolicies
serverSettingsUris
updatedAt

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

Examples:

Filter with equality check

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

filter=name eq 'Production Group'

Filter with equality check on a nested attribute

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

filter=autoAddServerTags/Department eq 'Development - Texas'

Filter with url encoding applied to all reserved characters (example is fully URL encoded)

Return group where name == my+group

filter=name%20eq%20%27my%2Bgroup%27

Filter on an inverted query

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

filter=not autoAddServerTags/Department eq 'Development - Texas'

Filter that a property contains a value

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

filter=not name eq null

Filter that field value contains a specific substring

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

filter=contains(name,'Group')

Filter on multiple conditionals

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

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

Filter for a value to have one of multiple possibilities

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

filter=autoAddServerTags/Department in ('Development - Texas','Development - Colorado')

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

Responses

Successful Response

Response

No content

Unassign a device from a group

Request

Unassign a device from a group

Security

Bearer

Path

group-idstring(uuid)required

device-idstringrequired

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 servers and "BIOS" is the only supported subsystem.

Default []

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 DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups/{group-id}/devices/{device-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response

No content

Get external storage compliance

Request

List all the external storage's compliance detail

Security

Bearer

Path

group-idstring(uuid)required

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops/v1beta2/groups/{group-id}/external-storage-compliance' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success (Group's external storage compliance)

Bodyapplication/json

groupIdstring(uuid)

The group id of the external storage

createdAtstring(date-time)

Time of compliance entry creation

updatedAtstring(date-time)

This refers to when the compliance was checked.

generationinteger>= 1

Monotonically increasing update counter

hostOsstring(externalStorageHostOS)

The host OS of the external storage

Enum"UNKNOWN""AIX""APPLE"

complianceStatestring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

deviationsobject

The deviations from the compliance check

Response

application/json

{
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "generation": 1,
  "hostOs": "UNKNOWN",
  "complianceState": "COMPLIANT",
  "deviations": {
    "mismatchOperatingSystem": [ … ],
    "missingInitiators": [ … ],
    "extraInitiator": [ … ],
    "missingHostsFromHostGroup": [ … ],
    "extraHostsInHostGroup": [ … ],
    "initiatorsWithMultipleHosts": [ … ],
    "missingHostGroups": [ … ],
    "hostGroupsNotCreated": [ … ],
    "noInitiators": [ … ],
    "preExistingHostNames": [ … ]
  }
}

Get iLO Settings compliance

Request

List all the iLO Settings compliance detail

Security

Bearer

Path

group-idstring(uuid)required

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/v1beta2/groups/{group-id}/ilo-settings-compliance' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success (Group's iLO Settings compliance)

Bodyapplication/json

countinteger>= 0required

Number of items returned

Example: 1

offsetinteger>= 0required

Zero-based resource offset

itemsArray of objectsrequired

items[].idstring(uuid)

Primary identifier for the compliance given by the system

items[].typestring

Type of the resource

Value "compute-ops/group/ilo-settings-compliance"

items[].generationinteger>= 1

Monotonically increasing update counter

items[].createdAtstring(date-time)

Time of compliance entry creation

items[].updatedAtstring(date-time)

This refers to when the firmware compliance was checked.

items[].resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/eb54e96e-21b8-4f54-9cd4-80fccbd06f55/ilo-settings-compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3"

items[].serialstring

items[].productIdstring

items[].serverIdstring

items[].deviationsArray of objects(iLOSettingsdeviceDeviation-v1beta2)

items[].complianceStatestring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

items[].remediationobject

Specifies remediation actions for the device

items[].complianceCategoryany

This refers to the Compliance Category

Value "ILO_SETTINGS"

items[].groupIdstring(uuid)

The group id of the ilo settings

items[].serverUristring(uri-reference)

Server URI

Example: "/compute-ops/v1beta2/servers/975017-V69+8899975017569500"

items[].errorReasonstring

It will have the reason for why the compliance state is UNKNOWN. for other compliance states it will be empty string.

totalinteger>= 0

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

Example: 12

startinteger>= 0

Zero-based resource offset, alias of offset

Response

application/json

{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ],
  "start": 0
}

Get a device iLO Settings compliance by iLO Settings compliance Id

Request

Get a specific device compliance detail of the group by passing group id and iLO Settings compliance id.

Security

Bearer

Path

group-idstring(uuid)required

ilo-settings-compliance-idstring(uuid)required

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/v1beta2/groups/{group-id}/ilo-settings-compliance/{ilo-settings-compliance-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

idstring(uuid)

Primary identifier for the compliance given by the system

typestring

Type of the resource

Value "compute-ops/group/ilo-settings-compliance"

generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of compliance entry creation

updatedAtstring(date-time)

This refers to when the firmware compliance was checked.

resourceUristring(uri-reference)

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

Example: "/compute-ops/v1beta2/groups/eb54e96e-21b8-4f54-9cd4-80fccbd06f55/ilo-settings-compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3"

serialstring

productIdstring

serverIdstring

deviationsArray of objects(iLOSettingsdeviceDeviation-v1beta2)

complianceStatestring(complianceState)

This state defines the compliance status of a device. If all devices in a group are COMPLIANT, the group state will be compliant. If a group contains devices that are COMPLIANT or UNKNOWN, the UNKNOWN state overrides the COMPLIANT state and the group state will be UNKNOWN. If a group contains devices that are NOT_COMPLIANT, COMPLIANT, or UNKNOWN the NOT_COMPLIANT state will override the COMPLIANT and UNKNOWN states, so the group state will be NOT_COMPLIANT. Finally, the NOT_APPLICABLE state overrides all others so if a device in a group is NOT_APPLICABLE or if the group has no devices, the group state will be NOT_APPLICABLE.

Enum"COMPLIANT""NOT_COMPLIANT""UNKNOWN"

remediationobject

Specifies remediation actions for the device

complianceCategoryany

This refers to the Compliance Category

Value "ILO_SETTINGS"

groupIdstring(uuid)

The group id of the ilo settings

serverUristring(uri-reference)

Server URI

Example: "/compute-ops/v1beta2/servers/975017-V69+8899975017569500"

errorReasonstring

It will have the reason for why the compliance state is UNKNOWN. for other compliance states it will be empty string.

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "compute-ops/group/ilo-settings-compliance",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "resourceUri": "/compute-ops/v1beta2/groups/eb54e96e-21b8-4f54-9cd4-80fccbd06f55/ilo-settings-compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3",
  "serial": "string",
  "productId": "string",
  "serverId": "string",
  "deviations": [
    { … }
  ],
  "complianceState": "COMPLIANT",
  "remediation": {},
  "complianceCategory": "ILO_SETTINGS",
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "serverUri": "/compute-ops/v1beta2/servers/975017-V69+8899975017569500",
  "errorReason": "string"
}

job-templates - v1beta2

Operations

jobs - v1

Operations

jobs - v1beta3

Operations

jobs - v1beta2

Operations

metrics-configurations - v1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations

HPE Compute Ops Management API (latest)

UPDATED API ENDPOINTS

accounts - v1beta1

activation-keys - v1beta1

activation-tokens - v1beta1

activities - v1beta2

ahs-files - v1beta1

appliance-firmware-bundles - v1

appliance-firmware-bundles - v1beta1

async-operations - v1

async-operations - v1beta1

energy-over-time - v1beta1

energy-by-entity - v1beta1

external-services - v1beta1

filters - v1beta1

firmware-bundles - v1

firmware-bundles - v1beta2

groups - v1

groups - v1beta3

groups - v1beta2

List all groups

Request

Responses

Was this helpful?

Create a group

RequestExpand all

Responses

Was this helpful?

Get a group by ID

Request

Responses

Was this helpful?

Delete a group

Request

Responses

Was this helpful?

Patch a group

RequestExpand all

Responses

Was this helpful?

List all devices compliance in a group

Request

Responses

Was this helpful?

Get a device compliance by compliance Id

Request

Responses

Was this helpful?

List all devices in a group

Request

Responses

Was this helpful?

Assign a device to a group

RequestExpand all

Responses

Was this helpful?

Bulk unassign devices from a group

Request

Responses

Was this helpful?

Unassign a device from a group

Request

Responses

Was this helpful?

Get external storage compliance

Request

Responses

Was this helpful?

Get iLO Settings compliance

Request

Responses

Was this helpful?

Get a device iLO Settings compliance by iLO Settings compliance Id

Request

Responses

Was this helpful?

job-templates - v1beta2

jobs - v1

jobs - v1beta3

jobs - v1beta2

Request

Request

Request