AnsibleModule และข้อกำหนดอาร์กิวเมนต์
กำหนดและตรวจสอบอินพุตของโมดูล
AnsibleModule และข้อกำหนดอาร์กิวเมนต์ เป็นบทเรียน Ansible Academy ฟรีบน CoddyKit นี่คือบทเรียนที่ 2 จากทั้งหมด 4 บทเรียน คุณสามารถอ่านบทเรียนทั้งหมดด้านล่างฟรี — จากนั้นลองปฏิบัติด้วยตัวคุณเองในเบราว์เซอร์พร้อมตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7 บทเรียนนี้เป็นส่วนหนึ่งของเส้นทางการเรียน Ansible Academy และความก้าวหน้าของคุณจะซิงค์ข้ามเว็บและแอป CoddyKit คอร์ส Ansible Academy มีบทเรียนทั้งหมด 4 บทเรียน
พบกับ AnsibleModule
คลาส AnsibleModule คือชุดเครื่องมือของคุณ คลาสนี้จะแยกวิเคราะห์อาร์กิวเมนต์ที่ Ansible ส่งมา ตรวจสอบความถูกต้อง และมอบตัวช่วยสำหรับส่งคืนผลลัพธ์
from ansible.module_utils.basic import AnsibleModuleแผนผัง argument_spec
คุณอธิบายข้อมูลนำเข้าทุกอย่างที่โมดูลยอมรับไว้ในพจนานุกรม argument_spec Ansible จะอ่านข้อมูลนี้เพื่อตรวจสอบสิ่งที่ผู้ใช้ส่งเข้ามา
argument_spec=dict(
name=dict(type='str', required=True)
)กำหนดชนิดให้แต่ละอาร์กิวเมนต์
กำหนด type เช่น str, int, bool, list หรือ dict Ansible จะปรับชนิดและปฏิเสธข้อมูลนำเข้าที่ไม่ถูกต้องก่อนที่โค้ดของคุณจะเริ่มทำงาน
count=dict(type='int', default=1)ระบุสิ่งที่จำเป็น
เพิ่ม required=True แล้ว Ansible จะแสดงข้อผิดพลาดที่ชัดเจนหากผู้ใช้ลืมอาร์กิวเมนต์นั้น คุณจึงไม่ต้องตรวจสอบป้องกันด้วยตนเอง
path=dict(type='str', required=True)ระบุค่าเริ่มต้นที่เหมาะสม
ใช้ default เพื่อให้อาร์กิวเมนต์ที่ไม่บังคับมีค่าโดยอัตโนมัติ ผู้ใช้จะกำหนดเฉพาะสิ่งที่ต้องการเปลี่ยนเท่านั้น
state=dict(type='str', default='present')จำกัดให้ใช้เฉพาะตัวเลือกที่ถูกต้อง
รายการ choices จะจำกัดอาร์กิวเมนต์ให้ใช้ได้เฉพาะค่าที่อนุญาต ค่าอื่น ๆ จะถูกปฏิเสธตั้งแต่ต้นพร้อมข้อความที่ช่วยอธิบาย
state=dict(choices=['present', 'absent'])สร้างออบเจ็กต์โมดูล
ส่งข้อกำหนดของคุณเข้าไปใน AnsibleModule เพื่อสร้างออบเจ็กต์ จากจุดนี้ ข้อมูลนำเข้าทั้งหมดของคุณจะอยู่ใน module.params อย่างปลอดภัย
module = AnsibleModule(argument_spec=argument_spec)อ่านข้อมูลนำเข้าที่ผ่านการตรวจสอบแล้ว
เข้าถึงอาร์กิวเมนต์ของคุณผ่าน module.params ซึ่งเป็นพจนานุกรมธรรมดา ค่าเหล่านี้ถูกกำหนดชนิดและตรวจสอบแล้ว จึงนำไปใช้ได้ทันที
name = module.params['name']กฎระหว่างอาร์กิวเมนต์
ต้องใช้อาร์กิวเมนต์สองรายการร่วมกัน หรือห้ามใช้พร้อมกันใช่ไหม ส่งกฎอย่าง required_together หรือ mutually_exclusive ให้ AnsibleModule แล้วระบบจะบังคับใช้กฎเหล่านั้น
mutually_exclusive=[['src', 'content']]ซ่อนข้อมูลลับด้วย no_log
ทำเครื่องหมายข้อมูลนำเข้าที่ละเอียดอ่อนด้วย no_log=True เพื่อไม่ให้รหัสผ่านปรากฏในบันทึกของ Ansible หรือผลลัพธ์แบบละเอียด
password=dict(type='str', no_log=True)ให้ข้อกำหนดจัดการงานแทน
argument_spec ที่ดีช่วยแทนที่การตรวจสอบด้วยตนเองจำนวนมาก คุณอธิบายข้อมูลนำเข้าเพียงครั้งเดียว แล้ว Ansible จะจัดการชนิดข้อมูล ข้อผิดพลาด และเอกสารให้โดยอัตโนมัติ
ตรวจสอบอย่างรวดเร็ว
ลองคิดดูว่าข้อมูลนำเข้าของผู้ใช้ส่งต่อไปถึงโค้ดโมดูลของคุณอย่างไร
ทบทวน
กำหนดข้อมูลนำเข้าใน argument_spec พร้อมชนิดข้อมูล ค่าเริ่มต้น required และ choices สร้าง AnsibleModule แล้วอ่านค่าที่สะอาดจาก module.params ✅
คำถามที่พบบ่อย
บทเรียน “AnsibleModule และข้อกำหนดอาร์กิวเมนต์” ฟรีหรือไม่
ใช่ — ข้อความเต็มของ “AnsibleModule และข้อกำหนดอาร์กิวเมนต์” ฟรีให้อ่านที่นี่บนเว็บ เพื่อปฏิบัติแบบโต้ตอบ (ตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7) และปลดล็อคส่วนที่เหลือของคอร์ส Ansible Academy ให้อัปเกรดเป็น CoddyKit PRO คอร์ส Ansible Academy มีบทเรียนทั้งหมด 4 บทเรียน
คุณจะเรียนรู้อะไรในบทเรียน “AnsibleModule และข้อกำหนดอาร์กิวเมนต์”
กำหนดและตรวจสอบอินพุตของโมดูล คุณปฏิบัติ Ansible Academy ด้วยโค้ดที่ใช้งานได้จริงที่คุณเรียกใช้โดยตรงในเบราว์เซอร์ และติวเตอร์ AI ตลอด 24/7 ตอบคำถามของคุณขณะที่คุณไปผ่านบทเรียน
คุณต้องมีประสบการณ์ก่อนที่จะเริ่มเรียน Ansible Academy หรือไม่
ไม่จำเป็นต้องมีประสบการณ์มาก่อน Ansible Academy บน CoddyKit ออกแบบมาสำหรับผู้เริ่มต้นไปจนถึงผู้เรียนขั้นสูง คุณสามารถเริ่มต้นที่นี่หรือเริ่มจากตัวแรกและเรียนด้วยความเร็วของคุณเอง นี่คือบทเรียนที่ 2 จากทั้งหมด 4 บทเรียน
บทเรียน “AnsibleModule และข้อกำหนดอาร์กิวเมนต์” ใช้เวลานานแค่ไหน
บทเรียน CoddyKit ส่วนใหญ่ใช้เวลาประมาณ 5–10 นาที แต่ละบทเรียนจึงสั้นและเป็นแบบโต้ตอบ คุณสามารถก้าวหน้าอย่างต่อเนื่องและกลับมาเรียนต่อจากตรงที่เพิ่งหยุดบนเว็บและแอปได้เลย
ฉันเขียนและรันโค้ดในบทเรียน Ansible Academy นี้ได้ไหม
ได้ บทเรียน Ansible Academy ทุกบทมีตัวแก้ไขโค้ดในตัว คุณจึงเขียนและรันโค้ดจริงได้เลยในเบราว์เซอร์ และได้รับข้อเสนอแนะจาก AI ในทันที — ไม่ต้องติดตั้งในเครื่องของคุณ
บทเรียนทั้งหมดในหลักสูตรนี้
- เมื่อใดควรสร้างโมดูลแบบกำหนดเอง
- AnsibleModule และข้อกำหนดอาร์กิวเมนต์
- คืนค่า JSON และรองรับ changed
- รองรับโหมดตรวจสอบในโมดูลของคุณ