Scroll to navigation

ANSIBLE-CONSOLE(1) System administration commands ANSIBLE-CONSOLE(1)

NAME

ansible-console - REPL console for executing Ansible tasks.

SYNOPSIS

ansible-console [<host-pattern>] [options]

DESCRIPTION

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

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 | enable | machinectl ]


--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 subsitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.


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


--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 password file


--version

show program's version number 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=['/home/randall/.ansible/plugins/modules', '/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, --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)


-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


-s, --sudo

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


-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 -- 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 direcotry) 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 (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.7.7