ansible man page

ansible — Define and run a single task 'playbook' against a set of hosts

TL;DR

ansible group --list-hosts

ansible group -m ping

ansible group -m setup

ansible group -m command -a 'my command'

ansible group --become --ask-become-pass -m command -a 'my command'

ansible group -i inventory_file -m command -a 'my command'

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-su-pass

ask for su password (deprecated, use become)

--ask-sudo-pass

ask for sudo password (deprecated, use become)

--ask-vault-pass

ask 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 ]

--become-user BECOME_USER

run operations as this user (default=root)

--list-hosts

outputs a list of matching hosts; does not execute anything else

--new-vault-id NEW_VAULT_ID

the new vault identity to use for rekey

--new-vault-password-file

new vault password file for rekey

--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 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=[u'/home/jenkins/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules'])

-P POLL_INTERVAL, --poll POLL_INTERVAL

set the poll interval if using -B (default=15)

-R SU_USER, --su-user SU_USER

run operations with su as this user (default=None) (deprecated, use become)

-S, --su

run 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)

-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

-s, --sudo

run operations with sudo (nopasswd) (deprecated, use become)

-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.

See Also

ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(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

Referenced By

ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1), gdeploy(1), loopabull(1).

11/29/2017 Ansible 2.4.2.0 System administration commands