ansible.builtin.config lookup – Lookup current Ansible configuration values
Note
This lookup plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
config
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same lookup plugin name.
New in version 2.5: of ansible.builtin
Synopsis
Retrieves the value of an Ansible configuration setting.
You can use
ansible-config list
to see all available settings.
Parameters
Parameter |
Comments |
---|---|
The key(s) to look up |
|
action to take if term is missing from config Error will raise a fatal error Skip will just ignore the term Warn will skip over it but issue a warning Choices:
|
|
name of the plugin for which you want to retrieve configuration settings. |
|
the type of the plugin referenced by ‘plugin_name’ option. Choices:
|
Examples
- name: Show configured default become user
debug: msg="{{ lookup('config', 'DEFAULT_BECOME_USER')}}"
- name: print out role paths
debug:
msg: "These are the configured role paths: {{lookup('config', 'DEFAULT_ROLES_PATH')}}"
- name: find retry files, skip if missing that key
find:
paths: "{{lookup('config', 'RETRY_FILES_SAVE_PATH')|default(playbook_dir, True)}}"
patterns: "*.retry"
- name: see the colors
debug: msg="{{item}}"
loop: "{{lookup('config', 'COLOR_OK', 'COLOR_CHANGED', 'COLOR_SKIP', wantlist=True)}}"
- name: skip if bad value in var
debug: msg="{{ lookup('config', config_in_var, on_missing='skip')}}"
var:
config_in_var: UNKNOWN
- name: show remote user and port for ssh connection
debug: msg={{q("config", "remote_user", "port", plugin_type="connection", plugin_name="ssh", on_missing='skip')}}
- name: show remote_tmp setting for shell (sh) plugin
debug: msg={{q("config", "remote_tmp", plugin_type="shell", plugin_name="sh")}}
Return Values
Common return values are documented here, the following are the fields unique to this lookup:
Key |
Description |
---|---|
value(s) of the key(s) in the config Returned: success |
Authors
Ansible Core Team
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.