JSON 반환 및 changed 준수

모듈이 실행을 마치면 Ansible에 JSON 결과를 전달해야 합니다. 그래야 제어 노드가 호스트에서 무슨 일이 일어났는지 알 수 있습니다.

성공하면 module.exit_json을 호출하십시오. 결과를 JSON으로 출력하고 올바른 종료 코드와 함께 모듈을 정상적으로 끝냅니다.

항상 changed를 정직하게 보고하십시오. 이 값은 시스템을 변경했는지를 Ansible에 알려 주며, 출력에서 정상 줄과 변경 줄을 결정합니다.

changed를 올바르게 처리하려면 먼저 현재 상태를 읽으십시오. 이미 목표와 일치한다면 changed=False로 설정하고 아무 작업도 하지 마십시오.

exit_json에 원하는 키를 추가하면 작업 결과에 나타납니다. 사용자는 나중에 그 데이터를 등록하고 재사용할 수 있습니다.

문제가 발생하면 명확한 메시지와 함께 module.fail_json을 호출하십시오. Ansible은 작업을 실패로 표시하고 해당 내용을 보여 줍니다.

print나 원시 표준 출력을 사용하지 마십시오. Ansible은 최종 JSON 객체만을 기대하므로, 불필요한 print가 결과를 손상시키고 작업을 실패하게 만듭니다.

각 모듈은 정확히 하나의 exit_json 또는 fail_json으로 끝나야 합니다. 둘 다 SystemExit를 발생시키므로 그 뒤의 코드는 실행되지 않습니다.

무엇을 했는지 설명하는 친절한 msg를 결과에 포함하십시오. 좋은 메시지는 혼란스러운 실행 결과를 읽기 쉽게 바꿔 줍니다.

출력이 핵심 모듈처럼 보이도록 만드십시오. changed를 보고하고, 의미 있는 필드를 반환하며, 이유를 분명히 밝히면서 실패하게 하십시오. 일관성이 신뢰를 만듭니다.

처리기, 조건문, 등록된 변수는 모두 여러분의 JSON을 읽습니다. changed를 올바르게 설정해야 모듈이 Ansible의 좋은 구성원으로 동작합니다.

아무것도 수정되지 않았을 때 모듈이 무엇을 보고해야 하는지 생각해 보십시오.

성공하면 exit_json으로, 오류가 발생하면 fail_json으로 끝내고, changed를 정직하게 보고하며, 원시 출력을 절대 표시하지 마십시오. 이것이 모듈 결과 프로토콜입니다. 📦