Improve type documentation. (#62178)

(cherry picked from commit fbf182c369)
pull/62986/head
Felix Fontein 5 years ago committed by Toshio Kuratomi
parent 9efac6864d
commit 7ad4f6238c

@ -69,6 +69,7 @@ options:
- "Must be specified when state is C(present). Will be ignored - "Must be specified when state is C(present). Will be ignored
if state is C(absent) or C(changed_key)." if state is C(absent) or C(changed_key)."
type: list type: list
elements: str
default: [] default: []
terms_agreed: terms_agreed:
description: description:

@ -49,6 +49,7 @@ options:
certificates in PEM format." certificates in PEM format."
- "Symbolic links will be followed." - "Symbolic links will be followed."
type: list type: list
elements: path
required: yes required: yes
intermediate_certificates: intermediate_certificates:
description: description:
@ -61,6 +62,7 @@ options:
certificates in PEM format." certificates in PEM format."
- "Symbolic links will be followed." - "Symbolic links will be followed."
type: list type: list
elements: path
default: [] default: []
''' '''

@ -127,6 +127,7 @@ options:
- In the case of certificates of type C(STANDARD_SSL) certificates, if the CN of the certificate is <domain>.<tld> only the www.<domain>.<tld> value - In the case of certificates of type C(STANDARD_SSL) certificates, if the CN of the certificate is <domain>.<tld> only the www.<domain>.<tld> value
is accepted. If the CN of the certificate is www.<domain>.<tld> only the <domain>.<tld> value is accepted. is accepted. If the CN of the certificate is www.<domain>.<tld> only the <domain>.<tld> value is accepted.
type: list type: list
elements: str
eku: eku:
description: description:
- If specified, overrides the key usage in the I(csr). - If specified, overrides the key usage in the I(csr).
@ -166,6 +167,7 @@ options:
parameter can be used to force failure if an unapproved organizational unit is provided. parameter can be used to force failure if an unapproved organizational unit is provided.
- A maximum of one OU may be specified for current products. Multiple OUs are reserved for future products. - A maximum of one OU may be specified for current products. Multiple OUs are reserved for future products.
type: list type: list
elements: str
end_user_key_storage_agreement: end_user_key_storage_agreement:
description: description:
- The end user of the Code Signing certificate must generate and store the private key for this request on cryptographically secure - The end user of the Code Signing certificate must generate and store the private key for this request on cryptographically secure
@ -192,6 +194,7 @@ options:
additional_emails: additional_emails:
description: A list of additional email addresses to receive the delivery notice and expiry notification for the certificate. description: A list of additional email addresses to receive the delivery notice and expiry notification for the certificate.
type: list type: list
elements: str
custom_fields: custom_fields:
description: description:
- Mapping of custom fields to associate with the certificate request and certificate. - Mapping of custom fields to associate with the certificate request and certificate.

@ -84,6 +84,7 @@ options:
- "Certificates may be limited to be valid for a set of principal (user/host) names. - "Certificates may be limited to be valid for a set of principal (user/host) names.
By default, generated certificates are valid for all users or hosts." By default, generated certificates are valid for all users or hosts."
type: list type: list
elements: str
options: options:
description: description:
- "Specify certificate options when signing a key. The option that are valid for user certificates are:" - "Specify certificate options when signing a key. The option that are valid for user certificates are:"
@ -104,6 +105,7 @@ options:
The C(address_list) is a comma-separated list of one or more address/netmask pairs in CIDR format." The C(address_list) is a comma-separated list of one or more address/netmask pairs in CIDR format."
- "At present, no options are valid for host keys." - "At present, no options are valid for host keys."
type: list type: list
elements: str
identifier: identifier:
description: description:
- Specify the key identity when signing a public key. The identifier that is logged by the server when the certificate is used for authentication. - Specify the key identity when signing a public key. The identifier that is logged by the server when the certificate is used for authentication.
@ -534,8 +536,8 @@ def main():
valid_from=dict(type='str'), valid_from=dict(type='str'),
valid_to=dict(type='str'), valid_to=dict(type='str'),
valid_at=dict(type='str'), valid_at=dict(type='str'),
principals=dict(type='list'), principals=dict(type='list', elements='str'),
options=dict(type='list'), options=dict(type='list', elements='str'),
), ),
supports_check_mode=True, supports_check_mode=True,
add_file_common_args=True, add_file_common_args=True,

