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

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

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

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

Общие

backup_file

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

изменён

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

неудачно

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

вызов

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

сообщение

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

код возврата

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

результаты

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

пропущен

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

stderr

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

строки stderr

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

stdout

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

строки stdout

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

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

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

ansible_facts

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

исключение

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

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

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

предупреждения о устаревании

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