You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ansible-config

View ansible configuration.

Synopsis 

usage: ansible-config [-h] [--version] [-v] {list,dump,view,init} ...

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.

Actions 

list 

list and output available configs

-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

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

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

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.