Возврат JSON и соблюдение changed

Завершая работу, модуль должен передать Ansible результат в формате JSON. Так контроллер узнаёт, что произошло на узле.

При успешном выполнении вызывайте module.exit_json. Он выводит результат в формате JSON и корректно завершает работу модуля с правильным кодом завершения.

Всегда достоверно сообщайте значение changed. Оно показывает Ansible, изменили ли Вы систему, и определяет, будет ли в выводе строка ok или changed.

Чтобы правильно использовать changed, сначала считайте текущее состояние. Если оно уже соответствует цели, установите changed=False и ничего не делайте.

В exit_json можно добавить любые ключи, и они появятся в результате задачи. Позже пользователи смогут сохранить эти данные и использовать их повторно.

Если что-то пошло не так, вызовите module.fail_json с понятным сообщением. Ansible отметит задачу как неуспешную и покажет Ваш текст.

Не используйте print или необработанный stdout. Ansible ожидает только итоговый объект JSON, поэтому лишний вызов print повреждает результат и приводит к сбою задачи.

Каждый модуль завершается ровно одним вызовом exit_json или fail_json. Оба вызывают SystemExit, поэтому код после них не выполняется.

Добавляйте в результаты понятное msg с описанием выполненных действий. Хорошие сообщения превращают непонятные запуски в удобные для чтения.

Формируйте вывод так же, как это делают основные модули: сообщайте о changed, возвращайте содержательные поля и явно сообщайте об ошибке с указанием причины. Единообразие укрепляет доверие.

Обработчики, условные конструкции и зарегистрированные переменные читают данные из Вашего JSON. Именно правильное значение changed делает модуль полноценным участником экосистемы Ansible.

Подумайте, что должен сообщить модуль, если ничего не было изменено.

При успехе завершайте работу через exit_json, а при ошибке — через fail_json, честно сообщайте значение changed и никогда не выводите необработанные данные. Таков протокол результатов модуля. 📦