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

• Общие
  • 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

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

вызов

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

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

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

exception

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

warnings

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

deprecations

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