mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Fix various module docs. (#4887)
This commit is contained in:
parent
8017cec8f6
commit
2dcdd2faca
20 changed files with 40 additions and 40 deletions
|
@ -191,10 +191,10 @@ notes:
|
||||||
2.1, the later requires python to be installed in the instance which can
|
2.1, the later requires python to be installed in the instance which can
|
||||||
be done with the command module.
|
be done with the command module.
|
||||||
- You can copy a file from the host to the instance
|
- You can copy a file from the host to the instance
|
||||||
with the Ansible M(ansible.builtin.copy) and M(ansible.builtin.template) module and the `lxd` connection plugin.
|
with the Ansible M(ansible.builtin.copy) and M(ansible.builtin.template) module and the C(community.general.lxd) connection plugin.
|
||||||
See the example below.
|
See the example below.
|
||||||
- You can copy a file in the created instance to the localhost
|
- You can copy a file in the created instance to the localhost
|
||||||
with `command=lxc file pull instance_name/dir/filename filename`.
|
with C(command=lxc file pull instance_name/dir/filename filename).
|
||||||
See the first example below.
|
See the first example below.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -107,7 +107,7 @@ state:
|
||||||
returned: always
|
returned: always
|
||||||
command:
|
command:
|
||||||
type: str
|
type: str
|
||||||
description: Full `serverless` command run by this module, in case you want to re-run the command outside the module.
|
description: Full C(serverless) command run by this module, in case you want to re-run the command outside the module.
|
||||||
returned: always
|
returned: always
|
||||||
sample: serverless deploy --stage production
|
sample: serverless deploy --stage production
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -67,7 +67,7 @@ options:
|
||||||
state_file:
|
state_file:
|
||||||
description:
|
description:
|
||||||
- The path to an existing Terraform state file to use when building plan.
|
- The path to an existing Terraform state file to use when building plan.
|
||||||
If this is not specified, the default `terraform.tfstate` will be used.
|
If this is not specified, the default C(terraform.tfstate) will be used.
|
||||||
- This option is ignored when plan is specified.
|
- This option is ignored when plan is specified.
|
||||||
type: path
|
type: path
|
||||||
variables_files:
|
variables_files:
|
||||||
|
@ -103,7 +103,7 @@ options:
|
||||||
force_init:
|
force_init:
|
||||||
description:
|
description:
|
||||||
- To avoid duplicating infra, if a state file can't be found this will
|
- To avoid duplicating infra, if a state file can't be found this will
|
||||||
force a `terraform init`. Generally, this should be turned off unless
|
force a C(terraform init). Generally, this should be turned off unless
|
||||||
you intend to provision an entirely new Terraform deployment.
|
you intend to provision an entirely new Terraform deployment.
|
||||||
default: false
|
default: false
|
||||||
type: bool
|
type: bool
|
||||||
|
@ -149,7 +149,7 @@ options:
|
||||||
type: int
|
type: int
|
||||||
version_added: '3.8.0'
|
version_added: '3.8.0'
|
||||||
notes:
|
notes:
|
||||||
- To just run a `terraform plan`, use check mode.
|
- To just run a C(terraform plan), use check mode.
|
||||||
requirements: [ "terraform" ]
|
requirements: [ "terraform" ]
|
||||||
author: "Ryan Scott Brown (@ryansb)"
|
author: "Ryan Scott Brown (@ryansb)"
|
||||||
'''
|
'''
|
||||||
|
@ -205,7 +205,7 @@ EXAMPLES = """
|
||||||
RETURN = """
|
RETURN = """
|
||||||
outputs:
|
outputs:
|
||||||
type: complex
|
type: complex
|
||||||
description: A dictionary of all the TF outputs by their assigned name. Use `.outputs.MyOutputName.value` to access the value.
|
description: A dictionary of all the TF outputs by their assigned name. Use C(.outputs.MyOutputName.value) to access the value.
|
||||||
returned: on success
|
returned: on success
|
||||||
sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}'
|
sample: '{"bukkit_arn": {"sensitive": false, "type": "string", "value": "arn:aws:s3:::tf-test-bukkit"}'
|
||||||
contains:
|
contains:
|
||||||
|
@ -223,12 +223,12 @@ outputs:
|
||||||
description: The value of the output as interpolated by Terraform
|
description: The value of the output as interpolated by Terraform
|
||||||
stdout:
|
stdout:
|
||||||
type: str
|
type: str
|
||||||
description: Full `terraform` command stdout, in case you want to display it or examine the event log
|
description: Full C(terraform) command stdout, in case you want to display it or examine the event log
|
||||||
returned: always
|
returned: always
|
||||||
sample: ''
|
sample: ''
|
||||||
command:
|
command:
|
||||||
type: str
|
type: str
|
||||||
description: Full `terraform` command built by this module, in case you want to re-run the command outside the module or debug a problem.
|
description: Full C(terraform) command built by this module, in case you want to re-run the command outside the module or debug a problem.
|
||||||
returned: always
|
returned: always
|
||||||
sample: terraform apply ...
|
sample: terraform apply ...
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -75,15 +75,15 @@ options:
|
||||||
target_hostname:
|
target_hostname:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- One of `target_hostname` and `target_alias` is required for remote.* checks,
|
- One of I(target_hostname) and I(target_alias) is required for remote.* checks,
|
||||||
but prohibited for agent.* checks. The hostname this check should target.
|
but prohibited for agent.* checks. The hostname this check should target.
|
||||||
Must be a valid IPv4, IPv6, or FQDN.
|
Must be a valid IPv4, IPv6, or FQDN.
|
||||||
target_alias:
|
target_alias:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- One of `target_alias` and `target_hostname` is required for remote.* checks,
|
- One of I(target_alias) and I(target_hostname) is required for remote.* checks,
|
||||||
but prohibited for agent.* checks. Use the corresponding key in the entity's
|
but prohibited for agent.* checks. Use the corresponding key in the entity's
|
||||||
`ip_addresses` hash to resolve an IP address to target.
|
I(ip_addresses) hash to resolve an IP address to target.
|
||||||
details:
|
details:
|
||||||
type: dict
|
type: dict
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -35,7 +35,7 @@ options:
|
||||||
user_data:
|
user_data:
|
||||||
type: dict
|
type: dict
|
||||||
description:
|
description:
|
||||||
- User defined data. Typically used with `cloud-init`.
|
- User defined data. Typically used with C(cloud-init).
|
||||||
- Pass your cloud-init script here as a string
|
- Pass your cloud-init script here as a string
|
||||||
required: false
|
required: false
|
||||||
|
|
||||||
|
|
|
@ -28,14 +28,14 @@ author:
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- The action to take with the supplied key and value. If the state is 'present' and `value` is set, the key
|
- The action to take with the supplied key and value. If the state is C(present) and I(value) is set, the key
|
||||||
contents will be set to the value supplied and `changed` will be set to `true` only if the value was
|
contents will be set to the value supplied and C(changed) will be set to C(true) only if the value was
|
||||||
different to the current contents. If the state is 'present' and `value` is not set, the existing value
|
different to the current contents. If the state is C(present) and I(value) is not set, the existing value
|
||||||
associated to the key will be returned. The state 'absent' will remove the key/value pair,
|
associated to the key will be returned. The state C(absent) will remove the key/value pair,
|
||||||
again 'changed' will be set to true only if the key actually existed
|
again C(changed) will be set to true only if the key actually existed
|
||||||
prior to the removal. An attempt can be made to obtain or free the
|
prior to the removal. An attempt can be made to obtain or free the
|
||||||
lock associated with a key/value pair with the states 'acquire' or
|
lock associated with a key/value pair with the states C(acquire) or
|
||||||
'release' respectively. a valid session must be supplied to make the
|
C(release) respectively. a valid session must be supplied to make the
|
||||||
attempt changed will be true if the attempt is successful, false
|
attempt changed will be true if the attempt is successful, false
|
||||||
otherwise.
|
otherwise.
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -20,7 +20,7 @@ description:
|
||||||
- "Allows to post events to Datadog (www.datadoghq.com) service."
|
- "Allows to post events to Datadog (www.datadoghq.com) service."
|
||||||
- "Uses http://docs.datadoghq.com/api/#events API."
|
- "Uses http://docs.datadoghq.com/api/#events API."
|
||||||
author:
|
author:
|
||||||
- "Artūras `arturaz` Šlajus (@arturaz)"
|
- "Artūras 'arturaz' Šlajus (@arturaz)"
|
||||||
- "Naoya Nakazawa (@n0ts)"
|
- "Naoya Nakazawa (@n0ts)"
|
||||||
options:
|
options:
|
||||||
api_key:
|
api_key:
|
||||||
|
|
|
@ -99,7 +99,7 @@ options:
|
||||||
weight:
|
weight:
|
||||||
description:
|
description:
|
||||||
- The value passed in argument.
|
- The value passed in argument.
|
||||||
- If the value ends with the `%` sign, then the new weight will be
|
- If the value ends with the C(%) sign, then the new weight will be
|
||||||
relative to the initially configured weight.
|
relative to the initially configured weight.
|
||||||
- Relative weights are only permitted between 0 and 100% and absolute
|
- Relative weights are only permitted between 0 and 100% and absolute
|
||||||
weights are permitted between 0 and 256.
|
weights are permitted between 0 and 256.
|
||||||
|
|
|
@ -17,7 +17,7 @@ options:
|
||||||
clients:
|
clients:
|
||||||
description:
|
description:
|
||||||
- A list of the pip executables that will be used to get the packages.
|
- A list of the pip executables that will be used to get the packages.
|
||||||
They can be supplied with the full path or just the executable name, i.e `pip3.7`.
|
They can be supplied with the full path or just the executable name, for example C(pip3.7).
|
||||||
default: ['pip']
|
default: ['pip']
|
||||||
required: False
|
required: False
|
||||||
type: list
|
type: list
|
||||||
|
|
|
@ -62,8 +62,8 @@ options:
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
notes:
|
notes:
|
||||||
- '"name" and "upgrade" are mutually exclusive.'
|
- 'I(name) and I(upgrade) are mutually exclusive.'
|
||||||
- When used with a `loop:` each package will be processed individually, it is much more efficient to pass the list directly to the `name` option.
|
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the I(name) option.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -35,7 +35,7 @@ options:
|
||||||
elements: str
|
elements: str
|
||||||
path:
|
path:
|
||||||
description:
|
description:
|
||||||
- "A ':' separated list of paths to search for 'brew' executable.
|
- "A C(:) separated list of paths to search for C(brew) executable.
|
||||||
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of I(brew) command,
|
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of I(brew) command,
|
||||||
providing an alternative I(brew) path enables managing different set of packages in an alternative location in the system."
|
providing an alternative I(brew) path enables managing different set of packages in an alternative location in the system."
|
||||||
default: '/usr/local/bin:/opt/homebrew/bin'
|
default: '/usr/local/bin:/opt/homebrew/bin'
|
||||||
|
@ -70,8 +70,8 @@ options:
|
||||||
elements: str
|
elements: str
|
||||||
version_added: '0.2.0'
|
version_added: '0.2.0'
|
||||||
notes:
|
notes:
|
||||||
- When used with a `loop:` each package will be processed individually,
|
- When used with a C(loop:) each package will be processed individually,
|
||||||
it is much more efficient to pass the list directly to the `name` option.
|
it is much more efficient to pass the list directly to the I(name) option.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -70,8 +70,8 @@ options:
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
notes:
|
notes:
|
||||||
- When used with a `loop:` each package will be processed individually,
|
- When used with a C(loop:) each package will be processed individually,
|
||||||
it is much more efficient to pass the list directly to the `name` option.
|
it is much more efficient to pass the list directly to the I(name) option.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -102,8 +102,8 @@ options:
|
||||||
author: "bleader (@bleader)"
|
author: "bleader (@bleader)"
|
||||||
notes:
|
notes:
|
||||||
- When using pkgsite, be careful that already in cache packages won't be downloaded again.
|
- When using pkgsite, be careful that already in cache packages won't be downloaded again.
|
||||||
- When used with a `loop:` each package will be processed individually,
|
- When used with a C(loop:) each package will be processed individually,
|
||||||
it is much more efficient to pass the list directly to the `name` option.
|
it is much more efficient to pass the list directly to the I(name) option.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -119,7 +119,7 @@ options:
|
||||||
repoview:
|
repoview:
|
||||||
description:
|
description:
|
||||||
- Whether to generate repoview files for a published repository. Setting
|
- Whether to generate repoview files for a published repository. Setting
|
||||||
this to "yes" automatically activates `generate_sqlite`.
|
this to "yes" automatically activates C(generate_sqlite).
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
|
|
|
@ -136,8 +136,8 @@ options:
|
||||||
- Adds C(--clean-deps) option to I(zypper) remove command.
|
- Adds C(--clean-deps) option to I(zypper) remove command.
|
||||||
version_added: '4.6.0'
|
version_added: '4.6.0'
|
||||||
notes:
|
notes:
|
||||||
- When used with a `loop:` each package will be processed individually,
|
- When used with a C(loop:) each package will be processed individually,
|
||||||
it is much more efficient to pass the list directly to the `name` option.
|
it is much more efficient to pass the list directly to the I(name) option.
|
||||||
# informational: requirements for nodes
|
# informational: requirements for nodes
|
||||||
requirements:
|
requirements:
|
||||||
- "zypper >= 1.0 # included in openSUSE >= 11.1 or SUSE Linux Enterprise Server/Desktop >= 11.0"
|
- "zypper >= 1.0 # included in openSUSE >= 11.1 or SUSE Linux Enterprise Server/Desktop >= 11.0"
|
||||||
|
|
|
@ -29,7 +29,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
executable:
|
executable:
|
||||||
description:
|
description:
|
||||||
- Path to the hponcfg executable (`hponcfg` which uses $PATH).
|
- Path to the hponcfg executable (C(hponcfg) which uses $PATH).
|
||||||
default: hponcfg
|
default: hponcfg
|
||||||
type: str
|
type: str
|
||||||
verbose:
|
verbose:
|
||||||
|
|
|
@ -36,7 +36,7 @@ options:
|
||||||
force:
|
force:
|
||||||
description:
|
description:
|
||||||
- Discards uncommitted changes. Runs C(hg update -C). Prior to
|
- Discards uncommitted changes. Runs C(hg update -C). Prior to
|
||||||
1.9, the default was `yes`.
|
1.9, the default was C(yes).
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: 'no'
|
||||||
purge:
|
purge:
|
||||||
|
|
|
@ -17,7 +17,7 @@ description:
|
||||||
- See the C(zfs allow) section of C(zfs(1M)) for detailed explanations of options.
|
- See the C(zfs allow) section of C(zfs(1M)) for detailed explanations of options.
|
||||||
- This module attempts to adhere to the behavior of the command line tool as much as possible.
|
- This module attempts to adhere to the behavior of the command line tool as much as possible.
|
||||||
requirements:
|
requirements:
|
||||||
- "A ZFS/OpenZFS implementation that supports delegation with `zfs allow`, including: Solaris >= 10, illumos (all
|
- "A ZFS/OpenZFS implementation that supports delegation with C(zfs allow), including: Solaris >= 10, illumos (all
|
||||||
versions), FreeBSD >= 8.0R, ZFS on Linux >= 0.7.0."
|
versions), FreeBSD >= 8.0R, ZFS on Linux >= 0.7.0."
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
|
|
|
@ -129,7 +129,7 @@ state:
|
||||||
type: str
|
type: str
|
||||||
sample: "reloaded"
|
sample: "reloaded"
|
||||||
status:
|
status:
|
||||||
description: a dictionary with the key=value pairs returned by `system-control show-json` or C(None) if the service is not loaded
|
description: A dictionary with the key=value pairs returned by C(system-control show-json) or C(None) if the service is not loaded
|
||||||
returned: success
|
returned: success
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
contains:
|
||||||
|
|
|
@ -186,7 +186,7 @@ options:
|
||||||
validate_certs:
|
validate_certs:
|
||||||
required: false
|
required: false
|
||||||
description:
|
description:
|
||||||
- Require valid SSL certificates (set to `false` if you'd like to use self-signed certificates)
|
- Require valid SSL certificates (set to C(false) if you'd like to use self-signed certificates)
|
||||||
default: true
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue