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 ini
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.0: of ansible.builtin
key1=value1
. This plugin retrieves the value on the right side after the equal sign '='
of a given section [section]
.Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
_terms string / required | The key(s) to look up. On Python 2, key names are case insensitive. In Python 3, key names are case sensitive. Duplicate key names found in a file will result in an error. | ||
default string | Default: "" | Return value if the key is not in the ini file. | |
encoding string | Default: "utf-8" | Text encoding to use. | |
file string | Default: "ansible.ini" | Name of the file to load. | |
re boolean |
| Flag to indicate if the key supplied is a regexp. | |
section string | Default: "global" | Section where to lookup the key. | |
type string |
| Type of the file. 'properties' refers to the Java properties files. |
- debug: msg="User in integration is {{ lookup('ini', 'user section=integration file=users.ini') }}" - debug: msg="User in production is {{ lookup('ini', 'user section=production file=users.ini') }}" - debug: msg="user.name is {{ lookup('ini', 'user.name type=properties file=user.properties') }}" - debug: msg: "{{ item }}" with_ini: - '.* section=section1 file=test.ini re=True'
Common return values are documented here, the following are the fields unique to this lookup:
Key | Returned | Description |
---|---|---|
_raw list / elements=string | success | value(s) of the key(s) in the ini file |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/ini_lookup.html