service_domain_dkims

Creates, updates, deletes, gets or lists a service_domain_dkims resource.

Overview

Name	service_domain_dkims
Type	Resource
Id	ovh.email_exchange.service_domain_dkims

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_pending_id	integer	Pending task for this DKIM (wire: taskPendingId)
selector_name	string	selectorName (wire: selectorName)
cname_is_valid	boolean	If true your dns cname configuration is valid (wire: cnameIsValid)
customer_record	string	customer dns record (wire: customerRecord)
header	string	header used for dkim signature
last_update	string (date-time)	Last update date (wire: lastUpdate)
record_type	string	Record type of the customer record (wire: recordType)
status	string	dkim status (deleting, disabling, enabling, inProduction, ready, todo, waitingRecord)
target_record	string	Target of the customer record (wire: targetRecord)

list

DKIM for a domain

Name	Datatype	Description
task_pending_id	integer	Pending task for this DKIM (wire: taskPendingId)
selector_name	string	selectorName (wire: selectorName)
cname_is_valid	boolean	If true your dns cname configuration is valid (wire: cnameIsValid)
customer_record	string	customer dns record (wire: customerRecord)
header	string	header used for dkim signature
last_update	string (date-time)	Last update date (wire: lastUpdate)
record_type	string	Record type of the customer record (wire: recordType)
status	string	dkim status (deleting, disabling, enabling, inProduction, ready, todo, waitingRecord)
target_record	string	Target of the customer record (wire: targetRecord)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain_name, exchange_service, organization_name, selector_name		Get a DKIM selector. Returns the status of the DKIM selector, the DNS record to create (name, type and target) and whether the CNAME record is valid.
list	select	domain_name, exchange_service, organization_name	x_pagination_mode	List DKIM selectors. Returns the names of the DKIM selectors of the domain. Get one to read its DNS record and its status.
create	insert	domain_name, exchange_service, organization_name, selector_name		Create a DKIM selector. Creates a DKIM selector on the domain and returns the task. For a domain hosted by OVHcloud, configureDkim creates the DNS record and autoEnableDKIM enables the selector once configured.
delete	delete	domain_name, exchange_service, organization_name, selector_name		Delete a DKIM selector. Removes the DKIM selector and its key from the domain of the Exchange service, and returns the task.
disable	exec	domainName, exchangeService, organizationName, selectorName		Disable DKIM signing. Stops signing the emails of the domain with this DKIM selector, and returns the task. The selector is kept.
enable	exec	domainName, exchangeService, organizationName, selectorName		Enable DKIM signing. Enables DKIM signing with the selector, or switches the selector in use to this one, and returns the task.

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"}})
domainName	string	Domain name
domain_name	string	Domain name (wire: domainName)
exchangeService	string	The internal name of your exchange service
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organizationName	string	The internal name of your exchange organization
organization_name	string	The internal name of your exchange organization (wire: organizationName)
selectorName	string	selectorName
selector_name	string	selectorName (wire: selectorName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a DKIM selector. Returns the status of the DKIM selector, the DNS record to create (name, type and target) and whether the CNAME record is valid.

SELECT
task_pending_id,
selector_name,
cname_is_valid,
customer_record,
header,
last_update,
record_type,
status,
target_record
FROM ovh.email_exchange.service_domain_dkims
WHERE domain_name = '{{ domain_name }}' -- required
AND exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND selector_name = '{{ selector_name }}' -- required
;

list

List DKIM selectors. Returns the names of the DKIM selectors of the domain. Get one to read its DNS record and its status.

SELECT
task_pending_id,
selector_name,
cname_is_valid,
customer_record,
header,
last_update,
record_type,
status,
target_record
FROM ovh.email_exchange.service_domain_dkims
WHERE domain_name = '{{ domain_name }}' -- required
AND exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a DKIM selector. Creates a DKIM selector on the domain and returns the task. For a domain hosted by OVHcloud, configureDkim creates the DNS record and autoEnableDKIM enables the selector once configured.

INSERT INTO ovh.email_exchange.service_domain_dkims (
auto_enable_dkim,
configure_dkim,
selector_name,
domain_name,
exchange_service,
organization_name
)
SELECT 
{{ auto_enable_dkim }},
{{ configure_dkim }},
'{{ selector_name }}' /* required */,
'{{ domain_name }}',
'{{ exchange_service }}',
'{{ organization_name }}'
RETURNING
id,
finish_date,
function,
status,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: service_domain_dkims
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the service_domain_dkims resource.
  - name: exchange_service
    value: "{{ exchange_service }}"
    description: Required parameter for the service_domain_dkims resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the service_domain_dkims resource.
  - name: auto_enable_dkim
    value: {{ auto_enable_dkim }}
    description: |
      Enable DKIM automatically after DKIM configuration
  - name: configure_dkim
    value: {{ configure_dkim }}
    description: |
      If you host domain in OVH we can configure dkim dns record automatically
  - name: selector_name
    value: "{{ selector_name }}"
    description: |
      selector name for DKIM

DELETE examples

delete

Delete a DKIM selector. Removes the DKIM selector and its key from the domain of the Exchange service, and returns the task.

DELETE FROM ovh.email_exchange.service_domain_dkims
WHERE domain_name = '{{ domain_name }}' --required
AND exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required
AND selector_name = '{{ selector_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

disable

Disable DKIM signing. Stops signing the emails of the domain with this DKIM selector, and returns the task. The selector is kept.

EXEC ovh.email_exchange.service_domain_dkims.disable 
@domainName='{{ domainName }}' --required, 
@exchangeService='{{ exchangeService }}' --required, 
@organizationName='{{ organizationName }}' --required, 
@selectorName='{{ selectorName }}' --required
;

enable

Enable DKIM signing. Enables DKIM signing with the selector, or switches the selector in use to this one, and returns the task.

EXEC ovh.email_exchange.service_domain_dkims.enable 
@domainName='{{ domainName }}' --required, 
@exchangeService='{{ exchangeService }}' --required, 
@organizationName='{{ organizationName }}' --required, 
@selectorName='{{ selectorName }}' --required
;