Convert to reduced list of known types (#50010)

This commit is contained in:
Dag Wieers 2018-12-18 22:25:30 +01:00 committed by Jordan Borean
parent fcd1486b51
commit 05c6ff79f9
908 changed files with 4822 additions and 4821 deletions

View file

@ -114,7 +114,7 @@ RETURN = '''
account_uri:
description: ACME account URI, or None if account does not exist.
returned: always
type: string
type: str
'''
from ansible.module_utils.acme import (

View file

@ -66,7 +66,7 @@ exists:
account_uri:
description: ACME account URI, or None if account does not exist.
returned: always
type: string
type: str
account:
description: The account information, as retrieved from the ACME server.

View file

@ -281,7 +281,7 @@ challenge_data:
resource:
description: the challenge resource that must be created for validation
returned: changed
type: string
type: str
sample: .well-known/acme-challenge/evaGxfADs6pSRb2LAv9IZf17Dt3juxGJ-PCt92wr-oA
resource_value:
description:
@ -294,12 +294,12 @@ challenge_data:
for details. To do this, you might need the C(b64decode) Jinja filter
to extract the binary blob from this return value."
returned: changed
type: string
type: str
sample: IlirfxKKXA...17Dt3juxGJ-PCt92wr-oA
record:
description: the full DNS record's name for the challenge
returned: changed and challenge is C(dns-01)
type: string
type: str
sample: _acme-challenge.example.com
version_added: "2.5"
challenge_data_dns:
@ -319,17 +319,17 @@ authorizations:
order_uri:
description: ACME order URI.
returned: changed
type: string
type: str
version_added: "2.5"
finalization_uri:
description: ACME finalization URI.
returned: changed
type: string
type: str
version_added: "2.5"
account_uri:
description: ACME account URI.
returned: changed
type: string
type: str
version_added: "2.5"
'''

View file

@ -97,12 +97,12 @@ domain:
description:
- "The domain the challenge is for."
returned: always
type: string
type: str
challenge_certificate:
description:
- "The challenge certificate in PEM format."
returned: always
type: string
type: str
regular_certificate:
description:
- "A self-signed certificate for the challenge domain."
@ -110,7 +110,7 @@ regular_certificate:
https in the first place if that is needed for providing
the challenge."
returned: always
type: string
type: str
'''
from ansible.module_utils.acme import (

View file

@ -224,7 +224,7 @@ headers:
output_text:
description: The raw text output
returned: always
type: string
type: str
sample: "{\\n \\\"id\\\": 12345,\\n \\\"key\\\": {\\n \\\"kty\\\": \\\"RSA\\\",\\n ..."
output_json:
description: The output parsed as JSON

View file

@ -105,7 +105,7 @@ root:
description:
- "The root certificate in PEM format."
returned: success
type: string
type: str
chain:
description:
- "The chain added to the given input chain. Includes the root certificate."

View file

@ -50,7 +50,7 @@ RETURN = '''
cert:
description: The certificate retrieved from the port
returned: success
type: string
type: str
expired:
description: Boolean indicating if the cert is expired
returned: success
@ -66,19 +66,19 @@ issuer:
not_after:
description: Expiration date of the cert
returned: success
type: string
type: str
not_before:
description: Issue date of the cert
returned: success
type: string
type: str
serial_number:
description: The serial number of the cert
returned: success
type: string
type: str
signature_algorithm:
description: The algorithm used to sign the cert
returned: success
type: string
type: str
subject:
description: Information about the subject of the cert (OU, CN, etc)
returned: success
@ -86,7 +86,7 @@ subject:
version:
description: The version number of the certificate
returned: success
type: string
type: str
'''
EXAMPLES = '''

View file

@ -96,17 +96,17 @@ size:
type:
description: Algorithm used to generate the SSH private key
returned: changed or success
type: string
type: str
sample: rsa
filename:
description: Path to the generated SSH private key file
returned: changed or success
type: string
type: str
sample: /tmp/id_ssh_rsa
fingerprint:
description: The fingerprint of the key.
returned: changed or success
type: string
type: str
sample: 4096 SHA256:r4YCZxihVjedH2OlfjVGI6Y5xAYtdCwk8VxKyzVyYfM example@example.com (RSA)
'''

View file

@ -391,7 +391,7 @@ RETURN = '''
filename:
description: Path to the generated Certificate
returned: changed or success
type: string
type: str
sample: /etc/ssl/crt/www.ansible.com.crt
'''

View file

@ -249,12 +249,12 @@ RETURN = '''
privatekey:
description: Path to the TLS/SSL private key the CSR was generated for
returned: changed or success
type: string
type: str
sample: /etc/ssl/private/ansible.com.pem
filename:
description: Path to the generated Certificate Signing Request
returned: changed or success
type: string
type: str
sample: /etc/ssl/csr/www.ansible.com.csr
subject:
description: A list of the subject tuples attached to the CSR

View file

@ -76,7 +76,7 @@ size:
filename:
description: Path to the generated Diffie-Hellman parameters
returned: changed or success
type: string
type: str
sample: /etc/ssl/dhparams.pem
'''

View file

@ -129,12 +129,12 @@ RETURN = '''
filename:
description: Path to the generate PKCS#12 file.
returned: changed or success
type: string
type: str
sample: /opt/certs/ansible.p12
privatekey:
description: Path to the TLS/SSL private key the public key was generated from
returned: changed or success
type: string
type: str
sample: /etc/ssl/private/ansible.com.pem
'''

View file

@ -163,7 +163,7 @@ size:
type:
description: Algorithm used to generate the TLS/SSL private key
returned: changed or success
type: string
type: str
sample: RSA
curve:
description: Elliptic curve used to generate the TLS/SSL private key
@ -173,7 +173,7 @@ curve:
filename:
description: Path to the generated TLS/SSL private key file
returned: changed or success
type: string
type: str
sample: /etc/ssl/private/ansible.com.pem
fingerprint:
description: The fingerprint of the public key. Fingerprint will be generated for

View file

@ -97,17 +97,17 @@ RETURN = '''
privatekey:
description: Path to the TLS/SSL private key the public key was generated from
returned: changed or success
type: string
type: str
sample: /etc/ssl/private/ansible.com.pem
format:
description: The format of the public key (PEM, OpenSSH, ...)
returned: changed or success
type: string
type: str
sample: PEM
filename:
description: Path to the generated TLS/SSL public key file
returned: changed or success
type: string
type: str
sample: /etc/ssl/public/ansible.com.pem
fingerprint:
description: The fingerprint of the public key. Fingerprint will be generated for each hashlib.algorithms available.