Add documentation to setup.py and remove use of $params.fact_path in setup.ps1

This commit is contained in:
David O'Brien 2016-02-05 18:03:07 +01:00 committed by Matt Clay
parent 2fa3f16012
commit ce7a86b4ce
2 changed files with 37 additions and 5 deletions

View file

@ -54,12 +54,14 @@ 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.
- If the target host is Windows, you will not currently have the ability to use
C(fact_path) or C(filter) as this is provided by a simpler implementation of the module.
Different facts are returned for Windows hosts.
- If the target host is Windows you can now use C(fact_path). Make sure that this path
exists on the target host. Files in this path MUST be PowerShell scripts (*.ps1) and
their output must be formattable in JSON (Ansible will take care of this). Test the
output of your scripts.
author:
- "Ansible Core Team"
- "Michael DeHaan"
- "David O'Brien @david_obrien davidobrien1985"
'''
EXAMPLES = """
@ -74,6 +76,9 @@ ansible all -m setup -a 'filter=facter_*'
# Display only facts about certain interfaces.
ansible all -m setup -a 'filter=ansible_eth[0-2]'
# Display facts from Windows hosts with custom facts stored in C(C:\\custom_facts).
ansible windows -m setup -a "fact_path='c:\\custom_facts'"
"""