groups - v1beta3

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

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. Device 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:

autoAddTags
description
generation
complianceStatus
id
name
deviceType
policies
settingsUris
securityStatus
createdAt
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=autoAddTags/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 autoAddTags/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=autoAddTags/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-mgmt/v1beta3/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[].deviceTypestring(deviceType)

Device type of all devices in the group.

DIRECT_CONNECT_SERVER - servers
OVE_APPLIANCE_SYNERGY - OneView Synergy appliances
OVE_APPLIANCE_VM - OneView VM appliances

Note: Depending on the deviceType the response payload will change. Selecting the dropdown to change the deviceType will change the response details.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"

Discriminator

items[].idstring(uuid)

Primary identifier for the group supplied by the system

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

Unique name for the group as supplied by the user

Example: "Production Group"

items[].typestringread-only

The type of the resource.

Value "compute-mgmt-ops/group"

items[].descriptionstring or null<= 10000 characters

Example: "All prod servers"

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[].settingsUrisArray of strings

URIs for group settings

Default []

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

items[].devicesUristring

URI for devices that belong to the group

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

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

List of devices that belong to the group

Default []

items[].policiesobject(groupServerPolicies-v1beta3)

Store policy settings for server group actions.

items[].autoAddTagsobject 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[].securityStatusstring(securityState)

Indicates the group security status

Enum"RISK""OK""IGNORED"

items[].groupComplianceobject(groupCompliance-v1beta3)

Compliance status and status reason for device in the group.

items[].resourceUristring(uri-reference)

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

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

items[].generationinteger>= 1

Monotonically increasing update counter

items[].createdAtstring(date-time)

Time of group creation

items[].updatedAtstring(date-time)

Time of the last group update

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.

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"

deviceTypestring(deviceType)required

Device type of all devices in the group.

DIRECT_CONNECT_SERVER - servers
OVE_APPLIANCE_SYNERGY - OneView Synergy appliances
OVE_APPLIANCE_VM - OneView VM appliances

Note: Depending on the deviceType the response payload will change. Selecting the dropdown to change the deviceType will change the response details.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"

Discriminator

descriptionstring<= 10000 characters

Example: "All prod servers"

settingsUrisArray of strings

URIs for group device settings

Default []

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

policiesobject(groupServerPolicies-v1beta3)

Store policy settings for server group actions.

autoAddTagsobject

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 can not have the same tag.

When a device is onboarded or has its tags changed, the devices's tags will be checked against the group's autoAddTags. If at least one of the device tags matches one group's autoAddTags, the device will be 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 put into any group.

If a devices 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 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-mgmt/v1beta3/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Production Group",
    "deviceType": "DIRECT_CONNECT_SERVER"
  }'

Responses

Successful Response

Headers

Locationstring(uri-reference)

Location for the group that was created

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

Bodyapplication/json

deviceTypestring(deviceType)

Device type of all devices in the group.

DIRECT_CONNECT_SERVER - servers
OVE_APPLIANCE_SYNERGY - OneView Synergy appliances
OVE_APPLIANCE_VM - OneView VM appliances

Note: Depending on the deviceType the response payload will change. Selecting the dropdown to change the deviceType will change the response details.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"

Discriminator

idstring(uuid)

Primary identifier for the group supplied by the system

namestring[ 1 .. 100 ] characters

Unique name for the group as supplied by the user

Example: "Production Group"

typestringread-only

The type of the resource.

Value "compute-mgmt-ops/group"

descriptionstring or null<= 10000 characters

Example: "All prod servers"

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"

settingsUrisArray of strings

URIs for group settings

Default []

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

devicesUristring

URI for devices that belong to the group

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

devicesArray of objects(deviceResponse-v1beta3)

List of devices that belong to the group

Default []

policiesobject(groupServerPolicies-v1beta3)

Store policy settings for server group actions.

autoAddTagsobject 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"}

securityStatusstring(securityState)

Indicates the group security status

Enum"RISK""OK""IGNORED"

groupComplianceobject(groupCompliance-v1beta3)

Compliance status and status reason for device in the group.

resourceUristring(uri-reference)

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

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

generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of group creation

updatedAtstring(date-time)

Time of the last group update

Response

application/json

{
  "deviceType": "DIRECT_CONNECT_SERVER",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Production Group",
  "type": "compute-mgmt-ops/group",
  "description": "All prod servers",
  "complianceStatus": "COMPLIANT",
  "settingsUris": [
    "/compute-ops-mgmt/v1beta1/settings/00000000-0000-0000-0000-800000000001"
  ],
  "devicesUri": "/compute-ops-mgmt/v1beta3/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  "devices": [],
  "policies": {
    "onDeviceAdd": { … },
    "onDeviceApply": { … }
  },
  "autoAddTags": {
    "Department": "Development - Texas"
  },
  "securityStatus": "RISK",
  "groupCompliance": {
    "summary": "Not Compliant",
    "firmware": { … },
    "iloSettings": { … }
  },
  "resourceUri": "/compute-ops-mgmt/v1beta3/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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-mgmt/v1beta3/groups/{group-id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

deviceTypestring(deviceType)

Device type of all devices in the group.

DIRECT_CONNECT_SERVER - servers
OVE_APPLIANCE_SYNERGY - OneView Synergy appliances
OVE_APPLIANCE_VM - OneView VM appliances

Note: Depending on the deviceType the response payload will change. Selecting the dropdown to change the deviceType will change the response details.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"

Discriminator

idstring(uuid)

Primary identifier for the group supplied by the system

namestring[ 1 .. 100 ] characters

Unique name for the group as supplied by the user

Example: "Production Group"

typestringread-only

The type of the resource.

Value "compute-mgmt-ops/group"

descriptionstring or null<= 10000 characters

Example: "All prod servers"

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"

settingsUrisArray of strings

URIs for group settings

Default []

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

devicesUristring

URI for devices that belong to the group

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

devicesArray of objects(deviceResponse-v1beta3)

List of devices that belong to the group

Default []

policiesobject(groupServerPolicies-v1beta3)

Store policy settings for server group actions.

autoAddTagsobject 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"}

securityStatusstring(securityState)

Indicates the group security status

Enum"RISK""OK""IGNORED"

groupComplianceobject(groupCompliance-v1beta3)

Compliance status and status reason for device in the group.

resourceUristring(uri-reference)

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

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

generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of group creation

updatedAtstring(date-time)

Time of the last group update

Response

application/json

{
  "deviceType": "DIRECT_CONNECT_SERVER",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Production Group",
  "type": "compute-mgmt-ops/group",
  "description": "All prod servers",
  "complianceStatus": "COMPLIANT",
  "settingsUris": [
    "/compute-ops-mgmt/v1beta1/settings/00000000-0000-0000-0000-800000000001"
  ],
  "devicesUri": "/compute-ops-mgmt/v1beta3/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  "devices": [],
  "policies": {
    "onDeviceAdd": { … },
    "onDeviceApply": { … }
  },
  "autoAddTags": {
    "Department": "Development - Texas"
  },
  "securityStatus": "RISK",
  "groupCompliance": {
    "summary": "Not Compliant",
    "firmware": { … },
    "iloSettings": { … }
  },
  "resourceUri": "/compute-ops-mgmt/v1beta3/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a group

Request

Delete a group.

Security

Bearer

Path

group-idstring(uuid)required

Query

forceboolean

If you would like to remove all devices and delete the group, provide the query parameter force=true.

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-mgmt/v1beta3/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"

settingsUrisArray of strings

URIs for group device settings

Default []

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

policiesServer Policies (object) or OneView Appliance Policies (object) or null(groupPolicies-v1beta3)

One of:

Store policy settings for server group actions.

autoAddTagsobject

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 can not have the same tag.

When a device is onboarded or has its tags changed, the devices's tags will be checked against the group's autoAddTags. If at least one of the device tags matches one group's autoAddTags, the device will be 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 put into any group.

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

Responses

Successful Response

Bodyapplication/json

deviceTypestring(deviceType)

Device type of all devices in the group.

DIRECT_CONNECT_SERVER - servers
OVE_APPLIANCE_SYNERGY - OneView Synergy appliances
OVE_APPLIANCE_VM - OneView VM appliances

Note: Depending on the deviceType the response payload will change. Selecting the dropdown to change the deviceType will change the response details.

Enum"DIRECT_CONNECT_SERVER""OVE_APPLIANCE_SYNERGY""OVE_APPLIANCE_VM"

Discriminator

idstring(uuid)

Primary identifier for the group supplied by the system

namestring[ 1 .. 100 ] characters

Unique name for the group as supplied by the user

Example: "Production Group"

typestringread-only

The type of the resource.

Value "compute-mgmt-ops/group"

descriptionstring or null<= 10000 characters

Example: "All prod servers"

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"

settingsUrisArray of strings

URIs for group settings

Default []

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

devicesUristring

URI for devices that belong to the group

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

devicesArray of objects(deviceResponse-v1beta3)

List of devices that belong to the group

Default []

policiesobject(groupServerPolicies-v1beta3)

Store policy settings for server group actions.

autoAddTagsobject 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"}

securityStatusstring(securityState)

Indicates the group security status

Enum"RISK""OK""IGNORED"

groupComplianceobject(groupCompliance-v1beta3)

Compliance status and status reason for device in the group.

resourceUristring(uri-reference)

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

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

generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of group creation

updatedAtstring(date-time)

Time of the last group update

Response

application/json

{
  "deviceType": "DIRECT_CONNECT_SERVER",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Production Group",
  "type": "compute-mgmt-ops/group",
  "description": "All prod servers",
  "complianceStatus": "COMPLIANT",
  "settingsUris": [
    "/compute-ops-mgmt/v1beta1/settings/00000000-0000-0000-0000-800000000001"
  ],
  "devicesUri": "/compute-ops-mgmt/v1beta3/groups/6081a383-b9e5-45e3-8371-1e0ba7b72068/devices",
  "devices": [],
  "policies": {
    "onDeviceAdd": { … },
    "onDeviceApply": { … }
  },
  "autoAddTags": {
    "Department": "Development - Texas"
  },
  "securityStatus": "RISK",
  "groupCompliance": {
    "summary": "Not Compliant",
    "firmware": { … },
    "iloSettings": { … }
  },
  "resourceUri": "/compute-ops-mgmt/v1beta3/groups/0e7f516c-0829-4135-83d6-09ce844ddd9d",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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

Group compliance can be filtered by:

bundleId
complianceCategory
complianceState
createdAt
generation
productId
remediation
score
updatedAt

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

Examples:

Filter with equality check

Return device compliance data where a property equals a value. <property> eq <value>

filter=score eq 0

Filter on an inverted query

Return device compliance data where a property does not equal a value not <property> eq <value>

filter=not complianceState eq 'NOT APPLICABLE'

Filter that a property contains a value

Return device compliance data with populated property. not <property> eq null

filter=not bundleId eq null

Filter that field value contains a specific substring

Return device compliance data where property contains a value. contains(<property>, <value>)

filter=contains(productId,'A01')

Filter on multiple conditionals

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

filter=not bundleId eq null and contains(productId,'A01')

Filter for a value to have one of multiple possibilities

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

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

Headers

Tenant-Acidstring(uuid)

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

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

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta3/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[].groupIdstring(uuid)

items[].serialstring

items[].productIdstring

items[].deviceIdstring

items[].bundleIdstring

Primary identifier for the firmware bundle

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

items[].scoreinteger

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[].errorReasonstring

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

items[].remediationobject

Specifies remediation actions for the device

items[].complianceCategoryany

This refers to the Compliance Category

Value "FIRMWARE"

items[].idstring(uuid)

Primary identifier for the compliance given by the system

items[].typestring

Type of the resource

Value "compute-ops-mgmt/group/compliance"

items[].resourceUristring(uri-reference)

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

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

items[].deviceUristring

Example: "/compute-ops-mgmt/v1beta2/servers/873357-P04+WKQ82425HD"

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.

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

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

Responses

Successful Response

Bodyapplication/json

groupIdstring(uuid)

serialstring

productIdstring

deviceIdstring

bundleIdstring

Primary identifier for the firmware bundle

deviationsArray of objects(deviceDeviation-v1beta3)

scoreinteger

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"

errorReasonstring

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

remediationobject

Specifies remediation actions for the device

complianceCategoryany

This refers to the Compliance Category

Value "FIRMWARE"

idstring(uuid)

Primary identifier for the compliance given by the system

typestring

Type of the resource

Value "compute-ops-mgmt/group/compliance"

resourceUristring(uri-reference)

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

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

deviceUristring

Example: "/compute-ops-mgmt/v1beta2/servers/873357-P04+WKQ82425HD"

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.

Response

application/json

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

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

Devices in a group can be filtered by:

eTag
groupId
overallSecurityStatus
productId
serial
subscriptionState
subscriptionTier

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

Examples:

Filter with equality check

Return devices in a group where a property equals a value. <property> eq <value>

filter=productId eq '000001-A01'

Filter on an inverted query

Return devices in a group where a property does not equal a value not <property> eq <value>

filter=not overallSecurityStatus eq 'OK'

Filter that a property contains a value

Return devices in a group with populated property. not <property> eq null

filter=not eTag eq null

Filter that field value contains a specific substring

Return devices in a group where property contains a value. contains(<property>, <value>)

filter=contains(productId,'A01')

Filter on multiple conditionals

Return devices in a group where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not eTag eq null and contains(productId,'A01')

Filter for a value to have one of multiple possibilities

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

filter=overallSecurityStatus in ('RISK', 'UNKNOWN')

Headers

Tenant-Acidstring(uuid)

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

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

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta3/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[].idstring

Primary identifier for the device given by the system

Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"

items[].typestring

Type of the resource

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

items[].resourceUristring(uri-reference)

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

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

items[].serialstring

Example: "SYN1002J11"

items[].productIdstring

Example: "P43990-121"

items[].eTagstring

Example: "0xb2e9346d"

items[].deviceIdstring

Example: "P43990-121+SYN1002J11"

items[].deviceUristring

Example: "/compute-ops-mgmt/v1beta2/servers/873357-P04+WKQ82425HD"

items[].groupIdstring(uuid)

items[].subscriptionStatestring(subscriptionState)

Subscription state.

Enum"REQUIRED""SUBSCRIBED""EXPIRED"

items[].subscriptionTierstring(subscriptionTier)

Subscription tier.

Value"ENHANCED"

items[].overallSecurityStatusstring(overallSecurityStatus)

The current security status of a device

Enum"IGNORED""OK""RISK"

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

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-v1beta3)non-emptyrequired

Specifies the devices to be assigned to the group.

devices[].deviceIdstringrequired

The device to assign to the group.

Example: "LUKEB1-G11+TUXED0CA77"

devices[].eTagstring

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

When moving a device from one group to another, the latest eTag for that device must be specified. A device'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 device.

In the rare case that a request is made to assign a device 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.

Example: "0xb2e9346d"

curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta3/groups/{group-id}/devices' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "devices": [
      {
        "deviceId": "LUKEB1-G11+TUXED0CA77"
      }
    ]
  }'

