Значения возврата

• Общие
  • backup_file
  • изменён
  • неудачно
  • вызов
  • сообщение
  • rc
  • результаты
  • пропущен
  • stderr
  • stderr_строки
  • stdout
  • stdout_строки
• Внутреннее использование
  • ansible_facts
  • исключение
  • предупреждения
  • устаревшие_элементы

Модули Ansible обычно возвращают структуру данных, которую можно зарегистрировать в переменной или увидеть непосредственно при выводе программы ansible. Каждый модуль может дополнительно документировать свои собственные уникальные значения возврата (видимые через ansible-doc и на главной странице документации.

Этот документ охватывает значения возврата, общие для всех модулей.

Общие

backup_file

Для тех модулей, которые реализуют backup=no|yes при работе с файлами, путь к созданному резервному файлу.

изменён

Булево значение, указывающее, должен ли модуль внести изменения.

неудачно

Булево значение, указывающее, завершился ли модуль неудачно.

вызов

Информация о том, как был вызван модуль.

сообщение

Строка с общим сообщением, переданным пользователю.

rc

Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (raw, shell, command и т.д.), это поле содержит код возврата этих утилит.

результаты

Если этот ключ существует, это означает, что для задачи был цикл, и он содержит список обычных «результатов» модуля для каждого элемента.

пропущен

Булево значение, указывающее, был ли пропущен модуль.

stderr

Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (raw, shell, command и т.д.), это поле содержит вывод об ошибках этих утилит.

stderr_строки

Когда stderr возвращается, мы также всегда предоставляем это поле, которое представляет собой список строк, по одной строке из исходного.

stdout

Некоторые модули выполняют утилиты командной строки или предназначены для непосредственного выполнения команд (raw, shell, command и т.д.). Это поле содержит стандартный вывод этих утилит.

stdout_строки

Когда stdout возвращается, Ansible всегда предоставляет список строк, каждая из которых содержит одну строку из исходного вывода.

Внутренние значения возврата

Модули могут добавлять эти ключи, но они будут удалены из зарегистрированных переменных; они «потребляются» самим Ansible.

ansible_facts

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

исключение

Этот ключ может содержать информацию об отслеживании стека, вызванную исключением в модуле. Она будет отображаться только при высокой детализации (-vvv).

предупреждения

Этот ключ содержит список строк, которые будут представлены пользователю.

устаревшие_элементы

Этот ключ содержит список словарей, которые будут представлены пользователю. Ключами словарей являются msg и version, значениями являются строки, значение для ключа version может быть пустой строкой.