Section 1 · User commands

ansible-config.1

Package: ansible-core

ANSIBLE-CONFIG

NAME
SYNOPSIS
DESCRIPTION
COMMON OPTIONS
ACTIONS
ENVIRONMENT
FILES
AUTHOR
COPYRIGHT
SEE ALSO

NAME

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

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.