ansible-config - Man Page
View ansible configuration.
Synopsis
usage: ansible-config [-h] [--version] [-v] {list,dump,view,init,validate} ...
Description
Config command line class
Common Options
- --version
show program's version number, config file location, configured module search path, module location, executable location and exit
- -h, --help
show this help message and exit
- -v, --verbose
Causes Ansible to print more debug messages. Adding multiple -v will increase the verbosity, the builtin plugins currently evaluate up to -vvvvvv. A reasonable level to start is -vvv, connection debugging might require -vvvv. This argument may be specified multiple times.
Actions
- list
- list and output available configs
- --format 'FORMAT', -f 'FORMAT'
Output format for list
- -c 'CONFIG_FILE', --config 'CONFIG_FILE'
path to configuration file, defaults to first file found in precedence.
- -t 'TYPE', --type 'TYPE'
Filter down to a specific plugin type.
- dump
Shows the current settings, merges ansible.cfg if specified
- --format 'FORMAT', -f 'FORMAT'
Output format for dump
- --only-changed, --changed-only
Only show configurations that have changed from the default
- -c 'CONFIG_FILE', --config 'CONFIG_FILE'
path to configuration file, defaults to first file found in precedence.
- -t 'TYPE', --type 'TYPE'
Filter down to a specific plugin type.
- view
Displays the current config file
- -c 'CONFIG_FILE', --config 'CONFIG_FILE'
path to configuration file, defaults to first file found in precedence.
- -t 'TYPE', --type 'TYPE'
Filter down to a specific plugin type.
- init
- Create initial configuration
- --disabled
Prefixes all entries with a comment character to disable them
- --format 'FORMAT', -f 'FORMAT'
Output format for init
- -c 'CONFIG_FILE', --config 'CONFIG_FILE'
path to configuration file, defaults to first file found in precedence.
- -t 'TYPE', --type 'TYPE'
Filter down to a specific plugin type.
validate
- --format 'FORMAT', -f 'FORMAT'
Output format for init
- -c 'CONFIG_FILE', --config 'CONFIG_FILE'
path to configuration file, defaults to first file found in precedence.
- -t 'TYPE', --type 'TYPE'
Filter down to a specific plugin type.
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 (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> >