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

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

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

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

Общие значения возврата

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 может быть пустой строкой.