Updating documentation for the setup module (#60696)

pull/60668/merge
Jiri Tyr 5 years ago committed by Alicia Cozine
parent e7a8e48053
commit 134379b273

@ -22,7 +22,7 @@ options:
gather_subset: gather_subset:
version_added: "2.1" version_added: "2.1"
description: description:
- "if supplied, restrict the additional facts collected to the given subset. - "If supplied, restrict the additional facts collected to the given subset.
Possible values: C(all), C(min), C(hardware), C(network), C(virtual), C(ohai), and Possible values: C(all), C(min), C(hardware), C(network), C(virtual), C(ohai), and
C(facter). Can specify a list of values to specify a larger subset. C(facter). Can specify a list of values to specify a larger subset.
Values can also be used with an initial C(!) to specify that Values can also be used with an initial C(!) to specify that
@ -34,30 +34,30 @@ options:
Use the filter parameter if you do not want to display some collected Use the filter parameter if you do not want to display some collected
facts." facts."
required: false required: false
default: 'all' default: "all"
gather_timeout: gather_timeout:
version_added: "2.2" version_added: "2.2"
description: description:
- "Set the default timeout in seconds for individual fact gathering" - Set the default timeout in seconds for individual fact gathering.
required: false required: false
default: 10 default: 10
filter: filter:
version_added: "1.1" version_added: "1.1"
description: description:
- if supplied, only return facts that match this shell-style (fnmatch) wildcard. - If supplied, only return facts that match this shell-style (fnmatch) wildcard.
required: false required: false
default: '*' default: "*"
fact_path: fact_path:
version_added: "1.3" version_added: "1.3"
description: description:
- path used for local ansible facts (C(*.fact)) - files in this dir - Path used for local ansible facts (C(*.fact)) - files in this dir
will be run (if executable) and their results be added to C(ansible_local) facts will be run (if executable) and their results be added to C(ansible_local) facts
if a file is not executable it is read. Check notes for Windows options. (from 2.1 on) if a file is not executable it is read. Check notes for Windows options. (from 2.1 on)
File/results format can be JSON or INI-format. The default C(fact_path) can be File/results format can be JSON or INI-format. The default C(fact_path) can be
specified in C(ansible.cfg) for when setup is automatically called as part of specified in C(ansible.cfg) for when setup is automatically called as part of
C(gather_facts). C(gather_facts).
required: false required: false
default: '/etc/ansible/facts.d' default: /etc/ansible/facts.d
description: description:
- This module is automatically called by playbooks to gather useful - This module is automatically called by playbooks to gather useful
variables about remote hosts that can be used in playbooks. It can also be variables about remote hosts that can be used in playbooks. It can also be

Loading…
Cancel
Save