internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 13:52:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tweak DOCUMENTATION YAML as per latest 991

Browse Source
This commit is contained in:
Jan-Piet Mens
2012-09-19 16:09:26 +02:00
parent 1bd9ea6440
commit 60e0410298
4 changed files with 77 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
library/setup
View File

@@ -30,20 +30,20 @@ DOCUMENTATION = '''
---
module: setup
short_description: Gathers facts about remote hosts
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
executed directly by /usr/bin/ansible to check what variables are
available to a host. Ansible provides many 'facts' about the system,
automatically.
notes: >
More ansible facts will be added with successive releases. If facter or
ohai are installed, variables from these programs will also be snapshotted
into the JSON file for usage in templating. These variables are prefixed
with facter_ and ohai_ so it's easy to tell their source. All variables are
bubbled up to the caller. Using the ansible facts and choosing to not
install facter and ohai means you can avoid ruby-dependencies on your
remote systems.
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
executed directly by C(/usr/bin/ansible) to check what variables are
available to a host. Ansible provides many I(facts) about the system,
automatically.
notes:
- More ansible facts will be added with successive releases. If I(facter) or
I(ohai) are installed, variables from these programs will also be snapshotted
into the JSON file for usage in templating. These variables are prefixed
with C(facter_) and C(ohai_) so it's easy to tell their source. All variables are
bubbled up to the caller. Using the ansible facts and choosing to not
install I(facter) and I(ohai) means you can avoid Ruby-dependencies on your
remote systems.
examples:
- code: ansible all -m setup -tree /tmp/facts
description: Obtain facts from all hosts and store them indexed by hostname at /tmp/facts.