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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

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

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

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

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

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

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

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

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

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

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

Параметр	Комментарии
canonical логический	Если задано значение `true`, экспортировать тип тега в выходные данные. Варианты: `false` `true`
default_style строка	Определяет стиль скалярного значения. Варианты: `""` `"'"` `"\""` `"\|"` `">"`
encoding строка	Задаёт кодировку выходных данных.
explicit_end логический	Если задано значение `true`, добавляет явный маркер окончания с помощью `...`. Варианты: `false` `true`
explicit_start логический	Если задано значение `true`, добавляет явный маркер начала с помощью `---`. Варианты: `false` `true`
indent целое число	Количество пробелов для отступа структур Python; в основном используется для удобного отображения. По умолчанию: `2`
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_nice_yaml }}"

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

Ключ	Описание
Возвращаемое значение строка	Строка в формате 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_nice_yaml_filter.html