From 582f088e7e4b1812f52d3670abe0a4d50ba6bba5 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sat, 23 Feb 2013 15:11:15 -0500 Subject: [PATCH] Fix module docs formatting --- library/setup | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/library/setup b/library/setup index 30c05763de0..0e0c9a3cf5f 100644 --- a/library/setup +++ b/library/setup @@ -37,7 +37,7 @@ options: description: - if supplied, only return facts that match this shell-style (fnmatch) wildcard. required: false - default: * + default: '*' description: - This module is automatically called by playbooks to gather useful 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 remote systems. (See also M(facter) and M(ohai).) - 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 ''' +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: import selinux HAVE_SELINUX=True