community.general.binary_file lookup — чтение двоичного файла и возврат в кодировке Base64
Примечание
Этот плагин поиска входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.general.
Чтобы использовать её в плейбуке, укажите: community.general.binary_file.
Добавлено в community.general 11.2.0
Краткое описание
- Этот плагин поиска возвращает содержимое файла в файловой системе контроллера Ansible.
- Файл считывается как двоичный, а его содержимое возвращается в кодировке Base64. Это аналогично использованию ansible.builtin.file вместе с фильтром ansible.builtin.b64encode, за исключением того, что ansible.builtin.file не поддерживает двоичные файлы, поскольку интерпретирует их содержимое как UTF-8, из-за чего данные могут быть неверно закодированы в Base64.
Аргументы
Параметр | Комментарии |
|---|---|
Аргументы list / elements=string / обязательный | Пути к считываемым файлам. Относительные пути будут искаться в разных местах. Подробнее см. в разделе пути задач Ansible. |
Именованные параметры
Здесь описаны именованные параметры плагина поиска. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('community.general.binary_file', key1=value1, key2=value2, ...) и query('community.general.binary_file', key1=value1, key2=value2, ...)
Параметр | Комментарии |
|---|---|
not_exist string | Определяет поведение, если указанный файл не найден. Варианты:
|
Примечания
Примечание
- При совместном использовании именованных и позиционных параметров позиционные параметры необходимо указывать перед именованными:
lookup('community.general.binary_file', term1, term2, key1=value1, key2=value2)иquery('community.general.binary_file', term1, term2, key1=value1, key2=value2) - Этот плагин поиска не поддерживает «подстановочные шаблоны» — вместо него используйте плагин поиска ansible.builtin.fileglob.
См. также
См. также
- Фильтр ansible.builtin.b64decode
-
Фильтр b64decode можно использовать для декодирования данных в кодировке Base64. Учтите, что Ansible не может обрабатывать двоичные данные: они будут интерпретироваться как текст UTF-8!
- Плагин поиска ansible.builtin.file
-
Этот плагин поиска можно использовать для чтения текстовых файлов с контроллера Ansible.
- ansible.builtin.slurp
-
Также позволяет считывать двоичные файлы в кодировке Base64, но с удалённых узлов. С помощью
delegate_to: localhostего можно перенаправить для выполнения на контроллере, однако необходимо знать путь к считываемому файлу. И этот плагин, и ansible.builtin.file используют логику поиска по путям, благодаря которой, например, файлы также могут находиться в каталогеfilesроли. - Пути задач
-
Пути поиска для относительных файлов.
Примеры
---
- name: Output Base64 contents of binary files on screen
ansible.builtin.debug:
msg: "Content: {{ lookup('community.general.binary_file', item) }}"
loop:
- some-binary-file.bin
Возвращаемое значение
Ключ | Описание |
|---|---|
Возвращаемое значение list / elements=string |
Ссылки на коллекцию
© 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/community/general/binary_file_lookup.html
