diff --git a/branch/main/acme_account_info_module.html b/branch/main/acme_account_info_module.html index 417a3611..b8fd568d 100644 --- a/branch/main/acme_account_info_module.html +++ b/branch/main/acme_account_info_module.html @@ -458,7 +458,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

diff --git a/branch/main/acme_account_module.html b/branch/main/acme_account_module.html index f17f89c4..6b3aeded 100644 --- a/branch/main/acme_account_module.html +++ b/branch/main/acme_account_module.html @@ -566,7 +566,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key
diff --git a/branch/main/acme_ari_info_module.html b/branch/main/acme_ari_info_module.html index 42b687c8..0a2d315c 100644 --- a/branch/main/acme_ari_info_module.html +++ b/branch/main/acme_ari_info_module.html @@ -391,7 +391,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key
diff --git a/branch/main/acme_certificate_module.html b/branch/main/acme_certificate_module.html index 5f803e5f..6351f7b7 100644 --- a/branch/main/acme_certificate_module.html +++ b/branch/main/acme_certificate_module.html @@ -894,7 +894,7 @@ If

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

@@ -1023,7 +1023,7 @@ If

The value the resource has to produce for the validation.

For http-01 and dns-01 challenges, the value can be used as-is.

-

For tls-alpn-01 challenges, note that this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation x509 extension; see https://www.rfc-editor.org/rfc/rfc8737.html#section-3 for details. To do this, you might need the ansible.builtin.b64decode Jinja filter to extract the binary blob from this return value.

+

For tls-alpn-01 challenges, note that this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation x509 extension; see https://www.rfc-editor.org/rfc/rfc8737.html#section-3 for details. To do this, you might need the ansible.builtin.b64decode Jinja filter to extract the binary blob from this return value.

Returned: changed

Sample: "IlirfxKKXA...17Dt3juxGJ-PCt92wr-oA"

diff --git a/branch/main/acme_certificate_order_create_module.html b/branch/main/acme_certificate_order_create_module.html index c4eb9322..0d2d9424 100644 --- a/branch/main/acme_certificate_order_create_module.html +++ b/branch/main/acme_certificate_order_create_module.html @@ -615,7 +615,7 @@ If

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

@@ -745,7 +745,7 @@ If

string

 diff --git a/branch/main/acme_certificate_order_finalize_module.html b/branch/main/acme_certificate_order_finalize_module.html index 781f6e6b..e3f6588c 100644 --- a/branch/main/acme_certificate_order_finalize_module.html +++ b/branch/main/acme_certificate_order_finalize_module.html @@ -665,7 +665,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

The value the resource has to produce for the validation.

-

Note: this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation X.509 extension; see https://www.rfc-editor.org/rfc/rfc8737.html#section-3 for details. To do this, you might need the ansible.builtin.b64decode Jinja filter to extract the binary blob from this return value.

+

Note: this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation X.509 extension; see https://www.rfc-editor.org/rfc/rfc8737.html#section-3 for details. To do this, you might need the ansible.builtin.b64decode Jinja filter to extract the binary blob from this return value.

Returned: success

Sample: "AAb="

diff --git a/branch/main/acme_certificate_order_info_module.html b/branch/main/acme_certificate_order_info_module.html index 6d780732..bba84a67 100644 --- a/branch/main/acme_certificate_order_info_module.html +++ b/branch/main/acme_certificate_order_info_module.html @@ -448,7 +448,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/acme_certificate_order_validate_module.html b/branch/main/acme_certificate_order_validate_module.html index 2a3b40d1..e43005d5 100644 --- a/branch/main/acme_certificate_order_validate_module.html +++ b/branch/main/acme_certificate_order_validate_module.html @@ -558,7 +558,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/acme_certificate_renewal_info_module.html b/branch/main/acme_certificate_renewal_info_module.html index 85e1fc8a..b4d180b3 100644 --- a/branch/main/acme_certificate_renewal_info_module.html +++ b/branch/main/acme_certificate_renewal_info_module.html @@ -463,7 +463,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/acme_challenge_cert_helper_module.html b/branch/main/acme_challenge_cert_helper_module.html index 39476eeb..9708b405 100644 --- a/branch/main/acme_challenge_cert_helper_module.html +++ b/branch/main/acme_challenge_cert_helper_module.html @@ -369,7 +369,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/acme_inspect_module.html b/branch/main/acme_inspect_module.html index de1e0e29..c0d9d5c1 100644 --- a/branch/main/acme_inspect_module.html +++ b/branch/main/acme_inspect_module.html @@ -548,7 +548,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/certificate_complete_chain_module.html b/branch/main/certificate_complete_chain_module.html index ae737dbb..30ccae5b 100644 --- a/branch/main/certificate_complete_chain_module.html +++ b/branch/main/certificate_complete_chain_module.html @@ -333,7 +333,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/crypto_info_module.html b/branch/main/crypto_info_module.html index 3e9dbee9..bd0fc02d 100644 --- a/branch/main/crypto_info_module.html +++ b/branch/main/crypto_info_module.html @@ -256,7 +256,7 @@ To check whether it is installed, run

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/environment_variables.html b/branch/main/environment_variables.html index eb8223c9..676a19b7 100644 --- a/branch/main/environment_variables.html +++ b/branch/main/environment_variables.html @@ -162,7 +162,7 @@

