ansible-console
Description
a REPL that allows for running ad-hoc tasks against a chosen inventory (based on dominis’ ansible-shell).
- ask for su 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)
—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.
—scp-extra-args
<SCP_EXTRA_ARGS>
—ssh-common-args
<SSH_COMMON_ARGS>
- specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
—step
- one-step-at-a-time: confirm each task before running
—vault-id
- the vault identity to use
—version
- show program’s version number and exit
-D
—diff
- when changing (small) files and templates, show the differences in those files; works great with –check
-M
,
—module-path
- prepend colon-separated path(s) to module library (default=[‘/home/jenkins/.ansible/plugins/modules’, ‘/usr/share/ansible/plugins/modules’])
-S
,
—su
- run operations with su (deprecated, use become)
-U
<SUDO_USER>
,
—sudo-user
<SUDO_USER>
- desired sudo user (default=root) (deprecated, use become)
-c
<CONNECTION>
,
—connection
<CONNECTION>
- connection type to use (default=smart)
-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
-s
,
—sudo
- run operations with sudo (nopasswd) (deprecated, use become)
-v
,
—verbose
Environment
The following environment variables may be specified.
ANSIBLE_CONFIG
– Override the default ansible config file
/etc/ansible/ansible.cfg
– Config file, used if present
– User config file, overrides the default config if present
Author
Ansible was originally written by Michael DeHaan.
Copyright © 2017 Red Hat, Inc | Ansible.
Ansible is released under the terms of the GPLv3 License.
See also
ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1),