mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
[PR #9418/43599c68 backport][stable-10] c*.py: normalize docs (#9426)
c*.py: normalize docs (#9418)
* c*.py: normalize docs
* fix copy/paste mistake
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 43599c6850
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
05ba79c5fe
commit
3db0a11148
36 changed files with 1437 additions and 1614 deletions
|
@ -8,8 +8,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: cobbler_sync
|
||||
short_description: Sync Cobbler
|
||||
description:
|
||||
|
@ -24,44 +23,44 @@ attributes:
|
|||
options:
|
||||
host:
|
||||
description:
|
||||
- The name or IP address of the Cobbler system.
|
||||
- The name or IP address of the Cobbler system.
|
||||
default: 127.0.0.1
|
||||
type: str
|
||||
port:
|
||||
description:
|
||||
- Port number to be used for REST connection.
|
||||
- The default value depends on parameter O(use_ssl).
|
||||
- Port number to be used for REST connection.
|
||||
- The default value depends on parameter O(use_ssl).
|
||||
type: int
|
||||
username:
|
||||
description:
|
||||
- The username to log in to Cobbler.
|
||||
- The username to log in to Cobbler.
|
||||
default: cobbler
|
||||
type: str
|
||||
password:
|
||||
description:
|
||||
- The password to log in to Cobbler.
|
||||
- The password to log in to Cobbler.
|
||||
type: str
|
||||
use_ssl:
|
||||
description:
|
||||
- If V(false), an HTTP connection will be used instead of the default HTTPS connection.
|
||||
- If V(false), an HTTP connection will be used instead of the default HTTPS connection.
|
||||
type: bool
|
||||
default: true
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated.
|
||||
- This should only set to V(false) when used on personally controlled sites using self-signed certificates.
|
||||
- If V(false), SSL certificates will not be validated.
|
||||
- This should only set to V(false) when used on personally controlled sites using self-signed certificates.
|
||||
type: bool
|
||||
default: true
|
||||
author:
|
||||
- Dag Wieers (@dagwieers)
|
||||
- Dag Wieers (@dagwieers)
|
||||
todo:
|
||||
notes:
|
||||
- Concurrently syncing Cobbler is bound to fail with weird errors.
|
||||
- On python 2.7.8 and older (i.e. on RHEL7) you may need to tweak the python behaviour to disable certificate validation.
|
||||
More information at L(Certificate verification in Python standard library HTTP clients,https://access.redhat.com/articles/2039753).
|
||||
'''
|
||||
- Concurrently syncing Cobbler is bound to fail with weird errors.
|
||||
- On Python 2.7.8 and older (such as RHEL7) you may need to tweak the Python behaviour to disable certificate validation.
|
||||
More information at L(Certificate verification in Python standard library HTTP clients,https://access.redhat.com/articles/2039753).
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Commit Cobbler changes
|
||||
community.general.cobbler_sync:
|
||||
host: cobbler01
|
||||
|
@ -69,11 +68,11 @@ EXAMPLES = r'''
|
|||
password: MySuperSecureP4sswOrd
|
||||
run_once: true
|
||||
delegate_to: localhost
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
# Default return values
|
||||
'''
|
||||
"""
|
||||
|
||||
import ssl
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue