Create server settings

post/compute-ops/v1beta1/server-settings

Create a server settings 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 server-settings item

category
required
string

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
Enum: "FIRMWARE" "BIOS" "STORAGE" "OS" "EXTERNAL_STORAGE" "ILO"
description
string or null <= 10000 characters
platformFamily
string
Default: "ANY"

Server platform family to which this server setting applies. There are no restrictions for server setting 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 servers can be in the group(s) which are associated with this server setting, regardless of the value passed in.

Enum: "ANY" "PROLIANT"
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 server 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
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",
  • "category": "FIRMWARE",
  • "description": "Firmware server setting",
  • "platformFamily": "ANY",
  • "settings": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "category": "FIRMWARE",
  • "platformFamily": "ANY",
  • "settings": {
    },
  • "generation": 1,
  • "resourceUri": "/compute-ops/v1beta1/server-settings/a2fdaf7a-4933-4c47-bfe0-891f0a83dc6e",
  • "type": "compute-ops/server-setting",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}