Runs Ansible playbooks, executing the defined tasks on the targeted hosts.
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.
--ask-su-passask for su password (deprecated, use become)
--ask-sudo-passask for sudo password (deprecated, use become)
--ask-vault-passask for vault password
--become-method <BECOME_METHOD>¶privilege escalation method to use (default=sudo), valid choices: [ sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas | pmrun | enable | machinectl ]
--become-user <BECOME_USER>¶run operations as this user (default=root)
--flush-cacheclear the fact cache for every host in inventory
--force-handlersrun handlers even if a task fails
--list-hostsoutputs a list of matching hosts; does not execute anything else
list all available tags
--list-taskslist all tasks that would be executed
--private-key, --key-fileuse 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)
only run plays and tasks whose tags do not match these values
--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)
--start-at-task <START_AT_TASK>¶start the playbook at the task matching this name
--stepone-step-at-a-time: confirm each task before running
--syntax-checkperform a syntax check on the playbook, but do not execute it
--vault-idthe vault identity to use
--vault-password-filevault password file
--versionshow program’s version number and exit
-C, --checkdon’t make any changes; instead, try to predict some of the changes that may occur
-D, --diffwhen changing (small) files and templates, show the differences in those files; works great with –check
-K, --ask-become-passask for privilege escalation password
-M, --module-pathprepend colon-separated path(s) to module library (default=[u’/root/.ansible/plugins/modules’, u’/usr/share/ansible/plugins/modules’])
-R <SU_USER>, --su-user <SU_USER>¶run operations with su as this user (default=None) (deprecated, use become)
-S, --surun operations with su (deprecated, use become)
-T <TIMEOUT>, --timeout <TIMEOUT>¶override the connection timeout in seconds (default=10)
-U <SUDO_USER>, --sudo-user <SUDO_USER>¶desired sudo user (default=root) (deprecated, use become)
-b, --becomerun operations with become (does not imply password prompting)
-c <CONNECTION>, --connection <CONNECTION>¶connection type to use (default=smart)
-e, --extra-varsset 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, --helpshow this help message and exit
-i, --inventory, --inventory-filespecify inventory host path or comma separated host list. –inventory-file is deprecated
-k, --ask-passask for connection password
-l <SUBSET>, --limit <SUBSET>¶further limit selected hosts to an additional pattern
-s, --sudorun operations with sudo (nopasswd) (deprecated, use become)
only run plays and tasks tagged with these values
-u <REMOTE_USER>, --user <REMOTE_USER>¶connect as this user (default=None)
-v, --verboseverbose mode (-vvv for more, -vvvv to enable connection debugging)
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
/etc/ansible/ansible.cfg – Config file, used if present
~/.ansible.cfg – User config file, overrides the default config if present
Ansible was originally written by Michael DeHaan.
See the AUTHORS file for a complete list of contributors.