cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Setup module: use C() formatting function in parameter descriptions, add a task based example (#42411)

Browse source 
* setup module: use C() in parameters description

* setup module: use a task example
This commit is contained in:
Pilou 2018-07-09 21:08:01 +02:00 committed by Brian Coca
parent abb05c98f3
commit 72d7a1eb5c
1 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/ansible/modules/system/setup.py
View file

@ -23,14 +23,14 @@ options:
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: all, min, hardware, network, virtual, ohai, and Possible values: C(all), C(min), C(hardware), C(network), C(virtual), C(ohai), and
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
that specific subset should not be collected. For instance: that specific subset should not be collected. For instance:
!hardware, !network, !virtual, !ohai, !facter. If !all is specified C(!hardware,!network,!virtual,!ohai,!facter). If C(!all) is specified
then only the min subset is collected. To avoid collecting even the then only the min subset is collected. To avoid collecting even the
min subset, specify !all and !min subsets. To collect only specific facts, min subset, specify C(!all,!min). To collect only specific facts,
use !all, !min, and specify the particular fact subsets. use C(!all,!min), and specify the particular fact subsets.
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
@ -50,8 +50,8 @@ options:
fact_path: fact_path:
version_added: "1.3" version_added: "1.3"
description: description:
- path used for local ansible facts (*.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 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 File/results format can be json or ini-format
required: false required: false
@ -99,6 +99,13 @@ EXAMPLES = """
# Collect only facts returned by facter. # Collect only facts returned by facter.
# ansible all -m setup -a 'gather_subset=!all,!any,facter' # ansible all -m setup -a 'gather_subset=!all,!any,facter'
- name: Collect only facts returned by facter
setup:
gather_subset:
- '!all'
- '!any'
- facter
# Display only facts about certain interfaces. # Display only facts about certain interfaces.
# ansible all -m setup -a 'filter=ansible_eth[0-2]' # ansible all -m setup -a 'filter=ansible_eth[0-2]'