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

Fix module docs formatting

Browse source
This commit is contained in:
Michael DeHaan 2013-02-23 15:11:15 -05:00
parent c86b34dae1
commit 582f088e7e
1 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
library/setup
View file

@ -37,7 +37,7 @@ options:
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: '*'
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
@ -53,22 +53,23 @@ notes:
install I(facter) and I(ohai) means you can avoid Ruby-dependencies on your install I(facter) and I(ohai) means you can avoid Ruby-dependencies on your
remote systems. (See also M(facter) and M(ohai).) remote systems. (See also M(facter) and M(ohai).)
- The filter option filters only the first level subkey below ansible_facts. - The filter option filters only the first level subkey below ansible_facts.
examples:
- code: ansible all -m setup --tree /tmp/facts
description: Obtain facts from all hosts and store them indexed by I(hostname) at C(/tmp/facts).
- code: ansible all -m setup -a 'filter=ansible_*_mb'
description: Obtain I(only) facts regarding memory found by ansible on all hosts and output them.
- code: ansible all -m setup -a 'filter=facter_*'
description: Display I(only) facts returned by facter.
- code: ansible all -m setup -a 'filter=ansible_eth[0-2]'
description: Displays ansible facts abouts ethernet interfaces eth0, eth1, and eth2.
- code: ansible all -m setup -a 'filter=ansible_eth?'
description: Displays ansible facts abouts ethernet interfaces eth0 through eth9 (but not eth10).
- code: ansible all -m setup -a 'filter=ansible_eth[!0]'
description: Displays ansible facts abouts all ethernet interfaces but eth0.
author: Michael DeHaan author: Michael DeHaan
''' '''
EXAMPLES = """
# Display facts from all hosts and store them indexed by I(hostname) at C(/tmp/facts).
ansible all -m setup --tree /tmp/facts
# Display only facts regarding memory found by ansible on all hosts and output them.
ansible all -m setup -a 'filter=ansible_*_mb'
# Display only facts returned by facter.
ansible all -m setup -a 'filter=facter_*'
# Display only facts returned by facter.
ansible all -m setup -a 'filter=ansible_eth[0-2]'
"""
try: try:
import selinux import selinux
HAVE_SELINUX=True HAVE_SELINUX=True