mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 13:20:23 -07:00
add a user + docs rebuild
This commit is contained in:
parent
75d5f2579d
commit
bb7ef45347
5 changed files with 246 additions and 23 deletions
147
modules.html
147
modules.html
|
@ -161,8 +161,10 @@ s.parentNode.insertBefore(ga, s);
|
|||
<li><a class="reference internal" href="#group">group</a></li>
|
||||
<li><a class="reference internal" href="#ohai">ohai</a></li>
|
||||
<li><a class="reference internal" href="#ping">ping</a></li>
|
||||
<li><a class="reference internal" href="#postgresql-db">postgresql_db</a></li>
|
||||
<li><a class="reference internal" href="#postgresql-user">postgresql_user</a></li>
|
||||
<li><a class="reference internal" href="#raw">raw</a></li>
|
||||
<li><a class="reference internal" href="#id13">service</a></li>
|
||||
<li><a class="reference internal" href="#service">service</a></li>
|
||||
<li><a class="reference internal" href="#setup">setup</a></li>
|
||||
<li><a class="reference internal" href="#shell">shell</a></li>
|
||||
<li><a class="reference internal" href="#template">template</a></li>
|
||||
|
@ -689,8 +691,133 @@ successful contact.</p>
|
|||
takes no parameters & does not support change hooks, nor does it make
|
||||
any changes on the system.</p>
|
||||
</div>
|
||||
<div class="section" id="postgresql-db">
|
||||
<h2>postgresql_db<a class="headerlink" href="#postgresql-db" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Add or remove PostgreSQL databases from a remote host.</p>
|
||||
<p>The default authentication assumes that you are either logging in as or
|
||||
sudo’ing to the postgres account on the host.</p>
|
||||
<p>This module uses psycopg2, a Python PostgreSQL database adapter. You must
|
||||
ensure that psycopg2 is installed on the host before using this module. If
|
||||
the remote host is the PostgreSQL server (which is the default case), then
|
||||
PostgreSQL must also be installed on the remote host. For Ubuntu-based systems,
|
||||
install the postgresql, libpq-dev, and python-psycopg2 packages on the remote
|
||||
host before using this module.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="17%" />
|
||||
<col width="9%" />
|
||||
<col width="9%" />
|
||||
<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>db</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>name of the database to add or remove</td>
|
||||
</tr>
|
||||
<tr><td>login_user</td>
|
||||
<td>no</td>
|
||||
<td>postgres</td>
|
||||
<td>user (role) used to authenticate with PostgreSQL</td>
|
||||
</tr>
|
||||
<tr><td>login_password</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<td>password used to authenticate with PostgreSQL</td>
|
||||
</tr>
|
||||
<tr><td>login_host</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<td>host running PostgreSQL. Default (blank) implies localhost</td>
|
||||
</tr>
|
||||
<tr><td>state</td>
|
||||
<td> </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>postgresql_db db=acme</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="postgresql-user">
|
||||
<h2>postgresql_user<a class="headerlink" href="#postgresql-user" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Add or remove PostgreSQL users (roles) from a remote host, and grant the users
|
||||
access to an existing database.</p>
|
||||
<p>The default authentication assumes that you are either logging in as or
|
||||
sudo’ing to the postgres account on the host.</p>
|
||||
<p>This module uses psycopg2, a Python PostgreSQL database adapter. You must
|
||||
ensure that psycopg2 is installed on the host before using this module. If
|
||||
the remote host is the PostgreSQL server (which is the default case), then
|
||||
PostgreSQL must also be installed on the remote host. For Ubuntu-based systems,
|
||||
install the postgresql, libpq-dev, and python-psycopg2 packages on the remote
|
||||
host before using this module.</p>
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="17%" />
|
||||
<col width="9%" />
|
||||
<col width="9%" />
|
||||
<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>user</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>name of the user (role) to add or remove</td>
|
||||
</tr>
|
||||
<tr><td>password</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>set the user’s password</td>
|
||||
</tr>
|
||||
<tr><td>db</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<td>name of an existing database to grant user access to</td>
|
||||
</tr>
|
||||
<tr><td>login_user</td>
|
||||
<td>no</td>
|
||||
<td>postgres</td>
|
||||
<td>user (role) used to authenticate with PostgreSQL</td>
|
||||
</tr>
|
||||
<tr><td>login_password</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<td>password used to authenticate with PostgreSQL</td>
|
||||
</tr>
|
||||
<tr><td>login_host</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<td>host running PostgreSQL. Default (blank) implies localhost</td>
|
||||
</tr>
|
||||
<tr><td>state</td>
|
||||
<td> </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>postgresql_user db=acme user=django password=ceec4eif7ya</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="raw">
|
||||
<span id="service"></span><h2>raw<a class="headerlink" href="#raw" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id13"></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.
|
||||
This module is new in Ansible 0.4.</p>
|
||||
<p>This is useful and should only be done in two cases. The first case is installing
|
||||
|
@ -705,8 +832,8 @@ for this module.</p>
|
|||
<div class="highlight-python"><pre>ansible newhost.example.com raw -a "yum install python-simplejson"</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id13">
|
||||
<h2>service<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="service">
|
||||
<span id="id14"></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>
|
||||
|
@ -757,7 +884,7 @@ service name=httpd state=reloaded</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="setup">
|
||||
<span id="id14"></span><h2>setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id15"></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>
|
||||
|
@ -839,7 +966,7 @@ on your remote systems.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="shell">
|
||||
<span id="id15"></span><h2>shell<a class="headerlink" href="#shell" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id16"></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>
|
||||
|
@ -857,7 +984,7 @@ command was running.</p>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="template">
|
||||
<span id="id16"></span><h2>template<a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id17"></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>
|
||||
|
@ -897,7 +1024,7 @@ a relative or absolute path.</td>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="user">
|
||||
<span id="id17"></span><h2>user<a class="headerlink" href="#user" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id18"></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>
|
||||
|
@ -996,7 +1123,7 @@ user name=mdehaan state=absent force=yes</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="virt">
|
||||
<span id="id18"></span><h2>virt<a class="headerlink" href="#virt" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id19"></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">
|
||||
|
@ -1056,7 +1183,7 @@ ansible host -m virt -a "command=virttype"</pre>
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="yum">
|
||||
<span id="id19"></span><h2>yum<a class="headerlink" href="#yum" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="id20"></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>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue