security_options
Creates, updates, deletes, gets or lists a security_options resource.
Overview​
| Name | security_options |
| Type | Resource |
| Id | ovh.dedicated_cloud.security_options |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
state | string | State of security options (creating, deleted, deleting, delivered, disabled, pending, toCreate, updating) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the security options | |
resume_pending_enabling | exec | serviceName, option | Resume a security option activation. Retries the activation of a pending security option. Returns a task to track progress. |
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 | Domain of the service |
service_name | string | Domain of the service (wire: serviceName) |
SELECT examples​
- get
Get the security options
SELECT
state
FROM ovh.dedicated_cloud.security_options
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- resume_pending_enabling
Resume a security option activation. Retries the activation of a pending security option. Returns a task to track progress.
EXEC ovh.dedicated_cloud.security_options.resume_pending_enabling
@serviceName='{{ serviceName }}' --required
@@json=
'{
"option": "{{ option }}"
}'
;