@ -277,6 +277,7 @@ options:
- This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13. - This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13.
For alternatives, see the example on replacing C(assertonly). For alternatives, see the example on replacing C(assertonly).
type: list type: list
elements: str
issuer: issuer:
description: description:
@ -390,6 +391,7 @@ options:
- This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13. - This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13.
For alternatives, see the example on replacing C(assertonly). For alternatives, see the example on replacing C(assertonly).
type: list type: list
elements: str
aliases: [ keyUsage ] aliases: [ keyUsage ]
key_usage_strict: key_usage_strict:
@ -409,6 +411,7 @@ options:
- This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13. - This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13.
For alternatives, see the example on replacing C(assertonly). For alternatives, see the example on replacing C(assertonly).
type: list type: list
elements: str
aliases: [ extendedKeyUsage ] aliases: [ extendedKeyUsage ]
extended_key_usage_strict: extended_key_usage_strict:
@ -428,6 +431,7 @@ options:
- This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13. - This option is deprecated since Ansible 2.9 and will be removed with the C(assertonly) provider in Ansible 2.13.
For alternatives, see the example on replacing C(assertonly). For alternatives, see the example on replacing C(assertonly).
type: list type: list
elements: str
aliases: [ subjectAltName ] aliases: [ subjectAltName ]
subject_alt_name_strict: subject_alt_name_strict:

@ -122,6 +122,7 @@ options:
set to I(false). set to I(false).
- More at U(https://tools.ietf.org/html/rfc5280#section-4.2.1.6). - More at U(https://tools.ietf.org/html/rfc5280#section-4.2.1.6).
type: list type: list
elements: str
aliases: [ subjectAltName ] aliases: [ subjectAltName ]
subject_alt_name_critical: subject_alt_name_critical:
description: description:
@ -141,6 +142,7 @@ options:
- This defines the purpose (e.g. encipherment, signature, certificate signing) - This defines the purpose (e.g. encipherment, signature, certificate signing)
of the key contained in the certificate. of the key contained in the certificate.
type: list type: list
elements: str
aliases: [ keyUsage ] aliases: [ keyUsage ]
key_usage_critical: key_usage_critical:
description: description:
@ -152,6 +154,7 @@ options:
- Additional restrictions (e.g. client authentication, server authentication) - Additional restrictions (e.g. client authentication, server authentication)
on the allowed purposes for which the public key may be used. on the allowed purposes for which the public key may be used.
type: list type: list
elements: str
aliases: [ extKeyUsage, extendedKeyUsage ] aliases: [ extKeyUsage, extendedKeyUsage ]
extended_key_usage_critical: extended_key_usage_critical:
description: description:
@ -162,6 +165,7 @@ options:
description: description:
- Indicates basic constraints, such as if the certificate is a CA. - Indicates basic constraints, such as if the certificate is a CA.
type: list type: list
elements: str
version_added: '2.5' version_added: '2.5'
aliases: [ basicConstraints ] aliases: [ basicConstraints ]
basic_constraints_critical: basic_constraints_critical:
@ -254,6 +258,7 @@ options:
- The C(AuthorityKeyIdentifier) will only be added if at least one of I(authority_key_identifier), - The C(AuthorityKeyIdentifier) will only be added if at least one of I(authority_key_identifier),
I(authority_cert_issuer) and I(authority_cert_serial_number) is specified. I(authority_cert_issuer) and I(authority_cert_serial_number) is specified.
type: list type: list
elements: str
version_added: "2.9" version_added: "2.9"
authority_cert_serial_number: authority_cert_serial_number:
description: description:

@ -33,6 +33,7 @@ options:
description: description:
- List of other certificates to include. Pre 2.8 this parameter was called C(ca_certificates) - List of other certificates to include. Pre 2.8 this parameter was called C(ca_certificates)
type: list type: list
elements: path
aliases: [ ca_certificates ] aliases: [ ca_certificates ]
certificate_path: certificate_path:
description: description:

Loading…
Cancel
Save