ansible.builtin.ini lookup — чтение данных из ini-файла

Примечание

Этот плагин поиска входит в ansible-core и включен во все установки Ansible. В большинстве случаев можно использовать краткое имя плагина ini. Однако рекомендуем использовать полное имя коллекции (FQCN) ansible.builtin.ini, чтобы упростить переход к документации плагина и избежать конфликтов с другими коллекциями, в которых может быть плагин поиска с таким же именем.

Краткое описание
Аргументы
Именованные параметры
Примечания
См. также
Примеры
Возвращаемое значение

Краткое описание

Плагин поиска ini считывает содержимое файла в формате INI key1=value1. Плагин извлекает значение справа от знака равенства '=' в указанной секции [section].
Также можно считывать файл свойств, который в этом случае не содержит секций.

Аргументы

Параметр	Комментарии
Аргументы строка / обязательный	Ключ или ключи для поиска.

Именованные параметры

Здесь описаны именованные параметры поиска. В следующих примерах это значения key1=value1, key2=value2 и т. д.: lookup('ansible.builtin.ini', key1=value1, key2=value2, ...) и query('ansible.builtin.ini', key1=value1, key2=value2, ...)

Параметр	Комментарии
allow_no_value псевдонимы: allow_none логический добавлено в ansible-core 2.12	Считывать ini-файл, содержащий ключ без значения и без символа «=». Варианты: `false` ← (по умолчанию) `true`
case_sensitive строка добавлено в ansible-core 2.12	Учитывать ли регистр имен ключей, считываемых из `file`. Это позволяет избежать ошибок из-за дублирования ключей, различающихся только регистром. По умолчанию: `false`
default строка	Возвращаемое значение, если ключ отсутствует в ini-файле. По умолчанию: `""`
encoding строка	Используемая кодировка текста. По умолчанию: `"utf-8"`
file строка	Имя загружаемого файла. По умолчанию: `"ansible.ini"`
interpolation логический добавлено в ansible-core 2.18	Разрешает интерполяцию значений. См. https://docs.python.org/3/library/configparser.html#configparser.BasicInterpolation Варианты: `false` `true` ← (по умолчанию)
re логический	Флаг, указывающий, является ли переданный ключ регулярным выражением. Варианты: `false` ← (по умолчанию) `true`
section строка	Секция, в которой выполняется поиск ключа. По умолчанию: `"global"`
type строка	Тип файла. Значение «properties» обозначает файлы свойств Java. Варианты: `"ini"` ← (по умолчанию) `"properties"`

Примечания

Примечание

При совместном использовании именованных и позиционных параметров позиционные параметры необходимо указывать перед именованными: lookup('ansible.builtin.ini', term1, term2, key1=value1, key2=value2) и query('ansible.builtin.ini', term1, term2, key1=value1, key2=value2)

См. также

Пути задач: Пути поиска для относительных файлов.
community.general.ini_file: Изменение параметров в INI-файлах.
community.general.from_ini плагин фильтра: Преобразует текст в формате INI в словарь.
community.general.to_ini плагин фильтра: Преобразует словарь в формат INI-файла.

Примеры

- ansible.builtin.debug: msg="User in integration is {{ lookup('ansible.builtin.ini', 'user', section='integration', file='users.ini') }}"

- ansible.builtin.debug: msg="User in production  is {{ lookup('ansible.builtin.ini', 'user', section='production',  file='users.ini') }}"

- ansible.builtin.debug: msg="user.name is {{ lookup('ansible.builtin.ini', 'user.name', type='properties', file='user.properties') }}"

- ansible.builtin.debug:
    msg: "{{ item }}"
  loop: "{{ q('ansible.builtin.ini', '.*', section='section1', file='test.ini', re=True) }}"

- name: Read an ini file with allow_no_value
  ansible.builtin.debug:
    msg: "{{ lookup('ansible.builtin.ini', 'user', file='mysql.ini', section='mysqld', allow_no_value=True) }}"

Возвращаемое значение

Ключ	Описание
Возвращаемое значение список / элементы=строка	значение или значения ключа или ключей в ini-файле Возвращается: при успехе

Авторы

Yannig Perre <yannig.perre(at)gmail.com>

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ansible/builtin/ini_lookup.html