mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
formatting/rebuild
This commit is contained in:
Michael DeHaan
parent
fc7591eeaa
commit
54a9f17b25
3 changed files with 64 additions and 28 deletions
86
modules.html
86
modules.html
|
|
@ -151,6 +151,7 @@ s.parentNode.insertBefore(ga, s);
|
|||
<span class="localtoc"><ul>
|
||||
<li><a class="reference internal" href="#">Ansible Modules</a><ul>
|
||||
<li><a class="reference internal" href="#apt">apt</a></li>
|
||||
<li><a class="reference internal" href="#apt-repository">apt_repository</a></li>
|
||||
<li><a class="reference internal" href="#assemble">assemble</a></li>
|
||||
<li><a class="reference internal" href="#authorized-key">authorized_key</a></li>
|
||||
<li><a class="reference internal" href="#command">command</a></li>
|
||||
|
|
@ -302,8 +303,43 @@ apt pkg=nginx state=latest default-release=squeeze-backports update-cache=yes
|
|||
apt pkg=openjdk-6-jdk state=latest install-recommends=no</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="apt-repository">
|
||||
<span id="id2"></span><h2>apt_repository<a class="headerlink" href="#apt-repository" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Manages apt repositores</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="17%" />
|
||||
<col width="9%" />
|
||||
<col width="8%" />
|
||||
<col width="66%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr><th class="head">parameter</th>
|
||||
<th class="head">required</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head">comments</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr><td>repo</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>The repository name/value</td>
|
||||
</tr>
|
||||
<tr><td>state</td>
|
||||
<td>no</td>
|
||||
<td>present</td>
|
||||
<td>‘absent’ or ‘present’</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Example action from Ansible <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>:</p>
|
||||
<div class="highlight-python"><pre>apt_repository repo=ppa:nginx/stable
|
||||
apt_repository repo='deb http://archive.canonical.com/ubuntu hardy partner'</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="assemble">
|
||||
<span id="id2"></span><h2>assemble<a class="headerlink" href="#assemble" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id3"></span><h2>assemble<a class="headerlink" href="#assemble" title="Permalink to this headline">¶</a></h2>
|
||||
<p>(new in 0.5) Assembles a configuration file from fragments. Often a particular program will take a single configuration file
|
||||
and does not support a conf.d style structure where it is easy to build up the configuration from multiple sources.
|
||||
Assmeble will take a directory of files that have already been transferred to the system, and concatenate them
|
||||
|
|
@ -346,7 +382,7 @@ together to produce a destination file. Files are assembled in string sorting o
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="authorized-key">
|
||||
<span id="id3"></span><h2>authorized_key<a class="headerlink" href="#authorized-key" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id4"></span><h2>authorized_key<a class="headerlink" href="#authorized-key" title="Permalink to this headline">¶</a></h2>
|
||||
<p>(new in 0.5). Adds or removes an authorized key for a user from a remote host.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -385,7 +421,7 @@ together to produce a destination file. Files are assembled in string sorting o
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="command">
|
||||
<span id="id4"></span><h2>command<a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id5"></span><h2>command<a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The command module takes the command name followed by a list of
|
||||
arguments, space delimited.</p>
|
||||
<table border="1" class="docutils">
|
||||
|
|
@ -436,7 +472,7 @@ The ‘command’ module is much more secure as it’s not affected
|
|||
<p>The <cite>creates=</cite> and <cite>chdir</cite> options will not be passed to the actual executable.</p>
|
||||
</div>
|
||||
<div class="section" id="copy">
|
||||
<span id="id5"></span><h2>copy<a class="headerlink" href="#copy" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id6"></span><h2>copy<a class="headerlink" href="#copy" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The copy module moves a file on the local box to remote locations. In addition to the options
|
||||
listed below, the arguments available to the <cite>file</cite> module can also be passed to the copy
|
||||
module.</p>
|
||||
|
|
@ -478,7 +514,7 @@ relative.</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="easy-install">
|
||||
<h2>easy_install<a class="headerlink" href="#easy-install" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="easyinstall"></span><h2>easy_install<a class="headerlink" href="#easy-install" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The easy_install module installs Python libraries.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -515,7 +551,7 @@ easy_install name=flask virtualenv=/srv/webapps/my_app/venv</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="facter">
|
||||
<span id="id6"></span><h2>facter<a class="headerlink" href="#facter" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id7"></span><h2>facter<a class="headerlink" href="#facter" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Runs the discovery program ‘facter’ on the remote system, returning
|
||||
JSON data that can be useful for inventory purposes.</p>
|
||||
<p>Requires that ‘facter’ and ‘ruby-json’ be installed on the remote end.</p>
|
||||
|
|
@ -526,7 +562,7 @@ module behind the scenes.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="fetch">
|
||||
<span id="id7"></span><h2>fetch<a class="headerlink" href="#fetch" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id8"></span><h2>fetch<a class="headerlink" href="#fetch" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This module works like ‘copy’, but in reverse. It is used for fetching files
|
||||
from remote machines and storing them locally in a file tree, organized by hostname.</p>
|
||||
<table border="1" class="docutils">
|
||||
|
|
@ -564,7 +600,7 @@ be saved into ‘/foo/host.example.com/tmp/bar’</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="file">
|
||||
<span id="id8"></span><h2>file<a class="headerlink" href="#file" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id9"></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
|
||||
support the same options as the file module – including ‘copy’, ‘template’, and ‘assmeble’.</p>
|
||||
<table border="1" class="docutils">
|
||||
|
|
@ -662,7 +698,7 @@ file path=/some/path state=directory context=default</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="get-url">
|
||||
<span id="id9"></span><h2>get_url<a class="headerlink" href="#get-url" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id10"></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
|
||||
access to the remote resource.</p>
|
||||
<table border="1" class="docutils">
|
||||
|
|
@ -708,7 +744,7 @@ the basename of the file on the remote server will be used.</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="git">
|
||||
<span id="id10"></span><h2>git<a class="headerlink" href="#git" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id11"></span><h2>git<a class="headerlink" href="#git" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Deploys software (or files) from git checkouts.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -753,7 +789,7 @@ the basename of the file on the remote server will be used.</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="group">
|
||||
<span id="id11"></span><h2>group<a class="headerlink" href="#group" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id12"></span><h2>group<a class="headerlink" href="#group" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Adds or removes groups.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -798,7 +834,7 @@ the basename of the file on the remote server will be used.</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="mount">
|
||||
<span id="id12"></span><h2>mount<a class="headerlink" href="#mount" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id13"></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>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -856,7 +892,7 @@ configured in fstab. ‘absent’, and ‘present’ only deal
|
|||
</table>
|
||||
</div>
|
||||
<div class="section" id="mysql-db">
|
||||
<span id="id13"></span><h2>mysql_db<a class="headerlink" href="#mysql-db" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id14"></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>Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as
|
||||
apt-get install python-mysqldb.</p>
|
||||
|
|
@ -997,7 +1033,7 @@ finally fall back to using the MySQL default login of ‘root’ with no
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="ohai">
|
||||
<span id="id14"></span><h2>ohai<a class="headerlink" href="#ohai" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id15"></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.
|
||||
Ohai data is a bit more verbose and nested than facter.</p>
|
||||
<p>Requires that ‘ohai’ be installed on the remote end.</p>
|
||||
|
|
@ -1008,7 +1044,7 @@ Ohai data is a bit more verbose and nested than facter.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="ping">
|
||||
<span id="id15"></span><h2>ping<a class="headerlink" href="#ping" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id16"></span><h2>ping<a class="headerlink" href="#ping" title="Permalink to this headline">¶</a></h2>
|
||||
<p>A trivial test module, this module always returns ‘pong’ on
|
||||
successful contact. It does not make sense in playbooks, but is useful
|
||||
from /usr/bin/ansible:</p>
|
||||
|
|
@ -1016,7 +1052,7 @@ from /usr/bin/ansible:</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="pip">
|
||||
<span id="id16"></span><h2>pip<a class="headerlink" href="#pip" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id17"></span><h2>pip<a class="headerlink" href="#pip" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Manages Python library dependencies.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -1195,7 +1231,7 @@ host before using this module.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="raw">
|
||||
<span id="id17"></span><h2>raw<a class="headerlink" href="#raw" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id18"></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>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
|
||||
|
|
@ -1210,7 +1246,7 @@ for this module.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="service">
|
||||
<span id="id18"></span><h2>service<a class="headerlink" href="#service" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id19"></span><h2>service<a class="headerlink" href="#service" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Controls services on remote machines.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -1254,7 +1290,7 @@ service name=httpd state=reloaded</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="setup">
|
||||
<span id="id19"></span><h2>setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id20"></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
|
||||
in playbooks. It can also be executed directly by /usr/bin/ansible to check what variables are available
|
||||
to a host.</p>
|
||||
|
|
@ -1336,7 +1372,7 @@ on your remote systems.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="shell">
|
||||
<span id="id20"></span><h2>shell<a class="headerlink" href="#shell" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id21"></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
|
||||
arguments, space delimited. It is almost exactly like the command module
|
||||
but runs the command through the user’s configured shell on the remote node.</p>
|
||||
|
|
@ -1383,7 +1419,7 @@ use your best judgement.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="supervisorctl">
|
||||
<span id="id21"></span><h2>supervisorctl<a class="headerlink" href="#supervisorctl" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id22"></span><h2>supervisorctl<a class="headerlink" href="#supervisorctl" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Manage the state of a program or group of programs running via Supervisord</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -1417,7 +1453,7 @@ use your best judgement.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="template">
|
||||
<span id="id22"></span><h2>template<a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id23"></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>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -1457,7 +1493,7 @@ a relative or absolute path.</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="user">
|
||||
<span id="id23"></span><h2>user<a class="headerlink" href="#user" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id24"></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>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
@ -1556,7 +1592,7 @@ user name=mdehaan state=absent force=yes</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="virt">
|
||||
<span id="id24"></span><h2>virt<a class="headerlink" href="#virt" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id25"></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
|
||||
on the managed machine.</p>
|
||||
<table border="1" class="docutils">
|
||||
|
|
@ -1616,7 +1652,7 @@ ansible host -m virt -a "command=virttype"</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="yum">
|
||||
<span id="id25"></span><h2>yum<a class="headerlink" href="#yum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id26"></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>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ Example action from Ansible :doc:`playbooks`::
|
|||
.. _apt_repository:
|
||||
|
||||
apt_repository
|
||||
```
|
||||
``````````````
|
||||
|
||||
Manages apt repositores
|
||||
|
||||
|
|
@ -203,7 +203,7 @@ Example action from Ansible :doc:`playbooks`::
|
|||
|
||||
|
||||
|
||||
.. easy_install
|
||||
.. _easyinstall:
|
||||
|
||||
easy_install
|
||||
````````````
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue