Devolver JSON y respetar changed

Cuando su módulo termina, debe entregar a Ansible un resultado en JSON. Así es como el controlador sabe qué ocurrió en el host.

Llame a module.exit_json cuando la operación tenga éxito. Imprime el resultado como JSON y finaliza el módulo correctamente con el código de salida adecuado.

Informe siempre changed con honestidad. Indica a Ansible si modificó el sistema y determina si la salida muestra ok o changed.

Para gestionar correctamente changed, lea primero el estado actual. Si ya coincide con el objetivo, establezca changed=False y no haga nada.

Añada las claves que quiera a exit_json y aparecerán en el resultado de la tarea. Los usuarios pueden registrar esos datos y reutilizarlos más adelante.

Cuando algo salga mal, llame a module.fail_json con un mensaje claro. Ansible marcará la tarea como fallida y mostrará su texto.

No use print ni la salida estándar sin procesar. Ansible espera únicamente ese objeto JSON final, por lo que un print inesperado corrompe el resultado y hace que la tarea falle.

Cada módulo termina exactamente con un exit_json o fail_json. Ambos generan SystemExit, por lo que nada posterior llega a ejecutarse.

Incluya un msg claro y cercano en los resultados para describir lo que hizo. Los buenos mensajes convierten las ejecuciones confusas en resultados fáciles de leer.

Haga que su salida se comporte como la de los módulos principales: informe changed, devuelva campos significativos y falle claramente indicando el motivo. La coherencia genera confianza.

Los controladores, las condicionales y las variables registradas leen su JSON. Establecer correctamente changed es lo que convierte su módulo en un buen ciudadano de Ansible.

Piense en lo que debería informar su módulo cuando no se haya modificado nada.

Termine con exit_json si la operación tiene éxito o con fail_json si se produce un error, informe changed con honestidad y no imprima nunca la salida sin procesar. Ese es el protocolo de resultados de los módulos. 📦