Spec-Zone.ru › Ansible

ansible.builtin.default callback — стандартный вывод Ansible на экран

Примечание

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

  • Плагин обратного вызова
  • Краткое описание
  • Требования
  • Параметры

Плагин обратного вызова

Этот плагин является плагином обратного вызова stdout. Одновременно можно использовать только один плагин обратного вызова stdout. При этом можно включить дополнительные агрегирующие плагины обратного вызова или плагины уведомлений. Дополнительные сведения о плагинах обратного вызова см. в разделе Плагины обратного вызова.

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

  • Это плагин обратного вызова вывода по умолчанию для ansible-playbook.

Требования

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

  • указан как stdout в конфигурации

Параметры

Параметр

Комментарии

check_mode_markers

boolean

добавлено в Ansible 2.9

Включает или отключает отображение маркеров при запуске в режиме проверки.

Маркеры DRY RUN отображаются в начале и в конце выполнения плейбука (при вызове ansible-playbook --check), а маркер CHECK MODE — в конце каждого плей и каждой задачи, выполняемых в режиме проверки.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    check_mode_markers = false
    
  • Переменная среды: ANSIBLE_CHECK_MODE_MARKERS

display_failed_stderr

boolean

добавлено в Ansible 2.7

Включает или отключает вывод сведений о неудачно завершившихся и недоступных задачах в STDERR вместо STDOUT.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    display_failed_stderr = false
    
  • Переменная среды: ANSIBLE_DISPLAY_FAILED_STDERR

display_included_hosts

boolean

добавлено в ansible-core 2.21

Включает или отключает отображение результатов включённых задач и узлов в задаче.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    display_included_hosts = true
    
  • Переменная среды: ANSIBLE_DISPLAY_INCLUDED_HOSTS

display_ok_hosts

boolean

добавлено в Ansible 2.7

Включает или отключает отображение результатов задач и узлов со статусом «ok» в задаче.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    display_ok_hosts = true
    
  • Переменная среды: ANSIBLE_DISPLAY_OK_HOSTS

display_skipped_hosts

boolean

Включает или отключает отображение результатов пропущенных задач и узлов в задаче.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    display_skipped_hosts = true
    
  • Переменная среды: ANSIBLE_DISPLAY_SKIPPED_HOSTS
  • Переменная: ansible_display_skipped_hosts

    добавлено в ansible-core 2.21

pretty_results

boolean

добавлено в ansible-core 2.13

Настраивает более удобный для чтения формат результатов.

Если для result_format задано значение yaml, по умолчанию для этого параметра используется true; если задано значение json, по умолчанию используется false.

Установка для этого параметра значения true принудительно включает красивое форматирование результатов json и yaml независимо от уровня подробности вывода.

Если задано значение true и используется формат результатов yaml, этот параметр изменяет ответы модулей, пытаясь сделать вывод более понятным для человека, в ущерб точности. Не следует полагаться на него при написании операций с переменными или условий. Для обеспечения точности задайте этому параметру значение false или установите для result_format значение json.

Варианты:

  • false
  • true

Конфигурация:

  • Запись INI:

    [defaults]
    callback_format_pretty = VALUE
    
  • Переменная среды: ANSIBLE_CALLBACK_FORMAT_PRETTY

result_format

string

добавлено в ansible-core 2.13

Задаёт формат результатов задач в выводе плагина обратного вызова.

Эти форматы не приводят к тому, что плагин обратного вызова выводит корректный JSON или YAML.

Вывод содержит данные в этих форматах вперемешку с другими данными, которые невозможно обработать машинным способом.

Варианты:

  • "json" ← (по умолчанию)
  • "yaml"

Конфигурация:

  • Запись INI:

    [defaults]
    callback_result_format = json
    
  • Переменная среды: ANSIBLE_CALLBACK_RESULT_FORMAT

result_indentation

integer

добавлено в ansible-core 2.20

Позволяет настроить отступы для YAML и подробного/форматированного JSON.

Обратите внимание: для result_format=yaml PyYAML корректно обрабатывает только значения от 2 до 9. Если отступ равен 1, 10 или больше, для первого уровня используется заданный отступ, а для всех последующих — 2 пробела.

По умолчанию: 4

Конфигурация:

  • Запись INI:

    [defaults]
    callback_result_indentation = 4
    
  • Переменная среды: ANSIBLE_CALLBACK_RESULT_INDENTATION

result_yaml_line_width

string

добавлено в ansible-core 2.21

Настраивает ширину строки для YAML. Сериализатор YAML пытается переносить слишком длинные строки.

Варианты:

  • "default" (по умолчанию): использовать значение PyYAML по умолчанию — около 80 символов.
  • "no-break": отключить переносы строк.
  • "terminal-width": использовать определённую ширину терминала, которая также используется для другого вывода этого плагина обратного вызова.

Конфигурация:

  • Запись INI:

    [defaults]
    callback_result_yaml_line_width = default
    
  • Переменная среды: ANSIBLE_CALLBACK_YAML_LINE_WIDTH

show_custom_stats

boolean

Добавляет в сводку выполнения плейбука пользовательскую статистику, заданную с помощью плагина set_stats.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    show_custom_stats = false
    
  • Переменная среды: ANSIBLE_SHOW_CUSTOM_STATS

show_per_host_start

boolean

добавлено в Ansible 2.9

Добавляет вывод, показывающий начало выполнения задачи для каждого узла.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    show_per_host_start = false
    
  • Переменная среды: ANSIBLE_SHOW_PER_HOST_START

show_task_path_on_failure

boolean

добавлено в ansible-core 2.11

При сбое задачи отображает путь к файлу, содержащему эту задачу, и номер строки. При запуске с уровнем подробности -vv или выше эта информация автоматически отображается для каждой задачи.

Варианты:

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

Конфигурация:

  • Запись INI:

    [defaults]
    show_task_path_on_failure = false
    
  • Переменная среды: ANSIBLE_SHOW_TASK_PATH_ON_FAILURE

Примечание

Записи конфигурации, перечисленные выше для каждого типа записей (переменная Ansible, переменная среды и т. д.), упорядочены от низкого к высокому приоритету. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по приоритету — от низкого к высокому. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь с сообществом

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API