ansible/docs/man/man1/ansible-playbook.1.asciidoc.in

235 lines
5.1 KiB
Text
Raw Normal View History

ansible-playbook(1)
===================
:doctype:manpage
:man source: Ansible
:man version: %VERSION%
:man manual: System administration commands
NAME
----
ansible-playbook - run an ansible playbook
SYNOPSIS
--------
ansible-playbook <filename.yml> ... [options]
DESCRIPTION
-----------
*Ansible playbooks* are a configuration and multinode deployment
system. Ansible-playbook is the tool used to run them. See the
project home page (link below) for more information.
ARGUMENTS
---------
*filename.yml*::
The names of one or more YAML format files to run as ansible playbooks.
OPTIONS
-------
2015-07-22 10:56:50 +02:00
*-k*, *--ask-pass*::
2015-07-22 10:56:50 +02:00
Prompt for the SSH password instead of assuming key-based
authentication with ssh-agent.
2015-07-22 10:56:50 +02:00
*-K*, *--ask-sudo-pass*::
2015-07-22 10:56:50 +02:00
Prompt for the password to use for playbook plays that request sudo
access, if any.
2015-07-22 10:56:50 +02:00
*-b*, *--become*::
2015-07-22 10:56:50 +02:00
Run operations with become (nopasswd implied)
2015-07-22 10:56:50 +02:00
*--become-method=BECOME_METHOD*::
Privilege escalation method to use (default=sudo),
2015-08-18 03:31:18 +02:00
valid choices: [ sudo | su | pbrun | pfexec | runas | doas ]
2015-07-22 10:56:50 +02:00
*--become-user=BECOME_USER*::
Run operations as this user (default=None).
*-C*, *--check*::
Do not make any changes on the remote system, but test resources to see what might
have changed. Note this can not scan all possible resource types and is only
a simulation.
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
Connection type to use. Possible options are 'paramiko' (SSH), 'ssh',
and 'local'. 'local' is mostly useful for crontab or kickstarts.
*-D*, *--diff*::
When changing any templated files, show the unified diffs of how they changed. When
used with --check, shows how the files would have changed if --check were not used.
*-e* 'VARS', *--extra-vars=*'VARS'::
Extra variables to inject into a playbook, in key=value key=value format or
as quoted JSON (hashes and arrays). To load variables from a file, specify
the file preceded by @ (e.g. @vars.yml).
2015-07-22 10:56:50 +02:00
*--flush-cache*::
Clear the fact cache.
*--force-handlers*::
Run handlers even if a task fails.
*-f* 'NUM', *--forks=*'NUM'::
Level of parallelism. 'NUM' is specified as an integer, the default is 5.
2015-07-22 10:56:50 +02:00
*-h*, *--help*::
2015-07-22 10:56:50 +02:00
Show help page and exit
2015-07-22 10:56:50 +02:00
*-i* 'PATH', *--inventory=*'PATH'::
2015-07-22 10:56:50 +02:00
The 'PATH' to the inventory hosts file, which defaults to
'/etc/ansible/hosts'.
2015-07-22 10:56:50 +02:00
*-l* 'SUBSET', *--limit=*'SUBSET'::
2015-07-22 10:56:50 +02:00
Further limits the selected host/group patterns.
2015-07-22 10:56:50 +02:00
*--list-hosts*::
Outputs a list of matching hosts; does not execute anything else.
2015-07-22 10:56:50 +02:00
*--list-tags*::
2015-07-22 10:56:50 +02:00
List all available tags.
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
*--list-tasks*::
2015-07-22 10:56:50 +02:00
List all tasks that would be executed
2015-07-22 10:56:50 +02:00
*-M* 'DIRECTORY', *--module-path=*'DIRECTORY'::
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
The 'DIRECTORY' search path to load modules from. The default is
'/usr/share/ansible'. This can also be set with the ANSIBLE_LIBRARY
environment variable.
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
*--private-key=*'PRIVATE_KEY_FILE'::
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
Use this file to authenticate the connection
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
*--skip-tages=*'SKIP_TAGS'::
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
Only run plays and tasks whose tags do not match these values.
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
*--start-at-task=*'START_AT'::
2013-02-16 21:38:59 +01:00
2015-07-22 10:56:50 +02:00
Start the playbook at the task matching this name.
2012-03-14 02:54:42 +01:00
2015-07-22 10:56:50 +02:00
*--step*::
One-step-at-a-time: confirm each task before running.
2012-03-14 02:54:42 +01:00
2015-07-22 10:56:50 +02:00
*-S*, --su*::
Run operations with su (deprecated, use become)
*-R SU-USER*, *--su-user=*'SU_USER'::
run operations with su as this user (default=root)
(deprecated, use become)
2012-03-14 02:54:42 +01:00
*-s*, *--sudo*::
2015-07-22 10:56:50 +02:00
Run operations with sudo (nopasswd) (deprecated, use become)
2015-07-22 10:56:50 +02:00
*-U*, 'SUDO_USER', *--sudo-user=*'SUDO_USER'::
Desired sudo user (default=root) (deprecated, use become).
*--skip-tags=*'SKIP_TAGS'::
Only run plays and tasks whose tags do not match these values.
*--syntax-check*::
Look for syntax errors in the playbook, but don't run anything
*-t*, 'TAGS', *--tags=*'TAGS'::
Only run plays and tasks tagged with these values.
*-T* 'SECONDS', *--timeout=*'SECONDS'::
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
*-u* 'USERNAME', *--user=*'USERNAME'::
Use this remote user name on playbook steps that do not indicate a
user name to run as.
2015-07-22 10:56:50 +02:00
*--vault-password-file=*'VAULT_PASSWORD_FILE'::
2015-07-22 10:56:50 +02:00
Vault password file.
2015-07-22 10:56:50 +02:00
*-v*, *--verbose*::
2012-09-07 00:42:18 +02:00
2015-07-22 10:56:50 +02:00
Verbose mode, more output from successful actions will be shown. Give
up to three times for more output.
2015-07-22 10:56:50 +02:00
*--version*::
2015-07-22 10:56:50 +02:00
Show program's version number and exit.
ENVIRONMENT
-----------
2014-02-11 16:50:10 +01:00
The following environment variables may be specified.
ANSIBLE_INVENTORY -- Override the default ansible inventory file
ANSIBLE_LIBRARY -- Override the default ansible module library path
2012-10-12 23:31:13 +02:00
FILES
-----
/etc/ansible/hosts -- Default inventory file
/usr/share/ansible/ -- Default module library
/etc/ansible/ansible.cfg -- Config file, used if present
2012-10-12 23:31:13 +02:00
~/.ansible.cfg -- User config file, overrides the default config if present
AUTHOR
------
Ansible was originally written by Michael DeHaan. See the AUTHORS file
for a complete list of contributors.
COPYRIGHT
---------
Copyright © 2012, Michael DeHaan
Ansible is released under the terms of the GPLv3 License.
SEE ALSO
--------
*ansible*(1), *ansible-pull*(1), *ansible-doc*(1)
Extensive documentation is available in the documentation site:
<http://docs.ansible.com>. IRC and mailing list info can be found
in file CONTRIBUTING.md, available in: <https://github.com/ansible/ansible>