table of contents
ANSIBLE-PLAYBOOK(1) | System administration commands | ANSIBLE-PLAYBOOK(1) |
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] [-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] [--syntax-check] [--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¶
--ask-vault-password, --ask-vault-pass
--become-method 'BECOME_METHOD'
--become-password-file 'BECOME_PASSWORD_FILE', --become-pass-file 'BECOME_PASSWORD_FILE'
--become-user 'BECOME_USER'
--connection-password-file 'CONNECTION_PASSWORD_FILE', --conn-pass-file 'CONNECTION_PASSWORD_FILE'
--flush-cache
--force-handlers
--list-hosts
--list-tags
--list-tasks
--private-key 'PRIVATE_KEY_FILE', --key-file 'PRIVATE_KEY_FILE'
--scp-extra-args 'SCP_EXTRA_ARGS'
--sftp-extra-args 'SFTP_EXTRA_ARGS'
--skip-tags
--ssh-common-args 'SSH_COMMON_ARGS'
--ssh-extra-args 'SSH_EXTRA_ARGS'
--start-at-task 'START_AT_TASK'
--step
--syntax-check
--vault-id
--vault-password-file, --vault-pass-file
--version
-C, --check
-D, --diff
-K, --ask-become-pass
-M, --module-path
-T 'TIMEOUT', --timeout 'TIMEOUT'
-b, --become
-c 'CONNECTION', --connection 'CONNECTION'
-e, --extra-vars
-f 'FORKS', --forks 'FORKS'
-h, --help
-i, --inventory, --inventory-file
-k, --ask-pass
-l 'SUBSET', --limit 'SUBSET'
-t, --tags
-u 'REMOTE_USER', --user 'REMOTE_USER'
-v, --verbose
INVENTORY¶
Ansible stores the hosts it can potentially operate on in an inventory. This can be an YAML file, ini-like file, a script, directory, list, etc. For additional options, see the documentation on https://docs.ansible.com/.
ENVIRONMENT¶
The following environment variables may be specified.
ANSIBLE_INVENTORY -- Override the default ansible inventory sources
ANSIBLE_LIBRARY -- Override the default ansible module library path
ANSIBLE_CONFIG -- Specify override location for the ansible config file
Many more are available for most options in ansible.cfg
For a full list check https://docs.ansible.com/. or use the ansible-config command.
FILES¶
/etc/ansible/hosts -- Default inventory file
/etc/ansible/ansible.cfg -- Config file, used if present
~/.ansible.cfg -- User config file, overrides the default config if present
./ansible.cfg -- Local config file (in current working directory) assumed to be 'project specific' and overrides the rest if present.
As mentioned above, the ANSIBLE_CONFIG environment variable will override all others.
AUTHOR¶
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)
Extensive documentation is available in the documentation site: <https://docs.ansible.com>. IRC and mailing list info can be found in file CONTRIBUTING.md, available in: <https://github.com/ansible/ansible>
Ansible 2.14.16 |