<title>community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API — Community.Crypto Collection documentation</title>
<linkrel="next"title="community.crypto.get_certificate module – Get a certificate from a host:port"href="get_certificate_module.html"/>
<linkrel="prev"title="community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API"href="ecs_certificate_module.html"/><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
</head>
<bodyclass="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
<liclass="toctree-l1"><aclass="reference internal"href="docsite/guide_selfsigned.html">How to create self-signed certificates</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docsite/guide_ownca.html">How to create a small CA</a></li>
</ul>
<ulclass="current">
<liclass="toctree-l1"><aclass="reference internal"href="acme_account_module.html">community.crypto.acme_account module – Create, modify or delete ACME accounts</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="acme_account_info_module.html">community.crypto.acme_account_info module – Retrieves information on ACME accounts</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="acme_certificate_module.html">community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="acme_certificate_revoke_module.html">community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="acme_challenge_cert_helper_module.html">community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as <codeclass="docutils literal notranslate"><spanclass="pre">tls-alpn-01</span></code></a></li>
<liclass="toctree-l1"><aclass="reference internal"href="acme_inspect_module.html">community.crypto.acme_inspect module – Send direct requests to an ACME server</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="certificate_complete_chain_module.html">community.crypto.certificate_complete_chain module – Complete certificate chain given a set of untrusted and root certificates</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="ecs_certificate_module.html">community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API</a></li>
<liclass="toctree-l1 current"><aclass="current reference internal"href="#">community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API</a><ul>
<liclass="toctree-l1"><aclass="reference internal"href="get_certificate_module.html">community.crypto.get_certificate module – Get a certificate from a host:port</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssh_cert_module.html">community.crypto.openssh_cert module – Generate OpenSSH host or user certificates.</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssh_keypair_module.html">community.crypto.openssh_keypair module – Generate OpenSSH private and public keys</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_csr_info_module.html">community.crypto.openssl_csr_info module – Provide information of OpenSSL Certificate Signing Requests (CSR)</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_privatekey_info_module.html">community.crypto.openssl_privatekey_info module – Provide information for OpenSSL private keys</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_privatekey_pipe_module.html">community.crypto.openssl_privatekey_pipe module – Generate OpenSSL private keys without disk access</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_publickey_module.html">community.crypto.openssl_publickey module – Generate an OpenSSL public key from its private key.</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_publickey_info_module.html">community.crypto.openssl_publickey_info module – Provide information for OpenSSL public keys</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_signature_module.html">community.crypto.openssl_signature module – Sign data with openssl</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_signature_info_module.html">community.crypto.openssl_signature_info module – Verify signatures with openssl</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="x509_certificate_info_module.html">community.crypto.x509_certificate_info module – Provide information of OpenSSL X.509 certificates</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="gpg_fingerprint_filter.html">community.crypto.gpg_fingerprint filter – Retrieve a GPG fingerprint from a GPG public or private key</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_privatekey_info_filter.html">community.crypto.openssl_privatekey_info filter – Retrieve information from OpenSSL private keys</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="openssl_publickey_info_filter.html">community.crypto.openssl_publickey_info filter – Retrieve information from OpenSSL public keys in PEM format</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="x509_certificate_info_filter.html">community.crypto.x509_certificate_info filter – Retrieve information from X.509 certificates in PEM format</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="x509_crl_info_filter.html">community.crypto.x509_crl_info filter – Retrieve information from X.509 CRLs in PEM format</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="gpg_fingerprint_lookup.html">community.crypto.gpg_fingerprint lookup – Retrieve a GPG fingerprint from a GPG public or private key file</a></li>
<liclass="breadcrumb-item active">community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API</li>
<liclass="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<ahref="https://github.com/ansible-collections/community.crypto/edit/main/plugins/modules/ecs_domain.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr"class="fa fa-github"> Edit on GitHub</a>
<h1>community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API<aclass="headerlink"href="#community-crypto-ecs-domain-module-request-validation-of-a-domain-with-the-entrust-certificate-services-ecs-api"title="Link to this heading"></a></h1>
<p>This module is part of the <aclass="reference external"href="https://galaxy.ansible.com/ui/repo/published/community/crypto/">community.crypto collection</a> (version 2.17.0).</p>
<p>It is not included in <codeclass="docutils literal notranslate"><spanclass="pre">ansible-core</span></code>.
To check whether it is installed, run <codeclass="code docutils literal notranslate"><spanclass="pre">ansible-galaxy</span><spanclass="pre">collection</span><spanclass="pre">list</span></code>.</p>
You need further requirements to be able to use this module,
see <aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-requirements"><spanclass="std std-ref">Requirements</span></a> for details.</p>
<p>To use it in a playbook, specify: <codeclass="code docutils literal notranslate"><spanclass="pre">community.crypto.ecs_domain</span></code>.</p>
</div>
<pclass="ansible-version-added">New in community.crypto 1.0.0</p>
<li><p>Request validation or re-validation of a domain with the Entrust Certificate Services (ECS) API.</p></li>
<li><p>Requires credentials for the <aclass="reference external"href="https://www.entrustdatacard.com/products/categories/ssl-certificates">Entrust Certificate Services</a> (ECS) API.</p></li>
<li><p>If the domain is already in the validation process, no new validation will be requested, but the validation data (if applicable) will be returned.</p></li>
<li><p>If the domain is already in the validation process but the <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method</span></span></a></strong></code> specified is different than the current <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method</span></span></a></strong></code>, the <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method</span></span></a></strong></code> will be updated and validation data (if applicable) will be returned.</p></li>
<li><p>If the domain is an active, validated domain, the return value of <codeclass="docutils literal notranslate"><spanclass="pre">changed</span></code> will be false, unless <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-domain-status"><spanclass="std std-ref"><spanclass="pre">domain_status=EXPIRED</span></span></a></code>, in which case a re-validation will be performed.</p></li>
<li><p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=dns</span></span></a></code>, details about the required DNS entry will be specified in the return parameters <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><spanclass="std std-ref"><spanclass="pre">dns_contents</span></span></a></code>, <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><spanclass="std std-ref"><spanclass="pre">dns_location</span></span></a></code>, and <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-resource-type"><spanclass="std std-ref"><spanclass="pre">dns_resource_type</span></span></a></code>.</p></li>
<li><p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=web_server</span></span></a></code>, details about the required file details will be specified in the return parameters <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-file-contents"><spanclass="std std-ref"><spanclass="pre">file_contents</span></span></a></code> and <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-file-location"><spanclass="std std-ref"><spanclass="pre">file_location</span></span></a></code>.</p></li>
<li><p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=email</span></span></a></code>, the email address(es) that the validation email(s) were sent to will be in the return parameter <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-emails"><spanclass="std std-ref"><spanclass="pre">emails</span></span></a></code>. This is purely informational. For domains requested using this module, this will always be a list of size 1.</p></li>
<spanid="ansible-collections-community-crypto-ecs-domain-module-requirements"></span><h2><aclass="toc-backref"href="#id2"role="doc-backlink">Requirements</a><aclass="headerlink"href="#requirements"title="Link to this heading"></a></h2>
<aclass="ansibleOptionLink"href="#parameter-client_id"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The client ID to request the domain be associated with.</p>
<p>If no client ID is specified, the domain will be added under the primary client with ID of 1.</p>
<aclass="ansibleOptionLink"href="#parameter-domain_name"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span> / <spanclass="ansible-option-required">required</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The domain name to be verified or reverified.</p>
<aclass="ansibleOptionLink"href="#parameter-entrust_api_client_cert_key_path"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">path</span> / <spanclass="ansible-option-required">required</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The path to the key for the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
<aclass="ansibleOptionLink"href="#parameter-entrust_api_client_cert_path"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">path</span> / <spanclass="ansible-option-required">required</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The path to the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
<aclass="ansibleOptionLink"href="#parameter-entrust_api_key"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span> / <spanclass="ansible-option-required">required</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The key (password) for authentication to the Entrust Certificate Services (ECS) API.</p>
<aclass="ansibleOptionLink"href="#parameter-entrust_api_specification_path"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">path</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The path to the specification file defining the Entrust Certificate Services (ECS) API configuration.</p>
<p>You can use this to keep a local copy of the specification to avoid downloading it every time the module is used.</p>
<aclass="ansibleOptionLink"href="#parameter-entrust_api_user"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span> / <spanclass="ansible-option-required">required</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The username for authentication to the Entrust Certificate Services (ECS) API.</p>
<aclass="ansibleOptionLink"href="#parameter-verification_email"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Email address to be used to verify domain ownership.</p>
<p>Email address must be either an email address present in the WHOIS data for <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><spanclass="std std-ref"><spanclass="pre">domain_name</span></span></a></strong></code>, or one of the following constructed emails: admin@<codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><spanclass="std std-ref"><spanclass="pre">domain_name</span></span></a></strong></code>, administrator@<codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><spanclass="std std-ref"><spanclass="pre">domain_name</span></span></a></strong></code>, webmaster@<codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><spanclass="std std-ref"><spanclass="pre">domain_name</span></span></a></strong></code>, hostmaster@<codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><spanclass="std std-ref"><spanclass="pre">domain_name</span></span></a></strong></code>, postmaster@<codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><spanclass="std std-ref"><spanclass="pre">domain_name</span></span></a></strong></code>.</p>
<p>Note that if <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><spanclass="std std-ref"><spanclass="pre">domain_name</span></span></a></strong></code> includes subdomains, the top level domain should be used. For example, if requesting validation of example1.ansible.com, or test.example2.ansible.com, and you want to use the “admin” preconstructed name, the email address should be <aclass="reference external"href="mailto:admin%40ansible.com">admin<span>@</span>ansible<span>.</span>com</a>.</p>
<p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=email</span></span></a></code> but <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><spanclass="std std-ref"><spanclass="pre">verification_email</span></span></a></strong></code> is not provided, the first email address found in WHOIS data for the domain will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-verification_method"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span> / <spanclass="ansible-option-required">required</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The verification method to be used to prove control of the domain.</p>
<p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=email</span></span></a></code> and the value <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><spanclass="std std-ref"><spanclass="pre">verification_email</span></span></a></strong></code> is specified, that value is used for the email validation. If <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><spanclass="std std-ref"><spanclass="pre">verification_email</span></span></a></strong></code> is not provided, the first value present in WHOIS data will be used. An email will be sent to the address in <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><spanclass="std std-ref"><spanclass="pre">verification_email</span></span></a></strong></code> with instructions on how to verify control of the domain.</p>
<p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=dns</span></span></a></code>, the value <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><spanclass="std std-ref"><spanclass="pre">dns_contents</span></span></a></code> must be stored in location <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><spanclass="std std-ref"><spanclass="pre">dns_location</span></span></a></code>, with a DNS record type of <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-resource-type"><spanclass="std std-ref"><spanclass="pre">dns_resource_type</span></span></a></code>. To prove domain ownership, update your DNS records so the text string returned by <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><spanclass="std std-ref"><spanclass="pre">dns_contents</span></span></a></code> is available at <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><spanclass="std std-ref"><spanclass="pre">dns_location</span></span></a></code>.</p>
<p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=web_server</span></span></a></code>, the contents of return value <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-file-contents"><spanclass="std std-ref"><spanclass="pre">file_contents</span></span></a></code> must be made available on a web server accessible at location <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-file-location"><spanclass="std std-ref"><spanclass="pre">file_location</span></span></a></code>.</p>
<p>If <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=manual</span></span></a></code>, the domain will be validated with a manual process. This is not recommended.</p>
<td><divclass="ansible-option-cell"><p>Can run in <codeclass="docutils literal notranslate"><spanclass="pre">check_mode</span></code> and return changed status prediction without modifying target.</p>
<td><divclass="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <codeclass="docutils literal notranslate"><spanclass="pre">check_mode</span></code>), when in diff mode.</p>
<li><p>There is a small delay (typically about 5 seconds, but can be as long as 60 seconds) before obtaining the random values when requesting a validation while <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=dns</span></span></a></code> or <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method=web_server</span></span></a></code>. Be aware of that if doing many domain validation requests.</p></li>
<dt><aclass="reference internal"href="x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module"><spanclass="std std-ref">community.crypto.x509_certificate</span></a></dt><dd><p>Can be used to request certificates from ECS, with <codeclass="ansible-option-value docutils literal notranslate"><aclass="reference internal"href="x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module-parameter-provider"><spanclass="std std-ref"><spanclass="pre">provider=entrust</span></span></a></code>.</p>
<dt><aclass="reference internal"href="ecs_certificate_module.html#ansible-collections-community-crypto-ecs-certificate-module"><spanclass="std std-ref">community.crypto.ecs_certificate</span></a></dt><dd><p>Can be used to request a Certificate from ECS using a verified domain.</p>
<divclass="highlight-yaml+jinja notranslate"><divclass="highlight"><pre><span></span><spanclass="p p-Indicator">-</span><spanclass="w"></span><spanclass="nt">name</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">Request domain validation using email validation for client ID of 2.</span>
<spanclass="p p-Indicator">-</span><spanclass="w"></span><spanclass="nt">name</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">Request domain validation using DNS. If domain is already valid,</span>
<spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">request revalidation if expires within 90 days</span>
<spanclass="p p-Indicator">-</span><spanclass="w"></span><spanclass="nt">name</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">Request domain validation using web server validation, and revalidate</span>
<spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">if fewer than 60 days remaining of EV eligibility.</span>
<h2><aclass="toc-backref"href="#id8"role="doc-backlink">Return Values</a><aclass="headerlink"href="#return-values"title="Link to this heading"></a></h2>
<p>Common return values are documented <aclass="reference external"href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values"title="(in Ansible vdevel)"><spanclass="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<aclass="ansibleOptionLink"href="#return-client_id"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
<td><divclass="ansible-option-cell"><p>Client ID that the domain belongs to. If the input value <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-client-id"><spanclass="std std-ref"><spanclass="pre">client_id</span></span></a></strong></code> is specified, this will always be the same as <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-client-id"><spanclass="std std-ref"><spanclass="pre">client_id</span></span></a></strong></code></p>
<aclass="ansibleOptionLink"href="#return-dns_contents"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<td><divclass="ansible-option-cell"><p>The value that ECS will be expecting to find in the DNS record located at <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><spanclass="std std-ref"><spanclass="pre">dns_location</span></span></a></code>.</p>
<pclass="ansible-option-line"><strongclass="ansible-option-returned-bold">Returned:</strong> changed and if <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method</span></span></a></strong></code> is <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">dns</span></code></p>
<aclass="ansibleOptionLink"href="#return-dns_location"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<td><divclass="ansible-option-cell"><p>The location that ECS will be expecting to be able to find the DNS entry for domain verification, containing the contents of <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><spanclass="std std-ref"><spanclass="pre">dns_contents</span></span></a></code>.</p>
<pclass="ansible-option-line"><strongclass="ansible-option-returned-bold">Returned:</strong> changed and if <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method</span></span></a></strong></code> is <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">dns</span></code></p>
<aclass="ansibleOptionLink"href="#return-dns_resource_type"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<td><divclass="ansible-option-cell"><p>The type of resource record that ECS will be expecting for the DNS record located at <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><spanclass="std std-ref"><spanclass="pre">dns_location</span></span></a></code>.</p>
<pclass="ansible-option-line"><strongclass="ansible-option-returned-bold">Returned:</strong> changed and if <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method</span></span></a></strong></code> is <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">dns</span></code></p>
<aclass="ansibleOptionLink"href="#return-domain_status"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-emails"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The list of emails used to request validation of this domain.</p>
<p>Domains requested using this module will only have a list of size 1.</p>
<aclass="ansibleOptionLink"href="#return-ev_days_remaining"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
<td><divclass="ansible-option-cell"><p>The number of days the domain remains eligible for submission of “EV” certificates. Will never be greater than the value of <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-ov-days-remaining"><spanclass="std std-ref"><spanclass="pre">ov_days_remaining</span></span></a></code></p>
<aclass="ansibleOptionLink"href="#return-ev_eligible"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">boolean</span></p>
<td><divclass="ansible-option-cell"><p>Whether the domain is eligible for submission of “EV” certificates. Will never be <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">true</span></code> if <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-ov-eligible"><spanclass="std std-ref"><spanclass="pre">ov_eligible</span></span></a></code> is <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">false</span></code></p>
<aclass="ansibleOptionLink"href="#return-file_contents"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<td><divclass="ansible-option-cell"><p>The contents of the file that ECS will be expecting to find at <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-file-location"><spanclass="std std-ref"><spanclass="pre">file_location</span></span></a></code>.</p>
<aclass="ansibleOptionLink"href="#return-file_location"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<td><divclass="ansible-option-cell"><p>The location that ECS will be expecting to be able to find the file for domain verification, containing the contents of <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-file-contents"><spanclass="std std-ref"><spanclass="pre">file_contents</span></span></a></code>.</p>
<aclass="ansibleOptionLink"href="#return-ov_days_remaining"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
<td><divclass="ansible-option-cell"><p>The number of days the domain remains eligible for submission of “OV” certificates. Will never be less than the value of <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-ev-days-remaining"><spanclass="std std-ref"><spanclass="pre">ev_days_remaining</span></span></a></code></p>
<aclass="ansibleOptionLink"href="#return-ov_eligible"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">boolean</span></p>
<td><divclass="ansible-option-cell"><p>Whether the domain is eligible for submission of “OV” certificates. Will never be <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">false</span></code> if <codeclass="ansible-return-value docutils literal notranslate"><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-return-ev-eligible"><spanclass="std std-ref"><spanclass="pre">ev_eligible</span></span></a></code> is <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">true</span></code></p>
<aclass="ansibleOptionLink"href="#return-verification_method"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<td><divclass="ansible-option-cell"><p>Verification method used to request the domain validation. If <codeclass="docutils literal notranslate"><spanclass="pre">changed</span></code> will be the same as <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><spanclass="std std-ref"><spanclass="pre">verification_method</span></span></a></strong></code> input parameter.</p>
<ahref="ecs_certificate_module.html"class="btn btn-neutral float-left"title="community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API"accesskey="p"rel="prev"><spanclass="fa fa-arrow-circle-left"aria-hidden="true"></span> Previous</a>
<ahref="get_certificate_module.html"class="btn btn-neutral float-right"title="community.crypto.get_certificate module – Get a certificate from a host:port"accesskey="n"rel="next">Next <spanclass="fa fa-arrow-circle-right"aria-hidden="true"></span></a>
