bios_settings_sgxes
Creates, updates, deletes, gets or lists a bios_settings_sgxes resource.
Overview​
| Name | bios_settings_sgxes |
| Type | Resource |
| Id | ovh.dedicated_server.bios_settings_sgxes |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
prmrr | string | Settings sections (128, 131072, 16384, 2048, 256, 32, 32768, 4096, 512, 64, 65536, 8192) |
status | string | Settings sections (disabled, enabled, software controlled) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the SGX settings. Returns the SGX configuration of the server: the SGX status and the size of the Processor Reserved Memory (PRMRR). To change it, use the configure operation. (Beta version) | |
configure | exec | serviceName | Configure SGX. Enables or disables SGX and sets the size of the Processor Reserved Memory (PRMRR). The server reboots one or several times. On a server without SGX BIOS settings, the call returns an error. (Beta version) |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
serviceName | string | The internal name of your dedicated server |
service_name | string | The internal name of your dedicated server (wire: serviceName) |
SELECT examples​
- get
Get the SGX settings. Returns the SGX configuration of the server: the SGX status and the size of the Processor Reserved Memory (PRMRR). To change it, use the configure operation. (Beta version)
SELECT
prmrr,
status
FROM ovh.dedicated_server.bios_settings_sgxes
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- configure
Configure SGX. Enables or disables SGX and sets the size of the Processor Reserved Memory (PRMRR). The server reboots one or several times. On a server without SGX BIOS settings, the call returns an error. (Beta version)
EXEC ovh.dedicated_server.bios_settings_sgxes.configure
@serviceName='{{ serviceName }}' --required
@@json=
'{
"prmrr": "{{ prmrr }}",
"status": "{{ status }}"
}'
;