mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2366 lines
92 KiB
HTML
2366 lines
92 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>Ansible Modules — Ansible Documentation</title>
|
|
|
|
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/bootstrap.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '',
|
|
VERSION: '0.01',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: false
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<script type="text/javascript" src="_static/bootstrap-dropdown.js"></script>
|
|
<script type="text/javascript" src="_static/bootstrap-scrollspy.js"></script>
|
|
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
|
<link rel="top" title="Ansible Documentation" href="index.html" />
|
|
<link rel="next" title="YAML Syntax" href="YAMLSyntax.html" />
|
|
<link rel="prev" title="Command Line Examples And Next Steps" href="examples.html" />
|
|
<script type="text/javascript">
|
|
(function () {
|
|
/**
|
|
* Patch TOC list.
|
|
*
|
|
* Will mutate the underlying span to have a correct ul for nav.
|
|
*
|
|
* @param $span: Span containing nested UL's to mutate.
|
|
* @param minLevel: Starting level for nested lists. (1: global, 2: local).
|
|
*/
|
|
var patchToc = function ($span, minLevel) {
|
|
var $tocList = $("<ul/>").attr('class', "dropdown-menu"),
|
|
findA;
|
|
|
|
// Find all a "internal" tags, traversing recursively.
|
|
findA = function ($elem, level) {
|
|
var level = level || 0,
|
|
$items = $elem.find("> li > a.internal, > ul, > li > ul");
|
|
|
|
// Iterate everything in order.
|
|
$items.each(function (index, item) {
|
|
var $item = $(item),
|
|
tag = item.tagName.toLowerCase(),
|
|
pad = 10 + ((level - minLevel) * 10);
|
|
|
|
if (tag === 'a' && level >= minLevel) {
|
|
// Add to existing padding.
|
|
$item.css('padding-left', pad + "px");
|
|
// Add list element.
|
|
$tocList.append($("<li/>").append($item));
|
|
} else if (tag === 'ul') {
|
|
// Recurse.
|
|
findA($item, level + 1);
|
|
}
|
|
});
|
|
};
|
|
|
|
// Start construction and return.
|
|
findA($span);
|
|
|
|
// Wipe out old list and patch in new one.
|
|
return $span.empty("ul").append($tocList);
|
|
};
|
|
|
|
$(document).ready(function () {
|
|
// Patch the global and local TOC's to be bootstrap-compliant.
|
|
patchToc($("span.globaltoc"), 1);
|
|
patchToc($("span.localtoc"), 2);
|
|
|
|
// Activate.
|
|
$('#topbar').dropdown();
|
|
});
|
|
}());
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
|
|
var _gaq = _gaq || [];
|
|
_gaq.push(['_setAccount', 'UA-29861888-1']);
|
|
_gaq.push(['_trackPageview']);
|
|
|
|
(function() {
|
|
var ga = document.createElement('script'); ga.type =
|
|
'text/javascript'; ga.async = true;
|
|
ga.src = ('https:' == document.location.protocol ? 'https://ssl' :
|
|
'http://www') + '.google-analytics.com/ga.js';
|
|
var s = document.getElementsByTagName('script')[0];
|
|
s.parentNode.insertBefore(ga, s);
|
|
})();
|
|
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
(function() {
|
|
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
|
|
po.src = 'https://apis.google.com/js/plusone.js';
|
|
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
|
|
})();
|
|
</script>
|
|
|
|
<script>(function(d, s, id) {
|
|
var js, fjs = d.getElementsByTagName(s)[0];
|
|
if (d.getElementById(id)) return;
|
|
js = d.createElement(s); js.id = id;
|
|
js.src = "//connect.facebook.net/en_US/all.js#xfbml=1";
|
|
fjs.parentNode.insertBefore(js, fjs);
|
|
}(document, 'script', 'facebook-jssdk'));</script>
|
|
|
|
</head>
|
|
<body>
|
|
<div class="topbar" data-scrollspy="scrollspy" >
|
|
<div class="topbar-inner">
|
|
<div class="container">
|
|
<a class="brand" href="index.html">Ansible Documentation</a>
|
|
<ul class="nav">
|
|
|
|
<li><a href="/">Home</A>
|
|
<li class="dropdown" data-dropdown="dropdown">
|
|
<a href="index.html"
|
|
class="dropdown-toggle">Chapter</a>
|
|
<span class="globaltoc"><ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="patterns.html">Inventory & Patterns</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="examples.html">Command Line Examples And Next Steps</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="">Ansible Modules</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="YAMLSyntax.html">YAML Syntax</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="playbooks.html">Playbooks</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="playbooks2.html">Advanced Playbooks</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="bestpractices.html">Best Practices</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api.html">API & Integrations</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="moduledev.html">Module Development</a></li>
|
|
</ul>
|
|
</span>
|
|
</li>
|
|
<li class="dropdown" data-dropdown="dropdown">
|
|
<a href="#"
|
|
class="dropdown-toggle">Page</a>
|
|
<span class="localtoc"><ul>
|
|
<li><a class="reference internal" href="#">Ansible Modules</a><ul>
|
|
<li><a class="reference internal" href="#introduction">Introduction</a></li>
|
|
<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="#async-status">async_status</a></li>
|
|
<li><a class="reference internal" href="#authorized-key">authorized_key</a></li>
|
|
<li><a class="reference internal" href="#command">command</a></li>
|
|
<li><a class="reference internal" href="#copy">copy</a></li>
|
|
<li><a class="reference internal" href="#easy-install">easy_install</a></li>
|
|
<li><a class="reference internal" href="#facter">facter</a></li>
|
|
<li><a class="reference internal" href="#fail">fail</a></li>
|
|
<li><a class="reference internal" href="#fetch">fetch</a></li>
|
|
<li><a class="reference internal" href="#file">file</a></li>
|
|
<li><a class="reference internal" href="#fireball">fireball</a></li>
|
|
<li><a class="reference internal" href="#get-url">get_url</a></li>
|
|
<li><a class="reference internal" href="#git">git</a></li>
|
|
<li><a class="reference internal" href="#group">group</a></li>
|
|
<li><a class="reference internal" href="#ini-file">ini_file</a></li>
|
|
<li><a class="reference internal" href="#lineinfile">lineinfile</a></li>
|
|
<li><a class="reference internal" href="#mount">mount</a></li>
|
|
<li><a class="reference internal" href="#mysql-db">mysql_db</a></li>
|
|
<li><a class="reference internal" href="#mysql-user">mysql_user</a></li>
|
|
<li><a class="reference internal" href="#nagios">nagios</a></li>
|
|
<li><a class="reference internal" href="#ohai">ohai</a></li>
|
|
<li><a class="reference internal" href="#pause">pause</a></li>
|
|
<li><a class="reference internal" href="#ping">ping</a></li>
|
|
<li><a class="reference internal" href="#pip">pip</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="#seboolean">seboolean</a></li>
|
|
<li><a class="reference internal" href="#selinux">selinux</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="#slurp">slurp</a></li>
|
|
<li><a class="reference internal" href="#subversion">subversion</a></li>
|
|
<li><a class="reference internal" href="#supervisorctl">supervisorctl</a></li>
|
|
<li><a class="reference internal" href="#template">template</a></li>
|
|
<li><a class="reference internal" href="#user">user</a></li>
|
|
<li><a class="reference internal" href="#virt">virt</a></li>
|
|
<li><a class="reference internal" href="#wait-for">wait_for</a></li>
|
|
<li><a class="reference internal" href="#yum">yum</a></li>
|
|
<li><a class="reference internal" href="#additional-contrib-modules">Additional Contrib Modules</a></li>
|
|
<li><a class="reference internal" href="#writing-your-own-modules">Writing your own modules</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</span>
|
|
</li>
|
|
|
|
</ul>
|
|
<ul class="nav secondary-nav">
|
|
|
|
|
|
<form class="pull-left" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="container">
|
|
|
|
<div class="section" id="ansible-modules">
|
|
<h1><a class="toc-backref" href="#contents">Ansible Modules</a><a class="headerlink" href="#ansible-modules" title="Permalink to this headline">¶</a></h1>
|
|
<div class="contents topic" id="contents">
|
|
<p class="topic-title first">Contents</p>
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#ansible-modules" id="id43">Ansible Modules</a><ul>
|
|
<li><a class="reference internal" href="#introduction" id="id44">Introduction</a></li>
|
|
<li><a class="reference internal" href="#apt" id="id45">apt</a></li>
|
|
<li><a class="reference internal" href="#apt-repository" id="id46">apt_repository</a></li>
|
|
<li><a class="reference internal" href="#assemble" id="id47">assemble</a></li>
|
|
<li><a class="reference internal" href="#async-status" id="id48">async_status</a></li>
|
|
<li><a class="reference internal" href="#authorized-key" id="id49">authorized_key</a></li>
|
|
<li><a class="reference internal" href="#command" id="id50">command</a></li>
|
|
<li><a class="reference internal" href="#copy" id="id51">copy</a></li>
|
|
<li><a class="reference internal" href="#easy-install" id="id52">easy_install</a></li>
|
|
<li><a class="reference internal" href="#facter" id="id53">facter</a></li>
|
|
<li><a class="reference internal" href="#fail" id="id54">fail</a></li>
|
|
<li><a class="reference internal" href="#fetch" id="id55">fetch</a></li>
|
|
<li><a class="reference internal" href="#file" id="id56">file</a></li>
|
|
<li><a class="reference internal" href="#fireball" id="id57">fireball</a></li>
|
|
<li><a class="reference internal" href="#get-url" id="id58">get_url</a></li>
|
|
<li><a class="reference internal" href="#git" id="id59">git</a></li>
|
|
<li><a class="reference internal" href="#group" id="id60">group</a></li>
|
|
<li><a class="reference internal" href="#ini-file" id="id61">ini_file</a></li>
|
|
<li><a class="reference internal" href="#lineinfile" id="id62">lineinfile</a></li>
|
|
<li><a class="reference internal" href="#mount" id="id63">mount</a></li>
|
|
<li><a class="reference internal" href="#mysql-db" id="id64">mysql_db</a></li>
|
|
<li><a class="reference internal" href="#mysql-user" id="id65">mysql_user</a></li>
|
|
<li><a class="reference internal" href="#nagios" id="id66">nagios</a></li>
|
|
<li><a class="reference internal" href="#ohai" id="id67">ohai</a></li>
|
|
<li><a class="reference internal" href="#pause" id="id68">pause</a></li>
|
|
<li><a class="reference internal" href="#ping" id="id69">ping</a></li>
|
|
<li><a class="reference internal" href="#pip" id="id70">pip</a></li>
|
|
<li><a class="reference internal" href="#postgresql-db" id="id71">postgresql_db</a></li>
|
|
<li><a class="reference internal" href="#postgresql-user" id="id72">postgresql_user</a></li>
|
|
<li><a class="reference internal" href="#raw" id="id73">raw</a></li>
|
|
<li><a class="reference internal" href="#seboolean" id="id74">seboolean</a></li>
|
|
<li><a class="reference internal" href="#selinux" id="id75">selinux</a></li>
|
|
<li><a class="reference internal" href="#service" id="id76">service</a></li>
|
|
<li><a class="reference internal" href="#setup" id="id77">setup</a></li>
|
|
<li><a class="reference internal" href="#shell" id="id78">shell</a></li>
|
|
<li><a class="reference internal" href="#slurp" id="id79">slurp</a></li>
|
|
<li><a class="reference internal" href="#subversion" id="id80">subversion</a></li>
|
|
<li><a class="reference internal" href="#supervisorctl" id="id81">supervisorctl</a></li>
|
|
<li><a class="reference internal" href="#template" id="id82">template</a></li>
|
|
<li><a class="reference internal" href="#user" id="id83">user</a></li>
|
|
<li><a class="reference internal" href="#virt" id="id84">virt</a></li>
|
|
<li><a class="reference internal" href="#wait-for" id="id85">wait_for</a></li>
|
|
<li><a class="reference internal" href="#yum" id="id86">yum</a></li>
|
|
<li><a class="reference internal" href="#additional-contrib-modules" id="id87">Additional Contrib Modules</a></li>
|
|
<li><a class="reference internal" href="#writing-your-own-modules" id="id88">Writing your own modules</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="introduction">
|
|
<h2><a class="toc-backref" href="#contents">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
|
|
<p>Ansible ships with a number of modules (called the ‘module library’)
|
|
that can be executed directly on remote hosts or through <a class="reference internal" href="playbooks.html"><em>Playbooks</em></a>.
|
|
Users can also write their own modules. These modules can control system
|
|
resources, like services, packages, or files (anything really), or
|
|
handle executing system commands.</p>
|
|
<p>Let’s review how we execute three different modules from the command line:</p>
|
|
<div class="highlight-python"><pre>ansible webservers -m service -a "name=httpd state=running"
|
|
ansible webservers -m ping
|
|
ansible webservers -m command -a "/sbin/reboot -t now"</pre>
|
|
</div>
|
|
<p>Each module supports taking arguments. Nearly all modules take <tt class="docutils literal"><span class="pre">key=value</span></tt>
|
|
arguments, space delimited. Some modules take no arguments, and the
|
|
command/shell modules simply take the string of the command you want to run.</p>
|
|
<p>From playbooks, Ansible modules are executed in a very similar way:</p>
|
|
<div class="highlight-python"><pre>- name: reboot the servers
|
|
action: command /sbin/reboot -t now</pre>
|
|
</div>
|
|
<p>All modules technically return JSON format data, though if you are using the
|
|
command line or playbooks, you don’t really need to know much about
|
|
that. If you’re writing your own module, you care, and this means you do
|
|
not have to write modules in any particular language – you get to choose.</p>
|
|
<p>Modules are <cite>idempotent</cite>, meaning they will seek to avoid changes to the system unless a change needs to be made. When using Ansible
|
|
playbooks, these modules can trigger ‘change events’ in the form of notifying ‘handlers’
|
|
to run additional tasks.</p>
|
|
<p>Let’s see what’s available in the Ansible module library, out of the box:</p>
|
|
</div>
|
|
<div class="section" id="apt">
|
|
<span id="id1"></span><h2><a class="toc-backref" href="#contents">apt</a><a class="headerlink" href="#apt" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.0.2.</span></p>
|
|
<p>Manages apt-packages (such as for Debian/Ubuntu).</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>purge</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Will force purging of configuration files if the module state is set to <code>absent</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>installed</li><li>latest</li><li>remove</li><li>absent</li><li>present</li></ul></td>
|
|
<td>Indicates the desired package state</td>
|
|
</tr>
|
|
<tr>
|
|
<td>force</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>If <code>yes</code>, force installs/removes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>pkg</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>A package name or package specifier with version, like <code>foo</code> or <code>foo=1.0</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>update_cache</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Run the equivalent of <code>apt-get update</code> before the operation. Can be run as part of the package installation or as a seperate step</td>
|
|
</tr>
|
|
<tr>
|
|
<td>default_release</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Corresponds to the <code>-t</code> option for <em>apt</em> and sets pin priorities</td>
|
|
</tr>
|
|
<tr>
|
|
<td>install_recommends</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Corresponds to the <code>--no-install-recommends</code> option for <em>apt</em>, default behavior works as apt's default behavior, <code>no</code> does not install recommended packages. Suggested packages are never installed.</td>
|
|
</tr>
|
|
</table><p>Update repositories cache and install <code>foo</code> package</p> <p><pre>
|
|
apt pkg=foo update-cache=yes
|
|
</pre></p>
|
|
<p>Remove <code>foo</code> package</p> <p><pre>
|
|
apt pkg=foo state=removed
|
|
</pre></p>
|
|
<p>Install the the package <code>foo</code></p> <p><pre>
|
|
apt pkg=foo state=installed
|
|
</pre></p>
|
|
<p>Install the version '1.00' of package <code>foo</code></p> <p><pre>
|
|
apt pkg=foo=1.00 state=installed
|
|
</pre></p>
|
|
<p>Update the repository cache and update package <code>ngnix</code> to latest version using default release <code>squeeze-backport</code></p> <p><pre>
|
|
apt pkg=nginx state=latest default-release=squeeze-backports update-cache=yes
|
|
</pre></p>
|
|
<p>Install latest version of <code>openjdk-6-jdk</code> ignoring <code>install-recomands</code></p> <p><pre>
|
|
apt pkg=openjdk-6-jdk state=latest install-recommends=no
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="apt-repository">
|
|
<span id="id2"></span><h2><a class="toc-backref" href="#contents">apt_repository</a><a class="headerlink" href="#apt-repository" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>Manages apt repositores (such as for Debian/Ubuntu).</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>repo</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The repository name/value</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>The repository state</td>
|
|
</tr>
|
|
</table><p>Add nginx stable repository from PPA</p> <p><pre>
|
|
apt_repository repo=ppa://nginx/stable
|
|
</pre></p>
|
|
<p>Add specified repository into sources.</p> <p><pre>
|
|
apt_repository repo='deb http://archive.canonical.com/ubuntu hardy partner'
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>This module works on Debian and Ubuntu only and requires <code>apt-add-repository</code> be available on destination server. To ensure this package is available use the <code>apt</code> module and install the <code>python-software-properties</code> package before using this module.</p>
|
|
<p>A bug in <code>apt-add-repository</code> always adds <code>deb</code> and <code>deb-src</code> types for repositories (see the issue on Launchpad <a href='https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264'>https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264</a>), if a repo doesn't have source information (eg MongoDB repo from 10gen) the system will fail while updating repositories.</p></div>
|
|
<div class="section" id="assemble">
|
|
<span id="id3"></span><h2><a class="toc-backref" href="#contents">assemble</a><a class="headerlink" href="#assemble" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.5.</span></p>
|
|
<p>Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a <tt class="docutils literal"><span class="pre">conf.d</span></tt> style structure where it is easy to build up the configuration from multiple sources. Assemble will take a directory of files that have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea <em>fragments</em>.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>A file to create using the concatenation of all of the source files.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>src</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>An already existing directory full of source files.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>backup</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Create a backup file (if <code>yes</code>), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>others</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>all arguments accepted by the <span class='module'>file</span> module also work here</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
assemble src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="async-status">
|
|
<span id="id4"></span><h2><a class="toc-backref" href="#contents">async_status</a><a class="headerlink" href="#async-status" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.5.</span></p>
|
|
<p>This module gets the status of an asynchronous task. See: <a class="reference external" href="http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling">http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling</a></p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>jid</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Job or task identifier</td>
|
|
</tr>
|
|
<tr>
|
|
<td>mode</td>
|
|
<td>no</td>
|
|
<td>status</td>
|
|
<td><ul><li>status</li><li>cleanup</li></ul></td>
|
|
<td>if <code>status</code>, obtain the status; if <code>cleanup</code>, clean up the async job cache located in <code>~/.ansible_async/</code> for the specified job <em>jid</em>.</td>
|
|
</tr>
|
|
</table><br/><h4>Notes</h4>
|
|
<p>See <a href='http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling'>http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling</a></p></div>
|
|
<div class="section" id="authorized-key">
|
|
<span id="id5"></span><h2><a class="toc-backref" href="#contents">authorized_key</a><a class="headerlink" href="#authorized-key" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.5.</span></p>
|
|
<p>Adds or removes an SSH authorized key for a user from a remote host.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>whether the given key should or should not be in the file</td>
|
|
</tr>
|
|
<tr>
|
|
<td>user</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Name of the user who should have access to the remote host</td>
|
|
</tr>
|
|
<tr>
|
|
<td>key</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>the SSH public key, as a string</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
authorized_key user=charlie key="ssh-dss ASDF1234L+8BTwaRYr/rycsBF1D8e5pTxEsXHQs4iq+mZdyWqlW++L6pMiam1A8yweP+rKtgjK2httVS6GigVsuWWfOd7/sdWippefq74nppVUELHPKkaIOjJNN1zUHFoL/YMwAAAEBALnAsQN10TNGsRDe5arBsW8cTOjqLyYBcIqgPYTZW8zENErFxt7ij3fW3Jh/sCpnmy8rkS7FyK8ULX0PEy/2yDx8/5rXgMIICbRH/XaBy9Ud5bRBFVkEDu/r+rXP33wFPHjWjwvHAtfci1NRBAudQI/98DbcGQw5HmE89CjgZRo5ktkC5yu/8agEPocVjdHyZr7PaHfxZGUDGKtGRL2QzRYukCmWo1cZbMBHcI5FzImvTHS9/8B3SATjXMPgbfBuEeBwuBK5EjL+CtHY5bWs9kmYjmeo0KfUMH8hY4MAXDoKhQ7DhBPIrcjS5jPtoGxIREZjba67r6/P2XKXaCZH6Fc= charlie@example.org 2011-01-17"
|
|
</pre></p>
|
|
<p>Shorthand available in Ansible 0.8 and later</p> <p><pre>
|
|
authorized_key user=charlie key=$FILE(/home/charlie/.ssh/id_rsa.pub)
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="command">
|
|
<span id="id6"></span><h2><a class="toc-backref" href="#contents">command</a><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 space-delimited arguments.
|
|
The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like <tt class="docutils literal"><span class="pre">$HOME</span></tt> and operations like <tt class="docutils literal"><span class="pre">"<"</span></tt>, <tt class="docutils literal"><span class="pre">">"</span></tt>, <tt class="docutils literal"><span class="pre">"|"</span></tt>, and <tt class="docutils literal"><span class="pre">"&"</span></tt> will not work. As such, all paths to commands must be fully qualified</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>creates</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>a filename, when it already exists, this step will <b>not</b> be run.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>free_form</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>the command module takes a free form command to run</td>
|
|
</tr>
|
|
<tr>
|
|
<td>chdir</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>cd into this directory before running the command (added in Ansible 0.6)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>removes</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>a filename, when it does not exist, this step will <b>not</b> be run. (added in Ansible 0.8)</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
command /sbin/shutdown -t now
|
|
</pre></p>
|
|
<p><em>creates</em>, <em>removes</em>, and <em>chdir</em> can be specified after the command. For instance, if you only want to run a command if a certain file does not exist, use this.</p> <p><pre>
|
|
command /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>If you want to run a command through the shell (say you are using <code><</code>, <code>></code>, <code>|</code>, etc), you actually want the <span class='module'>shell</span> module instead. The <span class='module'>command</span> module is much more secure as it's not affected by the user's environment.</p></div>
|
|
<div class="section" id="copy">
|
|
<span id="id7"></span><h2><a class="toc-backref" href="#contents">copy</a><a class="headerlink" href="#copy" title="Permalink to this headline">¶</a></h2>
|
|
<p>The <tt class="docutils literal"><span class="pre">copy</span></tt> module copies a file on the local box to remote locations.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Remote absolute path where the file should be copied to.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>src</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Local path to a file to copy to the remote server; can be absolute or relative.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>backup</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. (added in Ansible 0.7)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>others</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>all arguments accepted by the <span class='module'>file</span> module also work here</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
copy src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644
|
|
</pre></p>
|
|
<p>Copy a new <code>ntp.conf</code> file into place, backing up the original if it differs from the copied version</p> <p><pre>
|
|
copy src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="easy-install">
|
|
<span id="id8"></span><h2><a class="toc-backref" href="#contents">easy_install</a><a class="headerlink" href="#easy-install" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>Installs Python libraries, optionally in a <em>virtualenv</em></p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>virtualenv</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>an optional <em>virtualenv</em> directory path to install into. If the <em>virtualenv</em> does not exist, it is created automatically</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>A Python library name</td>
|
|
</tr>
|
|
</table><p>Examples from Ansible Playbooks</p> <p><pre>
|
|
easy_install name=pip
|
|
</pre></p>
|
|
<p>Install <em>Flask</em> (<a href='http://flask.pocoo.org/'>http://flask.pocoo.org/</a>) into the specified <em>virtualenv</em></p> <p><pre>
|
|
easy_install name=flask virtualenv=/webapps/myapp/venv
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Please note that the <span class='module'>easy_install</span> module can only install Python libraries. Thus this module is not able to remove libraries. It is generally recommended to use the <span class='module'>pip</span> module which you can first install using <span class='module'>easy_install</span>.</p>
|
|
<p>Also note that <em>virtualenv</em> must be installed on the remote host if the <code>virtualenv</code> parameter is specified.</p></div>
|
|
<div class="section" id="facter">
|
|
<span id="id9"></span><h2><a class="toc-backref" href="#contents">facter</a><a class="headerlink" href="#facter" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.2.</span></p>
|
|
<p>Runs the <em>facter</em> discovery program (<a class="reference external" href="https://github.com/puppetlabs/facter">https://github.com/puppetlabs/facter</a>) on the remote system, returning JSON data that can be useful for inventory purposes.</p>
|
|
<p>Example command-line invocation</p> <p><pre>
|
|
ansible www.example.net -m facter
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="fail">
|
|
<span id="id10"></span><h2><a class="toc-backref" href="#contents">fail</a><a class="headerlink" href="#fail" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.8.</span></p>
|
|
<p>This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using only_if.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>msg</td>
|
|
<td>no</td>
|
|
<td>Failed because only_if condition is true</td>
|
|
<td><ul></ul></td>
|
|
<td>The customized message used for failing execution. If ommited, fail will simple bail out with a generic message.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>rc</td>
|
|
<td>no</td>
|
|
<td>1</td>
|
|
<td><ul></ul></td>
|
|
<td>The return code of the failure. This is currently not used by Ansible, but might be used in the future.</td>
|
|
</tr>
|
|
</table><p>Example of how a playbook may fail when a condition is not met</p> <p><pre>
|
|
[{'action': 'fail msg="The system may not be provisioned according to the CMDB status."', 'only_if': "'$cmdb_status' != 'to-be-staged'"}]
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="fetch">
|
|
<span id="id11"></span><h2><a class="toc-backref" href="#contents">fetch</a><a class="headerlink" href="#fetch" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.2.</span></p>
|
|
<p>This module works like <tt class="docutils literal"><span class="pre">copy</span></tt>, 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>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>A directory to save the file into. For example, if the <em>dest</em> directory is <code>/backup</code> a src file named <code>/etc/profile</code> on host <code>host.example.com</code>, would be saved into <code>/backup/host.example.com/etc/profile</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>src</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The file on the remote system to fetch. This must be a file, not a directory. Recursive fetching may be supported in a later release.</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
fetch src=/var/log/messages dest=/home/logtree
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="file">
|
|
<span id="id12"></span><h2><a class="toc-backref" href="#contents">file</a><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 <tt class="docutils literal"><span class="pre">copy</span></tt>, <tt class="docutils literal"><span class="pre">template</span></tt>, and <tt class="docutils literal"><span class="pre">assmeble</span></tt>.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>src</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>path of the file to link to (applies only to <code>state=link</code>).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>group</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the group that should own the file/directory, as would be fed to <em>chown</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>defines the file being managed, unless when used with <em>state=link</em>, and then sets the destination to create a symbolic link to using <em>src</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td>selevel</td>
|
|
<td>no</td>
|
|
<td>s0</td>
|
|
<td><ul></ul></td>
|
|
<td>level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the <code>range</code>. <code>_default</code> feature works as for <em>seuser</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>seuser</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>user part of SELinux file context. Will default to system policy, if applicable. If set to <code>_default</code>, it will use the <code>user</code> portion of the the policy if available</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>file</td>
|
|
<td><ul><li>file</li><li>link</li><li>directory</li><li>absent</li></ul></td>
|
|
<td>If <code>directory</code>, all immediate subdirectories will be created if they do not exist. If <code>file</code>, the file will NOT be created if it does not exist, see the <span class='module'>copy</span> or <span class='module'>template</span> module if you want that behavior. If <code>link</code>, the symbolic link will be created or changed. If <code>absent</code>, directories will be recursively deleted, and files or symlinks will be unlinked.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serole</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>role part of SELinux file context, <code>_default</code> feature works as for <em>seuser</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>mode</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>mode the file or directory should be, such as 0644 as would be fed to</td>
|
|
</tr>
|
|
<tr>
|
|
<td>context</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul><li>default</li></ul></td>
|
|
<td>accepts only <code>default</code> as value. This will restore a file's SELinux context in the policy. Does nothing if no default value is available.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>owner</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the user that should own the file/directory, as would be fed to <em>chown</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td>force</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>force is required when changing an existing file to a directory, or a link to a directory, and so on. Use this with caution.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>setype</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>type part of SELinux file context, <code>_default</code> feature works as for <em>seuser</em>.</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
file path=/etc/foo.conf owner=foo group=foo mode=0644
|
|
</pre></p>
|
|
<p><pre>
|
|
file src=/file/to/link/to dest=/path/to/symlink owner=foo group=foo state=link
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>See also <span class='module'>copy</span>, <span class='module'>template</span>, <span class='module'>assemble</span></p></div>
|
|
<div class="section" id="fireball">
|
|
<span id="id13"></span><h2><a class="toc-backref" href="#contents">fireball</a><a class="headerlink" href="#fireball" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.9.</span></p>
|
|
<p>This modules launches an ephemeral <em>fireball</em> ZeroMQ message bus daemon on the remote node which Ansible can to communicate with nodes at high speed.
|
|
The daemon listens on a configurable port for a configurable amount of time.
|
|
Starting a new fireball as a given user terminates any existing user fireballs.
|
|
Fireball mode is AES encrypted</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>minutes</td>
|
|
<td>no</td>
|
|
<td>30</td>
|
|
<td><ul></ul></td>
|
|
<td>The <em>fireball</em> listener daemon is started on nodes and will stay around for this number of minutes before turning itself off.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>port</td>
|
|
<td>no</td>
|
|
<td>5099</td>
|
|
<td><ul></ul></td>
|
|
<td>TCP port for ZeroMQ</td>
|
|
</tr>
|
|
</table><p>This example playbook has two plays: the first launches <em>fireball</em> mode on all hosts via SSH, and the second actually starts using <em>fireball</em> node for subsequent management over the fireball interface</p> <p><pre>
|
|
- hosts: devservers
|
|
gather_facts: false
|
|
connection: ssh
|
|
sudo: yes
|
|
tasks:
|
|
- action: fireball
|
|
|
|
- hosts: devservers
|
|
connection: fireball
|
|
tasks:
|
|
- action: command /usr/bin/anything
|
|
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>See the advanced playbooks chapter for more about using fireball mode.</p></div>
|
|
<div class="section" id="get-url">
|
|
<span id="id14"></span><h2><a class="toc-backref" href="#contents">get_url</a><a class="headerlink" href="#get-url" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.6.</span></p>
|
|
<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>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>url</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>HTTP, HTTPS, or FTP URL</td>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>absolute path of where to download the file to.If <em>dest</em> is a directory, the basename of the file on the remote server will be used. If a directory, <em>thirsty=yes</em> must also be set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>thirsty</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>if <code>yes</code>, will download the file every time and replace the file if the contents change. if <code>no</code>, the file will only be downloaded if the destination does not exist. Generally should be <code>yes</code> only for small local files. prior to 0.6, acts if <code>yes</code> by default. (added in Ansible 0.7)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>others</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>all arguments accepted by the <span class='module'>file</span> module also work here</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
get_url url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>This module doesn't yet support configuration for proxies or passwords.</p></div>
|
|
<div class="section" id="git">
|
|
<span id="id15"></span><h2><a class="toc-backref" href="#contents">git</a><a class="headerlink" href="#git" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.0.1.</span></p>
|
|
<p>Manage git checkouts of repositories to deploy files or software.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>repo</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>git, ssh, or http protocol address of the git repository.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Absolute path of where the repository should be checked out to.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>version</td>
|
|
<td>no</td>
|
|
<td>HEAD</td>
|
|
<td><ul></ul></td>
|
|
<td>What version of the repository to check out. This can be the git <em>SHA</em>, the literal string <em>HEAD</em>, branch name, or a tag name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>force</td>
|
|
<td>no</td>
|
|
<td>yes</td>
|
|
<td><ul><li>True</li><li>False</li></ul></td>
|
|
<td>(New in 0.7) If yes, any modified files in the working repository will be discarded. Prior to 0.7, this was always 'yes' and could not be disabled.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>remote</td>
|
|
<td>no</td>
|
|
<td>origin</td>
|
|
<td><ul></ul></td>
|
|
<td>Name of the remote branch.</td>
|
|
</tr>
|
|
</table><p>Example git checkout from Ansible Playbooks</p> <p><pre>
|
|
git repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="group">
|
|
<span id="id16"></span><h2><a class="toc-backref" href="#contents">group</a><a class="headerlink" href="#group" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.0.2.</span></p>
|
|
<p>Manage presence of groups on a host.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>Whether the group should be present or not on the remote host.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>gid</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optional <em>GID</em> to set for the group.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Name of the group to manage.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>system</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>True</li><li>False</li></ul></td>
|
|
<td>If <em>yes</em>, indicates that the group created is a system group.</td>
|
|
</tr>
|
|
</table><p>Example group command from Ansible Playbooks</p> <p><pre>
|
|
group name=somegroup state=present
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="ini-file">
|
|
<span id="id17"></span><h2><a class="toc-backref" href="#contents">ini_file</a><a class="headerlink" href="#ini-file" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.9.</span></p>
|
|
<p>Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, <tt class="docutils literal"><span class="pre">template</span></tt> or <tt class="docutils literal"><span class="pre">assemble</span></tt>. Adds missing sections if they don’t exist.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>option</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>if set (required for changing a <em>value</em>), this is the name of the option.May be omitted if adding/removing a whole <em>section</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>others</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>all arguments accepted by the <span class='module'>file</span> module also work here</td>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Path to the INI-style file; this file is created if required</td>
|
|
</tr>
|
|
<tr>
|
|
<td>section</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Section name in INI file. This is added if <code>state=present</code> automatically when a single value is being set.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>backup</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>value</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>the string value to be associated with an <em>option</em>. May be omitted when removing an <em>option</em>.</td>
|
|
</tr>
|
|
</table><p>Ensure <code>fav=lemonade</code> is in section <code>[drinks]</code> in said file</p> <p><pre>
|
|
ini_file dest=/etc/conf section=drinks option=fav value=lemonade mode=0600 backup=true
|
|
</pre></p>
|
|
<p><pre>
|
|
ini_file dest=/etc/anotherconf
|
|
section=drinks
|
|
option=temperature
|
|
value=cold
|
|
backup=true
|
|
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>While it is possible to add an <em>option</em> without specifying a <em>value</em>, this makes no sense.</p></div>
|
|
<div class="section" id="lineinfile">
|
|
<span id="id18"></span><h2><a class="toc-backref" href="#contents">lineinfile</a><a class="headerlink" href="#lineinfile" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>This module will search a file for a line, and ensure that it is present or absent.
|
|
This is primarily useful when you want to change a single line in a file only. For other cases, see the <tt class="docutils literal"><span class="pre">copy</span></tt> or <tt class="docutils literal"><span class="pre">template</span></tt> modules.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>Whether the line should be there or not.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The file to modify</td>
|
|
</tr>
|
|
<tr>
|
|
<td>insertafter</td>
|
|
<td>no</td>
|
|
<td>EOF</td>
|
|
<td><ul><li>BOF</li><li>EOF</li></ul></td>
|
|
<td>Used with <code>state=present</code>. If specified, the line will be inserted after the specified regular expression. Two special values are available; <code>BOF</code> for inserting the line at the beginning of the file, and <code>EOF</code> for inserting the line at the end of the file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>regexp</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The regular expression to look for in the file. For <code>state=present</code>, the pattern to replace. For <code>state=absent</code>, the pattern of the line to remove.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>line</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Required for <code>state=present</code>. The line to insert/replace into the file. Must match the value given to <code>regexp</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>backup</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.</td>
|
|
</tr>
|
|
</table> <p><pre>
|
|
lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
|
|
</pre></p>
|
|
<p><pre>
|
|
lineinfile name=/etc/sudoers state=absent regexp="^%wheel"
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="mount">
|
|
<span id="id19"></span><h2><a class="toc-backref" href="#contents">mount</a><a class="headerlink" href="#mount" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.6.</span></p>
|
|
<p>This module controls active and configured mount points in <tt class="docutils literal"><span class="pre">/etc/fstab</span></tt>.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>src</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>device to be mounted on <em>name</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul><li>present</li><li>absent</li><li>mounted</li><li>unmounted</li></ul></td>
|
|
<td>If <code>mounted</code> or <code>unmounted</code>, the device will be actively mounted or unmounted as well as just configured in <em>fstab</em>. <code>absent</code> and <code>present</code> only deal with <em>fstab</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>path to the mount point, eg: <code>/mnt/files</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>dump</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>dump (see fstab(8))</td>
|
|
</tr>
|
|
<tr>
|
|
<td>passno</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>passno (see fstab(8))</td>
|
|
</tr>
|
|
<tr>
|
|
<td>opts</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>mount options (see fstab(8))</td>
|
|
</tr>
|
|
<tr>
|
|
<td>fstype</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>file-system type</td>
|
|
</tr>
|
|
</table><p>Mount DVD read-only</p> <p><pre>
|
|
mount name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="mysql-db">
|
|
<span id="id20"></span><h2><a class="toc-backref" href="#contents">mysql_db</a><a class="headerlink" href="#mysql-db" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.6.</span></p>
|
|
<p>Add or remove MySQL databases from a remote host.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>The database state</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the database to add or remove</td>
|
|
</tr>
|
|
<tr>
|
|
<td>encoding</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Encoding mode</td>
|
|
</tr>
|
|
<tr>
|
|
<td>collation</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Collation mode</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_user</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The username used to authenticate with</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_host</td>
|
|
<td>no</td>
|
|
<td>localhost</td>
|
|
<td><ul></ul></td>
|
|
<td>Host running the database</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_password</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The password used to authenticate with</td>
|
|
</tr>
|
|
</table><p>Create a new database with name 'bobdata'</p> <p><pre>
|
|
mysql_db db=bobdata state=present
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb.</p>
|
|
<p>Both <code>login_password</code> and <code>login_username</code> are required when you are passing credentials. If none are present, the module will attempt to read the credentials from <code>~/.my.cnf</code>, and finally fall back to using the MySQL default login of 'root' with no password.</p></div>
|
|
<div class="section" id="mysql-user">
|
|
<span id="id21"></span><h2><a class="toc-backref" href="#contents">mysql_user</a><a class="headerlink" href="#mysql-user" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.6.</span></p>
|
|
<p>Adds or removes a user from a MySQL database.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the user (role) to add or remove</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_user</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The username used to authenticate with</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_host</td>
|
|
<td>no</td>
|
|
<td>localhost</td>
|
|
<td><ul></ul></td>
|
|
<td>Host running the database</td>
|
|
</tr>
|
|
<tr>
|
|
<td>host</td>
|
|
<td>no</td>
|
|
<td>localhost</td>
|
|
<td><ul></ul></td>
|
|
<td>the 'host' part of the MySQL username</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>The database state</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_password</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The password used to authenticate with</td>
|
|
</tr>
|
|
<tr>
|
|
<td>password</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>set the user's password</td>
|
|
</tr>
|
|
<tr>
|
|
<td>priv</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>MySQL privileges string in the format: <code>db.table:priv1,priv2</code></td>
|
|
</tr>
|
|
</table><p>Create database user with name 'bob' and password '12345' with all database privileges</p> <p><pre>
|
|
mysql_user name=bob password=12345 priv=*.*:ALL state=present
|
|
</pre></p>
|
|
<p>Ensure no user named 'sally' exists, also passing in the auth credentials.</p> <p><pre>
|
|
mysql_user login_user=root login_password=123456 name=sally state=absent
|
|
</pre></p>
|
|
<p>Example privileges string format</p> <p><pre>
|
|
mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb.</p>
|
|
<p>Both <code>login_password</code> and <code>login_username</code> are required when you are passing credentials. If none are present, the module will attempt to read the credentials from <code>~/.my.cnf</code>, and finally fall back to using the MySQL default login of 'root' with no password.</p></div>
|
|
<div class="section" id="nagios">
|
|
<span id="id22"></span><h2><a class="toc-backref" href="#contents">nagios</a><a class="headerlink" href="#nagios" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>The <tt class="docutils literal"><span class="pre">nagios</span></tt> module has two basic functions: scheduling downtime and toggling alerts for services or hosts.
|
|
All actions require the <tt class="docutils literal"><span class="pre">host</span></tt> parameter to be given explicitly. In playbooks you can use the <tt class="docutils literal"><span class="pre">$inventory_hostname</span></tt> variable to refer to the host the playbook is currently running on.
|
|
You can specify multiple services at once by separating them with commas, .e.g., <tt class="docutils literal"><span class="pre">services=httpd,nfs,puppet</span></tt>.
|
|
When specifying what service to handle there is a special service value, <em>host</em>, which will handle alerts/downtime for the <em>host itself</em>, e.g., <tt class="docutils literal"><span class="pre">service=host</span></tt>. This keyword may not be given with other services at the same time. <em>Setting alerts/downtime for a host does not affect alerts/downtime for any of the services running on it.</em>
|
|
When using the <tt class="docutils literal"><span class="pre">nagios</span></tt> module you will need to specify your nagios server using the <tt class="docutils literal"><span class="pre">delegate_to</span></tt> parameter.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>action</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul><li>downtime</li><li>enable_alerts</li><li>disable_alerts</li><li>silence</li><li>unsilence</li></ul></td>
|
|
<td>Action to take.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>host</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Host to operate on in Nagios.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>author</td>
|
|
<td>no</td>
|
|
<td>Ansible</td>
|
|
<td><ul></ul></td>
|
|
<td>Author to leave downtime comments as. - Only useable with the <code>downtime</code> action.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>services</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>What to manage downtime/alerts for. Separate multiple services with commas.<code>service</code> is an alias for <code>services</code>.<b>Required</b> option when using the <code>downtime</code>, <code>enable_alerts</code>, and <code>disable_alerts</code> actions.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>minutes</td>
|
|
<td>no</td>
|
|
<td>30</td>
|
|
<td><ul></ul></td>
|
|
<td>Minutes to schedule downtime for.Only useable with the <code>downtime</code> action.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>cmdfile</td>
|
|
<td>no</td>
|
|
<td>auto-detected</td>
|
|
<td><ul></ul></td>
|
|
<td>Path to the nagios <em>command file</em> (FIFO pipe).Only required if auto-detection fails.</td>
|
|
</tr>
|
|
</table><p>set 30 minutes of apache downtime</p> <p><pre>
|
|
nagios action=downtime minutes=30 service=httpd host=$inventory_hostname
|
|
</pre></p>
|
|
<p>schedule an hour of HOST downtime</p> <p><pre>
|
|
nagios action=downtime minutes=60 service=host host=$inventory_hostname
|
|
</pre></p>
|
|
<p>schedule downtime for a few services</p> <p><pre>
|
|
nagios action=downtime services=frob,foobar,qeuz host=$inventory_hostname
|
|
</pre></p>
|
|
<p>enable SMART disk alerts</p> <p><pre>
|
|
nagios action=enable_alerts service=smart host=$inventory_hostname
|
|
</pre></p>
|
|
<p>two services at once: disable httpd and nfs alerts</p> <p><pre>
|
|
nagios action=disable_alerts service=httpd,nfs host=$inventory_hostname
|
|
</pre></p>
|
|
<p>disable HOST alerts</p> <p><pre>
|
|
nagios action=disable_alerts service=host host=$inventory_hostname
|
|
</pre></p>
|
|
<p>silence ALL alerts</p> <p><pre>
|
|
nagios action=silence host=$inventory_hostname
|
|
</pre></p>
|
|
<p>unsilence all alerts</p> <p><pre>
|
|
nagios action=unsilence host=$inventory_hostname
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="ohai">
|
|
<span id="id23"></span><h2><a class="toc-backref" href="#contents">ohai</a><a class="headerlink" href="#ohai" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.6.</span></p>
|
|
<p>Similar to the <tt class="docutils literal"><span class="pre">facter</span></tt> module, this runs the <em>ohai</em> discovery program (<a class="reference external" href="http://wiki.opscode.com/display/chef/Ohai">http://wiki.opscode.com/display/chef/Ohai</a>) on the remote host and returns JSON inventory data. <em>Ohai</em> data is a bit more verbose and nested than <em>facter</em>.</p>
|
|
<p>Retrieve <em>ohai</em> data from all Web servers and store in one-file per host</p> <p><pre>
|
|
ansible webservers -m ohai --tree=/tmp/ohaidata
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="pause">
|
|
<span id="id24"></span><h2><a class="toc-backref" href="#contents">pause</a><a class="headerlink" href="#pause" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.8.</span></p>
|
|
<p>Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to pause with a prompt.
|
|
You can use <tt class="docutils literal"><span class="pre">ctrl+c</span></tt> if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early: press <tt class="docutils literal"><span class="pre">ctrl+c</span></tt> and then <tt class="docutils literal"><span class="pre">c</span></tt>. To abort a playbook: press <tt class="docutils literal"><span class="pre">ctrl+c</span></tt> and then <tt class="docutils literal"><span class="pre">a</span></tt>.
|
|
The pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with the <tt class="docutils literal"><span class="pre">serial</span></tt> playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>seconds</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Number of minutes to pause for.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>minutes</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Number of minutes to pause for.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>prompt</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optional text to use for the prompt message.</td>
|
|
</tr>
|
|
</table><p>Pause for 5 minutes to build app cache.</p> <p><pre>
|
|
pause minutes=5
|
|
</pre></p>
|
|
<p>Pause until you can verify updates to an application were successful.</p> <p><pre>
|
|
pause
|
|
</pre></p>
|
|
<p>A helpful reminder of what to look out for post-update.</p> <p><pre>
|
|
pause prompt=Make sure org.foo.FooOverload exception is not present
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="ping">
|
|
<span id="id25"></span><h2><a class="toc-backref" href="#contents">ping</a><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 <tt class="docutils literal"><span class="pre">/usr/bin/ansible</span></tt></p>
|
|
<p>Test 'webservers' status</p> <p><pre>
|
|
ansible webservers -m ping
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="pip">
|
|
<span id="id26"></span><h2><a class="toc-backref" href="#contents">pip</a><a class="headerlink" href="#pip" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>Manage Python library dependencies.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>virtualenv</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>An optional path to a virtualenv directory to install into</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li><li>latest</li></ul></td>
|
|
<td>The state of module</td>
|
|
</tr>
|
|
<tr>
|
|
<td>version</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The version number to install of the Python library specified in the 'name' parameter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>requirements</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The path to a pip requirements file</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The name of a Python library to install</td>
|
|
</tr>
|
|
</table><p>Install <em>flask</em> python package.</p> <p><pre>
|
|
pip name=flask
|
|
</pre></p>
|
|
<p>Install <em>flask</em> python package on version 0.8.</p> <p><pre>
|
|
pip name=flask version=0.8
|
|
</pre></p>
|
|
<p>Install <em>Flask</em> (<a href='http://flask.pocoo.org/'>http://flask.pocoo.org/</a>) into the specified <em>virtualenv</em></p> <p><pre>
|
|
pip name=flask virtualenv=/srv/webapps/my_app/venv
|
|
</pre></p>
|
|
<p>Install specified python requirements.</p> <p><pre>
|
|
pip requirements=/srv/webapps/my_app/src/requirements.txt
|
|
</pre></p>
|
|
<p>Install specified python requirements in indicated virtualenv.</p> <p><pre>
|
|
pip requirements=/srv/webapps/my_app/src/requirements.txt virtualenv=/srv/webapps/my_app/venv
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Please note that <a href='http://www.virtualenv.org/, virtualenv'>http://www.virtualenv.org/, virtualenv</a> must be installed on the remote host if the virtualenv parameter is specified.</p></div>
|
|
<div class="section" id="postgresql-db">
|
|
<span id="id27"></span><h2><a class="toc-backref" href="#contents">postgresql_db</a><a class="headerlink" href="#postgresql-db" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.6.</span></p>
|
|
<p>Add or remove PostgreSQL databases from a remote host.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>The database state</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the database to add or remove</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_password</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The password used to authenticate with</td>
|
|
</tr>
|
|
<tr>
|
|
<td>owner</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Name of the role to set as owner of the database</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_user</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The username used to authenticate with</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_host</td>
|
|
<td>no</td>
|
|
<td>localhost</td>
|
|
<td><ul></ul></td>
|
|
<td>Host running the database</td>
|
|
</tr>
|
|
</table><p>Create a new database with name 'acme'</p> <p><pre>
|
|
postgresql_db db=acme
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<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></div>
|
|
<div class="section" id="postgresql-user">
|
|
<span id="id28"></span><h2><a class="toc-backref" href="#contents">postgresql_user</a><a class="headerlink" href="#postgresql-user" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.6.</span></p>
|
|
<p>Add or remove PostgreSQL users (roles) from a remote host and, optionally, grant the users access to an existing database or tables.
|
|
The fundamental function of the module is to create, or delete, roles from a PostgreSQL cluster. Privilege assignment, or removal, is an optional step, which works on one database at a time. This allows for the module to be called several times in the same module to modify the permissions on different databases, or to grant permissions to already existing users.
|
|
A user cannot be removed untill all the privileges have been stripped from the user. In such situation, if the module tries to remove the user it will fail. To avoid this from happening the fail_on_user option signals the module to try to remove the user, but if not possible keep going; the module will report if changes happened and separately if the user was removed or not.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the user (role) to add or remove</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_user</td>
|
|
<td>no</td>
|
|
<td>postgres</td>
|
|
<td><ul></ul></td>
|
|
<td>User (role) used to authenticate with PostgreSQL</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_host</td>
|
|
<td>no</td>
|
|
<td>localhost</td>
|
|
<td><ul></ul></td>
|
|
<td>Host running PostgreSQL.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>db</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of database where permissions will be granted</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>The database state</td>
|
|
</tr>
|
|
<tr>
|
|
<td>login_password</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Password used to authenticate with PostgreSQL</td>
|
|
</tr>
|
|
<tr>
|
|
<td>password</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>set the user's password</td>
|
|
</tr>
|
|
<tr>
|
|
<td>fail_on_user</td>
|
|
<td>no</td>
|
|
<td>True</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>if yes, fail when user can't be removed. Otherwise just log and continue</td>
|
|
</tr>
|
|
<tr>
|
|
<td>priv</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>PostgreSQL privileges string in the format: <code>table:priv1,priv2</code></td>
|
|
</tr>
|
|
</table><p>Create django user and grant access to database and products table</p> <p><pre>
|
|
postgresql_user db=acme user=django password=ceec4eif7ya priv=CONNECT/products:ALL
|
|
</pre></p>
|
|
<p>Remove test user privileges from acme</p> <p><pre>
|
|
postgresql_user db=acme user=test priv=ALL/products:ALL state=absent fail_on_user=no
|
|
</pre></p>
|
|
<p>Remove test user from test database and the cluster</p> <p><pre>
|
|
postgresql_user db=test user=test priv=ALL state=absent
|
|
</pre></p>
|
|
<p>Example privileges string format</p> <p><pre>
|
|
INSERT,UPDATE/table:SELECT/anothertable:ALL
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<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></div>
|
|
<div class="section" id="raw">
|
|
<span id="id29"></span><h2><a class="toc-backref" href="#contents">raw</a><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 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 to run modules, since nearly all core modules require it. Another is speaking to any devices such as routers that do not have any Python installed. In any other case, using the <tt class="docutils literal"><span class="pre">shell</span></tt> or <tt class="docutils literal"><span class="pre">command</span></tt> module is much more appropriate. Arguments given to <tt class="docutils literal"><span class="pre">raw</span></tt> are run directly through the configured remote shell and only output is returned. There is no error detection or change handler support for this module</p>
|
|
<p>Example from /usr/bin/ansible to bootstrap a legacy python 2.4 host</p> <p><pre>
|
|
ansible newhost.example.com -m raw -a "yum -y install python-simplejson"
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="seboolean">
|
|
<span id="id30"></span><h2><a class="toc-backref" href="#contents">seboolean</a><a class="headerlink" href="#seboolean" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>Toggles SELinux booleans.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul><li>true</li><li>false</li></ul></td>
|
|
<td>Desired boolean value</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Name of the boolean to configure</td>
|
|
</tr>
|
|
<tr>
|
|
<td>persistent</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Set to 'yes' if the boolean setting should survive a reboot</td>
|
|
</tr>
|
|
</table><p>Set <em>httpd_can_network_connect</em> SELinux flag to <em>true</em> and <em>persistent</em></p> <p><pre>
|
|
seboolean name=httpd_can_network_connect state=true persistent=yes
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Not tested on any debian based system</p></div>
|
|
<div class="section" id="selinux">
|
|
<span id="id31"></span><h2><a class="toc-backref" href="#contents">selinux</a><a class="headerlink" href="#selinux" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>Configures the SELinux mode and policy. A reboot may be required after usage. Ansible will not issue this reboot but will let you know when it is required.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>policy</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the SELinux policy to use (example: 'targeted')</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul><li>enforcing</li><li>permissive</li><li>disabled</li></ul></td>
|
|
<td>The SELinux mode</td>
|
|
</tr>
|
|
<tr>
|
|
<td>conf</td>
|
|
<td>no</td>
|
|
<td>/etc/selinux/config</td>
|
|
<td><ul></ul></td>
|
|
<td>path to the SELinux configuration file, if non-standard</td>
|
|
</tr>
|
|
</table> <p><pre>
|
|
selinux policy=targeted state=enforcing
|
|
</pre></p>
|
|
<p><pre>
|
|
selinux policy=targeted state=disabled
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Not tested on any debian based system</p></div>
|
|
<div class="section" id="service">
|
|
<span id="id32"></span><h2><a class="toc-backref" href="#contents">service</a><a class="headerlink" href="#service" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.1.</span></p>
|
|
<p>Controls services on remote hosts.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>pattern</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>If the service does not respond to the status command, name a substring to look for as would be found in the output of the <em>ps</em> command as a stand-in for a status result. If the string is found, the servie will be assumed to be running. (added in Ansible 0.7)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul><li>running</li><li>started</li><li>stopped</li><li>restarted</li><li>reloaded</li></ul></td>
|
|
<td><em>started</em>, <em>stopped</em>, <em>reloaded</em>, <em>restarted</em>. <em>Started</em>/<em>stopped</em> are idempotent actions that will not run commands unless necessary. <em>restarted</em> will always bounce the service. <em>reloaded</em> will always reload.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>enabled</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Whether the service should start on boot.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Name of the service.</td>
|
|
</tr>
|
|
</table><p>Example action from Ansible Playbooks</p> <p><pre>
|
|
service name=httpd state=started
|
|
</pre></p>
|
|
<p>Example action from Ansible Playbooks</p> <p><pre>
|
|
service name=httpd state=stopped
|
|
</pre></p>
|
|
<p>Example action from Ansible Playbooks</p> <p><pre>
|
|
service name=httpd state=restarted
|
|
</pre></p>
|
|
<p>Example action from Ansible Playbooks</p> <p><pre>
|
|
service name=httpd state=reloaded
|
|
</pre></p>
|
|
<p>Example action from Ansible Playbooks</p> <p><pre>
|
|
service name=foo pattern=/usr/bin/foo state=started
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="setup">
|
|
<span id="id33"></span><h2><a class="toc-backref" href="#contents">setup</a><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 <tt class="docutils literal"><span class="pre">/usr/bin/ansible</span></tt> to check what variables are available to a host. Ansible provides many <em>facts</em> about the system, automatically.</p>
|
|
<p>Obtain facts from all hosts and store them indexed by hostname at /tmp/facts.</p> <p><pre>
|
|
ansible all -m setup -tree /tmp/facts
|
|
</pre></p>
|
|
<br/><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></div>
|
|
<div class="section" id="shell">
|
|
<span id="id34"></span><h2><a class="toc-backref" href="#contents">shell</a><a class="headerlink" href="#shell" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.2.</span></p>
|
|
<p>The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the <tt class="docutils literal"><span class="pre">command</span></tt> module but runs the command through the user’s configured shell on the remote node.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>creates</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>a filename, when it already exists, this step will NOT be run</td>
|
|
</tr>
|
|
<tr>
|
|
<td>chdir</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>cd into this directory before running the command (0.6 and later)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>(free form)</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The command module takes a free form command to run</td>
|
|
</tr>
|
|
</table><p>Execute the command in remote shell</p> <p><pre>
|
|
shell somescript.sh >> somelog.txt
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>If you want to execute a command securely and predicably, it may be better to use the <span class='module'>command</span> module instead. Best practices when writing playbooks will follow the trend of using <span class='module'>command</span> unless <span class='module'>shell</span> is explicitly required. When running ad-hoc commands, use your best judgement.</p></div>
|
|
<div class="section" id="slurp">
|
|
<span id="id35"></span><h2><a class="toc-backref" href="#contents">slurp</a><a class="headerlink" href="#slurp" title="Permalink to this headline">¶</a></h2>
|
|
<p>This module works like <tt class="docutils literal"><span class="pre">fetch</span></tt>. It is used for fetching a base64- encoded blob containing the data in a remote file.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>src</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The file on the remote system to fetch. This must be a file, not a directory.</td>
|
|
</tr>
|
|
</table><p>Example using <code>/usr/bin/ansible</code></p> <p><pre>
|
|
ansible host -m slurp -a 'src=/tmp/xx'
|
|
host | success >> {
|
|
"content": "aGVsbG8gQW5zaWJsZSB3b3JsZAo=",
|
|
"encoding": "base64"
|
|
}
|
|
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>See also: <span class='module'>fetch</span></p></div>
|
|
<div class="section" id="subversion">
|
|
<span id="id36"></span><h2><a class="toc-backref" href="#contents">subversion</a><a class="headerlink" href="#subversion" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>This module is really simple, so for now this checks out from the given branch of a repo at a particular SHA or tag. Latest is not supported, you should not be doing that.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>repo</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The subversion URL to the repository.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Absolute path where the repository should be deployed.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>force</td>
|
|
<td>no</td>
|
|
<td>True</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>If yes, any modified files in the working repository will be discarded. If no, this module will fail if it encounters modified files.</td>
|
|
</tr>
|
|
</table><p>Export subversion repository in a specified folder</p> <p><pre>
|
|
subversion repo=svn+ssh://an.example.org/path/to/repo dest=/src/checkout
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Requires subversion and grep on the client.</p></div>
|
|
<div class="section" id="supervisorctl">
|
|
<span id="id37"></span><h2><a class="toc-backref" href="#contents">supervisorctl</a><a class="headerlink" href="#supervisorctl" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<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>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul><li>started</li><li>stopped</li><li>restarted</li></ul></td>
|
|
<td>The state of service</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>The name of the supervisord program/process to manage</td>
|
|
</tr>
|
|
</table><p>Manage the state of program <em>my_app</em> to be in <em>started</em> state.</p> <p><pre>
|
|
supervisorctl name=my_app state=started
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="template">
|
|
<span id="id38"></span><h2><a class="toc-backref" href="#contents">template</a><a class="headerlink" href="#template" title="Permalink to this headline">¶</a></h2>
|
|
<p>Templates are processed by the Jinja2 templating language (<a class="reference external" href="http://jinja.pocoo.org/docs/">http://jinja.pocoo.org/docs/</a>) - documentation on the template formatting can be found in the Template Designer Documentation (<a class="reference external" href="http://jinja.pocoo.org/docs/templates/">http://jinja.pocoo.org/docs/templates/</a>).</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>dest</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Location to render the template to on the remote machine.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>src</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Path of a Jinja2 formatted template on the local server. This can be a relative or absolute path.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>backup</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
<td>Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>others</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>all arguments accepted by the <span class='module'>file</span> module also work here</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
template src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Since Ansible version 0.9, templates are loaded with <code>trim_blocks=True</code>.</p></div>
|
|
<div class="section" id="user">
|
|
<span id="id39"></span><h2><a class="toc-backref" href="#contents">user</a><a class="headerlink" href="#user" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.2.</span></p>
|
|
<p>Manage user accounts and user attributes.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>comment</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optionally sets the description (aka <em>GECOS</em>) of user account.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>shell</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optionally set the user's shell.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>force</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>True</li><li>False</li></ul></td>
|
|
<td>When used with <em>state=absent</em>, behavior is as with <em>userdel --force</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Name of the user to create, remove or modify.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>createhome</td>
|
|
<td>no</td>
|
|
<td>yes</td>
|
|
<td><ul><li>True</li><li>False</li></ul></td>
|
|
<td>Unless set to <em>no</em>, a home directory will be made for the user when the account is created.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>system</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>True</li><li>False</li></ul></td>
|
|
<td>When creating an account, setting this to <em>yes</em> makes the user a system account. This setting cannot be changed on existing users.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>remove</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>True</li><li>False</li></ul></td>
|
|
<td>When used with <em>state=absent</em>, behavior is as with <em>userdel --remove</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>absent</li></ul></td>
|
|
<td>Whether the account should exist. When <em>absent</em>, removes the user account.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>groups</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Puts the user in this comma-delimited list of groups.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>home</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optionally set the user's home directory.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>group</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optionally sets the user's primary group (takes a group name).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>password</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optionally set the user's password to this crypted value. See the user example in the github examples directory for what this looks like in a playbook.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>append</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>If <em>yes</em>, will only add groups, not set them to just the list in <em>groups</em>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>uid</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>Optionally sets the <em>UID</em> of the user.</td>
|
|
</tr>
|
|
</table><br/></div>
|
|
<div class="section" id="virt">
|
|
<span id="id40"></span><h2><a class="toc-backref" href="#contents">virt</a><a class="headerlink" href="#virt" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.2.</span></p>
|
|
<p>Manages virtual machines supported by <em>libvirt</em>.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>no</td>
|
|
<td><ul><li>running</li><li>shutdown</li><li>destroyed</li><li>undefined</li></ul></td>
|
|
<td>Note that there may be some lag for state requests like <code>shutdown</code> since these refer only to VM states. After starting a guest, it may not be immediately accessible.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>command</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>in addition to state management, various non-idempotent commands are available. See examples</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>name of the guest VM being managed</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
virt guest=alpha state=running
|
|
</pre></p>
|
|
<p>Example guest management with <code>/usr/bin/ansible</code></p> <p><pre>
|
|
ansible host -m virt -a "guest=alpha command=status"
|
|
</pre></p>
|
|
<br/><h4>Notes</h4>
|
|
<p>Other non-idempotent commands are: <code>status</code>, <code>pause</code>, <code>unpause</code>, <code>get_xml</code>, <code>autostart</code>, <code>freemem</code>, <code>list_vms</code>, <code>info</code>, <code>nodeinfo</code>, <code>virttype</code></p></div>
|
|
<div class="section" id="wait-for">
|
|
<span id="id41"></span><h2><a class="toc-backref" href="#contents">wait_for</a><a class="headerlink" href="#wait-for" title="Permalink to this headline">¶</a></h2>
|
|
<p class="versionadded">
|
|
<span class="versionmodified">New in version 0.7.</span></p>
|
|
<p>This is useful for when services are not immediately available after their init scripts return - which is true of certain Java application servers. It is also useful when starting guests with the <tt class="docutils literal"><span class="pre">virt</span></tt> module and needing to pause until they are ready.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>delay</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>number of seconds to wait before starting to poll</td>
|
|
</tr>
|
|
<tr>
|
|
<td>host</td>
|
|
<td>no</td>
|
|
<td>127.0.0.1</td>
|
|
<td><ul></ul></td>
|
|
<td>hostname or IP address to wait for</td>
|
|
</tr>
|
|
<tr>
|
|
<td>port</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>port number to poll</td>
|
|
</tr>
|
|
<tr>
|
|
<td>timeout</td>
|
|
<td>no</td>
|
|
<td>300</td>
|
|
<td><ul></ul></td>
|
|
<td>maximum number of seconds to wait for</td>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>started</td>
|
|
<td><ul><li>started</li><li>stopped</li></ul></td>
|
|
<td>either <code>started</code>, or <code>stopped</code> depending on whether the module should poll for the port being open or closed.</td>
|
|
</tr>
|
|
</table><p>Example from Ansible Playbooks</p> <p><pre>
|
|
wait_for port=8000 delay=10
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="yum">
|
|
<span id="id42"></span><h2><a class="toc-backref" href="#contents">yum</a><a class="headerlink" href="#yum" title="Permalink to this headline">¶</a></h2>
|
|
<p>Will install, upgrade, remove, and list packages with the <em>yum</em> package manager.</p>
|
|
<table>
|
|
<tr>
|
|
<th class="head">parameter</th>
|
|
<th class="head">required</th>
|
|
<th class="head">default</th>
|
|
<th class="head">choices</th>
|
|
<th class="head">comments</th>
|
|
</tr>
|
|
<tr>
|
|
<td>state</td>
|
|
<td>no</td>
|
|
<td>present</td>
|
|
<td><ul><li>present</li><li>latest</li><li>absent</li></ul></td>
|
|
<td>whether to install (<code>present</code>, <code>latest</code>), or remove (<code>absent</code>) a package.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>list</td>
|
|
<td>no</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>various non-idempotent commands for usage with <code>/usr/bin/ansible</code> and <em>not</em> playbooks. See examples.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>yes</td>
|
|
<td></td>
|
|
<td><ul></ul></td>
|
|
<td>package name, or package specifier with version, like <code>name-1.0</code>.</td>
|
|
</tr>
|
|
</table> <p><pre>
|
|
yum name=httpd state=latest
|
|
</pre></p>
|
|
<p><pre>
|
|
yum name=httpd state=removed
|
|
</pre></p>
|
|
<p><pre>
|
|
yum name=httpd state=installed
|
|
</pre></p>
|
|
<br/></div>
|
|
<div class="section" id="additional-contrib-modules">
|
|
<h2><a class="toc-backref" href="#contents">Additional Contrib Modules</a><a class="headerlink" href="#additional-contrib-modules" title="Permalink to this headline">¶</a></h2>
|
|
<p>In addition to the following built-in modules, community modules are available at <a class="reference external" href="http://github.com/ansible/ansible-resources">Ansible Resources</a>.</p>
|
|
</div>
|
|
<div class="section" id="writing-your-own-modules">
|
|
<h2><a class="toc-backref" href="#contents">Writing your own modules</a><a class="headerlink" href="#writing-your-own-modules" title="Permalink to this headline">¶</a></h2>
|
|
<p>See <a class="reference internal" href="moduledev.html"><em>Module Development</em></a>.</p>
|
|
<div class="admonition-see-also admonition seealso">
|
|
<p class="first admonition-title">See also</p>
|
|
<dl class="last docutils">
|
|
<dt><a class="reference external" href="https://github.com/ansible/ansible-resources">Ansible Resources (Contrib)</a></dt>
|
|
<dd>User contributed playbooks, modules, and articles</dd>
|
|
<dt><a class="reference internal" href="examples.html"><em>Command Line Examples And Next Steps</em></a></dt>
|
|
<dd>Examples of using modules in /usr/bin/ansible</dd>
|
|
<dt><a class="reference internal" href="playbooks.html"><em>Playbooks</em></a></dt>
|
|
<dd>Examples of using modules with /usr/bin/ansible-playbook</dd>
|
|
<dt><a class="reference internal" href="moduledev.html"><em>Module Development</em></a></dt>
|
|
<dd>How to write your own modules</dd>
|
|
<dt><a class="reference internal" href="api.html"><em>API & Integrations</em></a></dt>
|
|
<dd>Examples of using modules with the Python API</dd>
|
|
<dt><a class="reference external" href="http://groups.google.com/group/ansible-project">Mailing List</a></dt>
|
|
<dd>Questions? Help? Ideas? Stop by the list on Google Groups</dd>
|
|
<dt><a class="reference external" href="http://irc.freenode.net">irc.freenode.net</a></dt>
|
|
<dd>#ansible IRC chat channel</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<br/>
|
|
</div>
|
|
<footer class="footer">
|
|
<div class="container">
|
|
<p>
|
|
<p>
|
|
© Copyright 2012 Michael DeHaan.<br/>
|
|
Last updated on Oct 08, 2012.<br/>
|
|
</p>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html> |