Index of all Collection Environment Variables

The following index documents all environment variables declared by plugins in collections. -Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings.

+Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings.

No environment variables have been defined.

diff --git a/branch/main/get_certificate_module.html b/branch/main/get_certificate_module.html index b5cda5ef..528cfce5 100644 --- a/branch/main/get_certificate_module.html +++ b/branch/main/get_certificate_module.html @@ -470,7 +470,7 @@ see

Return Values

-

Common return values are documented here, the following are the fields unique to this module:

+

Common return values are documented here, the following are the fields unique to this module:

Key

diff --git a/branch/main/luks_device_module.html b/branch/main/luks_device_module.html index fa4a94cd..c732ca88 100644 --- a/branch/main/luks_device_module.html +++ b/branch/main/luks_device_module.html @@ -364,7 +364,7 @@ see "base64": The passphrase is provided as Base64 encoded bytes.

-

Use the ansible.builtin.b64encode filter to Base64-encode binary data.

+

Use the ansible.builtin.b64encode filter to Base64-encode binary data.

  • "text" (default): The passphrase is provided as UTF-8 encoded text.

    • @@ -747,7 +747,7 @@ The passphrase is provided as UTF-8 encoded text.

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssh_cert_module.html b/branch/main/openssh_cert_module.html index a004d23e..d3e7686c 100644 --- a/branch/main/openssh_cert_module.html +++ b/branch/main/openssh_cert_module.html @@ -649,7 +649,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssh_keypair_module.html b/branch/main/openssh_keypair_module.html index cf5fcab0..7b74ccfc 100644 --- a/branch/main/openssh_keypair_module.html +++ b/branch/main/openssh_keypair_module.html @@ -538,7 +538,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_csr_info_module.html b/branch/main/openssl_csr_info_module.html index 32e0a443..8c21055c 100644 --- a/branch/main/openssl_csr_info_module.html +++ b/branch/main/openssl_csr_info_module.html @@ -355,7 +355,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_csr_module.html b/branch/main/openssl_csr_module.html index 25beb806..3e643706 100644 --- a/branch/main/openssl_csr_module.html +++ b/branch/main/openssl_csr_module.html @@ -987,7 +987,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_csr_pipe_module.html b/branch/main/openssl_csr_pipe_module.html index 0f30558c..c3f0c463 100644 --- a/branch/main/openssl_csr_pipe_module.html +++ b/branch/main/openssl_csr_pipe_module.html @@ -765,7 +765,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_dhparam_module.html b/branch/main/openssl_dhparam_module.html index 9dafa1b8..d39d72d5 100644 --- a/branch/main/openssl_dhparam_module.html +++ b/branch/main/openssl_dhparam_module.html @@ -486,7 +486,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_pkcs12_module.html b/branch/main/openssl_pkcs12_module.html index 13d57f7b..33f6481d 100644 --- a/branch/main/openssl_pkcs12_module.html +++ b/branch/main/openssl_pkcs12_module.html @@ -675,7 +675,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_privatekey_convert_module.html b/branch/main/openssl_privatekey_convert_module.html index dca1fcf2..745191be 100644 --- a/branch/main/openssl_privatekey_convert_module.html +++ b/branch/main/openssl_privatekey_convert_module.html @@ -454,7 +454,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_privatekey_info_module.html b/branch/main/openssl_privatekey_info_module.html index a8c30602..79d8e4fa 100644 --- a/branch/main/openssl_privatekey_info_module.html +++ b/branch/main/openssl_privatekey_info_module.html @@ -369,7 +369,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_privatekey_module.html b/branch/main/openssl_privatekey_module.html index a4bbf534..e934f261 100644 --- a/branch/main/openssl_privatekey_module.html +++ b/branch/main/openssl_privatekey_module.html @@ -632,7 +632,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_privatekey_pipe_module.html b/branch/main/openssl_privatekey_pipe_module.html index b12a8033..d4065870 100644 --- a/branch/main/openssl_privatekey_pipe_module.html +++ b/branch/main/openssl_privatekey_pipe_module.html @@ -212,7 +212,7 @@ see

    Note

    -

    This module has a corresponding action plugin.

    +

    This module has a corresponding action plugin.

    @@ -531,7 +531,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_publickey_info_module.html b/branch/main/openssl_publickey_info_module.html index a755e138..c546a935 100644 --- a/branch/main/openssl_publickey_info_module.html +++ b/branch/main/openssl_publickey_info_module.html @@ -336,7 +336,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_publickey_module.html b/branch/main/openssl_publickey_module.html index 5930a819..d6bf25fe 100644 --- a/branch/main/openssl_publickey_module.html +++ b/branch/main/openssl_publickey_module.html @@ -535,7 +535,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_signature_info_module.html b/branch/main/openssl_signature_info_module.html index 1cf41c8c..5121cd3f 100644 --- a/branch/main/openssl_signature_info_module.html +++ b/branch/main/openssl_signature_info_module.html @@ -350,7 +350,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/openssl_signature_module.html b/branch/main/openssl_signature_module.html index 3dd72df8..8cc7407b 100644 --- a/branch/main/openssl_signature_module.html +++ b/branch/main/openssl_signature_module.html @@ -350,7 +350,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/x509_certificate_convert_module.html b/branch/main/x509_certificate_convert_module.html index 45d314e3..02fd9620 100644 --- a/branch/main/x509_certificate_convert_module.html +++ b/branch/main/x509_certificate_convert_module.html @@ -324,7 +324,7 @@ To check whether it is installed, run

    string

     @@ -444,7 +444,7 @@ To check whether it is installed, run

    See also

    -
    ansible.builtin.b64encode filter plugin

    The official documentation on the ansible.builtin.b64encode filter plugin.

    +
    ansible.builtin.b64encode filter plugin

    The official documentation on the ansible.builtin.b64encode filter plugin.

    community.crypto.x509_certificate

    Generate and/or check OpenSSL certificates.

    @@ -468,7 +468,7 @@ To check whether it is installed, run

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    The content of the file containing the X.509 certificate to convert.

    -

    This must be text. If you are not sure that the input file is PEM, you must Base64 encode the value and set src_content_base64=true. You can use the ansible.builtin.b64encode filter plugin for this.

    +

    This must be text. If you are not sure that the input file is PEM, you must Base64 encode the value and set src_content_base64=true. You can use the ansible.builtin.b64encode filter plugin for this.

    Exactly one of src_path or src_content must be specified.
    diff --git a/branch/main/x509_certificate_info_module.html b/branch/main/x509_certificate_info_module.html index 436574dd..8c287bed 100644 --- a/branch/main/x509_certificate_info_module.html +++ b/branch/main/x509_certificate_info_module.html @@ -401,7 +401,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    diff --git a/branch/main/x509_certificate_module.html b/branch/main/x509_certificate_module.html index 1e7c11ab..118375f1 100644 --- a/branch/main/x509_certificate_module.html +++ b/branch/main/x509_certificate_module.html @@ -530,7 +530,7 @@ see

    provider

    string

    -

    Key

    Name of the provider to use to generate/retrieve the OpenSSL certificate. Please see the examples on how to emulate it with community.crypto.x509_certificate_info, community.crypto.openssl_csr_info, community.crypto.openssl_privatekey_info and ansible.builtin.assert.

    +

    Name of the provider to use to generate/retrieve the OpenSSL certificate. Please see the examples on how to emulate it with community.crypto.x509_certificate_info, community.crypto.openssl_csr_info, community.crypto.openssl_privatekey_info and ansible.builtin.assert.

    Required if state is present.

    The entrust provider has been removed from community.crypto 3.0.0 due to sunsetting of the ECS API.

    Choices:

    @@ -891,7 +891,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    diff --git a/branch/main/x509_certificate_pipe_module.html b/branch/main/x509_certificate_pipe_module.html index 83fa883d..acccc49e 100644 --- a/branch/main/x509_certificate_pipe_module.html +++ b/branch/main/x509_certificate_pipe_module.html @@ -673,7 +673,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key
    diff --git a/branch/main/x509_crl_info_module.html b/branch/main/x509_crl_info_module.html index 4edefd21..9c5e8677 100644 --- a/branch/main/x509_crl_info_module.html +++ b/branch/main/x509_crl_info_module.html @@ -361,7 +361,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key
    diff --git a/branch/main/x509_crl_module.html b/branch/main/x509_crl_module.html index 169e5d65..e9462c79 100644 --- a/branch/main/x509_crl_module.html +++ b/branch/main/x509_crl_module.html @@ -750,7 +750,7 @@ see

    Return Values

    -

    Common return values are documented here, the following are the fields unique to this module:

    +

    Common return values are documented here, the following are the fields unique to this module:

    Key

    Key