Documentation: fix formatting (#157)
* Documentation: fix formatting * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de>pull/160/head
parent
3c7514f653
commit
2c25719da5
|
@ -23,6 +23,7 @@ notes:
|
||||||
accounts."
|
accounts."
|
||||||
- "This module was called C(acme_account_facts) before Ansible 2.8. The usage
|
- "This module was called C(acme_account_facts) before Ansible 2.8. The usage
|
||||||
did not change."
|
did not change."
|
||||||
|
- Supports C(check_mode).
|
||||||
options:
|
options:
|
||||||
retrieve_orders:
|
retrieve_orders:
|
||||||
description:
|
description:
|
||||||
|
@ -55,9 +56,11 @@ EXAMPLES = '''
|
||||||
that:
|
that:
|
||||||
- account_data.exists
|
- account_data.exists
|
||||||
- name: Print account URI
|
- name: Print account URI
|
||||||
debug: var=account_data.account_uri
|
ansible.builtin.debug:
|
||||||
|
var: account_data.account_uri
|
||||||
- name: Print account contacts
|
- name: Print account contacts
|
||||||
debug: var=account_data.account.contact
|
ansible.builtin.debug:
|
||||||
|
var: account_data.account.contact
|
||||||
|
|
||||||
- name: Check whether the account exists and is accessible with the given account key
|
- name: Check whether the account exists and is accessible with the given account key
|
||||||
acme_account_info:
|
acme_account_info:
|
||||||
|
@ -69,7 +72,8 @@ EXAMPLES = '''
|
||||||
that:
|
that:
|
||||||
- account_data.exists
|
- account_data.exists
|
||||||
- name: Print account contacts
|
- name: Print account contacts
|
||||||
debug: var=account_data.account.contact
|
ansible.builtin.debug:
|
||||||
|
var: account_data.account.contact
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
|
|
|
@ -25,6 +25,7 @@ notes:
|
||||||
was different than the one specified here. Also, depending on the
|
was different than the one specified here. Also, depending on the
|
||||||
server, it can happen that some other error is returned if the
|
server, it can happen that some other error is returned if the
|
||||||
certificate has already been revoked."
|
certificate has already been revoked."
|
||||||
|
- Does not support C(check_mode).
|
||||||
seealso:
|
seealso:
|
||||||
- name: The Let's Encrypt documentation
|
- name: The Let's Encrypt documentation
|
||||||
description: Documentation for the Let's Encrypt Certification Authority.
|
description: Documentation for the Let's Encrypt Certification Authority.
|
||||||
|
@ -98,7 +99,7 @@ options:
|
||||||
C(2) (cACompromise), C(3) (affiliationChanged), C(4) (superseded),
|
C(2) (cACompromise), C(3) (affiliationChanged), C(4) (superseded),
|
||||||
C(5) (cessationOfOperation), C(6) (certificateHold),
|
C(5) (cessationOfOperation), C(6) (certificateHold),
|
||||||
C(8) (removeFromCRL), C(9) (privilegeWithdrawn),
|
C(8) (removeFromCRL), C(9) (privilegeWithdrawn),
|
||||||
C(10) (aACompromise)"
|
C(10) (aACompromise)."
|
||||||
type: int
|
type: int
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -114,8 +115,7 @@ EXAMPLES = '''
|
||||||
certificate: /etc/httpd/ssl/sample.com.crt
|
certificate: /etc/httpd/ssl/sample.com.crt
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''#'''
|
||||||
'''
|
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
|
|
|
@ -52,6 +52,8 @@ options:
|
||||||
- "Content of the private key to use for this challenge certificate."
|
- "Content of the private key to use for this challenge certificate."
|
||||||
- "Mutually exclusive with C(private_key_src)."
|
- "Mutually exclusive with C(private_key_src)."
|
||||||
type: str
|
type: str
|
||||||
|
notes:
|
||||||
|
- Does not support C(check_mode).
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
Loading…
Reference in New Issue