List all device settings

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

Server Settings can be filtered by:

category
customerId
description
name
platformFamily
settings

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

Examples:

Filter with equality check

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

filter=category eq 'FIRMWARE'

Filter with equality check on a nested attribute

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

filter=settings/DEFAULT/raidType eq 'RAID0'

Filter on an inverted query

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

filter=not platformFamily eq 'PROLIANT'

Filter that a property contains a value

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

filter=not name eq null

Filter that field value contains a specific substring

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

filter=contains(category,'FIRM')

Filter on multiple conditionals

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')

Filter for a value to have one of multiple possibilities

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

filter=settings/DEFAULT/raidType in ('RAID0','RAID1')

header Parameters

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.

Responses

200

Successful Response

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

Request samples

curl
JavaScript
Python
Go

Response samples

application/json

{"offset": 0,
"count": 1,
"total": 12,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"category": "BIOS",
"settings": {"GEN10": {"id": "a9383ef62e362a0072b2947c923ba257"
},
"GEN11": {"id": "a9383ef62e362a0072b2947c923ba257"
},
"DEFAULT": {"enableCustomWorkloadProfile": true,
"redfishData": {"Attributes": {"AdminName": "Luke",
"WorkloadProfile": "GeneralPowerEfficientCompute"
}
}
}
},
"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"
}
]
}