JSON Döndürme ve changed Değerine Uyma

Modülünüz tamamlandığında Ansible'a bir JSON sonucu iletmelidir. Denetleyici, ana bilgisayarda ne olduğunu böyle öğrenir.

Başarılı olduğunuzda module.exit_json çağrısını yapın. Bu çağrı sonucu JSON olarak yazdırır ve modülü doğru çıkış koduyla temiz bir şekilde sonlandırır.

changed değerini her zaman doğru bildirin. Bu değer, sistemi değiştirip değiştirmediğinizi Ansible'a bildirir ve çıktıda ok ile changed satırlarından hangisinin gösterileceğini belirler.

changed değerini doğru bildirmek için önce mevcut durumu okuyun. Durum zaten hedefle eşleşiyorsa changed=False olarak ayarlayın ve hiçbir şey yapmayın.

exit_json çağrısına istediğiniz anahtarları ekleyin; bunlar görev sonucunda görünür. Kullanıcılar bu verileri daha sonra kaydedip yeniden kullanabilir.

Bir şeyler ters gittiğinde açık bir iletiyle module.fail_json çağrısını yapın. Ansible görevi başarısız olarak işaretler ve metninizi gösterir.

print veya ham stdout kullanmayın. Ansible yalnızca son JSON nesnesini bekler; bu nedenle araya giren bir print sonucu bozar ve görevi başarısız kılar.

Her modül tam olarak bir exit_json veya fail_json çağrısıyla sona erer. Her ikisi de SystemExit oluşturduğundan bunlardan sonra hiçbir şey çalışmaz.

Sonuçlarınıza ne yaptığınızı açıklayan anlaşılır bir msg ekleyin. İyi iletiler, kafa karıştırıcı çalıştırmaları okunabilir hâle getirir.

Çıktınızın çekirdek modüller gibi görünmesini sağlayın: changed değerini bildirin, anlamlı alanlar döndürün ve bir gerekçeyle açıkça hata verin. Tutarlılık güven oluşturur.

İşleyiciler, koşullu ifadeler ve kaydedilmiş değişkenlerin tümü JSON'unuzu okur. changed değerini doğru ayarlamak, modülünüzü Ansible'la uyumlu hâle getirir.

Hiçbir şey değiştirilmediğinde modülünüzün ne bildirmesi gerektiğini düşünün.

Başarılı olduğunuzda exit_json, hata durumunda fail_json ile sonlandırın, changed değerini dürüstçe bildirin ve ham çıktı yazdırmayın. Modül sonuç protokolü budur. 📦