deploy: 0d4b16aadb
parent
9289aa5a1d
commit
521cc1b17d
|
@ -390,7 +390,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -491,7 +491,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-state"><span class="std std-ref"><span class="pre">state=changed_key</span></span></a></code> is used, the module is not idempotent.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -344,7 +344,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -379,7 +379,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -629,7 +629,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code>, the module is not idempotent. If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force=false</span></span></a></code>, it depends on the certificate’s validity period and the value of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code>.</p>
|
||||
<p>The second phase invocation of the module is always idempotent, assuming no error occurs.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -399,7 +399,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -409,7 +409,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -299,7 +299,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-none">none</strong></p>
|
||||
<p>The certificates returned are never the same, since the Not Before and Not After timestamps depend on the invocation’s timestamp.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -416,7 +416,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-none">none</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -285,7 +285,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ce
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -231,7 +231,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -826,7 +826,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
|||
<p>The module is not idempotent if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code>.</p>
|
||||
<p>Under which conditions the module is idempotent still needs to be determined. If you are using this module and have more information, please contribute to the documentation!</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -348,7 +348,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>Under which conditions the module is idempotent still needs to be determined. If you are using this module and have more information, please contribute to the documentation!</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -392,7 +392,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -340,6 +340,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Adds additional passphrase to given container on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code>. Needs <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> option for authorization. LUKS container supports up to 8 keyslots. Parameter value is a string with the new passphrase.</p>
|
||||
<p>NOTE that adding additional passphrase is idempotent only since community.crypto 1.4.0. For older versions, a new keyslot will be used even if another keyslot already exists for this passphrase.</p>
|
||||
<p><strong>Note</strong> that the passphrase must be UTF-8 encoded text. If you want to use arbitrary binary data, or text using another encoding, use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase-encoding"><span class="std std-ref"><span class="pre">passphrase_encoding</span></span></a></strong></code> option and provide the passphrase Base64 encoded.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
|
@ -348,9 +349,28 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p><em class="ansible-option-versionadded">added in community.crypto 1.0.0</em></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Used to unlock the container. Either a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> or a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> is needed for most of the operations. Parameter value is a string with the passphrase.</p>
|
||||
<p><strong>Note</strong> that the passphrase must be UTF-8 encoded text. If you want to use arbitrary binary data, or text using another encoding, use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase-encoding"><span class="std std-ref"><span class="pre">passphrase_encoding</span></span></a></strong></code> option and provide the passphrase Base64 encoded.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-passphrase_encoding"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-passphrase-encoding"><strong>passphrase_encoding</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-passphrase_encoding" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.23.0</em></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Determine how passphrases are provided to parameters such as <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-new-passphrase"><span class="std std-ref"><span class="pre">new_passphrase</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-remove-passphrase"><span class="std std-ref"><span class="pre">remove_passphrase</span></span></a></strong></code>.</p>
|
||||
<p>Please note that binary passphrases cannot contain all possible binary octets. For example, a newline (0x0A) cannot be used since it indicates that the passphrase is over. If you want to use arbitrary binary data, you must use keyfiles.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"base64"</span></code>:
|
||||
The passphrase is provided as Base64 encoded bytes.</p>
|
||||
<p>Use the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/builtin/b64encode_filter.html#ansible-collections-ansible-builtin-b64encode-filter" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.builtin.b64encode</span></a> filter to Base64-encode binary data.</p>
|
||||
</li>
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"text"</span></strong></code> <span class="ansible-option-choices-default-mark">(default)</span>:
|
||||
The passphrase is provided as UTF-8 encoded text.</p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pbkdf"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-pbkdf"><strong>pbkdf</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pbkdf" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 1.4.0</em></p>
|
||||
|
@ -359,7 +379,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p>Will only be used on container creation, and when adding keys to an existing container.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pbkdf/algorithm"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-algorithm"><strong>algorithm</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pbkdf/algorithm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
|
@ -373,7 +393,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pbkdf/iteration_count"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-iteration-count"><strong>iteration_count</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pbkdf/iteration_count" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
|
@ -381,7 +401,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-iteration-time"><span class="std std-ref"><span class="pre">pbkdf.iteration_time</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pbkdf/iteration_time"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-iteration-time"><strong>iteration_time</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pbkdf/iteration_time" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">float</span></p>
|
||||
</div></td>
|
||||
|
@ -390,7 +410,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-iteration-count"><span class="std std-ref"><span class="pre">pbkdf.iteration_count</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pbkdf/memory"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-memory"><strong>memory</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pbkdf/memory" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
|
@ -398,7 +418,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p>This is not used for PBKDF2, but only for the Argon PBKDFs.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-pbkdf/parallel"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-parallel"><strong>parallel</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-pbkdf/parallel" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
|
@ -406,7 +426,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p>This is not used for PBKDF2, but only for the Argon PBKDFs.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-perf_no_read_workqueue"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-perf-no-read-workqueue"><strong>perf_no_read_workqueue</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-perf_no_read_workqueue" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.3.0</em></p>
|
||||
|
@ -420,7 +440,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-perf_no_write_workqueue"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-perf-no-write-workqueue"><strong>perf_no_write_workqueue</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-perf_no_write_workqueue" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.3.0</em></p>
|
||||
|
@ -434,7 +454,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-perf_same_cpu_crypt"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-perf-same-cpu-crypt"><strong>perf_same_cpu_crypt</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-perf_same_cpu_crypt" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.3.0</em></p>
|
||||
|
@ -449,7 +469,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-perf_submit_from_crypt_cpus"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-perf-submit-from-crypt-cpus"><strong>perf_submit_from_crypt_cpus</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-perf_submit_from_crypt_cpus" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.3.0</em></p>
|
||||
|
@ -465,7 +485,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-persistent"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-persistent"><strong>persistent</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-persistent" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.3.0</em></p>
|
||||
|
@ -480,7 +500,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remove_keyfile"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-remove-keyfile"><strong>remove_keyfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remove_keyfile" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
|
@ -490,7 +510,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p>BEWARE that working with keyfiles in plaintext is dangerous. Make sure that they are protected.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remove_keyslot"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-remove-keyslot"><strong>remove_keyslot</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remove_keyslot" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.16.0</em></p>
|
||||
|
@ -500,7 +520,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p><strong>Note</strong> that the given <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> must not be in the slot to be removed.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remove_passphrase"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-remove-passphrase"><strong>remove_passphrase</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remove_passphrase" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 1.0.0</em></p>
|
||||
|
@ -508,9 +528,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<td><div class="ansible-option-cell"><p>Removes given passphrase from the container on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code>. Parameter value is a string with the passphrase to remove.</p>
|
||||
<p>NOTE that removing passphrases is idempotent only since community.crypto 1.4.0. For older versions, trying to remove a passphrase which no longer exists results in an error.</p>
|
||||
<p>NOTE that to remove the last keyslot from a LUKS container, the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-force-remove-last-key"><span class="std std-ref"><span class="pre">force_remove_last_key</span></span></a></strong></code> option must be set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p><strong>Note</strong> that the passphrase must be UTF-8 encoded text. If you want to use arbitrary binary data, or text using another encoding, use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase-encoding"><span class="std std-ref"><span class="pre">passphrase_encoding</span></span></a></strong></code> option and provide the passphrase Base64 encoded.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-sector_size"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-sector-size"><strong>sector_size</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-sector_size" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 1.5.0</em></p>
|
||||
|
@ -519,7 +540,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<p>Will only be used on container creation.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
</div></td>
|
||||
|
@ -537,7 +558,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-type"><strong>type</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 1.0.0</em></p>
|
||||
|
@ -550,7 +571,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-uuid"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-uuid"><strong>uuid</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-uuid" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 1.0.0</em></p>
|
||||
|
@ -593,7 +614,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
Binary file not shown.
|
@ -550,7 +550,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<p>The module is not idempotent if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate=always</span></span></a></code>.</p>
|
||||
<p>If relative timestamps are used and <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code> (default), the module is not idempotent.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -474,7 +474,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>The module is not idempotent if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate=always</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -307,7 +307,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -839,7 +839,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -698,7 +698,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -430,7 +430,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>The module is not idempotent if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-dhparam-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -434,6 +434,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<p>The default choice is <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code>, which tries to use <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> if available, and falls back to <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code>. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-iter-size"><span class="std std-ref"><span class="pre">iter_size</span></span></a></strong></code> is used together with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-encryption-level"><span class="std std-ref"><span class="pre">encryption_level</span></span></a></strong></code> is not <code class="ansible-value docutils literal notranslate"><span class="pre">compatibility2022</span></code>, or if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-maciter-size"><span class="std std-ref"><span class="pre">maciter_size</span></span></a></strong></code> is used, <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code> will always result in <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> to be chosen for backwards compatibility.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">pyopenssl</span></code>, will try to use the <a class="reference external" href="https://pypi.org/project/pyOpenSSL/">pyOpenSSL</a> library.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">cryptography</span></code>, will try to use the <a class="reference external" href="https://cryptography.io/">cryptography</a> library.</p>
|
||||
<p><strong>Note</strong> that the <code class="ansible-value docutils literal notranslate"><span class="pre">pyopenssl</span></code> backend is deprecated and will be removed from community.crypto 3.0.0.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"auto"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
|
@ -545,7 +546,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>The module is not idempotent if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -409,7 +409,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -325,7 +325,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -552,7 +552,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>The option <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate=always</span></span></a></code> generally disables idempotency.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -458,7 +458,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>The option <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate=always</span></span></a></code> generally disables idempotency.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -287,7 +287,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -454,7 +454,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>The module is not idempotent if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -305,7 +305,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -305,7 +305,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-partial">partial</strong></p>
|
||||
<p>Signature algorithms are generally not deterministic. Thus the generated signature can change from one invocation to the next.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -114,6 +114,7 @@
|
|||
<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 current"><a class="current reference internal" href="#">community.crypto.x509_certificate_convert module – Convert X.509 certificates</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="#see-also">See Also</a></li>
|
||||
|
@ -180,18 +181,21 @@
|
|||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/crypto/">community.crypto collection</a> (version 2.23.0).</p>
|
||||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</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>.</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-x509-certificate-convert-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.x509_certificate_convert</span></code>.</p>
|
||||
</div>
|
||||
<p class="ansible-version-added">New in community.crypto 2.19.0</p>
|
||||
<nav class="contents local" 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="#parameters" id="id2">Parameters</a></p></li>
|
||||
<li><p><a class="reference internal" href="#attributes" id="id3">Attributes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#see-also" id="id4">See Also</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id6">Return Values</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="#see-also" id="id5">See Also</a></p></li>
|
||||
<li><p><a class="reference internal" href="#examples" id="id6">Examples</a></p></li>
|
||||
<li><p><a class="reference internal" href="#return-values" id="id7">Return Values</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="synopsis">
|
||||
|
@ -200,8 +204,15 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
<li><p>This module allows to convert X.509 certificates between different formats.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-community-crypto-x509-certificate-convert-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>cryptography >= 1.6 if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-convert-module-parameter-verify-cert-parsable"><span class="std std-ref"><span class="pre">verify_cert_parsable=true</span></span></a></code></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||||
|
@ -351,6 +362,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
<a class="ansibleOptionLink" href="#parameter-strict" 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 the input is a PEM file, ensure that it contains a single PEM object, that the header and footer match, and are of type <code class="docutils literal notranslate"><span class="pre">CERTIFICATE</span></code> or <code class="docutils literal notranslate"><span class="pre">X509</span> <span class="pre">CERTIFICATE</span></code>.</p>
|
||||
<p>See also the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-convert-module-parameter-verify-cert-parsable"><span class="std std-ref"><span class="pre">verify_cert_parsable</span></span></a></strong></code> option, which checks whether the certificate is parsable.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
|
@ -373,11 +385,25 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-verify_cert_parsable"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-convert-module-parameter-verify-cert-parsable"><strong>verify_cert_parsable</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-verify_cert_parsable" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><em class="ansible-option-versionadded">added in community.crypto 2.23.0</em></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, ensures that the certificate can be parsed.</p>
|
||||
<p>To ensure that a PEM file does not contain multiple certificates, use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-convert-module-parameter-strict"><span class="std std-ref"><span class="pre">strict</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></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>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="attributes">
|
||||
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
|
||||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
|
||||
|
@ -407,7 +433,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
<a class="ansibleOptionLink" href="#attribute-idempotent" title="Permalink to this attribute"></a></div></td>
|
||||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
@ -423,7 +449,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
</table>
|
||||
</section>
|
||||
<section id="see-also">
|
||||
<h2><a class="toc-backref" href="#id4" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
|
||||
<div class="admonition seealso">
|
||||
<p class="admonition-title">See also</p>
|
||||
<dl class="simple">
|
||||
|
@ -439,7 +465,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
</div>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link 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">Convert PEM X.509 certificate to DER format</span>
|
||||
<span class="w"> </span><span class="nt">community.crypto.x509_certificate_convert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">src_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/cert/ansible.com.pem</span>
|
||||
|
@ -449,7 +475,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
|
|||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link 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="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
|
|
|
@ -320,7 +320,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -845,7 +845,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
|||
<p>If relative timestamps are used and <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>, the module is not idempotent.</p>
|
||||
<p>The option <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code> generally disables idempotency.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -671,7 +671,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
|||
<p>If relative timestamps are used and <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>, the module is not idempotent.</p>
|
||||
<p>The option <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code> generally disables idempotency.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -307,7 +307,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
|||
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
||||
<p>This action does not modify state.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
|
@ -684,7 +684,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
|||
<p>The module is not idempotent if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code>.</p>
|
||||
<p>If relative timestamps and <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code> (default), the module is not idempotent.</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row with the same arguments, the second invocation indicates no change.</p>
|
||||
<td><div class="ansible-option-cell"><p>When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change.</p>
|
||||
<p>This assumes that the system controlled/queried by the module has not changed in a relevant way.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
|
Loading…
Reference in New Issue