zone_dnssec
Creates, updates, deletes, gets or lists a zone_dnssec resource.
Overview​
| Name | zone_dnssec |
| Type | Resource |
| Id | ovh.domain.zone_dnssec |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
status | string | DNSSEC Status (disableInProgress, disabled, enableInProgress, enabled) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | zone_name | Returns the DNSSEC status: enabled, disabled, or being enabled or disabled. | |
create | insert | zone_name | Enables DNSSEC on the zone. The status is enableInProgress until it completes. | |
delete | delete | zone_name | Disables DNSSEC on the zone. The status is disableInProgress until it completes. |
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"}}) |
zone_name | string | Zone name (wire: zoneName) |
SELECT examples​
- get
Returns the DNSSEC status: enabled, disabled, or being enabled or disabled.
SELECT
status
FROM ovh.domain.zone_dnssec
WHERE zone_name = '{{ zone_name }}' -- required
;
INSERT examples​
- create
- Manifest
Enables DNSSEC on the zone. The status is enableInProgress until it completes.
INSERT INTO ovh.domain.zone_dnssec (
zone_name
)
SELECT
'{{ zone_name }}'
;
# Description fields are for documentation purposes
- name: zone_dnssec
props:
- name: zone_name
value: "{{ zone_name }}"
description: Required parameter for the zone_dnssec resource.
DELETE examples​
- delete
Disables DNSSEC on the zone. The status is disableInProgress until it completes.
DELETE FROM ovh.domain.zone_dnssec
WHERE zone_name = '{{ zone_name }}' --required
;