archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

rebuild

Browse Source
pull/1256/head
Michael DeHaan 12 years ago
parent 10c89f4d49
commit 1f3e22687e
2 changed files with 30 additions and 23 deletions
Show Stats Download Patch File Download Diff File

51
modules.html
Unescape Escape View File

@ -526,7 +526,7 @@ relative.</td>
</div> </div>
</div> </div>
<div class="section" id="easy-install"> <div class="section" id="easy-install">
<span id="easyinstall"></span><h2>easy_install<a class="headerlink" href="#easy-install" title="Permalink to this headline"></a></h2> <span id="id7"></span><h2>easy_install<a class="headerlink" href="#easy-install" title="Permalink to this headline"></a></h2>
<p class="versionadded"> <p class="versionadded">
<span class="versionmodified">New in version 0.7.</span></p> <span class="versionmodified">New in version 0.7.</span></p>
<p>The easy_install module installs Python libraries.</p> <p>The easy_install module installs Python libraries.</p>
@ -558,14 +558,19 @@ does not exist it is created automatically</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
<p>Please note that the easy_install command can only install Python libraries.
Thus this module is not able to remove libraries. It is generally recommended to
use the <a class="reference internal" href="#pip"><em>pip</em></a> module which you can first install using easy_install.</p>
<p>Also note that <a class="reference external" href="http://www.virtualenv.org/">virtualenv</a> must be installed on
the remote host if the <cite>virtualenv</cite> parameter is specified.</p>
<p>Example action from Ansible <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p> <p>Example action from Ansible <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
<div class="highlight-python"><pre>easy_install name=flask <div class="highlight-python"><pre>easy_install name=pip
easy_install name=flask==0.8 easy_install name=flask==0.8
easy_install name=flask virtualenv=/srv/webapps/my_app/venv</pre> easy_install name=flask virtualenv=/srv/webapps/my_app/venv</pre>
</div> </div>
</div> </div>
<div class="section" id="facter"> <div class="section" id="facter">
<span id="id7"></span><h2>facter<a class="headerlink" href="#facter" title="Permalink to this headline"></a></h2> <span id="id8"></span><h2>facter<a class="headerlink" href="#facter" title="Permalink to this headline"></a></h2>
<p>Runs the discovery program &#8216;facter&#8217; on the remote system, returning <p>Runs the discovery program &#8216;facter&#8217; on the remote system, returning
JSON data that can be useful for inventory purposes.</p> JSON data that can be useful for inventory purposes.</p>
<p>Requires that &#8216;facter&#8217; and &#8216;ruby-json&#8217; be installed on the remote end.</p> <p>Requires that &#8216;facter&#8217; and &#8216;ruby-json&#8217; be installed on the remote end.</p>
@ -576,7 +581,7 @@ module behind the scenes.</p>
</div> </div>
</div> </div>
<div class="section" id="fetch"> <div class="section" id="fetch">
<span id="id8"></span><h2>fetch<a class="headerlink" href="#fetch" title="Permalink to this headline"></a></h2> <span id="id9"></span><h2>fetch<a class="headerlink" href="#fetch" title="Permalink to this headline"></a></h2>
<p>This module works like &#8216;copy&#8217;, but in reverse. It is used for fetching files <p>This module works like &#8216;copy&#8217;, but in reverse. It is used for fetching files
from remote machines and storing them locally in a file tree, organized by hostname.</p> from remote machines and storing them locally in a file tree, organized by hostname.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
@ -614,7 +619,7 @@ be saved into &#8216;/foo/host.example.com/tmp/bar&#8217;</td>
</div> </div>
</div> </div>
<div class="section" id="file"> <div class="section" id="file">
<span id="id9"></span><h2>file<a class="headerlink" href="#file" title="Permalink to this headline"></a></h2> <span id="id10"></span><h2>file<a class="headerlink" href="#file" title="Permalink to this headline"></a></h2>
<p>Sets attributes of files, symlinks, and directories, or removes files/symlinks/directories. Many other modules <p>Sets attributes of files, symlinks, and directories, or removes files/symlinks/directories. Many other modules
support the same options as the file module &#8211; including &#8216;copy&#8217;, &#8216;template&#8217;, and &#8216;assmeble&#8217;.</p> support the same options as the file module &#8211; including &#8216;copy&#8217;, &#8216;template&#8217;, and &#8216;assmeble&#8217;.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
@ -712,7 +717,7 @@ file path=/some/path state=directory context=default</pre>
</div> </div>
</div> </div>
<div class="section" id="get-url"> <div class="section" id="get-url">
<span id="id10"></span><h2>get_url<a class="headerlink" href="#get-url" title="Permalink to this headline"></a></h2> <span id="id11"></span><h2>get_url<a class="headerlink" href="#get-url" title="Permalink to this headline"></a></h2>
<p>Downloads files from http, https, or ftp to the remote server. The remote server must have direct <p>Downloads files from http, https, or ftp to the remote server. The remote server must have direct
access to the remote resource.</p> access to the remote resource.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
@ -758,7 +763,7 @@ the basename of the file on the remote server will be used.</td>
</div> </div>
</div> </div>
<div class="section" id="git"> <div class="section" id="git">
<span id="id11"></span><h2>git<a class="headerlink" href="#git" title="Permalink to this headline"></a></h2> <span id="id12"></span><h2>git<a class="headerlink" href="#git" title="Permalink to this headline"></a></h2>
<p>Deploys software (or files) from git checkouts.</p> <p>Deploys software (or files) from git checkouts.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
@ -803,7 +808,7 @@ the basename of the file on the remote server will be used.</td>
</div> </div>
</div> </div>
<div class="section" id="group"> <div class="section" id="group">
<span id="id12"></span><h2>group<a class="headerlink" href="#group" title="Permalink to this headline"></a></h2> <span id="id13"></span><h2>group<a class="headerlink" href="#group" title="Permalink to this headline"></a></h2>
<p>Adds or removes groups.</p> <p>Adds or removes groups.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
@ -848,7 +853,7 @@ the basename of the file on the remote server will be used.</td>
</div> </div>
</div> </div>
<div class="section" id="mount"> <div class="section" id="mount">
<span id="id13"></span><h2>mount<a class="headerlink" href="#mount" title="Permalink to this headline"></a></h2> <span id="id14"></span><h2>mount<a class="headerlink" href="#mount" title="Permalink to this headline"></a></h2>
<p>The mount module controls active and configured mount points (fstab).</p> <p>The mount module controls active and configured mount points (fstab).</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
@ -906,7 +911,7 @@ configured in fstab. &#8216;absent&#8217;, and &#8216;present&#8217; only deal
</table> </table>
</div> </div>
<div class="section" id="mysql-db"> <div class="section" id="mysql-db">
<span id="id14"></span><h2>mysql_db<a class="headerlink" href="#mysql-db" title="Permalink to this headline"></a></h2> <span id="id15"></span><h2>mysql_db<a class="headerlink" href="#mysql-db" title="Permalink to this headline"></a></h2>
<p>Add or remove MySQL databases from a remote host.</p> <p>Add or remove MySQL databases from a remote host.</p>
<p>Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as <p>Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as
apt-get install python-mysqldb.</p> apt-get install python-mysqldb.</p>
@ -1047,7 +1052,7 @@ finally fall back to using the MySQL default login of &#8216;root&#8217; with no
</div> </div>
</div> </div>
<div class="section" id="ohai"> <div class="section" id="ohai">
<span id="id15"></span><h2>ohai<a class="headerlink" href="#ohai" title="Permalink to this headline"></a></h2> <span id="id16"></span><h2>ohai<a class="headerlink" href="#ohai" title="Permalink to this headline"></a></h2>
<p>Similar to the <a class="reference internal" href="#facter"><em>facter</em></a> module, this returns JSON inventory data. <p>Similar to the <a class="reference internal" href="#facter"><em>facter</em></a> module, this returns JSON inventory data.
Ohai data is a bit more verbose and nested than facter.</p> Ohai data is a bit more verbose and nested than facter.</p>
<p>Requires that &#8216;ohai&#8217; be installed on the remote end.</p> <p>Requires that &#8216;ohai&#8217; be installed on the remote end.</p>
@ -1058,7 +1063,7 @@ Ohai data is a bit more verbose and nested than facter.</p>
</div> </div>
</div> </div>
<div class="section" id="ping"> <div class="section" id="ping">
<span id="id16"></span><h2>ping<a class="headerlink" href="#ping" title="Permalink to this headline"></a></h2> <span id="id17"></span><h2>ping<a class="headerlink" href="#ping" title="Permalink to this headline"></a></h2>
<p>A trivial test module, this module always returns &#8216;pong&#8217; on <p>A trivial test module, this module always returns &#8216;pong&#8217; on
successful contact. It does not make sense in playbooks, but is useful successful contact. It does not make sense in playbooks, but is useful
from /usr/bin/ansible:</p> from /usr/bin/ansible:</p>
@ -1066,7 +1071,7 @@ from /usr/bin/ansible:</p>
</div> </div>
</div> </div>
<div class="section" id="pip"> <div class="section" id="pip">
<span id="id17"></span><h2>pip<a class="headerlink" href="#pip" title="Permalink to this headline"></a></h2> <span id="id18"></span><h2>pip<a class="headerlink" href="#pip" title="Permalink to this headline"></a></h2>
<p class="versionadded"> <p class="versionadded">
<span class="versionmodified">New in version 0.7.</span></p> <span class="versionmodified">New in version 0.7.</span></p>
<p>Manages Python library dependencies.</p> <p>Manages Python library dependencies.</p>
@ -1113,6 +1118,8 @@ from /usr/bin/ansible:</p>
</tr> </tr>
</tbody> </tbody>
</table> </table>
<p>Please note that <a class="reference external" href="http://www.virtualenv.org/">virtualenv</a> must be installed on
the remote host if the <cite>virtualenv</cite> parameter is specified.</p>
<p>Examples:</p> <p>Examples:</p>
<div class="highlight-python"><pre>pip name=flask <div class="highlight-python"><pre>pip name=flask
pip name=flask version=0.8 pip name=flask version=0.8
@ -1247,7 +1254,7 @@ host before using this module.</p>
</div> </div>
</div> </div>
<div class="section" id="raw"> <div class="section" id="raw">
<span id="id18"></span><h2>raw<a class="headerlink" href="#raw" title="Permalink to this headline"></a></h2> <span id="id20"></span><h2>raw<a class="headerlink" href="#raw" title="Permalink to this headline"></a></h2>
<p>Executes a low-down and dirty SSH command, not going through the module subsystem.</p> <p>Executes a low-down and dirty SSH command, not going through the module subsystem.</p>
<p>This is useful and should only be done in two cases. The first case is installing <p>This is useful and should only be done in two cases. The first case is installing
python-simplejson on older (python 2.4 and before) hosts that need it as a dependency python-simplejson on older (python 2.4 and before) hosts that need it as a dependency
@ -1262,7 +1269,7 @@ for this module.</p>
</div> </div>
</div> </div>
<div class="section" id="service"> <div class="section" id="service">
<span id="id19"></span><h2>service<a class="headerlink" href="#service" title="Permalink to this headline"></a></h2> <span id="id21"></span><h2>service<a class="headerlink" href="#service" title="Permalink to this headline"></a></h2>
<p>Controls services on remote machines.</p> <p>Controls services on remote machines.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
@ -1306,7 +1313,7 @@ service name=httpd state=reloaded</pre>
</div> </div>
</div> </div>
<div class="section" id="setup"> <div class="section" id="setup">
<span id="id20"></span><h2>setup<a class="headerlink" href="#setup" title="Permalink to this headline"></a></h2> <span id="id22"></span><h2>setup<a class="headerlink" href="#setup" title="Permalink to this headline"></a></h2>
<p>This module is automatically called by playbooks to gather useful variables about remote hosts that can be used <p>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 in playbooks. It can also be executed directly by /usr/bin/ansible to check what variables are available
to a host.</p> to a host.</p>
@ -1388,7 +1395,7 @@ on your remote systems.</p>
</div> </div>
</div> </div>
<div class="section" id="shell"> <div class="section" id="shell">
<span id="id21"></span><h2>shell<a class="headerlink" href="#shell" title="Permalink to this headline"></a></h2> <span id="id23"></span><h2>shell<a class="headerlink" href="#shell" title="Permalink to this headline"></a></h2>
<p>The shell module takes the command name followed by a list of <p>The shell module takes the command name followed by a list of
arguments, space delimited. It is almost exactly like the command module arguments, space delimited. It is almost exactly like the command module
but runs the command through the user&#8217;s configured shell on the remote node.</p> but runs the command through the user&#8217;s configured shell on the remote node.</p>
@ -1438,7 +1445,7 @@ your best judgement.</p>
</div> </div>
</div> </div>
<div class="section" id="supervisorctl"> <div class="section" id="supervisorctl">
<span id="id22"></span><h2>supervisorctl<a class="headerlink" href="#supervisorctl" title="Permalink to this headline"></a></h2> <span id="id24"></span><h2>supervisorctl<a class="headerlink" href="#supervisorctl" title="Permalink to this headline"></a></h2>
<p class="versionadded"> <p class="versionadded">
<span class="versionmodified">New in version 0.7.</span></p> <span class="versionmodified">New in version 0.7.</span></p>
<p>Manage the state of a program or group of programs running via Supervisord</p> <p>Manage the state of a program or group of programs running via Supervisord</p>
@ -1474,7 +1481,7 @@ your best judgement.</p>
</div> </div>
</div> </div>
<div class="section" id="template"> <div class="section" id="template">
<span id="id23"></span><h2>template<a class="headerlink" href="#template" title="Permalink to this headline"></a></h2> <span id="id25"></span><h2>template<a class="headerlink" href="#template" title="Permalink to this headline"></a></h2>
<p>Templates a file out to a remote server.</p> <p>Templates a file out to a remote server.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
@ -1514,7 +1521,7 @@ a relative or absolute path.</td>
</div> </div>
</div> </div>
<div class="section" id="user"> <div class="section" id="user">
<span id="id24"></span><h2>user<a class="headerlink" href="#user" title="Permalink to this headline"></a></h2> <span id="id26"></span><h2>user<a class="headerlink" href="#user" title="Permalink to this headline"></a></h2>
<p>Creates user accounts, manipulates existing user accounts, and removes user accounts.</p> <p>Creates user accounts, manipulates existing user accounts, and removes user accounts.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>
@ -1613,7 +1620,7 @@ user name=mdehaan state=absent force=yes</pre>
</div> </div>
</div> </div>
<div class="section" id="virt"> <div class="section" id="virt">
<span id="id25"></span><h2>virt<a class="headerlink" href="#virt" title="Permalink to this headline"></a></h2> <span id="id27"></span><h2>virt<a class="headerlink" href="#virt" title="Permalink to this headline"></a></h2>
<p>Manages virtual machines supported by libvirt. Requires that libvirt be installed <p>Manages virtual machines supported by libvirt. Requires that libvirt be installed
on the managed machine.</p> on the managed machine.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
@ -1673,7 +1680,7 @@ ansible host -m virt -a "command=virttype"</pre>
</div> </div>
</div> </div>
<div class="section" id="yum"> <div class="section" id="yum">
<span id="id26"></span><h2>yum<a class="headerlink" href="#yum" title="Permalink to this headline"></a></h2> <span id="id28"></span><h2>yum<a class="headerlink" href="#yum" title="Permalink to this headline"></a></h2>
<p>Will install, upgrade, remove, and list packages with the yum package manager.</p> <p>Will install, upgrade, remove, and list packages with the yum package manager.</p>
<table border="1" class="docutils"> <table border="1" class="docutils">
<colgroup> <colgroup>

2
searchindex.js
View File

File diff suppressed because one or more lines are too long
Write Preview
Loading…
Cancel
Save