NAME
ansible-playbook - Runs Ansible playbooks, executing the defined tasks on the targeted hosts.SYNOPSIS
- usage: ansible-playbook [-h] [--version] [-v] [--private-key PRIVATE_KEY_FILE]
- [-u REMOTE_USER] [-c CONNECTION] [-T TIMEOUT] [--ssh-common-args SSH_COMMON_ARGS] [--sftp-extra-args SFTP_EXTRA_ARGS] [--scp-extra-args SCP_EXTRA_ARGS] [--ssh-extra-args SSH_EXTRA_ARGS] [-k | --connection-password-file CONNECTION_PASSWORD_FILE] [--force-handlers] [--flush-cache] [-b] [--become-method BECOME_METHOD] [--become-user BECOME_USER] [-K | --become-password-file BECOME_PASSWORD_FILE] [-t TAGS] [--skip-tags SKIP_TAGS] [-C] [--syntax-check] [-D] [-i INVENTORY] [--list-hosts] [-l SUBSET] [-e EXTRA_VARS] [--vault-id VAULT_IDS] [--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES] [-f FORKS] [-M MODULE_PATH] [--list-tasks] [--list-tags] [--step] [--start-at-task START_AT_TASK] playbook [playbook ...]
DESCRIPTION
the tool to run Ansible playbooks, which are a configuration and multinode deployment system. See the project home page ( https://docs.ansible.com) for more information.COMMON OPTIONS
Playbook(s)
ask for vault password
privilege escalation method to use
(default=sudo), use ansible-doc -t become -l to list valid
choices.
Become password file
run operations as this user
(default=root)
Connection password file
clear the fact cache for every host in
inventory
run handlers even if a task fails
outputs a list of matching hosts; does not
execute anything else
list all available tags
list all tasks that would be executed
use this file to authenticate the
connection
specify extra arguments to pass to scp only
(e.g. -l)
specify extra arguments to pass to sftp only
(e.g. -f, -l)
only run plays and tasks whose tags do not
match these values
specify common arguments to pass to
sftp/scp/ssh (e.g. ProxyCommand)
specify extra arguments to pass to ssh only
(e.g. -R)
start the playbook at the task matching this
name
one-step-at-a-time: confirm each task before
running
perform a syntax check on the playbook, but do
not execute it
the vault identity to use
vault password file
show program's version number, config file
location, configured module search path, module location, executable location
and exit
don't make any changes; instead, try to
predict some of the changes that may occur
when changing (small) files and templates,
show the differences in those files; works great with --check
ask for privilege escalation password
prepend colon-separated path(s) to module
library (default={{ ANSIBLE_HOME ~
"/plugins/modules:/usr/share/ansible/plugins/modules" }})
override the connection timeout in seconds
(default=10)
run operations with become (does not imply
password prompting)
connection type to use (default=smart)
set additional variables as key=value or
YAML/JSON, if filename prepend with @
specify number of parallel processes to use
(default=5)
show this help message and exit
specify inventory host path or comma separated
host list. --inventory-file is deprecated
ask for connection password
further limit selected hosts to an additional
pattern
only run plays and tasks tagged with these
values
connect as this user (default=None)
Causes Ansible to print more debug messages.
Adding multiple -v will increase the verbosity, the builtin plugins currently
evaluate up to -vvvvvv. A reasonable level to start is -vvv, connection
debugging might require -vvvv.
ENVIRONMENT
The following environment variables may be specified.FILES
/etc/ansible/ansible.cfg -- Config file, used if presentAUTHOR
Ansible was originally written by Michael DeHaan.COPYRIGHT
Copyright © 2018 Red Hat, Inc | Ansible. Ansible is released under the terms of the GPLv3 license.SEE ALSO
ansible (1), ansible-config (1), ansible-console (1), ansible-doc (1), ansible-galaxy (1), ansible-inventory (1), ansible-pull (1), ansible-vault (1)| Ansible 2.14.3 |