ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Check in generated manpage documentation from modules

Browse source
This commit is contained in:
Michael DeHaan 2012-10-02 22:46:49 -04:00
parent 046c6c66f2
commit 53d24ef002
43 changed files with 1867 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Makefile
View file

@ -62,7 +62,7 @@ tests:
PYTHONPATH=./lib nosetests -d -v
# To force a rebuild of the docs run 'touch VERSION && make docs'
docs: $(MANPAGES)
docs: $(MANPAGES) modulepages
# Regenerate %.1.asciidoc if %.1.asciidoc.in has been modified more
# recently than %.1.asciidoc.
@ -160,5 +160,5 @@ deb: debian
# for arch or gentoo, read instructions in the appropriate 'packaging' subdirectory directory
manpages:
modulepages:
hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man1/ --module-dir=library --template-dir=hacking/templates

73
docs/man/man1/ansible.apt.man Normal file
View file

@ -0,0 +1,73 @@
.TH ANSIBLE.APT 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/apt
.SH NAME
apt \- Manages apt-packages
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manages apt-packages (such as for Debian/Ubuntu).
." ------ OPTIONS
."
."
.SH OPTIONS
.IP purge
Will force purging of configuration files if the module state is set to \fCabsent\fR.
.IR Choices :
yes,no. (default: no)
.IP state
Indicates the desired package state
.IR Choices :
installed,latest,remove,absent,present. (default: present)
.IP force
If \fCyes\fR, force installs/removes.
.IR Choices :
yes,no. (default: no)
.IP pkg
A package name or package specifier with version, like \fCfoo\fR or \fCfoo=1.0\fR(required)
.IP update_cache
Run the equivalent of \fCapt-get update\fR before the operation. Can be run as part of the package installation or as a seperate step
.IR Choices :
yes,no. (default: no)
.IP default_release
Corresponds to the \fC-t\fR option for \fIapt\fR and sets pin priorities
.IP install_recommends
Corresponds to the \fC--no-install-recommends\fR option for \fIapt\fR, default behavior works as apt's default behavior, \fCno\fR does not install recommended packages. Suggested packages are never installed.
.IR Choices :
yes,no. (default: no)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
apt pkg=foo update-cache=yes
.fi
.PP
.nf
apt pkg=foo state=removed
.fi
.PP
.nf
apt pkg=foo state=installed
.fi
.PP
.nf
apt pkg=foo=1.00 state=installed
.fi
.PP
.nf
apt pkg=nginx state=latest default-release=squeeze-backports update-cache=yes
.fi
.PP
.nf
apt pkg=openjdk-6-jdk state=latest install-recommends=no
.fi
." ------- AUTHOR
.SH AUTHOR
Matthew Williams
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#apt

44
docs/man/man1/ansible.apt_repository.man Normal file
View file

