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

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