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

• Общие
  • backup_file
  • changed
  • failed
  • invocation
  • msg
  • rc
  • results
  • skipped
  • stderr
  • stderr_lines
  • stdout
  • stdout_lines
• Внутреннее использование
  • ansible_facts
  • exception
  • warnings
  • deprecations

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

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

Общие

backup_file

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

changed

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

failed

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

invocation

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

msg

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

rc

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

results

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

skipped

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

stderr

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

stderr_lines

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

stdout

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

stdout_lines

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

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

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

ansible_facts

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

исключение

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

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

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

устаревшие

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