2012-03-07 17:35:18 +01:00
< !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" / >
2012-03-08 19:36:47 +01:00
< title > Ansible Modules — Ansible v0.0.1 documentation< / title >
2012-03-07 17:35:18 +01:00
< link rel = "stylesheet" href = "_static/default.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2012-03-09 17:44:14 +01:00
< link rel = "stylesheet" href = "_static/bootstrap.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/bootstrap-sphinx.css" type = "text/css" / >
2012-03-07 17:35:18 +01:00
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
2012-03-09 17:50:07 +01:00
HAS_SOURCE: false
2012-03-07 17:35:18 +01:00
};
< / 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 >
2012-03-09 17:44:14 +01:00
< script type = "text/javascript" src = "_static/bootstrap-dropdown.js" > < / script >
< script type = "text/javascript" src = "_static/bootstrap-scrollspy.js" > < / script >
2012-03-07 17:35:18 +01:00
< link rel = "top" title = "Ansible v0.0.1 documentation" href = "index.html" / >
2012-03-09 04:52:16 +01:00
< link rel = "next" title = "YAML Format" href = "YAMLScripts.html" / >
2012-03-09 17:44:14 +01:00
< link rel = "prev" title = "Command Line Examples" 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 >
2012-03-07 17:35:18 +01:00
< / head >
< body >
2012-03-09 17:44:14 +01:00
< div class = "topbar" data-scrollspy = "scrollspy" >
< div class = "topbar-inner" >
< div class = "container" >
< a class = "brand" href = "index.html" > Ansible< / a >
< ul class = "nav" >
< li class = "dropdown" data-dropdown = "dropdown" >
< a href = "index.html"
class="dropdown-toggle">Site< / 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" > The Inventory File, Patterns, and Groups< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "examples.html" > Command Line Examples< / 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 = "YAMLScripts.html" > YAML Format< / 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 = "api.html" > Using the Python API< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "man.html" > Man Pages< / 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 = "#command" > command< / a > < / li >
< li > < a class = "reference internal" href = "#copy" > copy< / a > < / li >
< li > < a class = "reference internal" href = "#facter" > facter< / a > < / li >
< li > < a class = "reference internal" href = "#git" > git< / a > < / li >
< li > < a class = "reference internal" href = "#ohai" > ohai< / a > < / li >
< li > < a class = "reference internal" href = "#ping" > ping< / a > < / li >
< li > < a class = "reference internal" href = "#service" > service< / a > < / li >
< li > < a class = "reference internal" href = "#setup" > setup< / a > < / li >
< li > < a class = "reference internal" href = "#template" > template< / a > < / li >
< li > < a class = "reference internal" href = "#writing-your-own-modules" > Writing your own modules< / a > < / li >
< / ul >
< / li >
< / ul >
< / span >
< / li >
2012-03-07 17:35:18 +01:00
2012-03-09 17:44:14 +01:00
< li > < a href = "examples.html"
title="previous chapter">« Command Line Examples< / a > < / li >
< li > < a href = "YAMLScripts.html"
title="next chapter">YAML Format » < / a > < / 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" >
2012-03-08 19:36:47 +01:00
< div class = "section" id = "ansible-modules" >
< h1 > Ansible Modules< a class = "headerlink" href = "#ansible-modules" title = "Permalink to this headline" > ¶< / a > < / h1 >
2012-03-08 19:53:48 +01:00
< p > Ansible ships with a number of modules that can be executed directly on remote hosts or through
ansible playbooks.< / p >
2012-03-08 19:36:47 +01:00
< div class = "admonition-see-also admonition seealso" >
< p class = "first admonition-title" > See also< / p >
< dl class = "last docutils" >
2012-03-09 13:42:53 +01:00
< dt > < a class = "reference internal" href = "examples.html" > < em > Command Line Examples< / em > < / a > < / dt >
2012-03-08 19:36:47 +01:00
< dd > Examples of using modules in /usr/bin/ansible< / dd >
2012-03-09 17:44:14 +01:00
< dt > < a class = "reference internal" href = "playbooks.html" > < em > Playbooks< / em > < / a > < / dt >
2012-03-08 19:36:47 +01:00
< dd > Examples of using modules with /usr/bin/ansible-playbook< / dd >
2012-03-09 13:42:53 +01:00
< dt > < a class = "reference internal" href = "api.html" > < em > Using the Python API< / em > < / a > < / dt >
2012-03-08 19:36:47 +01:00
< dd > Examples of using modules with the Python API< / dd >
< / dl >
< / div >
2012-03-09 04:50:12 +01:00
< p > Nearly all modules take key=value parameters. Some modules take no parameters, and the command
module just takes arguments for the command you want to run.< / p >
< p > All modules return JSON format data, thoug if you are using the command line or playbooks, you
don’ t really need to know much about that.< / p >
2012-03-08 19:36:47 +01:00
< p > Most modules other than command are idempotent, meaning they will seek to avoid changes
unless a change needs to be made. When using ansible playbooks, these modules can
trigger change events. Unless otherwise noted, all modules support change hooks.< / p >
2012-03-09 04:50:12 +01:00
< p > Stock modules:< / p >
2012-03-08 19:36:47 +01:00
< div class = "section" id = "command" >
< h2 > command< a class = "headerlink" href = "#command" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The command module takes the command name followed by a list of arguments, space delimited.
This is the only module that does not use key=value style parameters.< / p >
< p > Example usage:< / p >
< div class = "highlight-python" > < pre > /sbin/shutdown -t now< / pre >
< / div >
2012-03-09 04:50:12 +01:00
< p > The given shell command will be executed on all selected nodes.< / p >
2012-03-08 19:36:47 +01:00
< p > This module does not support change hooks and returns the return code from the program as well as timing information about how long the command was running for.< / p >
< / div >
< div class = "section" id = "copy" >
< h2 > copy< a class = "headerlink" href = "#copy" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The copy module moves a file on the local box to remote locations.< / p >
< p > < em > src< / em > :< / p >
2012-03-09 04:50:12 +01:00
< p > Local path to a file to copy to the remote server. This can be an absolute or relative path.< / p >
2012-03-08 19:36:47 +01:00
< p > < em > dest< / em > :< / p >
2012-03-09 04:50:12 +01:00
< p > Remote absolute path where the file should end up.< / p >
2012-03-08 19:36:47 +01:00
< p > This module also returns md5sum information about the resultant file.< / p >
< / div >
< div class = "section" id = "facter" >
< h2 > facter< a class = "headerlink" href = "#facter" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Runs the discovery program ‘ facter’ on the remote system, returning
JSON data that can be useful for inventory purposes.< / p >
< p > Requires that ‘ facter’ and ‘ ruby-json’ be installed on the remote end.< / p >
< p > This module is informative only - it takes no parameters & does not support change hooks,
2012-03-09 04:50:12 +01:00
nor does it make any changes on the system. Playbooks do not actually use
this module, they use the ‘ setup’ module behind the scenes.< / p >
2012-03-08 19:36:47 +01:00
< / div >
< div class = "section" id = "git" >
< h2 > git< a class = "headerlink" href = "#git" title = "Permalink to this headline" > ¶< / a > < / h2 >
2012-03-09 04:50:12 +01:00
< p > Deploys software (or files) from git checkouts.< / p >
2012-03-08 19:36:47 +01:00
< p > < em > repo< / em > :< / p >
< p > git or http protocol address of the repo to checkout< / p >
< p > < em > dest< / em > :< / p >
< p > where to check it out, an absolute directory path< / p >
< p > < em > version< / em > :< / p >
< p > what version to check out – either the git SHA, the literal string ‘ HEAD’ , or a tag name< / p >
< / div >
< div class = "section" id = "ohai" >
< h2 > ohai< a class = "headerlink" href = "#ohai" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Similar to the facter module, this returns JSON inventory data. Ohai
data is a bit more verbose and nested than facter.< / p >
< p > Requires that ‘ ohai’ be installed on the remote end.< / p >
< p > This module is information only - it takes no parameters & does not
support change hooks, nor does it make any changes on the system.< / p >
2012-03-09 04:50:12 +01:00
< p > Playbooks should not call the ohai module, playbooks call the ‘ setup’
module behind the scenes instead.< / p >
2012-03-08 19:36:47 +01:00
< / div >
< div class = "section" id = "ping" >
< h2 > ping< a class = "headerlink" href = "#ping" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A trivial test module, this module always returns the integer ‘ 1’ on
successful contact.< / p >
2012-03-09 04:50:12 +01:00
< p > This module does not support change hooks and is informative only - it takes no parameters & does not
2012-03-08 19:36:47 +01:00
support change hooks, nor does it make any changes on the system.< / p >
< / div >
< div class = "section" id = "service" >
< h2 > service< a class = "headerlink" href = "#service" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Controls services on remote machines.< / p >
< p > < em > state< / em > < / p >
< p > Values are ‘ started’ , ‘ stopped’ , or ‘ restarted’ . Started/stopped
are idempotent actions that will not run commands unless neccessary.
‘ restarted’ will always bounce the service< / p >
< p > < em > name< / em > < / p >
< p > The name of the service< / p >
< / div >
< div class = "section" id = "setup" >
< h2 > setup< a class = "headerlink" href = "#setup" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Writes a JSON file containing key/value data, for use in templating.
Call this once before using the template modules. Playbooks will
2012-03-09 04:50:12 +01:00
execute this module automatically as the first step in each play using
the variables section, so it is unneccessary to make explicit calls to
setup within a playbook.< / p >
2012-03-08 19:36:47 +01:00
< p > If facter or ohai are installed, variables from these programs will also
be snapshotted into the JSON file for usage in templating. These variables
2012-03-09 04:50:12 +01:00
are prefixed with ‘ < a class = "reference internal" href = "#facter" > facter< / a > ‘ and ‘ < a class = "reference internal" href = "#ohai" > ohai< / a > ” so it’ s easy to tell their source.
All variables are then bubbled up to the caller.< / p >
2012-03-08 19:36:47 +01:00
< p > < em > anything< / em > < / p >
< p > any other parameters can be named basically anything, and set a key=value
pair in the JSON file for use in templating.< / p >
< / div >
< div class = "section" id = "template" >
< h2 > template< a class = "headerlink" href = "#template" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Templates a file out to a remote server. Call the setup module prior to usage.< / p >
< p > < em > src< / em > < / p >
2012-03-09 04:50:12 +01:00
< p > path of a Jinja2 formatted template on the local server. This can be a relative
or absolute path.< / p >
2012-03-08 19:36:47 +01:00
< p > < em > dest< / em > < / p >
< p > location to render the template on the remote server< / p >
< p > This module also returns md5sum information about the resultant file.< / p >
< / div >
< div class = "section" id = "writing-your-own-modules" >
2012-03-09 04:50:12 +01:00
< h2 > Writing your own modules< a class = "headerlink" href = "#writing-your-own-modules" title = "Permalink to this headline" > ¶< / a > < / h2 >
2012-03-08 19:36:47 +01:00
< p > To write your own modules, simply follow the convention of those already available in
/usr/share/ansible. Modules must return JSON but can be written in any language.
2012-03-09 04:50:12 +01:00
Modules should return hashes, but hashes can be nested.< / p >
< p > To support change hooks, modules should return hashes with a changed: True/False
element at the top level:< / p >
< div class = "highlight-python" > < div class = "highlight" > < pre > < span class = "p" > {< / span >
< span class = "s" > ' changed' < / span > < span class = "p" > :< / span > < span class = "bp" > True< / span > < span class = "p" > ,< / span >
< span class = "s" > ' something' < / span > < span class = "p" > :< / span > < span class = "mi" > 42< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / div >
< p > Modules can also choose to indicate a failure scenario by returning a top level ‘ failure’
element with a True value, and a ‘ msg’ element describing the nature of the failure.
Other return values are up to the module.< / p >
< blockquote >
< div > < dl class = "docutils" >
< dt > {< / dt >
< dd > ‘ failure’ : True,
‘ msg’ : “ here is what happened...” < / dd >
< / dl >
< p > }< / p >
< / div > < / blockquote >
< p > When shipping modules, drop them in /usr/share/ansible, or specify the module path to the
command line tool or API. It is easy to test modules by running them directly on
the command line, passing them arguments just like they would be passed with ansible.< / p >
2012-03-08 19:36:47 +01:00
< / div >
2012-03-07 17:35:18 +01:00
< / div >
< / div >
2012-03-09 17:44:14 +01:00
< footer class = "footer" >
< div class = "container" >
< p class = "pull-right" > < a href = "#" > Back to top< / a > < / p >
< p >
© Copyright 2012 Michael DeHaan.< br / >
Last updated on Mar 09, 2012.< br / >
Created using < a href = "http://sphinx.pocoo.org/" > Sphinx< / a > 1.0.7.< br / >
< / p >
< / div >
< / footer >
2012-03-07 17:35:18 +01:00
< / body >
< / html >
