Create a device setting

post/compute-ops-mgmt/v1/settings

Create a device setting entry

SecurityBearer
Request
header Parameters
Content-Type
required
string

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

Value: "application/json"
Tenant-Acid
string <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.

Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters

The display name for the setting

description
string or null <= 10000 characters

The description for the setting

category
required
string

The category to which the settings data applies.

The available server settings categories are:

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

The available OneView VM appliance settings categories are:

Category Purpose
OVE_APPLIANCE_SETTINGS_ANY appliance configuration
OVE_SERVER_TEMPLATES_VM server profile templates

The available OneView Synergy appliance settings categories are:

Category Purpose
OVE_APPLIANCE_SETTINGS_ANY appliance configuration
OVE_APPLIANCE_SETTINGS_SYNERGY synergy-specific appliance configuration
OVE_SERVER_TEMPLATES_SYNERGY server profile templates
Enum: "BIOS" "EXTERNAL_STORAGE" "FIRMWARE" "ILO" "OS" "STORAGE" "OVE_APPLIANCE_SETTINGS_ANY" "OVE_APPLIANCE_SETTINGS_SYNERGY" "OVE_SERVER_TEMPLATES_SYNERGY" "OVE_SERVER_TEMPLATES_VM"
object

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:

Category Key(s) Details
BIOS DEFAULT BIOS configuration
EXTERNAL_STORAGE DEFAULT HPE GreenLake for DSCC storage configuration
FIRMWARE GEN10, GEN11 Firmware for GEN10, GEN11 or both platforms
ILO DEFAULT iLO security configuration
OS DEFAULT Installed operating system
STORAGE DEFAULT Internal storage configuration
OVE_* DEFAULT All OneView appliance settings categories
Responses
201

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

409

Conflict

415

Unsupported media type

500

Internal server error

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