ansible
Define and run a single task ‘playbook’ against a set of hosts
Synopsis
ansible <host-pattern> [options]
Description
is an extra-simple tool/framework/API for doing ‘remote things’. this command allows you to define and run a single task ‘playbook’ against a set of hosts
Common Options
-
--ask-vault-pass
-
ask for vault password
-
--become-method <BECOME_METHOD>
-
privilege escalation method to use (default=%default), use
ansible-doc -t become -l
to list valid choices.
-
--become-user <BECOME_USER>
-
run operations as this user (default=root)
-
--list-hosts
-
outputs a list of matching hosts; does not execute anything else
-
--playbook-dir <BASEDIR>
-
Since this tool does not use playbooks, use this as a substitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.
-
--private-key, --key-file
-
use this file to authenticate the connection
-
--scp-extra-args <SCP_EXTRA_ARGS>
-
specify extra arguments to pass to scp only (e.g. -l)
-
--sftp-extra-args <SFTP_EXTRA_ARGS>
-
specify extra arguments to pass to sftp only (e.g. -f, -l)
-
--ssh-common-args <SSH_COMMON_ARGS>
-
specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
-
--ssh-extra-args <SSH_EXTRA_ARGS>
-
specify extra arguments to pass to ssh only (e.g. -R)
-
--syntax-check
-
perform a syntax check on the playbook, but do not execute it
-
--vault-id
-
the vault identity to use
-
--vault-password-file
-
vault password file
-
--version
-
show program’s version number, config file location, configured module search path, module location, executable location and exit
-
-B <SECONDS>, --background <SECONDS>
-
run asynchronously, failing after X seconds (default=N/A)
-
-C, --check
-
don’t make any changes; instead, try to predict some of the changes that may occur
-
-D, --diff
-
when changing (small) files and templates, show the differences in those files; works great with –check
-
-K, --ask-become-pass
-
ask for privilege escalation password
-
-M, --module-path
-
prepend colon-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
-
-P <POLL_INTERVAL>, --poll <POLL_INTERVAL>
-
set the poll interval if using -B (default=15)
-
-T <TIMEOUT>, --timeout <TIMEOUT>
-
override the connection timeout in seconds (default=10)
-
-a <MODULE_ARGS>, --args <MODULE_ARGS>
-
module arguments
-
-b, --become
-
run operations with become (does not imply password prompting)
-
-c <CONNECTION>, --connection <CONNECTION>
-
connection type to use (default=smart)
-
-e, --extra-vars
-
set additional variables as key=value or YAML/JSON, if filename prepend with @
-
-f <FORKS>, --forks <FORKS>
-
specify number of parallel processes to use (default=5)
-
-h, --help
-
show this help message and exit
-
-i, --inventory, --inventory-file
-
specify inventory host path or comma separated host list. –inventory-file is deprecated
-
-k, --ask-pass
-
ask for connection password
-
-l <SUBSET>, --limit <SUBSET>
-
further limit selected hosts to an additional pattern
-
-m <MODULE_NAME>, --module-name <MODULE_NAME>
-
module name to execute (default=command)
-
-o, --one-line
-
condense output
-
-t <TREE>, --tree <TREE>
-
log output to this directory
-
-u <REMOTE_USER>, --user <REMOTE_USER>
-
connect as this user (default=None)
-
-v, --verbose
-
verbose mode (-vvv for more, -vvvv to enable connection debugging)
Environment
The following environment variables may be specified.
ANSIBLE_CONFIG
– Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
/etc/ansible/ansible.cfg
– Config file, used if present
~/.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.
License
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-playbook(1), ansible-pull(1), ansible-vault(1),
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/cli/ansible.html