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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

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

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

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

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

Преобразует переменную Ansible в строковое представление YAML без сохранения зашифрованных строк, как это делает ansible.builtin.to_yaml.
Этот фильтр служит обёрткой для функции yaml.dump библиотеки Python PyYAML.

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

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

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

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

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

Параметр	Комментарии
canonical логическое значение	Если задано значение `true`, включить тип тега в вывод. Варианты: `false` `true`
default_style строка	Задаёт стиль скалярного значения. Варианты: `""` `"'"` `"\""` `"\|"` `">"`
encoding строка	Задаёт кодировку вывода.
explicit_end логическое значение	Если задано значение `true`, добавляет явный конец с помощью `...`. Варианты: `false` `true`
explicit_start логическое значение	Если задано значение `true`, добавляет явное начало с помощью `---`. Варианты: `false` `true`
indent целое число	Количество пробелов для отступа структур Python; в основном используется для удобного отображения данных.
line_break строка	Задаёт символ перевода строки.
redact_sensitive_values логическое значение	Если задано значение `true`, зашифрованные строки заменяются на `<redacted>`, а не расшифровываются. В будущих версиях ansible-core это поведение может распространяться и на другие строки, помеченные как конфиденциальные. Примечание: в ansible-core 2.18 и более ранних версиях результат может отличаться от ожидаемого, поскольку эти версии ansible-core удаляют информацию о шифровании из строк, являющихся частью более сложных структур данных, заданных в `vars`. Варианты: `false` ← (по умолчанию) `true`
sort_keys логическое значение	Определяет, будут ли ключи словаря отсортированы. Варианты: `false` `true` ← (по умолчанию)
width целое число	Задаёт предпочтительную ширину строки.

Примечания

Примечание

Могут быть доступны дополнительные параметры; подробности см. в документации PyYAML.
Эти параметры для yaml.dump не принимаются, поскольку переопределяются внутри: allow_unicode.

Примеры

---
# Dump variable in a template to create a YAML document
value: "{{ github_workflow | community.general.to_yaml }}"

---
# Same as above but 'prettier' (equivalent to community.general.to_nice_yaml filter)
value: "{{ docker_config | community.general.to_yaml(indent=2) }}"

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

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

Авторы

Команда Ansible Core
Felix Fontein (@felixfontein)

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

© 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_yaml_filter.html