1080 lines
113 KiB
HTML
1080 lines
113 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
<title>community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API — Ansible collections documentation</title>
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
|||
|
|
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/sphinx_highlight.js"></script>
|
|||
|
|
<script src="_static/js/theme.js"></script>
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API" href="ecs_domain_module.html" />
|
|||
|
|
<link rel="prev" title="community.crypto.crypto_info module – Retrieve cryptographic capabilities" href="crypto_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
<div class="DocSite-globalNav ansibleNav">
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
|||
|
|
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
|||
|
|
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
|||
|
|
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
|||
|
|
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<a class="DocSite-nav" href="/" style="padding-bottom: 30px;">
|
|||
|
|
|
|||
|
|
<img class="DocSiteNav-logo"
|
|||
|
|
src="_static/images/Ansible-Mark-RGB_White.png"
|
|||
|
|
alt="Ansible Logo">
|
|||
|
|
<div class="DocSiteNav-title">Ansible Collections Documentation</div>
|
|||
|
|
</a>
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
<a href="index.html" class="icon icon-home"> Ansible collections
|
|||
|
|
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<label class="sr-only" for="q">Search docs:</label>
|
|||
|
|
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="docsite/guide_selfsigned.html">How to create self-signed certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="docsite/guide_ownca.html">How to create a small CA</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_account_module.html">community.crypto.acme_account module – Create, modify or delete ACME accounts</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_account_info_module.html">community.crypto.acme_account_info module – Retrieves information on ACME accounts</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_certificate_module.html">community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_certificate_revoke_module.html">community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_challenge_cert_helper_module.html">community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code></a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_inspect_module.html">community.crypto.acme_inspect module – Send direct requests to an ACME server</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="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>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="crypto_info_module.html">community.crypto.crypto_info module – Retrieve cryptographic capabilities</a></li>
|
|||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#attributes">Attributes</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#notes">Notes</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#see-also">See Also</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#return-values">Return Values</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="ecs_domain_module.html">community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="get_certificate_module.html">community.crypto.get_certificate module – Get a certificate from a host:port</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="luks_device_module.html">community.crypto.luks_device module – Manage encrypted (LUKS) devices</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssh_cert_module.html">community.crypto.openssh_cert module – Generate OpenSSH host or user certificates.</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssh_keypair_module.html">community.crypto.openssh_keypair module – Generate OpenSSH private and public keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_csr_module.html">community.crypto.openssl_csr module – Generate OpenSSL Certificate Signing Request (CSR)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_csr_info_module.html">community.crypto.openssl_csr_info module – Provide information of OpenSSL Certificate Signing Requests (CSR)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_csr_pipe_module.html">community.crypto.openssl_csr_pipe module – Generate OpenSSL Certificate Signing Request (CSR)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_dhparam_module.html">community.crypto.openssl_dhparam module – Generate OpenSSL Diffie-Hellman Parameters</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_pkcs12_module.html">community.crypto.openssl_pkcs12 module – Generate OpenSSL PKCS#12 archive</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_module.html">community.crypto.openssl_privatekey module – Generate OpenSSL private keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_convert_module.html">community.crypto.openssl_privatekey_convert module – Convert OpenSSL private keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_info_module.html">community.crypto.openssl_privatekey_info module – Provide information for OpenSSL private keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_pipe_module.html">community.crypto.openssl_privatekey_pipe module – Generate OpenSSL private keys without disk access</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_publickey_module.html">community.crypto.openssl_publickey module – Generate an OpenSSL public key from its private key.</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_publickey_info_module.html">community.crypto.openssl_publickey_info module – Provide information for OpenSSL public keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_signature_module.html">community.crypto.openssl_signature module – Sign data with openssl</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_signature_info_module.html">community.crypto.openssl_signature_info module – Verify signatures with openssl</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_module.html">community.crypto.x509_certificate module – Generate and/or check OpenSSL certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_info_module.html">community.crypto.x509_certificate_info module – Provide information of OpenSSL X.509 certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_pipe_module.html">community.crypto.x509_certificate_pipe module – Generate and/or check OpenSSL certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_crl_module.html">community.crypto.x509_crl module – Generate Certificate Revocation Lists (CRLs)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_crl_info_module.html">community.crypto.x509_crl_info module – Retrieve information on Certificate Revocation Lists (CRLs)</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">Ansible collections</a>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
<div class="rst-content">
|
|||
|
|
<div role="navigation" aria-label="Page navigation">
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
<li><a href="index.html" class="icon icon-home"></a></li>
|
|||
|
|
<li class="breadcrumb-item active">community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API</li>
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
<!-- User defined GitHub URL -->
|
|||
|
|
<a href="https://github.com/ansible-collections/community.crypto/edit/main/plugins/modules/ecs_certificate.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>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<span class="target" id="ansible-collections-community-crypto-ecs-certificate-module"></span><section id="community-crypto-ecs-certificate-module-request-ssl-tls-certificates-with-the-entrust-certificate-services-ecs-api">
|
|||
|
|
<h1>community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API<a class="headerlink" href="#community-crypto-ecs-certificate-module-request-ssl-tls-certificates-with-the-entrust-certificate-services-ecs-api" title="Permalink to this heading"></a></h1>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.9.0).</p>
|
|||
|
|
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.crypto</span></code>.
|
|||
|
|
You need further requirements to be able to use this module,
|
|||
|
|
see <a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
|||
|
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.crypto.ecs_certificate</span></code>.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="contents local topic" id="contents">
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#attributes" id="id4">Attributes</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#notes" id="id5">Notes</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#see-also" id="id6">See Also</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#examples" id="id7">Examples</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#return-values" id="id8">Return Values</a></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<section id="synopsis">
|
|||
|
|
<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Create, reissue, and renew certificates with the Entrust Certificate Services (ECS) API.</p></li>
|
|||
|
|
<li><p>Requires credentials for the <a class="reference external" href="https://www.entrustdatacard.com/products/categories/ssl-certificates">Entrust Certificate Services</a> (ECS) API.</p></li>
|
|||
|
|
<li><p>In order to request a certificate, the domain and organization used in the certificate signing request must be already validated in the ECS system. It is <em>not</em> the responsibility of this module to perform those steps.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section id="requirements">
|
|||
|
|
<span id="ansible-collections-community-crypto-ecs-certificate-module-requirements"></span><h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
|||
|
|
<p>The below requirements are needed on the host that executes this module.</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>PyYAML >= 3.11</p></li>
|
|||
|
|
<li><p>cryptography >= 1.6</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section id="parameters">
|
|||
|
|
<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
|
|||
|
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|||
|
|
<th class="head"><p>Comments</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-additional_emails"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-additional-emails"><strong>additional_emails</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-additional_emails" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>A list of additional email addresses to receive the delivery notice and expiry notification for the certificate.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-backup"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-backup"><strong>backup</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-backup" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Whether a backup should be made for the certificate in <em>path</em>.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-cert_expiry"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-expiry"><strong>cert_expiry</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-cert_expiry" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The date the certificate should be set to expire, in RFC3339 compliant date or date-time format. For example, <code class="docutils literal notranslate"><span class="pre">2020-02-23</span></code>, <code class="docutils literal notranslate"><span class="pre">2020-02-23T15:00:00.05Z</span></code>.</p>
|
|||
|
|
<p><em>cert_expiry</em> is only supported for requests of <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>. If <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code>, <em>cert_expiry</em> will be used for the first certificate issuance, but subsequent issuances will have the same expiry as the initial certificate.</p>
|
|||
|
|
<p>A reissued certificate will always have the same expiry as the original certificate.</p>
|
|||
|
|
<p>Note that only the date (day, month, year) is supported for specifying the expiry date. If you choose to specify an expiry time with the expiry date, the time will be adjusted to Eastern Standard Time (EST). This could have the unintended effect of moving your expiry date to the previous day.</p>
|
|||
|
|
<p>Applies only to accounts with a pooling inventory model.</p>
|
|||
|
|
<p>Only one of <em>cert_expiry</em> or <em>cert_lifetime</em> may be specified.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-cert_lifetime"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-lifetime"><strong>cert_lifetime</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-cert_lifetime" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The lifetime of the certificate.</p>
|
|||
|
|
<p>Applies to all certificates for accounts with a non-pooling inventory model.</p>
|
|||
|
|
<p><em>cert_lifetime</em> is only supported for requests of <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>. If <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code>, <em>cert_lifetime</em> will be used for the first certificate issuance, but subsequent issuances will have the same expiry as the initial certificate.</p>
|
|||
|
|
<p>Applies to certificates of <em>cert_type</em>=<code class="docutils literal notranslate"><span class="pre">CDS_INDIVIDUAL,</span> <span class="pre">CDS_GROUP,</span> <span class="pre">CDS_ENT_LITE,</span> <span class="pre">CDS_ENT_PRO,</span> <span class="pre">SMIME_ENT</span></code> for accounts with a pooling inventory model.</p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">P1Y</span></code> is a certificate with a 1 year lifetime.</p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">P2Y</span></code> is a certificate with a 2 year lifetime.</p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">P3Y</span></code> is a certificate with a 3 year lifetime.</p>
|
|||
|
|
<p>Only one of <em>cert_expiry</em> or <em>cert_lifetime</em> may be specified.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"P1Y"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"P2Y"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"P3Y"</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-cert_type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-type"><strong>cert_type</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-cert_type" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Specify the type of certificate requested.</p>
|
|||
|
|
<p>If a certificate is being reissued or renewed, this parameter is ignored, and the <code class="docutils literal notranslate"><span class="pre">cert_type</span></code> of the initial certificate is used.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"STANDARD_SSL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ADVANTAGE_SSL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"UC_SSL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"EV_SSL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"WILDCARD_SSL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"PRIVATE_SSL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"PD_SSL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"CODE_SIGNING"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"EV_CODE_SIGNING"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"CDS_INDIVIDUAL"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"CDS_GROUP"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"CDS_ENT_LITE"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"CDS_ENT_PRO"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"SMIME_ENT"</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-client_id"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-client-id"><strong>client_id</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The client ID to submit the Certificate Signing Request under.</p>
|
|||
|
|
<p>If no client ID is specified, the certificate will be submitted under the primary client with ID of 1.</p>
|
|||
|
|
<p>When using a client other than the primary client, the <em>org</em> parameter cannot be specified.</p>
|
|||
|
|
<p>The issued certificate will have an organization value in the subject distinguished name represented by the client.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">1</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-csr"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><strong>csr</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-csr" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Base-64 encoded Certificate Signing Request (CSR). <em>csr</em> is accepted with or without PEM formatting around the Base-64 string.</p>
|
|||
|
|
<p>If no <em>csr</em> is provided when <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, the certificate will be generated with the same public key as the certificate being renewed or reissued.</p>
|
|||
|
|
<p>If <em>subject_alt_name</em> is specified, it will override the subject alternate names in the CSR.</p>
|
|||
|
|
<p>If <em>eku</em> is specified, it will override the extended key usage in the CSR.</p>
|
|||
|
|
<p>If <em>ou</em> is specified, it will override the organizational units “ou=” present in the subject distinguished name of the CSR, if any.</p>
|
|||
|
|
<p>The organization “O=” field from the CSR will not be used. It will be replaced in the issued certificate by <em>org</em> if present, and if not present, the organization tied to <em>client_id</em>.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-ct_log"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-ct-log"><strong>ct_log</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-ct_log" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>In compliance with browser requirements, this certificate may be posted to the Certificate Transparency (CT) logs. This is a best practice technique that helps domain owners monitor certificates issued to their domains. Note that not all certificates are eligible for CT logging.</p>
|
|||
|
|
<p>If <em>ct_log</em> is not specified, the certificate uses the account default.</p>
|
|||
|
|
<p>If <em>ct_log</em> is specified and the account settings allow it, <em>ct_log</em> overrides the account default.</p>
|
|||
|
|
<p>If <em>ct_log</em> is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, but the account settings are set to “always log”, the certificate generation will fail.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields"><strong>custom_fields</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Mapping of custom fields to associate with the certificate request and certificate.</p>
|
|||
|
|
<p>Only supported if custom fields are enabled for your account.</p>
|
|||
|
|
<p>Each custom field specified must be a custom field you have defined for your account.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/date1"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-date1"><strong>date1</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/date1" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom date field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/date2"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-date2"><strong>date2</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/date2" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom date field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/date3"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-date3"><strong>date3</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/date3" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom date field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/date4"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-date4"><strong>date4</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/date4" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom date field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/date5"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-date5"><strong>date5</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/date5" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom date field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/dropdown1"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-dropdown1"><strong>dropdown1</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/dropdown1" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom dropdown field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/dropdown2"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-dropdown2"><strong>dropdown2</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/dropdown2" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom dropdown field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/dropdown3"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-dropdown3"><strong>dropdown3</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/dropdown3" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom dropdown field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/dropdown4"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-dropdown4"><strong>dropdown4</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/dropdown4" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom dropdown field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/dropdown5"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-dropdown5"><strong>dropdown5</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/dropdown5" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom dropdown field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/email1"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-email1"><strong>email1</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/email1" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom email field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/email2"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-email2"><strong>email2</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/email2" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom email field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/email3"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-email3"><strong>email3</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/email3" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom email field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/email4"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-email4"><strong>email4</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/email4" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom email field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/email5"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-email5"><strong>email5</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/email5" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom email field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/number1"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-number1"><strong>number1</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/number1" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom number field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/number2"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-number2"><strong>number2</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/number2" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom number field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/number3"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-number3"><strong>number3</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/number3" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom number field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/number4"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-number4"><strong>number4</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/number4" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom number field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/number5"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-number5"><strong>number5</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/number5" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom number field.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text1"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text1"><strong>text1</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text1" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text10"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text10"><strong>text10</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text10" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text11"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text11"><strong>text11</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text11" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text12"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text12"><strong>text12</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text12" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text13"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text13"><strong>text13</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text13" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text14"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text14"><strong>text14</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text14" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text15"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text15"><strong>text15</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text15" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text2"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text2"><strong>text2</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text2" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text3"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text3"><strong>text3</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text3" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text4"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text4"><strong>text4</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text4" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text5"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text5"><strong>text5</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text5" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text6"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text6"><strong>text6</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text6" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text7"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text7"><strong>text7</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text7" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text8"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text8"><strong>text8</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text8" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-custom_fields/text9"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-custom-fields-text9"><strong>text9</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-custom_fields/text9" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Custom text field (maximum 500 characters)</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-eku"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-eku"><strong>eku</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-eku" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>If specified, overrides the key usage in the <em>csr</em>.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"SERVER_AUTH"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"CLIENT_AUTH"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"SERVER_AND_CLIENT_AUTH"</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-end_user_key_storage_agreement"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-end-user-key-storage-agreement"><strong>end_user_key_storage_agreement</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-end_user_key_storage_agreement" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The end user of the Code Signing certificate must generate and store the private key for this request on cryptographically secure hardware to be compliant with the Entrust CSP and Subscription agreement. If requesting a certificate of type <code class="docutils literal notranslate"><span class="pre">CODE_SIGNING</span></code> or <code class="docutils literal notranslate"><span class="pre">EV_CODE_SIGNING</span></code>, you must set <em>end_user_key_storage_agreement</em> to true if and only if you acknowledge that you will inform the user of this requirement.</p>
|
|||
|
|
<p>Applicable only to <em>cert_type</em> of values <code class="docutils literal notranslate"><span class="pre">CODE_SIGNING</span></code> and <code class="docutils literal notranslate"><span class="pre">EV_CODE_SIGNING</span></code>.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-entrust_api_client_cert_key_path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-entrust-api-client-cert-key-path"><strong>entrust_api_client_cert_key_path</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-entrust_api_client_cert_key_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The path to the key for the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-entrust_api_client_cert_path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-entrust-api-client-cert-path"><strong>entrust_api_client_cert_path</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-entrust_api_client_cert_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The path to the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-entrust_api_key"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-entrust-api-key"><strong>entrust_api_key</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-entrust_api_key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The key (password) for authentication to the Entrust Certificate Services (ECS) API.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-entrust_api_specification_path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-entrust-api-specification-path"><strong>entrust_api_specification_path</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-entrust_api_specification_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="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>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://cloud.entrust.net/EntrustCloud/documentation/cms-api-2.1.0.yaml"</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-entrust_api_user"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-entrust-api-user"><strong>entrust_api_user</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-entrust_api_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The username for authentication to the Entrust Certificate Services (ECS) API.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><strong>force</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-force" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>If force is used, a certificate is requested regardless of whether <em>path</em> points to an existing valid certificate.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, a forced renew will fail if the certificate being renewed has been issued within the past 30 days, regardless of the value of <em>remaining_days</em> or the return value of <em>cert_days</em> - the ECS API does not support the “renew” operation for certificates that are not at least 30 days old.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-full_chain_path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-full-chain-path"><strong>full_chain_path</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-full_chain_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The destination path for the full certificate chain of the certificate, intermediates, and roots.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-org"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-org"><strong>org</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-org" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Organization “O=” to include in the certificate.</p>
|
|||
|
|
<p>If <em>org</em> is not specified, the organization from the client represented by <em>client_id</em> is used.</p>
|
|||
|
|
<p>Unless the <em>cert_type</em> is <code class="docutils literal notranslate"><span class="pre">PD_SSL</span></code>, this field may not be specified if the value of <em>client_id</em> is not “1” (the primary client). non-primary clients, certificates may only be issued with the organization of that client.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-ou"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><strong>ou</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-ou" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Organizational unit “OU=” to include in the certificate.</p>
|
|||
|
|
<p><em>ou</em> behavior is dependent on whether organizational units are enabled for your account. If organizational unit support is disabled for your account, organizational units from the <em>csr</em> and the <em>ou</em> parameter are ignored.</p>
|
|||
|
|
<p>If both <em>csr</em> and <em>ou</em> are specified, the value in <em>ou</em> will override the OU fields present in the subject distinguished name in the <em>csr</em></p>
|
|||
|
|
<p>If neither <em>csr</em> nor <em>ou</em> are specified for a renew or reissue operation, the OU fields in the initial certificate are reused.</p>
|
|||
|
|
<p>An invalid OU from <em>csr</em> is ignored, but any invalid organizational units in <em>ou</em> will result in an error indicating “Unapproved OU”. The <em>ou</em> parameter can be used to force failure if an unapproved organizational unit is provided.</p>
|
|||
|
|
<p>A maximum of one OU may be specified for current products. Multiple OUs are reserved for future products.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><strong>path</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The destination path for the generated certificate as a PEM encoded cert.</p>
|
|||
|
|
<p>If the certificate at this location is not an Entrust issued certificate, a new certificate will always be requested even if the current certificate is technically valid.</p>
|
|||
|
|
<p>If there is already an Entrust certificate at this location, whether it is replaced is depends on the <em>remaining_days</em> calculation.</p>
|
|||
|
|
<p>If an existing certificate is being replaced (see <em>remaining_days</em>, <em>force</em>, and <em>tracking_id</em>), whether a new certificate is requested or the existing certificate is renewed or reissued is based on <em>request_type</em>.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-remaining_days"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><strong>remaining_days</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-remaining_days" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The number of days the certificate must have left being valid. If <code class="docutils literal notranslate"><span class="pre">cert_days</span> <span class="pre"><</span> <span class="pre">remaining_days</span></code> then a new certificate will be obtained using <em>request_type</em>.</p>
|
|||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, a renewal will fail if the certificate being renewed has been issued within the past 30 days, so do not set a <em>remaining_days</em> value that is within 30 days of the full lifetime of the certificate being acted upon.</p>
|
|||
|
|
<p>For exmaple, if you are requesting Certificates with a 90 day lifetime, do not set <em>remaining_days</em> to a value <code class="docutils literal notranslate"><span class="pre">60</span></code> or higher).</p>
|
|||
|
|
<p>The <em>force</em> option may be used to ensure that a new certificate is always obtained.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">30</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-request_type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><strong>request_type</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-request_type" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The operation performed if <em>tracking_id</em> references a valid certificate to reissue, or there is already a certificate present in <em>path</em> but either <em>force</em> is specified or <code class="docutils literal notranslate"><span class="pre">cert_days</span> <span class="pre"><</span> <span class="pre">remaining_days</span></code>.</p>
|
|||
|
|
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=validate_only</span></code> means the request will be validated against the ECS API, but no certificate will be issued.</p>
|
|||
|
|
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> means a certificate request will always be submitted and a new certificate issued.</p>
|
|||
|
|
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code> means that an existing certificate (specified by <em>tracking_id</em> if present, otherwise <em>path</em>) will be renewed. If there is no certificate to renew, a new certificate is requested.</p>
|
|||
|
|
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code> means that an existing certificate (specified by <em>tracking_id</em> if present, otherwise <em>path</em>) will be reissued. If there is no certificate to reissue, a new certificate is requested.</p>
|
|||
|
|
<p>If a certificate was issued within the past 30 days, the <code class="docutils literal notranslate"><span class="pre">renew</span></code> operation is not a valid operation and will fail.</p>
|
|||
|
|
<p>Note that <code class="docutils literal notranslate"><span class="pre">reissue</span></code> is an operation that will result in the revocation of the certificate that is reissued, be cautious with its use.</p>
|
|||
|
|
<p><em>check_mode</em> is only supported if <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code></p>
|
|||
|
|
<p>For example, setting <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code> and <code class="docutils literal notranslate"><span class="pre">remaining_days=30</span></code> and pointing to the same certificate on multiple playbook runs means that on the first run new certificate will be requested. It will then be left along on future runs until it is within 30 days of expiry, then the ECS “renew” operation will be performed.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"new"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"renew"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"reissue"</span></code></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"validate_only"</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-requester_email"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-requester-email"><strong>requester_email</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-requester_email" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The requester email to associate with certificate tracking information and receive delivery and expiry notices for the certificate.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-requester_name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-requester-name"><strong>requester_name</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-requester_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The requester name to associate with certificate tracking information.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-requester_phone"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-requester-phone"><strong>requester_phone</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-requester_phone" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The requester phone number to associate with certificate tracking information.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-subject_alt_name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-subject-alt-name"><strong>subject_alt_name</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-subject_alt_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The subject alternative name identifiers, as an array of values (applies to <em>cert_type</em> with a value of <code class="docutils literal notranslate"><span class="pre">STANDARD_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">ADVANTAGE_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">UC_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">EV_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">WILDCARD_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">PRIVATE_SSL</span></code>, and <code class="docutils literal notranslate"><span class="pre">PD_SSL</span></code>).</p>
|
|||
|
|
<p>If you are requesting a new SSL certificate, and you pass a <em>subject_alt_name</em> parameter, any SAN names in the CSR are ignored. If no subjectAltName parameter is passed, the SAN names in the CSR are used.</p>
|
|||
|
|
<p>See <em>request_type</em> to understand more about SANs during reissues and renewals.</p>
|
|||
|
|
<p>In the case of certificates of type <code class="docutils literal notranslate"><span class="pre">STANDARD_SSL</span></code> certificates, if the CN of the certificate is <domain>.<tld> only the www.<domain>.<tld> value is accepted. If the CN of the certificate is www.<domain>.<tld> only the <domain>.<tld> value is accepted.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-tracking_id"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><strong>tracking_id</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-tracking_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The tracking ID of the certificate to reissue or renew.</p>
|
|||
|
|
<p><em>tracking_id</em> is invalid if <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=validate_only</span></code>.</p>
|
|||
|
|
<p>If there is a certificate present in <em>path</em> and it is an ECS certificate, <em>tracking_id</em> will be ignored.</p>
|
|||
|
|
<p>If there is no certificate present in <em>path</em> or there is but it is from another provider, the certificate represented by <em>tracking_id</em> will be renewed or reissued and saved to <em>path</em>.</p>
|
|||
|
|
<p>If there is no certificate present in <em>path</em> and the <em>force</em> and <em>remaining_days</em> parameters do not indicate a new certificate is needed, the certificate referenced by <em>tracking_id</em> certificate will be saved to <em>path</em>.</p>
|
|||
|
|
<p>This can be used when a known certificate is not currently present on a server, but you want to renew or reissue it to be managed by an ansible playbook. For example, if you specify <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, <em>tracking_id</em> of an issued certificate, and <em>path</em> to a file that does not exist, the first run of a task will download the certificate specified by <em>tracking_id</em> (assuming it is still valid). Future runs of the task will (if applicable - see <em>force</em> and <em>remaining_days</em>) renew the certificate now present in <em>path</em>.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-tracking_info"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-info"><strong>tracking_info</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-tracking_info" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Free form tracking information to attach to the record for the certificate.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</section>
|
|||
|
|
<section id="attributes">
|
|||
|
|
<h2><a class="toc-backref" href="#id4">Attributes</a><a class="headerlink" href="#attributes" title="Permalink to this heading"></a></h2>
|
|||
|
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
|
|||
|
|
<th class="head"><p>Support</p></th>
|
|||
|
|
<th class="head"><p>Description</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-attribute-check-mode"><strong>check_mode</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-partial">partial</span></p>
|
|||
|
|
<p>Check mode is only supported if <em>request_type=new</em>.</p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-attribute-diff-mode"><strong>diff_mode</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-none">none</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="attribute-safe_file_operations"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-attribute-safe-file-operations"><strong>safe_file_operations</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#attribute-safe_file_operations" title="Permalink to this attribute"></a></div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-full">full</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Uses Ansible’s strict file operation functions to ensure proper permissions and avoid data corruption.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</section>
|
|||
|
|
<section id="notes">
|
|||
|
|
<h2><a class="toc-backref" href="#id5">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading"></a></h2>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">path</span></code> must be specified as the output location of the certificate.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="see-also">
|
|||
|
|
<h2><a class="toc-backref" href="#id6">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt><a class="reference internal" href="openssl_privatekey_module.html#ansible-collections-community-crypto-openssl-privatekey-module"><span class="std std-ref">community.crypto.openssl_privatekey</span></a></dt><dd><p>Can be used to create private keys (both for certificates and accounts).</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt><a class="reference internal" href="openssl_csr_module.html#ansible-collections-community-crypto-openssl-csr-module"><span class="std std-ref">community.crypto.openssl_csr</span></a></dt><dd><p>Can be used to create a Certificate Signing Request (CSR).</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="examples">
|
|||
|
|
<h2><a class="toc-backref" href="#id7">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
|
|||
|
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Request a new certificate from Entrust with bare minimum parameters.</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Will request a new certificate if current one is valid but within 30</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">days of expiry. If replacing an existing file in path, will back it up.</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.ecs_certificate</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">backup</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">full_chain_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.chain.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">csr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/ansible.com.csr</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">cert_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">EV_SSL</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Jo Doe</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_email</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">jdoe@ansible.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_phone</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">555-555-5555</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apiusername</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a^lv*32!cd9LnT</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_key_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.key</span><span class="w"></span>
|
|||
|
|
|
|||
|
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">If there is no certificate present in path, request a new certificate</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">of type EV_SSL. Otherwise, if there is an Entrust managed certificate</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">in path and it is within 63 days of expiration, request a renew of that</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">certificate.</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.ecs_certificate</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">csr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/ansible.com.csr</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">cert_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">EV_SSL</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">cert_expiry</span><span class="p">:</span><span class="w"> </span><span class="s">'2020-08-20'</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">request_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">renew</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">remaining_days</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">63</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Jo Doe</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_email</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">jdoe@ansible.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_phone</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">555-555-5555</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apiusername</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a^lv*32!cd9LnT</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_key_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.key</span><span class="w"></span>
|
|||
|
|
|
|||
|
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">If there is no certificate present in path, download certificate</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">specified by tracking_id if it is still valid. Otherwise, if the</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">certificate is within 79 days of expiration, request a renew of that</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">certificate and save it in path. This can be used to "migrate" a</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">certificate to be Ansible managed.</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.ecs_certificate</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">csr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/ansible.com.csr</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">tracking_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2378915</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">request_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">renew</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">remaining_days</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">79</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apiusername</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a^lv*32!cd9LnT</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_key_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.key</span><span class="w"></span>
|
|||
|
|
|
|||
|
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Force a reissue of the certificate specified by tracking_id.</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.ecs_certificate</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">force</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">tracking_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2378915</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">request_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">reissue</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apiusername</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a^lv*32!cd9LnT</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_key_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.key</span><span class="w"></span>
|
|||
|
|
|
|||
|
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Request a new certificate with an alternative client. Note that the</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">issued certificate will have it's Subject Distinguished Name use the</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">organization details associated with that client, rather than what is</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">in the CSR.</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.ecs_certificate</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">csr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/ansible.com.csr</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">client_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Jo Doe</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_email</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">jdoe@ansible.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_phone</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">555-555-5555</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apiusername</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a^lv*32!cd9LnT</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_key_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.key</span><span class="w"></span>
|
|||
|
|
|
|||
|
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Request a new certificate with a number of CSR parameters overridden</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">and tracking information</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.ecs_certificate</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">full_chain_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/crt/ansible.com.chain.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">csr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/ansible.com.csr</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">subject_alt_name</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ansible.testcertificates.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">www.testcertificates.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">eku</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SERVER_AND_CLIENT_AUTH</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">ct_log</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">org</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Test Organization Inc.</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">ou</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Administration</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">tracking_info</span><span class="p">:</span><span class="w"> </span><span class="s">"Submitted</span><span class="nv"> </span><span class="s">via</span><span class="nv"> </span><span class="s">Ansible"</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">additional_emails</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">itsupport@testcertificates.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">jsmith@ansible.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">custom_fields</span><span class="p">:</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">text1</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Admin</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">text2</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Invoice 25</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">number1</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">342</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">date1</span><span class="p">:</span><span class="w"> </span><span class="s">'2018-01-01'</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">email1</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sales@ansible.testcertificates.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">dropdown1</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">red</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">cert_expiry</span><span class="p">:</span><span class="w"> </span><span class="s">'2020-08-15'</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Jo Doe</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_email</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">jdoe@ansible.com</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">requester_phone</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">555-555-5555</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_user</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apiusername</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">a^lv*32!cd9LnT</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.crt</span><span class="w"></span>
|
|||
|
|
<span class="w"> </span><span class="nt">entrust_api_client_cert_key_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/entrust/ecs-client.key</span><span class="w"></span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="return-values">
|
|||
|
|
<h2><a class="toc-backref" href="#id8">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
|
|||
|
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
|||
|
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
|||
|
|
<th class="head"><p>Description</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-backup_file"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-backup-file"><strong>backup_file</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-backup_file" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Name of backup file created for the certificate.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/www.ansible.com.crt.2019-03-09@11:22~"</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-backup_full_chain_file"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-backup-full-chain-file"><strong>backup_full_chain_file</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-backup_full_chain_file" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Name of the backup file created for the certificate chain.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code> and <em>full_chain_path</em> is set.</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/ca.chain.crt.2019-03-09@11:22~"</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-cert_days"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-cert-days"><strong>cert_days</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-cert_days" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The number of days the certificate remains valid.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">253</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-cert_details"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-cert-details"><strong>cert_details</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-cert_details" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The full response JSON from the Get Certificate call of the ECS API.</p>
|
|||
|
|
<p>While the response contents are guaranteed to be forwards compatible with new ECS API releases, Entrust recommends that you do not make any playbooks take actions based on the content of this field. However it may be useful for debugging, logging, or auditing purposes.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-cert_status"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-cert-status"><strong>cert_status</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-cert_status" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The certificate status in ECS.</p>
|
|||
|
|
<p>Current possible values (which may be expanded in the future) are: <code class="docutils literal notranslate"><span class="pre">ACTIVE</span></code>, <code class="docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code>, <code class="docutils literal notranslate"><span class="pre">DECLINED</span></code>, <code class="docutils literal notranslate"><span class="pre">EXPIRED</span></code>, <code class="docutils literal notranslate"><span class="pre">NA</span></code>, <code class="docutils literal notranslate"><span class="pre">PENDING</span></code>, <code class="docutils literal notranslate"><span class="pre">PENDING_QUORUM</span></code>, <code class="docutils literal notranslate"><span class="pre">READY</span></code>, <code class="docutils literal notranslate"><span class="pre">REISSUED</span></code>, <code class="docutils literal notranslate"><span class="pre">REISSUING</span></code>, <code class="docutils literal notranslate"><span class="pre">RENEWED</span></code>, <code class="docutils literal notranslate"><span class="pre">RENEWING</span></code>, <code class="docutils literal notranslate"><span class="pre">REVOKED</span></code>, <code class="docutils literal notranslate"><span class="pre">SUSPENDED</span></code></p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"ACTIVE"</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-filename"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-filename"><strong>filename</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-filename" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The destination path for the generated certificate.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/etc/ssl/crt/www.ansible.com.crt"</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-serial_number"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-serial-number"><strong>serial_number</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-serial_number" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The serial number of the issued certificate.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">1235262234164342</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-tracking_id"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-return-tracking-id"><strong>tracking_id</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-tracking_id" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The tracking ID to reference and track the certificate in ECS.</p>
|
|||
|
|
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">380079</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<section id="authors">
|
|||
|
|
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h3>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Chris Trufan (@ctrufan)</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section id="collection-links">
|
|||
|
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading"></a></h3>
|
|||
|
|
<p class="ansible-links">
|
|||
|
|
<a href="https://github.com/ansible-collections/community.crypto/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
|||
|
|
<a href="https://github.com/ansible-collections/community.crypto" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
|||
|
|
<a href="https://github.com/ansible-collections/community.crypto/issues/new?assignees=&labels=&template=bug_report.md" aria-role="button" target="_blank" rel="noopener external">Submit a bug report</a>
|
|||
|
|
<a href="https://github.com/ansible-collections/community.crypto/issues/new?assignees=&labels=&template=feature_request.md" aria-role="button" target="_blank" rel="noopener external">Request a feature</a>
|
|||
|
|
<a href="./#communication-for-community-crypto" aria-role="button" target="_blank">Communication</a>
|
|||
|
|
</p></section>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|||
|
|
<a href="crypto_info_module.html" class="btn btn-neutral float-left" title="community.crypto.crypto_info module – Retrieve cryptographic capabilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
<a href="ecs_domain_module.html" class="btn btn-neutral float-right" title="community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>© Copyright Ansible contributors.</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
</div>
|
|||
|
|
<script>
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|