table of contents
ANSIBLE(1) | System administration commands | ANSIBLE(1) |
NAME¶
ansible - Define and run a single task 'playbook' against a set of hosts
SYNOPSIS¶
- usage: ansible [-h] [--version] [-v] [-b] [--become-method BECOME_METHOD]
- [--become-user BECOME_USER] [-K] [-i INVENTORY] [--list-hosts] [-l SUBSET] [-P POLL_INTERVAL] [-B SECONDS] [-o] [-t TREE] [-k] [--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] [-C] [--syntax-check] [-D] [-e EXTRA_VARS] [--vault-id VAULT_IDS] [--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES] [-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR] [-a MODULE_ARGS] [-m MODULE_NAME] pattern
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-password, --ask-vault-pass
--become-method 'BECOME_METHOD'
--become-user 'BECOME_USER'
--list-hosts
--playbook-dir 'BASEDIR'
--private-key 'PRIVATE_KEY_FILE', --key-file 'PRIVATE_KEY_FILE'
--scp-extra-args 'SCP_EXTRA_ARGS'
--sftp-extra-args 'SFTP_EXTRA_ARGS'
--ssh-common-args 'SSH_COMMON_ARGS'
--ssh-extra-args 'SSH_EXTRA_ARGS'
--syntax-check
--vault-id
--vault-password-file, --vault-pass-file
--version
-B 'SECONDS', --background 'SECONDS'
-C, --check
-D, --diff
-K, --ask-become-pass
-M, --module-path
-P 'POLL_INTERVAL', --poll 'POLL_INTERVAL'
-T 'TIMEOUT', --timeout 'TIMEOUT'
-a 'MODULE_ARGS', --args 'MODULE_ARGS'
-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'
-m 'MODULE_NAME', --module-name 'MODULE_NAME'
-o, --one-line
-t 'TREE', --tree 'TREE'
-u 'REMOTE_USER', --user 'REMOTE_USER'
-v, --verbose
ENVIRONMENT¶
The following environment variables may be specified.
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/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-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: <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.10.8 |