ANSIBLE-CONSOLE(1) | System administration commands | ANSIBLE-CONSOLE(1) |
ansible-console - REPL console for executing Ansible tasks.
A REPL that allows for running ad-hoc tasks against a chosen inventory from a nice shell with built-in tab completion (based on dominis' ansible-shell).
It supports several commands, and you can modify its configuration at runtime:
app*.dc*:!app01*) - list: list available hosts in the current path - list groups: list groups included in the current path - become: toggle the become flag - !: forces shell module instead of the ansible module (!yum update -y) - verbosity [num]: set the verbosity level - forks [num]: set the number of forks - become_user [user]: set the become_user - remote_user [user]: set the remote_user - become_method [method]: set the privilege escalation method - check [bool]: toggle check mode - diff [bool]: toggle diff mode - timeout [integer]: set the timeout of tasks in seconds (0 to disable) - help [command/module]: display documentation for the command or module - exit: exit ansible-console
--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'
--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'
--step
--syntax-check
--task-timeout 'TASK_TIMEOUT'
--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'
-u 'REMOTE_USER', --user 'REMOTE_USER'
-v, --verbose
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.
/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.
Ansible was originally written by Michael DeHaan.
Copyright © 2018 Red Hat, Inc | Ansible. Ansible is released under the terms of the GPLv3 license.
ansible (1), ansible-config (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.14.3 |