@ -0,0 +1,44 @@
.TH ANSIBLE.APT_REPOSITORY 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/apt_repository
.SH NAME
apt_repository \- Manages apt repositores
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manages apt repositores (such as for Debian/Ubuntu).
." ------ OPTIONS
."
."
.SH OPTIONS
.IP repo
The repository name/value(required)
.IP state
The repository state
.IR Choices :
present,absent. (default: present)."
."
." ------ NOTES
.SH NOTES
.PP
This module works on Debian and Ubuntu only and requires \fCapt-add-repository\fR be available on destination server. To ensure this package is available use the \fCapt\fR module and install the \fCpython-software-properties\fR package before using this module.
.PP
A bug in \fCapt-add-repository\fR always adds \fCdeb\fR and \fCdeb-src\fR types for repositories (see the issue on Launchpad \fIhttps://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264\fR), if a repo doesn't have source information (eg MongoDB repo from 10gen) the system will fail while updating repositories.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
apt_repository repo=ppa://nginx/stable
.fi
.PP
.nf
apt_repository repo='deb http://archive.canonical.com/ubuntu hardy partner'
.fi
." ------- AUTHOR
.SH AUTHOR
Matt Wright
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#apt-repository

39
docs/man/man1/ansible.assemble.man Normal file
View file

@ -0,0 +1,39 @@
.TH ANSIBLE.ASSEMBLE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/assemble
.SH NAME
assemble \- Assembles a configuration file from fragments
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a \fCconf.d\fR 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 \fIfragments\fR.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP dest
A file to create using the concatenation of all of the source files.(required)
.IP src
An already existing directory full of source files.(required)
.IP backup
Create a backup file (if \fCyes\fR), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
.IR Choices :
yes,no. (default: no)
.IP others
all arguments accepted by the \fIfile\fR module also work here."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
assemble src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf
.fi
." ------- AUTHOR
.SH AUTHOR
Stephen Fromm
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#assemble

33
docs/man/man1/ansible.async_status.man Normal file
View file

@ -0,0 +1,33 @@
.TH ANSIBLE.ASYNC_STATUS 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/async_status
.SH NAME
async_status \- Obtain status of asynchronous task
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
This module gets the status of an asynchronous task. See: \fIhttp://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling\fR
." ------ OPTIONS
."
."
.SH OPTIONS
.IP jid
Job or task identifier(required)
.IP mode
if \fCstatus\fR, obtain the status; if \fCcleanup\fR, clean up the async job cache located in \fC~/.ansible_async/\fR for the specified job \fIjid\fR.
.IR Choices :
status,cleanup. (default: status)."
."
." ------ NOTES
.SH NOTES
.PP
See \fIhttp://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling\fR
."
."
." ------ EXAMPLES
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#async-status

41
docs/man/man1/ansible.authorized_key.man Normal file
View file

@ -0,0 +1,41 @@
.TH ANSIBLE.AUTHORIZED_KEY 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/authorized_key
.SH NAME
authorized_key \- Adds or removes an SSH authorized key
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Adds or removes an SSH authorized key for a user from a remote host.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
whether the given key should or should not be in the file
.IR Choices :
present,absent. (default: present)
.IP user
Name of the user who should have access to the remote host(required)
.IP key
the SSH public key, as a string(required)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
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"
.fi
.PP
.nf
authorized_key user=charlie key=$FILE(/home/charlie/.ssh/id_rsa.pub)
.fi
." ------- AUTHOR
.SH AUTHOR
Brad Olson
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#authorized-key

48
docs/man/man1/ansible.command.man Normal file
View file

@ -0,0 +1,48 @@
.TH ANSIBLE.COMMAND 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/command
.SH NAME
command \- Executes a command on a remote node
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
The command module takes the command name followed by a list of space-delimited arguments.
.PP
The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like \fC$HOME\fR and operations like \fC"<"\fR, \fC">"\fR, \fC"|"\fR, and \fC"&"\fR will not work. As such, all paths to commands must be fully qualified
." ------ OPTIONS
."
."
.SH OPTIONS
.IP creates
a filename, when it already exists, this step will \fBnot\fR be run.
.IP free_form
the command module takes a free form command to run(required)
.IP chdir
cd into this directory before running the command(Added in Ansible version 0.6.)
.IP removes
a filename, when it does not exist, this step will \fBnot\fR be run.(Added in Ansible version 0.8.)
."
."
." ------ NOTES
.SH NOTES
.PP
If you want to run a command through the shell (say you are using \fC<\fR, \fC>\fR, \fC|\fR, etc), you actually want the \fIshell\fR module instead. The \fIcommand\fR module is much more secure as it's not affected by the user's environment.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
command /sbin/shutdown -t now
.fi
.PP
.nf
command /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#command

44
docs/man/man1/ansible.copy.man Normal file
View file

@ -0,0 +1,44 @@
.TH ANSIBLE.COPY 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/copy
.SH NAME
copy \- Copies files to remote locations.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
The \fIcopy\fR module copies a file on the local box to remote locations.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP dest
Remote absolute path where the file should be copied to.(required)
.IP src
Local path to a file to copy to the remote server; can be absolute or relative.(required)
.IP backup
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
.IR Choices :
yes,no. (default: no)(Added in Ansible version 0.7.)
.IP others
all arguments accepted by the \fIfile\fR module also work here."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
copy src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644
.fi
.PP
.nf
copy src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#copy

42
docs/man/man1/ansible.easy_install.man Normal file
View file

@ -0,0 +1,42 @@
.TH ANSIBLE.EASY_INSTALL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/easy_install
.SH NAME
easy_install \- Installs Python libraries
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Installs Python libraries, optionally in a \fIvirtualenv\fR
." ------ OPTIONS
."
."
.SH OPTIONS
.IP virtualenv
an optional \fIvirtualenv\fR directory path to install into. If the \fIvirtualenv\fR does not exist, it is created automatically
.IP name
A Python library name(required)."
."
." ------ NOTES
.SH NOTES
.PP
Please note that the \fIeasy_install\fR module can only install Python libraries. Thus this module is not able to remove libraries. It is generally recommended to use the \fIpip\fR module which you can first install using \fIeasy_install\fR.
.PP
Also note that \fIvirtualenv\fR must be installed on the remote host if the \fCvirtualenv\fR parameter is specified.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
easy_install name=pip
.fi
.PP
.nf
easy_install name=flask virtualenv=/webapps/myapp/venv
.fi
." ------- AUTHOR
.SH AUTHOR
Matt Wright
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#easy-install

28
docs/man/man1/ansible.facter.man Normal file
View file

@ -0,0 +1,28 @@
.TH ANSIBLE.FACTER 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/facter
.SH NAME
facter \- Runs the discovery program I(facter) on the remote system
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Runs the \fIfacter\fR discovery program (\fIhttps://github.com/puppetlabs/facter\fR) on the remote system, returning JSON data that can be useful for inventory purposes.
." ------ OPTIONS
."
."
."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
ansible www.example.net -m facter
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#facter

33
docs/man/man1/ansible.fail.man Normal file
View file

@ -0,0 +1,33 @@
.TH ANSIBLE.FAIL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/fail
.SH NAME
fail \- Fail with custom message
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
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.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP msg
The customized message used for failing execution. If ommited, fail will simple bail out with a generic message. (default: Failed because only_if condition is true)
.IP rc
The return code of the failure. This is currently not used by Ansible, but might be used in the future. (default: 1)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
[{'action': 'fail msg="The system may not be provisioned according to the CMDB status."', 'only_if': "'$cmdb_status' != 'to-be-staged'"}]
.fi
." ------- AUTHOR
.SH AUTHOR
Dag Wieers
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#fail

33
docs/man/man1/ansible.fetch.man Normal file
View file

@ -0,0 +1,33 @@
.TH ANSIBLE.FETCH 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/fetch
.SH NAME
fetch \- Fetches a file from remote nodes
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
This module works like \fIcopy\fR, but in reverse. It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP dest
A directory to save the file into. For example, if the \fIdest\fR directory is \fC/backup\fR a src file named \fC/etc/profile\fR on host \fChost.example.com\fR, would be saved into \fC/backup/host.example.com/etc/profile\fR(required)
.IP src
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.(required)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
fetch src=/var/log/messages dest=/home/logtree
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#fetch

62
docs/man/man1/ansible.file.man Normal file
View file

@ -0,0 +1,62 @@
.TH ANSIBLE.FILE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/file
.SH NAME
file \- Sets attributes of files
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Sets attributes of files, symlinks, and directories, or removes files/symlinks/directories. Many other modules support the same options as the file module - including \fIcopy\fR, \fItemplate\fR, and \fIassmeble\fR.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP src
path of the file to link to (applies only to \fCstate=link\fR).
.IP group
name of the group that should own the file/directory, as would be fed to \fIchown\fR
.IP dest
defines the file being managed, unless when used with \fIstate=link\fR, and then sets the destination to create a symbolic link to using \fIsrc\fR(required)
.IP selevel
level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the \fCrange\fR. \fC_default\fR feature works as for \fIseuser\fR. (default: s0)
.IP seuser
user part of SELinux file context. Will default to system policy, if applicable. If set to \fC_default\fR, it will use the \fCuser\fR portion of the the policy if available
.IP state
If \fCdirectory\fR, all immediate subdirectories will be created if they do not exist. If \fCfile\fR, the file will NOT be created if it does not exist, see the \fIcopy\fR or \fItemplate\fR module if you want that behavior. If \fClink\fR, the symbolic link will be created or changed. If \fCabsent\fR, directories will be recursively deleted, and files or symlinks will be unlinked.
.IR Choices :
file,link,directory,absent. (default: file)
.IP serole
role part of SELinux file context, \fC_default\fR feature works as for \fIseuser\fR.
.IP mode
mode the file or directory should be, such as 0644 as would be fed to
.IP context
accepts only \fCdefault\fR as value. This will restore a file's SELinux context in the policy. Does nothing if no default value is available.
.IR Choices :
default.
.IP owner
name of the user that should own the file/directory, as would be fed to \fIchown\fR
.IP setype
type part of SELinux file context, \fC_default\fR feature works as for \fIseuser\fR.."
."
." ------ NOTES
.SH NOTES
.PP
See also \fIcopy\fR, \fItemplate\fR, \fIassemble\fR
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
file path=/etc/foo.conf owner=foo group=foo mode=0644
.fi
.PP
.nf
file src=/file/to/link/to dest=/path/to/symlink owner=foo group=foo state=link
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#file

53
docs/man/man1/ansible.fireball.man Normal file
View file

@ -0,0 +1,53 @@
.TH ANSIBLE.FIREBALL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/fireball
.SH NAME
fireball \- Enable fireball mode on remote node
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
This modules launches an ephemeral \fIfireball\fR ZeroMQ message bus daemon on the remote node which Ansible can to communicate with nodes at high speed.
.PP
The daemon listens on a configurable port for a configurable amount of time.
.PP
Starting a new fireball as a given user terminates any existing user fireballs.
.PP
Fireball mode is AES encrypted
." ------ OPTIONS
."
."
.SH OPTIONS
.IP minutes
The \fIfireball\fR listener daemon is started on nodes and will stay around for this number of minutes before turning itself off. (default: 30)
.IP port
TCP port for ZeroMQ (default: 5099)."
."
." ------ NOTES
.SH NOTES
.PP
See the advanced playbooks chapter for more about using fireball mode.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
- hosts: devservers
gather_facts: false
connection: ssh
sudo: yes
tasks:
- action: fireball
- hosts: devservers
connection: fireball
tasks:
- action: command /usr/bin/anything
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#fireball

43
docs/man/man1/ansible.get_url.man Normal file
View file

@ -0,0 +1,43 @@
.TH ANSIBLE.GET_URL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/get_url
.SH NAME
get_url \- Downloads files from HTTP, HTTPS, or FTP to node
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server must have direct access to the remote resource.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP url
HTTP, HTTPS, or FTP URL(required)
.IP dest
absolute path of where to download the file to.If \fIdest\fR is a directory, the basename of the file on the remote server will be used. If a directory, \fIthirsty=yes\fR must also be set.(required)
.IP thirsty
if \fCyes\fR, will download the file every time and replace the file if the contents change. if \fCno\fR, the file will only be downloaded if the destination does not exist. Generally should be \fCyes\fR only for small local files. prior to 0.6, acts if \fCyes\fR by default.
.IR Choices :
yes,no. (default: no)(Added in Ansible version 0.7.)
.IP others
all arguments accepted by the \fIfile\fR module also work here."
."
." ------ NOTES
.SH NOTES
.PP
This module doesn't yet support configuration for proxies or passwords.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
get_url url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440
.fi
." ------- AUTHOR
.SH AUTHOR
Jan-Piet Mens
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#get-url

41
docs/man/man1/ansible.git.man Normal file
View file

@ -0,0 +1,41 @@
.TH ANSIBLE.GIT 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/git
.SH NAME
git \- Deploy software (or files) from git checkouts
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manage git checkouts of repositories to deploy files or software.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP repo
git, ssh, or http protocol address of the git repository.(required)
.IP dest
Absolute path of where the repository should be checked out to.(required)
.IP version
What version of the repository to check out. This can be the git \fISHA\fR, the literal string \fIHEAD\fR, branch name, or a tag name. (default: HEAD)
.IP force
(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.
.IR Choices :
True,False. (default: yes)
.IP remote
Name of the remote branch. (default: origin)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
git repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#git

41
docs/man/man1/ansible.group.man Normal file
View file

@ -0,0 +1,41 @@
.TH ANSIBLE.GROUP 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/group
.SH NAME
group \- Add or remove groups
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manage presence of groups on a host.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
Whether the group should be present or not on the remote host.
.IR Choices :
present,absent. (default: present)
.IP gid
Optional \fIGID\fR to set for the group.
.IP name
Name of the group to manage.(required)
.IP system
If \fIyes\fR, indicates that the group created is a system group.
.IR Choices :
True,False. (default: no)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
group name=somegroup state=present
.fi
." ------- AUTHOR
.SH AUTHOR
Stephen Fromm
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#group

55
docs/man/man1/ansible.ini_file.man Normal file
View file

@ -0,0 +1,55 @@
.TH ANSIBLE.INI_FILE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/ini_file
.SH NAME
ini_file \- Tweak settings in INI files
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, \fItemplate\fR or \fIassemble\fR. Adds missing sections if they don't exist.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP option
if set (required for changing a \fIvalue\fR), this is the name of the option.May be omitted if adding/removing a whole \fIsection\fR.
.IP others
all arguments accepted by the \fIfile\fR module also work here
.IP dest
Path to the INI-style file; this file is created if required(required)
.IP section
Section name in INI file. This is added if \fCstate=present\fR automatically when a single value is being set.(required)
.IP backup
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
.IR Choices :
yes,no.
.IP value
the string value to be associated with an \fIoption\fR. May be omitted when removing an \fIoption\fR.."
."
." ------ NOTES
.SH NOTES
.PP
While it is possible to add an \fIoption\fR without specifying a \fIvalue\fR, this makes no sense.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
ini_file dest=/etc/conf section=drinks option=fav value=lemonade mode=0600 backup=true
.fi
.PP
.nf
ini_file dest=/etc/anotherconf
section=drinks
option=temperature
value=cold
backup=true
.fi
." ------- AUTHOR
.SH AUTHOR
Jan-Piet Mens
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#ini-file

10
docs/man/man1/ansible.lineinfile.man
View file

@ -1,4 +1,4 @@
.TH ANSIBLE.LINEINFILE 5 "2012-09-30" "0.8" "ANSIBLE MODULES"
.TH ANSIBLE.LINEINFILE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/lineinfile
.SH NAME
lineinfile \- Ensure a particular line is in a file
@ -20,13 +20,13 @@ present,absent. (default: present)
.IP name
The file to modify(required)
.IP insertafter
Used with \fIstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.
Used with \fCstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.
.IR Choices :
BOF,EOF. (default: EOF)
.IP regexp
The regular expression to look for in the file. For \fIstate=present\fR, the pattern to replace. For \fIstate=absent\fR, the pattern of the line to remove.(required)
The regular expression to look for in the file. For \fCstate=present\fR, the pattern to replace. For \fCstate=absent\fR, the pattern of the line to remove.(required)
.IP line
Required for \fIstate=present\fR. The line to insert/replace into the file. Must match the value given to \fCregexp\fR.
Required for \fCstate=present\fR. The line to insert/replace into the file. Must match the value given to \fCregexp\fR.
.IP backup
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.."
."
@ -44,6 +44,8 @@ lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
lineinfile name=/etc/sudoers state=absent regexp="^%wheel"
.fi
." ------- AUTHOR
.SH AUTHOR
Daniel Hokka Zakrisson
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#lineinfile

45
docs/man/man1/ansible.mount.man Normal file
View file

@ -0,0 +1,45 @@
.TH ANSIBLE.MOUNT 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/mount
.SH NAME
mount \- Control active and configured mount points
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
This module controls active and configured mount points in \fC/etc/fstab\fR.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP src
device to be mounted on \fIname\fR.(required)
.IP state
If \fCmounted\fR or \fCunmounted\fR, the device will be actively mounted or unmounted as well as just configured in \fIfstab\fR. \fCabsent\fR and \fCpresent\fR only deal with \fIfstab\fR.
.IR Choices :
present,absent,mounted,unmounted.(required)
.IP name
path to the mount point, eg: \fC/mnt/files\fR(required)
.IP dump
dump (see fstab(8))
.IP passno
passno (see fstab(8))
.IP opts
mount options (see fstab(8))
.IP fstype
file-system type(required)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
mount name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro
.fi
." ------- AUTHOR
.SH AUTHOR
Seth Vidal
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#mount

50
docs/man/man1/ansible.mysql_db.man Normal file
View file

@ -0,0 +1,50 @@
.TH ANSIBLE.MYSQL_DB 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/mysql_db
.SH NAME
mysql_db \- Add or remove MySQL databases from a remote host.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Add or remove MySQL databases from a remote host.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
The database state
.IR Choices :
present,absent. (default: present)
.IP name
name of the database to add or remove(required)
.IP encoding
Encoding mode
.IP collation
Collation mode
.IP login_user
The username used to authenticate with
.IP login_host
Host running the database (default: localhost)
.IP login_password
The password used to authenticate with."
."
." ------ NOTES
.SH NOTES
.PP
Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb.
.PP
Both \fClogin_password\fR and \fClogin_username\fR are required when you are passing credentials. If none are present, the module will attempt to read the credentials from \fC~/.my.cnf\fR, and finally fall back to using the MySQL default login of 'root' with no password.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
mysql_db db=bobdata state=present
.fi
." ------- AUTHOR
.SH AUTHOR
Mark Theunissen
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#mysql-db

60
docs/man/man1/ansible.mysql_user.man Normal file
View file

@ -0,0 +1,60 @@
.TH ANSIBLE.MYSQL_USER 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/mysql_user
.SH NAME
mysql_user \- Adds or removes a user from a MySQL database.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Adds or removes a user from a MySQL database.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP name
name of the user (role) to add or remove(required)
.IP login_user
The username used to authenticate with
.IP login_host
Host running the database (default: localhost)
.IP host
the 'host' part of the MySQL username (default: localhost)
.IP state
The database state
.IR Choices :
present,absent. (default: present)
.IP login_password
The password used to authenticate with
.IP password
set the user's password
.IP priv
MySQL privileges string in the format: \fCdb.table:priv1,priv2\fR."
."
." ------ NOTES
.SH NOTES
.PP
Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb.
.PP
Both \fClogin_password\fR and \fClogin_username\fR are required when you are passing credentials. If none are present, the module will attempt to read the credentials from \fC~/.my.cnf\fR, and finally fall back to using the MySQL default login of 'root' with no password.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
mysql_user name=bob password=12345 priv=*.*:ALL state=present
.fi
.PP
.nf
mysql_user login_user=root login_password=123456 name=sally state=absent
.fi
.PP
.nf
mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL
.fi
." ------- AUTHOR
.SH AUTHOR
Mark Theunissen
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#mysql-user

79
docs/man/man1/ansible.nagios.man Normal file
View file

@ -0,0 +1,79 @@
.TH ANSIBLE.NAGIOS 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/nagios
.SH NAME
nagios \- Perform common tasks in Nagios related to downtime and notifications.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
The \fInagios\fR module has two basic functions: scheduling downtime and toggling alerts for services or hosts.
.PP
All actions require the \fChost\fR parameter to be given explicitly. In playbooks you can use the \fC$inventory_hostname\fR variable to refer to the host the playbook is currently running on.
.PP
You can specify multiple services at once by separating them with commas, .e.g., \fCservices=httpd,nfs,puppet\fR.
.PP
When specifying what service to handle there is a special service value, \fIhost\fR, which will handle alerts/downtime for the \fIhost itself\fR, e.g., \fCservice=host\fR. This keyword may not be given with other services at the same time. \fISetting alerts/downtime for a host does not affect alerts/downtime for any of the services running on it.\fR
.PP
When using the \fInagios\fR module you will need to specify your nagios server using the \fCdelegate_to\fR parameter.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP action
Action to take.
.IR Choices :
downtime,enable_alerts,disable_alerts,silence,unsilence.(required)
.IP host
Host to operate on in Nagios.(required)
.IP author
Author to leave downtime comments as. - Only useable with the \fCdowntime\fR action. (default: Ansible)
.IP services
What to manage downtime/alerts for. Separate multiple services with commas.\fCservice\fR is an alias for \fCservices\fR.\fBRequired\fR option when using the \fCdowntime\fR, \fCenable_alerts\fR, and \fCdisable_alerts\fR actions.(required)
.IP minutes
Minutes to schedule downtime for.Only useable with the \fCdowntime\fR action. (default: 30)
.IP cmdfile
Path to the nagios \fIcommand file\fR (FIFO pipe).Only required if auto-detection fails. (default: auto-detected)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
nagios action=downtime minutes=30 service=httpd host=$inventory_hostname
.fi
.PP
.nf
nagios action=downtime minutes=60 service=host host=$inventory_hostname
.fi
.PP
.nf
nagios action=downtime services=frob,foobar,qeuz host=$inventory_hostname
.fi
.PP
.nf
nagios action=enable_alerts service=smart host=$inventory_hostname
.fi
.PP
.nf
nagios action=disable_alerts service=httpd,nfs host=$inventory_hostname
.fi
.PP
.nf
nagios action=disable_alerts service=host host=$inventory_hostname
.fi
.PP
.nf
nagios action=silence host=$inventory_hostname
.fi
.PP
.nf
nagios action=unsilence host=$inventory_hostname
.fi
." ------- AUTHOR
.SH AUTHOR
Tim Bielawa
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#nagios

28
docs/man/man1/ansible.ohai.man Normal file
View file

@ -0,0 +1,28 @@
.TH ANSIBLE.OHAI 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/ohai
.SH NAME
ohai \- Returns inventory data from I(ohai)
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Similar to the \fIfacter\fR module, this runs the \fIohai\fR discovery program (\fIhttp://wiki.opscode.com/display/chef/Ohai\fR) on the remote host and returns JSON inventory data. \fIOhai\fR data is a bit more verbose and nested than \fIfacter\fR.
." ------ OPTIONS
."
."
."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
ansible webservers -m ohai --tree=/tmp/ohaidata
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#ohai

47
docs/man/man1/ansible.pause.man Normal file
View file

@ -0,0 +1,47 @@
.TH ANSIBLE.PAUSE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/pause
.SH NAME
pause \- Pause playbook execution
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
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.
.PP
You can use \fCctrl+c\fR 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 \fCctrl+c\fR and then \fCc\fR. To abort a playbook: press \fCctrl+c\fR and then \fCa\fR.
.PP
The pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with the \fCserial\fR playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP seconds
Number of minutes to pause for.
.IP minutes
Number of minutes to pause for.
.IP prompt
Optional text to use for the prompt message.."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
pause minutes=5
.fi
.PP
.nf
pause
.fi
.PP
.nf
pause prompt=Make sure org.foo.FooOverload exception is not present
.fi
." ------- AUTHOR
.SH AUTHOR
Tim Bielawa
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#pause

28
docs/man/man1/ansible.ping.man Normal file
View file

@ -0,0 +1,28 @@
.TH ANSIBLE.PING 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/ping
.SH NAME
ping \- Try to connect to host and return pong on success.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
A trivial test module, this module always returns 'pong' on successful contact. It does not make sense in playbooks, but is useful from \fC/usr/bin/ansible\fR
." ------ OPTIONS
."
."
."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
ansible webservers -m ping
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#ping

60
docs/man/man1/ansible.pip.man Normal file
View file

@ -0,0 +1,60 @@
.TH ANSIBLE.PIP 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/pip
.SH NAME
pip \- Manages Python library dependencies.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manage Python library dependencies.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP virtualenv
An optional path to a virtualenv directory to install into
.IP state
The state of module
.IR Choices :
present,absent,latest. (default: present)
.IP version
The version number to install of the Python library specified in the 'name' parameter
.IP requirements
The path to a pip requirements file
.IP name
The name of a Python library to install(required)."
."
." ------ NOTES
.SH NOTES
.PP
Please note that \fIhttp://www.virtualenv.org/, virtualenv\fR must be installed on the remote host if the virtualenv parameter is specified.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
pip name=flask
.fi
.PP
.nf
pip name=flask version=0.8
.fi
.PP
.nf
pip name=flask virtualenv=/srv/webapps/my_app/venv
.fi
.PP
.nf
pip requirements=/srv/webapps/my_app/src/requirements.txt
.fi
.PP
.nf
pip requirements=/srv/webapps/my_app/src/requirements.txt virtualenv=/srv/webapps/my_app/venv
.fi
." ------- AUTHOR
.SH AUTHOR
Matt Wright
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#pip

48
docs/man/man1/ansible.postgresql_db.man Normal file
View file

@ -0,0 +1,48 @@
.TH ANSIBLE.POSTGRESQL_DB 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/postgresql_db
.SH NAME
postgresql_db \- Add or remove PostgreSQL databases from a remote host.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Add or remove PostgreSQL databases from a remote host.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
The database state
.IR Choices :
present,absent. (default: present)
.IP name
name of the database to add or remove(required)
.IP login_password
The password used to authenticate with
.IP owner
Name of the role to set as owner of the database
.IP login_user
The username used to authenticate with
.IP login_host
Host running the database (default: localhost)."
."
." ------ NOTES
.SH NOTES
.PP
The default authentication assumes that you are either logging in as or sudo'ing to the postgres account on the host.
.PP
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.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
postgresql_db db=acme
.fi
." ------- AUTHOR
.SH AUTHOR
Lorin Hochstein
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#postgresql-db

72
docs/man/man1/ansible.postgresql_user.man Normal file
View file

@ -0,0 +1,72 @@
.TH ANSIBLE.POSTGRESQL_USER 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/postgresql_user
.SH NAME
postgresql_user \- Adds or removes a users (roles) from a PostgreSQL database.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Add or remove PostgreSQL users (roles) from a remote host and, optionally, grant the users access to an existing database or tables.
.PP
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.
.PP
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.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP name
name of the user (role) to add or remove(required)
.IP login_user
User (role) used to authenticate with PostgreSQL (default: postgres)
.IP login_host
Host running PostgreSQL. (default: localhost)
.IP db
name of database where permissions will be granted
.IP state
The database state
.IR Choices :
present,absent. (default: present)
.IP login_password
Password used to authenticate with PostgreSQL
.IP password
set the user's password(required)
.IP fail_on_user
if yes, fail when user can't be removed. Otherwise just log and continue
.IR Choices :
yes,no. (default: True)
.IP priv
PostgreSQL privileges string in the format: \fCtable:priv1,priv2\fR."
."
." ------ NOTES
.SH NOTES
.PP
The default authentication assumes that you are either logging in as or sudo'ing to the postgres account on the host.
.PP
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.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
postgresql_user db=acme user=django password=ceec4eif7ya priv=CONNECT/products:ALL
.fi
.PP
.nf
postgresql_user db=acme user=test priv=ALL/products:ALL state=absent fail_on_user=no
.fi
.PP
.nf
postgresql_user db=test user=test priv=ALL state=absent
.fi
.PP
.nf
INSERT,UPDATE/table:SELECT/anothertable:ALL
.fi
." ------- AUTHOR
.SH AUTHOR
Lorin Hochstein
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#postgresql-user

28
docs/man/man1/ansible.raw.man Normal file
View file

@ -0,0 +1,28 @@
.TH ANSIBLE.RAW 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/raw
.SH NAME
raw \- Executes a low-down and dirty SSH command
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
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 \fIshell\fR or \fIcommand\fR module is much more appropriate. Arguments given to \fIraw\fR 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
." ------ OPTIONS
."
."
."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
ansible newhost.example.com -m raw -a "yum -y install python-simplejson"
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#raw

42
docs/man/man1/ansible.seboolean.man Normal file
View file

@ -0,0 +1,42 @@
.TH ANSIBLE.SEBOOLEAN 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/seboolean
.SH NAME
seboolean \- Toggles SELinux booleans.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Toggles SELinux booleans.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
Desired boolean value
.IR Choices :
true,false.(required)
.IP name
Name of the boolean to configure(required)
.IP persistent
Set to 'yes' if the boolean setting should survive a reboot
.IR Choices :
yes,no.."
."
." ------ NOTES
.SH NOTES
.PP
Not tested on any debian based system
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
seboolean name=httpd_can_network_connect state=true persistent=yes
.fi
." ------- AUTHOR
.SH AUTHOR
Stephen Fromm
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#seboolean

44
docs/man/man1/ansible.selinux.man Normal file
View file

@ -0,0 +1,44 @@
.TH ANSIBLE.SELINUX 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/selinux
.SH NAME
selinux \- Change policy and state of SELinux
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
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.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP policy
name of the SELinux policy to use (example: 'targeted')(required)
.IP state
The SELinux mode
.IR Choices :
enforcing,permissive,disabled.(required)
.IP conf
path to the SELinux configuration file, if non-standard (default: /etc/selinux/config)."
."
." ------ NOTES
.SH NOTES
.PP
Not tested on any debian based system
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
selinux policy=targeted state=enforcing
.fi
.PP
.nf
selinux policy=targeted state=disabled
.fi
." ------- AUTHOR
.SH AUTHOR
Derek Carter
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#selinux

58
docs/man/man1/ansible.service.man Normal file
View file

@ -0,0 +1,58 @@
.TH ANSIBLE.SERVICE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/service
.SH NAME
service \- Manage services.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Controls services on remote hosts.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP pattern
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 \fIps\fR 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 version 0.7.)
.IP state
\fIstarted\fR, \fIstopped\fR, \fIreloaded\fR, \fIrestarted\fR. \fIStarted\fR/\fIstopped\fR are idempotent actions that will not run commands unless necessary. \fIrestarted\fR will always bounce the service. \fIreloaded\fR will always reload.
.IR Choices :
running,started,stopped,restarted,reloaded.
.IP enabled
Whether the service should start on boot.
.IR Choices :
yes,no.
.IP name
Name of the service.(required)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
service name=httpd state=started
.fi
.PP
.nf
service name=httpd state=stopped
.fi
.PP
.nf
service name=httpd state=restarted
.fi
.PP
.nf
service name=httpd state=reloaded
.fi
.PP
.nf
service name=foo pattern=/usr/bin/foo state=started
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#service

31
docs/man/man1/ansible.setup.man Normal file
View file

@ -0,0 +1,31 @@
.TH ANSIBLE.SETUP 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/setup
.SH NAME
setup \- Gathers facts about remote hosts
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
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 \fC/usr/bin/ansible\fR to check what variables are available to a host. Ansible provides many \fIfacts\fR about the system, automatically.
." ------ OPTIONS
."
."
."
."
." ------ NOTES
.SH NOTES
.PP
More ansible facts will be added with successive releases. If \fIfacter\fR or \fIohai\fR are installed, variables from these programs will also be snapshotted into the JSON file for usage in templating. These variables are prefixed with \fCfacter_\fR and \fCohai_\fR 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 \fIfacter\fR and \fIohai\fR means you can avoid Ruby-dependencies on your remote systems.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
ansible all -m setup -tree /tmp/facts
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#setup

38
docs/man/man1/ansible.shell.man Normal file
View file

@ -0,0 +1,38 @@
.TH ANSIBLE.SHELL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/shell
.SH NAME
shell \- Execute commands in nodes.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the \fIcommand\fR module but runs the command through the user's configured shell on the remote node.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP creates
a filename, when it already exists, this step will NOT be run
.IP chdir
cd into this directory before running the command (0.6 and later)
.IP (free form)
The command module takes a free form command to run."
."
." ------ NOTES
.SH NOTES
.PP
If you want to execute a command securely and predicably, it may be better to use the \fIcommand\fR module instead. Best practices when writing playbooks will follow the trend of using \fIcommand\fR unless \fIshell\fR is explicitly required. When running ad-hoc commands, use your best judgement.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
shell somescript.sh >> somelog.txt
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#shell

39
docs/man/man1/ansible.slurp.man Normal file
View file

@ -0,0 +1,39 @@
.TH ANSIBLE.SLURP 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/slurp
.SH NAME
slurp \- Slurps a file from remote nodes
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
This module works like \fIfetch\fR. It is used for fetching a base64- encoded blob containing the data in a remote file.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP src
The file on the remote system to fetch. This must be a file, not a directory.(required)."
."
." ------ NOTES
.SH NOTES
.PP
See also: \fIfetch\fR
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
ansible host -m slurp -a 'src=/tmp/xx'
host | success >> {
"content": "aGVsbG8gQW5zaWJsZSB3b3JsZAo=",
"encoding": "base64"
}
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#slurp

40
docs/man/man1/ansible.subversion.man Normal file
View file

@ -0,0 +1,40 @@
.TH ANSIBLE.SUBVERSION 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/subversion
.SH NAME
subversion \- Deploys a subversion repository.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
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.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP repo
The subversion URL to the repository.(required)
.IP dest
Absolute path where the repository should be deployed.(required)
.IP force
If yes, any modified files in the working repository will be discarded. If no, this module will fail if it encounters modified files.
.IR Choices :
yes,no. (default: True)."
."
." ------ NOTES
.SH NOTES
.PP
Requires subversion and grep on the client.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
subversion repo=svn+ssh://an.example.org/path/to/repo dest=/src/checkout
.fi
." ------- AUTHOR
.SH AUTHOR
Dane Summers
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#subversion

35
docs/man/man1/ansible.supervisorctl.man Normal file
View file

@ -0,0 +1,35 @@
.TH ANSIBLE.SUPERVISORCTL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/supervisorctl
.SH NAME
supervisorctl \- Manage the state of a program or group of programs running via Supervisord
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manage the state of a program or group of programs running via Supervisord
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
The state of service
.IR Choices :
started,stopped,restarted.(required)
.IP name
The name of the supervisord program/process to manage(required)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
supervisorctl name=my_app state=started
.fi
." ------- AUTHOR
.SH AUTHOR
Matt Wright
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#supervisorctl

42
docs/man/man1/ansible.template.man Normal file
View file

@ -0,0 +1,42 @@
.TH ANSIBLE.TEMPLATE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/template
.SH NAME
template \- Templates a file out to a remote server.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Templates are processed by the Jinja2 templating language (\fIhttp://jinja.pocoo.org/docs/\fR) - documentation on the template formatting can be found in the Template Designer Documentation (\fIhttp://jinja.pocoo.org/docs/templates/\fR).
." ------ OPTIONS
."
."
.SH OPTIONS
.IP dest
Location to render the template to on the remote machine.(required)
.IP src
Path of a Jinja2 formatted template on the local server. This can be a relative or absolute path.(required)
.IP backup
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
.IR Choices :
yes,no. (default: no)
.IP others
all arguments accepted by the \fIfile\fR module also work here."
."
." ------ NOTES
.SH NOTES
.PP
Since Ansible version 0.9, templates are loaded with \fCtrim_blocks=True\fR.
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
template src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#template

62
docs/man/man1/ansible.user.man Normal file
View file

@ -0,0 +1,62 @@
.TH ANSIBLE.USER 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/user
.SH NAME
user \- Manage user accounts
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manage user accounts and user attributes.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP comment
Optionally sets the description (aka \fIGECOS\fR) of user account.
.IP shell
Optionally set the user's shell.
.IP force
When used with \fIstate=absent\fR, behavior is as with \fIuserdel --force\fR.
.IR Choices :
True,False. (default: no)
.IP name
Name of the user to create, remove or modify.(required)
.IP createhome
Unless set to \fIno\fR, a home directory will be made for the user when the account is created.
.IR Choices :
True,False. (default: yes)
.IP system
When creating an account, setting this to \fIyes\fR makes the user a system account. This setting cannot be changed on existing users.
.IR Choices :
True,False. (default: no)
.IP remove
When used with \fIstate=absent\fR, behavior is as with \fIuserdel --remove\fR.
.IR Choices :
True,False. (default: no)
.IP state
Whether the account should exist. When \fIabsent\fR, removes the user account.
.IR Choices :
present,absent. (default: present)
.IP groups
Puts the user in this comma-delimited list of groups.
.IP home
Optionally set the user's home directory.
.IP group
Optionally sets the user's primary group (takes a group name).
.IP password
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.
.IP append
If \fIyes\fR, will only add groups, not set them to just the list in \fIgroups\fR.
.IP uid
Optionally sets the \fIUID\fR of the user.."
."
." ------ NOTES
."
."
." ------ EXAMPLES
." ------- AUTHOR
.SH AUTHOR
Stephen Fromm
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#user

44
docs/man/man1/ansible.virt.man Normal file
View file

@ -0,0 +1,44 @@
.TH ANSIBLE.VIRT 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/virt
.SH NAME
virt \- Manages virtual machines supported by libvirt
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Manages virtual machines supported by \fIlibvirt\fR.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
Note that there may be some lag for state requests like \fCshutdown\fR since these refer only to VM states. After starting a guest, it may not be immediately accessible.
.IR Choices :
running,shutdown,destroyed,undefined. (default: no)
.IP command
in addition to state management, various non-idempotent commands are available. See examples
.IP name
name of the guest VM being managed(required)."
."
." ------ NOTES
.SH NOTES
.PP
Other non-idempotent commands are: \fCstatus\fR, \fCpause\fR, \fCunpause\fR, \fCget_xml\fR, \fCautostart\fR, \fCfreemem\fR, \fClist_vms\fR, \fCinfo\fR, \fCnodeinfo\fR, \fCvirttype\fR
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
virt guest=alpha state=running
.fi
.PP
.nf
ansible host -m virt -a "guest=alpha command=status"
.fi
." ------- AUTHOR
.SH AUTHOR
Michael DeHaan, Seth Vidal
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#virt

41
docs/man/man1/ansible.wait_for.man Normal file
View file

@ -0,0 +1,41 @@
.TH ANSIBLE.WAIT_FOR 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/wait_for
.SH NAME
wait_for \- Waits for a given port to become accessible on a server.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
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 \fIvirt\fR module and needing to pause until they are ready.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP delay
number of seconds to wait before starting to poll
.IP host
hostname or IP address to wait for (default: 127.0.0.1)
.IP port
port number to poll(required)
.IP timeout
maximum number of seconds to wait for (default: 300)
.IP state
either \fCstarted\fR, or \fCstopped\fR depending on whether the module should poll for the port being open or closed.
.IR Choices :
started,stopped. (default: started)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
wait_for port=8000 delay=10
.fi
." ------- AUTHOR
.SH AUTHOR
Jeroen Hoekx
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#wait-for

45
docs/man/man1/ansible.yum.man Normal file
View file

@ -0,0 +1,45 @@
.TH ANSIBLE.YUM 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
." generated from library/yum
.SH NAME
yum \- Manages packages with the I(yum) package manager
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
Will install, upgrade, remove, and list packages with the \fIyum\fR package manager.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP state
whether to install (\fCpresent\fR, \fClatest\fR), or remove (\fCabsent\fR) a package.
.IR Choices :
present,latest,absent. (default: present)
.IP list
various non-idempotent commands for usage with \fC/usr/bin/ansible\fR and \fInot\fR playbooks. See examples.
.IP name
package name, or package specifier with version, like \fCname-1.0\fR.(required)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
yum name=httpd state=latest
.fi
.PP
.nf
yum name=httpd state=removed
.fi
.PP
.nf
yum name=httpd state=installed
.fi
." ------- AUTHOR
.SH AUTHOR
Seth Vidal
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#yum