Skip to content
Internal API Catalog
/
HPE Compute Ops Management API
/
settings - v1beta1

HPE Compute Ops Management API (latest)

HPE Compute Operations Management provides a Restful API to customers who want to manage their devices programmatically or through a command line. The API enables customers to invoke operations or tasks such as list devices, see device details, device health, and manage their device's firmware.

UPDATED API ENDPOINTS

Compute Ops Management now supports the HPE GreenLake API endpoints (<region>.api.greenlake.hpe.com). The Guide contains more information about this change.

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/

API endpoint for US West

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

API endpoint for EU Central

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

API endpoint for AP Northeast

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

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

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

List all device settings

Request

Get the list of a user's device settings

Security
Bearer
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.

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

Settings can be filtered by:

  • category
  • description
  • name
  • settings

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

Examples:

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

filter=category eq 'FIRMWARE'

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

filter=settings/DEFAULT/raidType eq 'RAID0'

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

filter=not deviceType eq 'DIRECT_CONNECT_SERVER'

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

filter=not name eq null

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

filter=contains(category,'FIRM')

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

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

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

filter=settings/DEFAULT/raidType in ('RAID0','RAID1')
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/v1beta1/settings \
  -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)

Primary identifier for the setting given by the system

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

The display name for the setting

items[].​descriptionstring or null<= 10000 characters

The description for the setting

items[].​categorystring

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration

The available OneView VM appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_SERVER_TEMPLATES_VM - server profile templates
  • OVE_SOFTWARE_VM - OneView appliance software

The available OneView Synergy appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_APPLIANCE_SETTINGS_SYNERGY - synergy-specific appliance configuration
  • OVE_SERVER_TEMPLATES_SYNERGY - server profile templates
  • OVE_SOFTWARE_SYNERGY - OneView Synergy appliance software
Enum"BIOS""EXTERNAL_STORAGE""FIRMWARE"
items[].​settingsobject

Configuration data corresponding to the specified category

items[].​generationinteger>= 1

Monotonically increasing update counter

items[].​resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
items[].​typestring

Type of the resource

Value "compute-ops-mgmt/setting"
items[].​createdAtstring(date-time)

Time of settings creation

items[].​updatedAtstring(date-time)

Time of the last settings 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 device setting

Request

Create a device setting entry

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

The display name for the setting

categorystringrequired

The category to which the settings data applies.

The available server settings categories are:

CategoryPurpose
BIOSBIOS configuration
EXTERNAL_STORAGEHPE GreenLake for Data Services Cloud Console (DSCC) configuration
FIRMWAREfirmware configuration
ILOiLO security configuration
OSoperating system
STORAGEinternal storage configuration

The available OneView VM appliance settings categories are:

CategoryPurpose
OVE_APPLIANCE_SETTINGS_ANYappliance configuration
OVE_SERVER_TEMPLATES_VMserver profile templates
OVE_SOFTWARE_VMOneView appliance software

The available OneView Synergy appliance settings categories are:

CategoryPurpose
OVE_APPLIANCE_SETTINGS_ANYappliance configuration
OVE_APPLIANCE_SETTINGS_SYNERGYsynergy-specific appliance configuration
OVE_SERVER_TEMPLATES_SYNERGYserver profile templates
OVE_SOFTWARE_SYNERGYOneView Synergy appliance software
Enum"BIOS""EXTERNAL_STORAGE""FIRMWARE"
descriptionstring or null<= 10000 characters

The description for the setting

Example: "Firmware server setting"
settingsobject

Configuration data corresponding to the specified category.

ILO settings are HPE-defined only. Adding a new ILO setting is not supported.

The following table shows the available schema keys for each settings category:

CategoryKey(s)Details
BIOSDEFAULTserver BIOS configuration
EXTERNAL_STORAGEDEFAULTHPE GreenLake for DSCC storage configuration
FIRMWAREGEN10, GEN11, GEN12Firmware for the specified platform(s)
ILODEFAULTiLO security configuration
OSDEFAULTInstalled operating system
STORAGEDEFAULTInternal storage configuration
OVE_*DEFAULTAll OneView appliance settings categories
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/v1beta1/settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "category": "BIOS"
  }'

Responses

Successful Response

Headers
Locationstring(uri-reference)

Location for the settings item that was created

Example: "/compute-ops-mgmt/v1beta1/settings/0e7f516c-0829-4135-83d6-09ce844ddd9d"
Bodyapplication/json
idstring(uuid)

Primary identifier for the setting given by the system

namestring[ 1 .. 100 ] characters

The display name for the setting

descriptionstring or null<= 10000 characters

The description for the setting

categorystring

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration

