ansible/docsite/rst/modules/setup.rst

.. _setup:

setup
``````````````````````````````


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. 


.. raw:: html

    <p>Obtain facts from all hosts and store them indexed by hostname at /tmp/facts.</p>    <p><pre>
    ansible all -m setup -t /tmp/facts
    </pre></p>
    <br/>

.. raw:: html

    <h4>Notes</h4>
        <p>More ansible facts will be added with successive releases. If <em>facter</em> or <em>ohai</em> are installed, variables from these programs will also be snapshotted into the JSON file for usage in templating. These variables are prefixed with <code>facter_</code> and <code>ohai_</code> 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 <em>facter</em> and <em>ohai</em> means you can avoid Ruby-dependencies on your remote systems.</p>
Break the modules docs into separate files. 2012-08-13 21:39:00 +02:00			`.. _setup:`

			`setup`
Change syntax to module formatter script 2012-09-28 14:21:33 +02:00			``````````````````````````````
Break the modules docs into separate files. 2012-08-13 21:39:00 +02:00

Tweaking module docs as a result of integrating the new module docs generator 2012-09-28 03:33:55 +02:00			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.
Break the modules docs into separate files. 2012-08-13 21:39:00 +02:00

Tweaking module docs as a result of integrating the new module docs generator 2012-09-28 03:33:55 +02:00			`.. raw:: html`
Break the modules docs into separate files. 2012-08-13 21:39:00 +02:00
Fix patterns typo, rebuild 2012-10-04 02:58:27 +02:00			`<p>Obtain facts from all hosts and store them indexed by hostname at /tmp/facts.</p> <p><pre>`
Typo in example section for 'setup' module. 2012-10-10 01:41:26 +02:00			`ansible all -m setup -t /tmp/facts`
Fix patterns typo, rebuild 2012-10-04 02:58:27 +02:00			`</pre></p>`
Tweaking module docs as a result of integrating the new module docs generator 2012-09-28 03:33:55 +02:00			`<br/>`

Fix patterns typo, rebuild 2012-10-04 02:58:27 +02:00			`.. raw:: html`

			`<h4>Notes</h4>`
			<p>More ansible facts will be added with successive releases. If <em>facter</em> or <em>ohai</em> are installed, variables from these programs will also be snapshotted into the JSON file for usage in templating. These variables are prefixed with <code>facter_</code> and <code>ohai_</code> 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 <em>facter</em> and <em>ohai</em> means you can avoid Ruby-dependencies on your remote systems.</p>