Фильтр community.general.to_toml — преобразование переменной в строку TOML

Примечание

Этот плагин фильтра входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого плагина фильтра могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.general.to_toml.

Добавлено в community.general 12.3.0

Краткое описание
Требования
Входные данные
Параметры-ключевые слова
Примеры
Возвращаемое значение

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

Преобразует переменную Ansible в строковое представление TOML.
Этот фильтр служит обёрткой для функции tomlkit.dumps библиотеки Python TOML Kit.

Требования

Следующие требования должны быть выполнены на локальном управляющем узле, который запускает этот фильтр.

tomlkit

Входные данные

Здесь описаны входные данные фильтра — значение перед | community.general.to_toml.

Параметр	Комментарии
Input dictionary / обязательный	Переменная или выражение, возвращающее структуру данных.

Параметры-ключевые слова

Здесь описаны параметры-ключевые слова фильтра. В следующем примере это значения key1=value1, key2=value2 и т. д.: input | community.general.to_toml(key1=value1, key2=value2, ...)

Параметр	Комментарии
redact_sensitive_values boolean	Если задано значение `true`, зашифрованные строки заменяются на `<redacted>`, а не расшифровываются. В будущих версиях ansible-core это может также распространяться на другие строки, помеченные как конфиденциальные. Примечание. В ansible-core 2.18 и более ранних версиях результат может отличаться от ожидаемого, поскольку эти версии ansible-core удаляют сведения о шифровании из строк, входящих в более сложные структуры данных, указанные в `vars`. Возможные значения: `false` ← (по умолчанию) `true`

Параметр

Комментарии

redact_sensitive_values

boolean

Если задано значение true, зашифрованные строки заменяются на <redacted>, а не расшифровываются.

В будущих версиях ansible-core это может также распространяться на другие строки, помеченные как конфиденциальные.

Примечание. В ansible-core 2.18 и более ранних версиях результат может отличаться от ожидаемого, поскольку эти версии ansible-core удаляют сведения о шифровании из строк, входящих в более сложные структуры данных, указанные в vars.

Возможные значения:

false ← (по умолчанию)
true

Примеры

---
# Dump variable in a template to create a TOML document
value: "{{ my_config | community.general.to_toml }}"

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

Ключ	Описание
Возвращаемое значение string	Строка в формате TOML, представляющая переданную структуру переменной. Возвращается: success

Авторы

Matt Williams (@milliams)

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

© 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/to_toml_filter.html