docs adjustments - batch(ghi) (#83399)

* review modules docs - batch(ghi)

* fix option markup in gather_facts
pull/83427/head
Alexei Znamensky 5 months ago committed by GitHub
parent 14df8c2cf2
commit c6ba5a3560
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -51,8 +51,8 @@ attributes:
notes:
- This is mostly a wrapper around other fact gathering modules.
- Options passed into this action must be supported by all the underlying fact modules configured.
- If using C(gather_timeout) and parallel execution, it will limit the total execution time of
modules that do not accept C(gather_timeout) themselves.
- If using O(ignore:gather_timeout) and parallel execution, it will limit the total execution time of
modules that do not accept O(ignore:gather_timeout) themselves.
- Facts returned by each module will be merged, conflicts will favor 'last merged'.
Order is not guaranteed, when doing parallel gathering on multiple modules.
author:

@ -13,7 +13,7 @@ short_description: Downloads files from HTTP, HTTPS, or FTP to node
description:
- Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote
server I(must) have direct access to the remote resource.
- By default, if an environment variable C(<protocol>_proxy) is set on
- By default, if an environment variable E(<protocol>_proxy) is set on
the target host, requests will be sent through that proxy. This
behaviour can be overridden by setting a variable for this task
(see R(setting the environment,playbooks_environment)),
@ -27,23 +27,23 @@ version_added: '0.6'
options:
ciphers:
description:
- SSL/TLS Ciphers to use for the request
- 'When a list is provided, all ciphers are joined in order with V(:)'
- SSL/TLS Ciphers to use for the request.
- 'When a list is provided, all ciphers are joined in order with C(:).'
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT)
for more details.
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
type: list
elements: str
version_added: '2.14'
decompress:
description:
- Whether to attempt to decompress gzip content-encoded responses
- Whether to attempt to decompress gzip content-encoded responses.
type: bool
default: true
version_added: '2.14'
url:
description:
- HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
- HTTP, HTTPS, or FTP URL in the form C((http|https|ftp)://[user[:pass]]@host.domain[:port]/path).
type: str
required: true
dest:
@ -60,9 +60,9 @@ options:
tmp_dest:
description:
- Absolute path of where temporary file is downloaded to.
- When run on Ansible 2.5 or greater, path defaults to ansible's remote_tmp setting
- When run on Ansible 2.5 or greater, path defaults to ansible's C(remote_tmp) setting.
- When run on Ansible prior to 2.5, it defaults to E(TMPDIR), E(TEMP) or E(TMP) env variables or a platform specific value.
- U(https://docs.python.org/3/library/tempfile.html#tempfile.tempdir)
- U(https://docs.python.org/3/library/tempfile.html#tempfile.tempdir).
type: path
version_added: '2.1'
force:
@ -87,19 +87,19 @@ options:
- 'If a checksum is passed to this parameter, the digest of the
destination file will be calculated after it is downloaded to ensure
its integrity and verify that the transfer completed successfully.
Format: <algorithm>:<checksum|url>, e.g. checksum="sha256:D98291AC[...]B6DC7B97",
checksum="sha256:http://example.com/path/sha256sum.txt"'
Format: <algorithm>:<checksum|url>, for example C(checksum="sha256:D98291AC[...]B6DC7B97",
C(checksum="sha256:http://example.com/path/sha256sum.txt").'
- If you worry about portability, only the sha1 algorithm is available
on all platforms and python versions.
- The Python ``hashlib`` module is responsible for providing the available algorithms.
- The Python C(hashlib) module is responsible for providing the available algorithms.
The choices vary based on Python version and OpenSSL version.
- On systems running in FIPS compliant mode, the ``md5`` algorithm may be unavailable.
- On systems running in FIPS compliant mode, the C(md5) algorithm may be unavailable.
- Additionally, if a checksum is passed to this parameter, and the file exist under
the O(dest) location, the C(destination_checksum) would be calculated, and if
checksum equals C(destination_checksum), the file download would be skipped
(unless O(force) is V(true)). If the checksum does not equal C(destination_checksum),
(unless O(force=true)). If the checksum does not equal C(destination_checksum),
the destination file is deleted.
- If the checksum URL requires username and password, C(username) and C(password) are used
- If the checksum URL requires username and password, O(url_username) and O(url_password) are used
to download the checksum file.
type: str
default: ''
@ -187,16 +187,16 @@ options:
authentication.
- Requires the Python library L(gssapi,https://github.com/pythongssapi/python-gssapi) to be installed.
- Credentials for GSSAPI can be specified with O(url_username)/O(url_password) or with the GSSAPI env var
C(KRB5CCNAME) that specified a custom Kerberos credential cache.
E(KRB5CCNAME) that specified a custom Kerberos credential cache.
- NTLM authentication is I(not) supported even if the GSSAPI mech for NTLM has been installed.
type: bool
default: no
version_added: '2.11'
use_netrc:
description:
- Determining whether to use credentials from ``~/.netrc`` file
- By default .netrc is used with Basic authentication headers
- When set to False, .netrc credentials are ignored
- Determining whether to use credentials from C(~/.netrc) file.
- By default C(.netrc) is used with Basic authentication headers.
- When V(false), C(.netrc) credentials are ignored.
type: bool
default: true
version_added: '2.14'

@ -42,19 +42,19 @@ options:
default: "HEAD"
accept_hostkey:
description:
- Will ensure or not that "-o StrictHostKeyChecking=no" is present as an ssh option.
- Will ensure or not that C(-o StrictHostKeyChecking=no) is present as an ssh option.
- Be aware that this disables a protection against MITM attacks.
- Those using OpenSSH >= 7.5 might want to set O(ssh_opts) to V(StrictHostKeyChecking=accept-new)
- Those using OpenSSH >= 7.5 might want to use O(accept_newhostkey) or set O(ssh_opts) to V(StrictHostKeyChecking=accept-new)
instead, it does not remove the MITM issue but it does restrict it to the first attempt.
type: bool
default: 'no'
version_added: "1.5"
accept_newhostkey:
description:
- As of OpenSSH 7.5, "-o StrictHostKeyChecking=accept-new" can be
- As of OpenSSH 7.5, C(-o StrictHostKeyChecking=accept-new) can be
used which is safer and will only accepts host keys which are
not present or are the same. if V(true), ensure that
"-o StrictHostKeyChecking=accept-new" is present as an ssh option.
not present or are the same. If V(true), ensure that
C(-o StrictHostKeyChecking=accept-new) is present as an ssh option.
type: bool
default: 'no'
version_added: "2.12"
@ -65,21 +65,21 @@ options:
- For older versions it appends E(GIT_SSH_OPTS) (specific to this module) to the
variables above or via a wrapper script.
- Other options can add to this list, like O(key_file) and O(accept_hostkey).
- An example value could be "-o StrictHostKeyChecking=no" (although this particular
- An example value could be C(-o StrictHostKeyChecking=no) (although this particular
option is better set by O(accept_hostkey)).
- The module ensures that 'BatchMode=yes' is always present to avoid prompts.
- The module ensures that C(BatchMode=yes) is always present to avoid prompts.
type: str
version_added: "1.5"
key_file:
description:
- Specify an optional private key file path, on the target host, to use for the checkout.
- This ensures 'IdentitiesOnly=yes' is present in O(ssh_opts).
- This ensures C(IdentitiesOnly=yes) is present in O(ssh_opts).
type: path
version_added: "1.5"
reference:
description:
- Reference repository (see "git clone --reference ...").
- Reference repository (see C(git clone --reference ...)).
type: str
version_added: "1.4"
remote:
@ -165,7 +165,7 @@ options:
track_submodules:
description:
- If V(true), submodules will track the latest commit on their
master branch (or other branch specified in .gitmodules). If
master branch (or other branch specified in C(.gitmodules)). If
V(false), submodules will be kept at the revision specified by the
main project. This is equivalent to specifying the C(--remote) flag
to git submodule update.
@ -235,7 +235,7 @@ notes:
SSH will prompt user to authorize the first contact with a remote host. To avoid this prompt,
one solution is to use the option accept_hostkey. Another solution is to
add the remote host public key in C(/etc/ssh/ssh_known_hosts) before calling
the git module, with the following command: ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_hosts."
the git module, with the following command: C(ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_hosts)."
'''
EXAMPLES = '''

@ -37,7 +37,7 @@ options:
force:
description:
- Whether to delete a group even if it is the primary group of a user.
- Only applicable on platforms which implement a --force flag on the group deletion command.
- Only applicable on platforms which implement a C(--force) flag on the group deletion command.
type: bool
default: false
version_added: "2.15"

@ -36,7 +36,7 @@ options:
description:
- Which strategy to use to update the hostname.
- If not set we try to autodetect, but this can be problematic, particularly with containers as they can present misleading information.
- Note that 'systemd' should be specified for RHEL/EL/CentOS 7+. Older distributions should use 'redhat'.
- Note that V(systemd) should be specified for RHEL/EL/CentOS 7+. Older distributions should use V(redhat).
choices: ['alpine', 'debian', 'freebsd', 'generic', 'macos', 'macosx', 'darwin', 'openbsd', 'openrc', 'redhat', 'sles', 'solaris', 'systemd']
type: str
version_added: '2.9'

@ -21,20 +21,20 @@ options:
file:
description:
- The file name from which variables should be loaded.
- If the path is relative, it will look for the file in vars/ subdirectory of a role or relative to playbook.
- If the path is relative, it will look for the file in C(vars/) subdirectory of a role or relative to playbook.
type: path
version_added: "2.2"
dir:
description:
- The directory name from which the variables should be loaded.
- If the path is relative and the task is inside a role, it will look inside the role's vars/ subdirectory.
- If the path is relative and the task is inside a role, it will look inside the role's C(vars/) subdirectory.
- If the path is relative and not inside a role, it will be parsed relative to the playbook.
type: path
version_added: "2.2"
name:
description:
- The name of a variable into which assign the included vars.
- If omitted (null) they will be made top level vars.
- If omitted (V(null)) they will be made top level vars.
type: str
version_added: "2.2"
depth:
@ -81,8 +81,8 @@ options:
version_added: "2.12"
free-form:
description:
- This module allows you to specify the 'file' option directly without any other options.
- There is no 'free-form' option, this is just an indicator, see example below.
- This module allows you to specify the O(file) option directly without any other options.
- There is no O(ignore:free-form) option, this is just an indicator, see example below.
extends_documentation_fragment:
- action_common_attributes
- action_common_attributes.conn

@ -39,7 +39,7 @@ options:
description:
- This option specifies the packet matching table on which the command should operate.
- If the kernel is configured with automatic module loading, an attempt will be made
to load the appropriate module for that table if it is not already there.
to load the appropriate module for that table if it is not already there.
type: str
choices: [ filter, nat, mangle, raw, security ]
default: filter
@ -135,7 +135,7 @@ options:
a specific property.
- The set of matches makes up the condition under which a target is invoked.
- Matches are evaluated first to last if specified as an array and work in short-circuit
fashion, i.e. if one extension yields false, the evaluation will stop.
fashion, in other words if one extension yields false, the evaluation will stop.
type: list
elements: str
default: []
@ -153,7 +153,7 @@ options:
gateway:
description:
- This specifies the IP address of the host to send the cloned packets.
- This option is only valid when O(jump) is set to V(TEE).
- This option is only valid when O(jump=TEE).
type: str
version_added: "2.8"
log_prefix:
@ -165,7 +165,7 @@ options:
description:
- Logging level according to the syslogd-defined priorities.
- The value can be strings or numbers from 1-8.
- This parameter is only applicable if O(jump) is set to V(LOG).
- This parameter is only applicable if O(jump=LOG).
type: str
version_added: "2.8"
choices: [ '0', '1', '2', '3', '4', '5', '6', '7', 'emerg', 'alert', 'crit', 'error', 'warning', 'notice', 'info', 'debug' ]
@ -242,13 +242,13 @@ options:
type: str
to_destination:
description:
- This specifies a destination address to use with C(DNAT).
- This specifies a destination address to use with O(ctstate=DNAT).
- Without this, the destination address is never altered.
type: str
version_added: "2.1"
to_source:
description:
- This specifies a source address to use with C(SNAT).
- This specifies a source address to use with O(ctstate=SNAT).
- Without this, the source address is never altered.
type: str
version_added: "2.2"
@ -342,14 +342,14 @@ options:
reject_with:
description:
- 'Specifies the error packet type to return while rejecting. It implies
"jump: REJECT".'
C(jump=REJECT).'
type: str
version_added: "2.1"
icmp_type:
description:
- This allows specification of the ICMP type, which can be a numeric
ICMP type, type/code pair, or one of the ICMP type names shown by the
command 'iptables -p icmp -h'
command C(iptables -p icmp -h).
type: str
version_added: "2.2"
flush:
@ -387,10 +387,10 @@ options:
version_added: "2.13"
numeric:
description:
- This parameter controls the running of the list -action of iptables, which is used internally by the module
- Does not affect the actual functionality. Use this if iptables hang when creating a chain or altering policy
- If V(true), then iptables skips the DNS-lookup of the IP addresses in a chain when it uses the list -action
- Listing is used internally for example when setting a policy or creating a chain
- This parameter controls the running of the list -action of iptables, which is used internally by the module.
- Does not affect the actual functionality. Use this if iptables hang when creating a chain or altering policy.
- If V(true), then iptables skips the DNS-lookup of the IP addresses in a chain when it uses the list -action.
- Listing is used internally for example when setting a policy or creating a chain.
type: bool
default: false
version_added: "2.15"

Loading…
Cancel
Save