The available OneView VM appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_SERVER_TEMPLATES_VM - server profile templates
  • OVE_SOFTWARE_VM - OneView appliance software

The available OneView Synergy appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_APPLIANCE_SETTINGS_SYNERGY - synergy-specific appliance configuration
  • OVE_SERVER_TEMPLATES_SYNERGY - server profile templates
  • OVE_SOFTWARE_SYNERGY - OneView Synergy appliance software
Enum"BIOS""EXTERNAL_STORAGE""FIRMWARE"
settingsobject

Configuration data corresponding to the specified category

generationinteger>= 1

Monotonically increasing update counter

resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
typestring

Type of the resource

Value "compute-ops-mgmt/setting"
createdAtstring(date-time)

Time of settings creation

updatedAtstring(date-time)

Time of the last settings update

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "category": "BIOS",
  "settings": {
    "GEN10": { … },
    "GEN11": { … },
    "GEN12": { … },
    "DEFAULT": { … }
  },
  "generation": 1,
  "resourceUri": "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  "type": "compute-ops-mgmt/setting",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get a device setting by ID

Request

Get a specific device settings item by its id.

Security
Bearer
Path
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/v1beta1/settings/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)

Primary identifier for the setting given by the system

namestring[ 1 .. 100 ] characters

The display name for the setting

descriptionstring or null<= 10000 characters

The description for the setting

categorystring

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration

The available OneView VM appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_SERVER_TEMPLATES_VM - server profile templates
  • OVE_SOFTWARE_VM - OneView appliance software

The available OneView Synergy appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_APPLIANCE_SETTINGS_SYNERGY - synergy-specific appliance configuration
  • OVE_SERVER_TEMPLATES_SYNERGY - server profile templates
  • OVE_SOFTWARE_SYNERGY - OneView Synergy appliance software
Enum"BIOS""EXTERNAL_STORAGE""FIRMWARE"
settingsobject

Configuration data corresponding to the specified category

generationinteger>= 1

Monotonically increasing update counter

resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
typestring

Type of the resource

Value "compute-ops-mgmt/setting"
createdAtstring(date-time)

Time of settings creation

updatedAtstring(date-time)

Time of the last settings update

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "category": "BIOS",
  "settings": {
    "GEN10": { … },
    "GEN11": { … },
    "GEN12": { … },
    "DEFAULT": { … }
  },
  "generation": 1,
  "resourceUri": "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  "type": "compute-ops-mgmt/setting",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a device setting

Request

Delete a device settings item.

Security
Bearer
Path
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-mgmt/v1beta1/settings/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content

Patch a device setting

Request

Partially update a device settings item.

Security
Bearer
Path
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

The display name for the setting

descriptionstring or null<= 10000 characters

The description for the setting

settingsobject

Configuration data corresponding to the specified category

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

Responses

Successful Response

Bodyapplication/json
idstring(uuid)

Primary identifier for the setting given by the system

namestring[ 1 .. 100 ] characters

The display name for the setting

descriptionstring or null<= 10000 characters

The description for the setting

categorystring

The category to which the settings data applies.

The available server settings categories are:

  • BIOS - BIOS configuration
  • EXTERNAL_STORAGE - storage configured in HPE GreenLake for Data Services Cloud Console (DSCC)
  • FIRMWARE - firmware configuration
  • ILO - iLO security configuration
  • OS - operating system
  • STORAGE - internal storage configuration

The available OneView VM appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_SERVER_TEMPLATES_VM - server profile templates
  • OVE_SOFTWARE_VM - OneView appliance software

The available OneView Synergy appliance settings categories are:

  • OVE_APPLIANCE_SETTINGS_ANY - appliance configuration
  • OVE_APPLIANCE_SETTINGS_SYNERGY - synergy-specific appliance configuration
  • OVE_SERVER_TEMPLATES_SYNERGY - server profile templates
  • OVE_SOFTWARE_SYNERGY - OneView Synergy appliance software
Enum"BIOS""EXTERNAL_STORAGE""FIRMWARE"
settingsobject

Configuration data corresponding to the specified category

generationinteger>= 1

Monotonically increasing update counter

resourceUristring(uri-reference)

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

Example: "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e"
typestring

Type of the resource

Value "compute-ops-mgmt/setting"
createdAtstring(date-time)

Time of settings creation

updatedAtstring(date-time)

Time of the last settings update

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "category": "BIOS",
  "settings": {
    "GEN10": { … },
    "GEN11": { … },
    "GEN12": { … },
    "DEFAULT": { … }
  },
  "generation": 1,
  "resourceUri": "/compute-ops-mgmt/v1beta1/settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  "type": "compute-ops-mgmt/setting",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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