ansible-config(1)

💅 ansible-config — the manual page, but make it make sense

okay so this is the ansible-config page from the System administration commands fam — she's the one you call when you need to view ansible configuration and honestly? she ate. 🎀

---

✨ NAME ✨

ansible-config — View ansible configuration.

---

🦋 SYNOPSIS 🦋

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

---

🌸 DESCRIPTION 🌸

Config command line class. that's it, that's the description bestie, she's a config command line class and she's thriving 💖

---

🌈 COMMON OPTIONS 🌈

these are the ones that work no matter which action you pick, iykyk:

• --version — show program's version number, config file location, configured module search path, module location, executable location and exit. literally the full lore drop, then she dips 👑
• -h, --help — show this help message and exit. the classic.
• -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.

ngl the -v stacking is giving volume knob. start at -vvv, and if your connection is acting up go -vvvv. max out at -vvvvvv — that's the ceiling, bestie, the plugins don't read past it 💀

---

🫶 ACTIONS 🫶

pick your fighter. one per invocation.

📋 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. Defaults to 'all'; use 'base' for the previous behavior.

🗑️ 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. Defaults to 'all'; use 'base' for the previous behavior.

👀 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. Defaults to 'all'; use 'base' for the previous behavior.

🌱 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. Defaults to 'all'; use 'base' for the previous behavior.

✅ 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. Defaults to 'all'; use 'base' for the previous behavior.

ok real talk: under validate, the --format blurb literally says "Output format for init" — that's what the page says, so that's what I'm telling you. no cap, no edits, I don't make the rules 🫠

---

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

she said "check the docs, or just ask me" and honestly? iconic behavior 💜

---

🍓 FILES 🍓

listed in order, and the later ones win — this is the precedence chain, bestie, respect it 🔥

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

⚠️ <red>lowkey the most important line on this whole page</red> ⚠️ — ANSIBLE_CONFIG beats everything. every single file up there? she doesn't care. env var is main character energy 👑

---

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

---

and that's the whole page, bestie 🎀 tysm for reading, mwah 💋 — this was Ansible 2.22.0, footer-dated the same as the ansible-config(1) page itself, and yes she's still serving 💅✨