Responses

Successful Response

Headers

Locationstring(uri-reference)required

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1beta1/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

forceboolean

If set to true, all devices will be unassigned from the group specified by the group-id. When this is true, do not provide a request body.

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 DIRECT_CONNECT_SERVER devices 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.

Bodyapplication/json

A request body containing devices is required if the force query parameter is not set to true. If force is true, then no body should be provided.

devicesArray of objects(deviceRemoveRequest-v1beta3)non-emptyrequired

devices[].deviceIdstringrequired

The device to unassign from the group.

Example: "LUKEB1-G11+TUXED0CA77"

curl -i -X POST \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta3/groups/{group-id}/devices/unassign' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "devices": [
      {}
    ]
  }'

Responses

Successful Response

Headers

Locationstring(uri-reference)required

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1beta1/async-operations/3921751d-1949-11ef-a4f9-20155d97c234"

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-mgmt/v1beta3/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": [ … ]
  }
}

List all devices iLO Settings compliance in a group

Request

List all the device's 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-mgmt/v1beta3/groups/{group-id}/ilo-settings-compliance' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response (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[].groupIdstring(uuid)

items[].serialstring

items[].productIdstring

items[].deviceIdstring

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

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[].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 "ILO_SETTINGS"

items[].remediationobject

Specifies remediation actions for the device

items[].idstring(uuid)

Primary identifier for the compliance given by the system

items[].typestring

Type of the resource

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

items[].resourceUristring(uri-reference)

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

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

items[].deviceUristring

Example: "/compute-ops-mgmt/v1beta2/servers/873357-P04+WKQ82425HD"

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.

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

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

Responses

Successful Response

Bodyapplication/json

groupIdstring(uuid)

serialstring

productIdstring

deviceIdstring

deviationsArray of objects(iLOSettingsdeviceDeviation-v1beta3)

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"

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

remediationobject

Specifies remediation actions for the device

idstring(uuid)

Primary identifier for the compliance given by the system

typestring

Type of the resource

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

resourceUristring(uri-reference)

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

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

deviceUristring

Example: "/compute-ops-mgmt/v1beta2/servers/873357-P04+WKQ82425HD"

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.

Response

application/json

{
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "serial": "string",
  "productId": "string",
  "deviceId": "string",
  "deviations": [
    { … }
  ],
  "complianceState": "COMPLIANT",
  "errorReason": "string",
  "complianceCategory": "ILO_SETTINGS",
  "remediation": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "compute-ops-mgmt/group/ilo-settings-compliance",
  "resourceUri": "/compute-ops-mgmt/v1beta3/groups/c26e618b-4048-4aee-8e75-fbc984897a51/ilo-settings-compliance/b73718fb-30c3-4b0f-bee3-f5dd598414f3",
  "deviceUri": "/compute-ops-mgmt/v1beta2/servers/873357-P04+WKQ82425HD",
  "generation": 1,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

groups - v1beta2

Operations

job-templates - v1beta2

Operations

jobs - v1

Operations

jobs - v1beta3

Operations

jobs - v1beta2

Operations

metrics-configurations - v1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

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

List all groups

Request

Responses

Was this helpful?

Create a group

Request

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 device(s) to a group

RequestExpand all

Responses

Was this helpful?

Unassign device(s) from a group

RequestExpand all

Responses

Was this helpful?

Get external storage compliance

Request

Responses

Was this helpful?

List all devices iLO Settings compliance in a group

Request

Responses

Was this helpful?

Get a device compliance by iLO Settings compliance Id

Request

Responses

Was this helpful?

groups - v1beta2

job-templates - v1beta2

jobs - v1

jobs - v1beta3

jobs - v1beta2

metrics-configurations - v1

oneview-appliances - v1beta1

oneview-settings - v1beta1

oneview-server-templates - v1beta1

Request

Request

Request