ansible-console

REPL console for executing Ansible tasks.

Synopsis
Description
Common Options
Environment
Files
Author
License
See also

Synopsis

usage: ansible-console [-h] [--version] [-v] [-b]
                    [--become-method BECOME_METHOD]
                    [--become-user BECOME_USER] [-K] [-i INVENTORY]
                    [--list-hosts] [-l SUBSET] [-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] [--vault-id VAULT_IDS]
                    [--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES]
                    [-f FORKS] [-M MODULE_PATH] [--playbook-dir BASEDIR]
                    [--step]
                    [pattern]

Description

a REPL that allows for running ad-hoc tasks against a chosen inventory (based on dominis’ ansible-shell).

Common Options

--ask-vault-password, --ask-vault-pass: ask for vault password

--become-method <BECOME_METHOD>: privilege escalation method to use (default=sudo), 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 <PRIVATE_KEY_FILE>, --key-file <PRIVATE_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)

--step: one-step-at-a-time: confirm each task before running

--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-pass-file: vault password file

--version: show program’s version number, config file location, configured module search path, module location, executable location and exit

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

-T <TIMEOUT>, --timeout <TIMEOUT>: override the connection timeout in seconds (default=10)

-b, --become: run operations with become (does not imply password prompting)

-c <CONNECTION>, --connection <CONNECTION>: connection type to use (default=smart)

-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

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