Add version_added: 1.0.0 for all new features. (#37)
parent
70683e540d
commit
109edecd78
|
@ -212,6 +212,7 @@ options:
|
||||||
to the same certificate in the chain."
|
to the same certificate in the chain."
|
||||||
- "This option can only be used with the C(cryptography) backend."
|
- "This option can only be used with the C(cryptography) backend."
|
||||||
type: list
|
type: list
|
||||||
|
version_added: '1.0.0'
|
||||||
suboptions:
|
suboptions:
|
||||||
test_certificates:
|
test_certificates:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -13,6 +13,7 @@ DOCUMENTATION = '''
|
||||||
module: ecs_domain
|
module: ecs_domain
|
||||||
author:
|
author:
|
||||||
- Chris Trufan (@ctrufan)
|
- Chris Trufan (@ctrufan)
|
||||||
|
version_added: '1.0.0'
|
||||||
short_description: Request validation of a domain with the Entrust Certificate Services (ECS) API
|
short_description: Request validation of a domain with the Entrust Certificate Services (ECS) API
|
||||||
description:
|
description:
|
||||||
- Request validation or re-validation of a domain with the Entrust Certificate Services (ECS) API.
|
- Request validation or re-validation of a domain with the Entrust Certificate Services (ECS) API.
|
||||||
|
|
|
@ -69,10 +69,12 @@ options:
|
||||||
I(keyfile) is needed for most of the operations. Parameter
|
I(keyfile) is needed for most of the operations. Parameter
|
||||||
value is a string with the passphrase."
|
value is a string with the passphrase."
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
keysize:
|
keysize:
|
||||||
description:
|
description:
|
||||||
- "Sets the key size only if LUKS container does not exist."
|
- "Sets the key size only if LUKS container does not exist."
|
||||||
type: int
|
type: int
|
||||||
|
version_added: '1.0.0'
|
||||||
new_keyfile:
|
new_keyfile:
|
||||||
description:
|
description:
|
||||||
- "Adds additional key to given container on I(device).
|
- "Adds additional key to given container on I(device).
|
||||||
|
@ -95,6 +97,7 @@ options:
|
||||||
new keyslot will be used even if another keyslot already exists
|
new keyslot will be used even if another keyslot already exists
|
||||||
for this passphrase."
|
for this passphrase."
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
remove_keyfile:
|
remove_keyfile:
|
||||||
description:
|
description:
|
||||||
- "Removes given key from the container on I(device). Does not
|
- "Removes given key from the container on I(device). Does not
|
||||||
|
@ -118,6 +121,7 @@ options:
|
||||||
container, the I(force_remove_last_key) option must be set
|
container, the I(force_remove_last_key) option must be set
|
||||||
to C(yes)."
|
to C(yes)."
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
force_remove_last_key:
|
force_remove_last_key:
|
||||||
description:
|
description:
|
||||||
- "If set to C(yes), allows removing the last key from a container."
|
- "If set to C(yes), allows removing the last key from a container."
|
||||||
|
@ -134,19 +138,20 @@ options:
|
||||||
not specified."
|
not specified."
|
||||||
- "This cannot be specified if I(type) is set to C(luks1)."
|
- "This cannot be specified if I(type) is set to C(luks1)."
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
uuid:
|
uuid:
|
||||||
description:
|
description:
|
||||||
- "With this option user can identify the LUKS container by UUID."
|
- "With this option user can identify the LUKS container by UUID."
|
||||||
- "Will only be used when I(device) and I(label) are not specified."
|
- "Will only be used when I(device) and I(label) are not specified."
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
type:
|
type:
|
||||||
description:
|
description:
|
||||||
- "This option allow the user explicit define the format of LUKS
|
- "This option allow the user explicit define the format of LUKS
|
||||||
container that wants to work with. Options are C(luks1) or C(luks2)"
|
container that wants to work with. Options are C(luks1) or C(luks2)"
|
||||||
type: str
|
type: str
|
||||||
choices: [luks1, luks2]
|
choices: [luks1, luks2]
|
||||||
|
version_added: '1.0.0'
|
||||||
|
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "cryptsetup"
|
- "cryptsetup"
|
||||||
|
|
|
@ -87,6 +87,7 @@ options:
|
||||||
- full_idempotence
|
- full_idempotence
|
||||||
- always
|
- always
|
||||||
default: partial_idempotence
|
default: partial_idempotence
|
||||||
|
version_added: '1.0.0'
|
||||||
notes:
|
notes:
|
||||||
- In case the ssh key is broken or password protected, the module will fail.
|
- In case the ssh key is broken or password protected, the module will fail.
|
||||||
Set the I(force) option to C(yes) if you want to regenerate the keypair.
|
Set the I(force) option to C(yes) if you want to regenerate the keypair.
|
||||||
|
|
|
@ -51,6 +51,7 @@ options:
|
||||||
- The content of the private key to use when signing the certificate signing request.
|
- The content of the private key to use when signing the certificate signing request.
|
||||||
- Either I(privatekey_path) or I(privatekey_content) must be specified if I(state) is C(present), but not both.
|
- Either I(privatekey_path) or I(privatekey_content) must be specified if I(state) is C(present), but not both.
|
||||||
type: str
|
type: str
|
||||||
|
version_added: "1.0.0"
|
||||||
privatekey_passphrase:
|
privatekey_passphrase:
|
||||||
description:
|
description:
|
||||||
- The passphrase for the private key.
|
- The passphrase for the private key.
|
||||||
|
@ -267,6 +268,7 @@ options:
|
||||||
- If set to C(yes), will return the (current or generated) CSR's content as I(csr).
|
- If set to C(yes), will return the (current or generated) CSR's content as I(csr).
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
|
version_added: "1.0.0"
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- files
|
- files
|
||||||
notes:
|
notes:
|
||||||
|
@ -419,6 +421,7 @@ csr:
|
||||||
description: The (current or generated) CSR's content.
|
description: The (current or generated) CSR's content.
|
||||||
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
||||||
type: str
|
type: str
|
||||||
|
version_added: "1.0.0"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import abc
|
import abc
|
||||||
|
|
|
@ -38,6 +38,7 @@ options:
|
||||||
- Content of the CSR file.
|
- Content of the CSR file.
|
||||||
- Either I(path) or I(content) must be specified, but not both.
|
- Either I(path) or I(content) must be specified, but not both.
|
||||||
type: str
|
type: str
|
||||||
|
version_added: "1.0.0"
|
||||||
select_crypto_backend:
|
select_crypto_backend:
|
||||||
description:
|
description:
|
||||||
- Determines which crypto backend to use.
|
- Determines which crypto backend to use.
|
||||||
|
|
|
@ -64,11 +64,13 @@ options:
|
||||||
type: str
|
type: str
|
||||||
default: auto
|
default: auto
|
||||||
choices: [ auto, cryptography, openssl ]
|
choices: [ auto, cryptography, openssl ]
|
||||||
|
version_added: "1.0.0"
|
||||||
return_content:
|
return_content:
|
||||||
description:
|
description:
|
||||||
- If set to C(yes), will return the (current or generated) DH params' content as I(dhparams).
|
- If set to C(yes), will return the (current or generated) DH params' content as I(dhparams).
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
|
version_added: "1.0.0"
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- files
|
- files
|
||||||
seealso:
|
seealso:
|
||||||
|
@ -115,6 +117,7 @@ dhparams:
|
||||||
description: The (current or generated) DH params' content.
|
description: The (current or generated) DH params' content.
|
||||||
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
||||||
type: str
|
type: str
|
||||||
|
version_added: "1.0.0"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import abc
|
import abc
|
||||||
|
|
|
@ -95,6 +95,7 @@ options:
|
||||||
- If set to C(yes), will return the (current or generated) PKCS#12's content as I(pkcs12).
|
- If set to C(yes), will return the (current or generated) PKCS#12's content as I(pkcs12).
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
|
version_added: "1.0.0"
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- files
|
- files
|
||||||
seealso:
|
seealso:
|
||||||
|
@ -173,6 +174,7 @@ pkcs12:
|
||||||
description: The (current or generated) PKCS#12's content Base64 encoded.
|
description: The (current or generated) PKCS#12's content Base64 encoded.
|
||||||
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
||||||
type: str
|
type: str
|
||||||
|
version_added: "1.0.0"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import base64
|
import base64
|
||||||
|
|
|
@ -129,6 +129,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
default: auto_ignore
|
default: auto_ignore
|
||||||
choices: [ pkcs1, pkcs8, raw, auto, auto_ignore ]
|
choices: [ pkcs1, pkcs8, raw, auto, auto_ignore ]
|
||||||
|
version_added: '1.0.0'
|
||||||
format_mismatch:
|
format_mismatch:
|
||||||
description:
|
description:
|
||||||
- Determines behavior of the module if the format of a private key does not match the expected format, but all
|
- Determines behavior of the module if the format of a private key does not match the expected format, but all
|
||||||
|
@ -139,6 +140,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
default: regenerate
|
default: regenerate
|
||||||
choices: [ regenerate, convert ]
|
choices: [ regenerate, convert ]
|
||||||
|
version_added: '1.0.0'
|
||||||
backup:
|
backup:
|
||||||
description:
|
description:
|
||||||
- Create a backup file including a timestamp so you can get
|
- Create a backup file including a timestamp so you can get
|
||||||
|
@ -152,6 +154,7 @@ options:
|
||||||
value is treated appropriately and not accidentally written to logs etc.! Use with care!
|
value is treated appropriately and not accidentally written to logs etc.! Use with care!
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
|
version_added: '1.0.0'
|
||||||
regenerate:
|
regenerate:
|
||||||
description:
|
description:
|
||||||
- Allows to configure in which situations the module is allowed to regenerate private keys.
|
- Allows to configure in which situations the module is allowed to regenerate private keys.
|
||||||
|
@ -184,6 +187,7 @@ options:
|
||||||
- full_idempotence
|
- full_idempotence
|
||||||
- always
|
- always
|
||||||
default: full_idempotence
|
default: full_idempotence
|
||||||
|
version_added: '1.0.0'
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- files
|
- files
|
||||||
seealso:
|
seealso:
|
||||||
|
@ -266,6 +270,7 @@ privatekey:
|
||||||
- Will be Base64-encoded if the key is in raw format.
|
- Will be Base64-encoded if the key is in raw format.
|
||||||
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import abc
|
import abc
|
||||||
|
|
|
@ -39,6 +39,7 @@ options:
|
||||||
- Content of the private key file.
|
- Content of the private key file.
|
||||||
- Either I(path) or I(content) must be specified, but not both.
|
- Either I(path) or I(content) must be specified, but not both.
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
passphrase:
|
passphrase:
|
||||||
description:
|
description:
|
||||||
- The passphrase for the private key.
|
- The passphrase for the private key.
|
||||||
|
|
|
@ -62,6 +62,7 @@ options:
|
||||||
- Either I(privatekey_path) or I(privatekey_content) must be specified, but not both.
|
- Either I(privatekey_path) or I(privatekey_content) must be specified, but not both.
|
||||||
If I(state) is C(present), one of them is required.
|
If I(state) is C(present), one of them is required.
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
privatekey_passphrase:
|
privatekey_passphrase:
|
||||||
description:
|
description:
|
||||||
- The passphrase for the private key.
|
- The passphrase for the private key.
|
||||||
|
@ -86,6 +87,7 @@ options:
|
||||||
- If set to C(yes), will return the (current or generated) public key's content as I(publickey).
|
- If set to C(yes), will return the (current or generated) public key's content as I(publickey).
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
|
version_added: '1.0.0'
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- files
|
- files
|
||||||
seealso:
|
seealso:
|
||||||
|
@ -171,6 +173,7 @@ publickey:
|
||||||
description: The (current or generated) public key's content.
|
description: The (current or generated) public key's content.
|
||||||
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -96,6 +96,7 @@ options:
|
||||||
- This is not required in C(assertonly) mode.
|
- This is not required in C(assertonly) mode.
|
||||||
- This is mutually exclusive with I(csr_path).
|
- This is mutually exclusive with I(csr_path).
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
|
|
||||||
privatekey_path:
|
privatekey_path:
|
||||||
description:
|
description:
|
||||||
|
@ -107,6 +108,7 @@ options:
|
||||||
- Path to the private key to use when signing the certificate.
|
- Path to the private key to use when signing the certificate.
|
||||||
- This is mutually exclusive with I(privatekey_path).
|
- This is mutually exclusive with I(privatekey_path).
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
|
|
||||||
privatekey_passphrase:
|
privatekey_passphrase:
|
||||||
description:
|
description:
|
||||||
|
@ -183,6 +185,7 @@ options:
|
||||||
- This is only used by the C(ownca) provider.
|
- This is only used by the C(ownca) provider.
|
||||||
- This is mutually exclusive with I(ownca_path).
|
- This is mutually exclusive with I(ownca_path).
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
|
|
||||||
ownca_privatekey_path:
|
ownca_privatekey_path:
|
||||||
description:
|
description:
|
||||||
|
@ -196,6 +199,7 @@ options:
|
||||||
- This is only used by the C(ownca) provider.
|
- This is only used by the C(ownca) provider.
|
||||||
- This is mutually exclusive with I(ownca_privatekey_path).
|
- This is mutually exclusive with I(ownca_privatekey_path).
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
|
|
||||||
ownca_privatekey_passphrase:
|
ownca_privatekey_passphrase:
|
||||||
description:
|
description:
|
||||||
|
@ -296,6 +300,7 @@ options:
|
||||||
- "Let's Encrypt recommends using their staging server while developing jobs. U(https://letsencrypt.org/docs/staging-environment/)."
|
- "Let's Encrypt recommends using their staging server while developing jobs. U(https://letsencrypt.org/docs/staging-environment/)."
|
||||||
type: str
|
type: str
|
||||||
default: https://acme-v02.api.letsencrypt.org/directory
|
default: https://acme-v02.api.letsencrypt.org/directory
|
||||||
|
version_added: '1.0.0'
|
||||||
|
|
||||||
signature_algorithms:
|
signature_algorithms:
|
||||||
description:
|
description:
|
||||||
|
@ -578,6 +583,7 @@ options:
|
||||||
- If set to C(yes), will return the (current or generated) certificate's content as I(certificate).
|
- If set to C(yes), will return the (current or generated) certificate's content as I(certificate).
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
|
version_added: '1.0.0'
|
||||||
|
|
||||||
extends_documentation_fragment: files
|
extends_documentation_fragment: files
|
||||||
notes:
|
notes:
|
||||||
|
@ -846,6 +852,7 @@ certificate:
|
||||||
description: The (current or generated) certificate's content.
|
description: The (current or generated) certificate's content.
|
||||||
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
returned: if I(state) is C(present) and I(return_content) is C(yes)
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -45,6 +45,7 @@ options:
|
||||||
- Content of the X.509 certificate in PEM format.
|
- Content of the X.509 certificate in PEM format.
|
||||||
- Either I(path) or I(content) must be specified, but not both.
|
- Either I(path) or I(content) must be specified, but not both.
|
||||||
type: str
|
type: str
|
||||||
|
version_added: '1.0.0'
|
||||||
valid_at:
|
valid_at:
|
||||||
description:
|
description:
|
||||||
- A dict of names mapping to time specifications. Every time specified here
|
- A dict of names mapping to time specifications. Every time specified here
|
||||||
|
|
|
@ -11,6 +11,7 @@ __metaclass__ = type
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
---
|
---
|
||||||
module: x509_crl
|
module: x509_crl
|
||||||
|
version_added: '1.0.0'
|
||||||
short_description: Generate Certificate Revocation Lists (CRLs)
|
short_description: Generate Certificate Revocation Lists (CRLs)
|
||||||
description:
|
description:
|
||||||
- This module allows one to (re)generate or update Certificate Revocation Lists (CRLs).
|
- This module allows one to (re)generate or update Certificate Revocation Lists (CRLs).
|
||||||
|
|
|
@ -11,6 +11,7 @@ __metaclass__ = type
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
---
|
---
|
||||||
module: x509_crl_info
|
module: x509_crl_info
|
||||||
|
version_added: '1.0.0'
|
||||||
short_description: Retrieve information on Certificate Revocation Lists (CRLs)
|
short_description: Retrieve information on Certificate Revocation Lists (CRLs)
|
||||||
description:
|
description:
|
||||||
- This module allows one to retrieve information on Certificate Revocation Lists (CRLs).
|
- This module allows one to retrieve information on Certificate Revocation Lists (CRLs).
|
||||||
|
|
Loading…
Reference in New Issue