AnsibleModule und Argument Spec
Definieren und validieren Sie Moduleingaben.
AnsibleModule und Argument Spec ist eine kostenlose Ansible Academy-Lektion auf CoddyKit. Dies ist Lektion 2 von 4. Du kannst die komplette Lektion unten kostenlos lesen – dann übst du sie direkt im Browser mit einem integrierten Code-Editor und einem KI-Tutor rund um die Uhr. Sie ist Teil des Ansible Academy-Lernpfads, und dein Fortschritt wird über Web und CoddyKit-App synchronisiert. Der Ansible Academy-Kurs umfasst insgesamt 4 Lektionen.
AnsibleModule kennenlernen
Die Klasse AnsibleModule ist Ihr Werkzeugkasten. Sie analysiert die von Ansible gesendeten Argumente, validiert sie und stellt Hilfsfunktionen zum Zurückgeben von Ergebnissen bereit.
from ansible.module_utils.basic import AnsibleModuleDas argument_spec-Dictionary
Sie beschreiben jede Eingabe, die Ihr Modul akzeptiert, in einem argument_spec-Dictionary. Ansible liest es, um die von Benutzern übergebenen Werte zu validieren.
argument_spec=dict(
name=dict(type='str', required=True)
)Jedem Argument einen Typ geben
Legen Sie einen type wie str, int, bool, list oder dict fest. Ansible konvertiert die Werte und weist ungültige Eingaben zurück, bevor Ihr Code überhaupt ausgeführt wird.
count=dict(type='int', default=1)Pflichtangaben kennzeichnen
Fügen Sie required=True hinzu. Dann bricht Ansible mit einer eindeutigen Fehlermeldung ab, wenn der Benutzer dieses Argument vergisst. Eine zusätzliche Prüfung ist nicht nötig.
path=dict(type='str', required=True)Sinnvolle Standardwerte bereitstellen
Verwenden Sie default, damit optionale Argumente automatisch einen Wert erhalten. Benutzer müssen nur festlegen, was sie ändern möchten.
state=dict(type='str', default='present')Auf gültige Auswahlmöglichkeiten beschränken
Die Liste choices beschränkt ein Argument auf zulässige Werte. Alles andere wird von vornherein mit einer hilfreichen Meldung zurückgewiesen.
state=dict(choices=['present', 'absent'])Das Modulobjekt erstellen
Übergeben Sie Ihre Spezifikation an AnsibleModule, um das Objekt zu erstellen. Ab diesem Zeitpunkt befinden sich alle Ihre Eingaben sicher in module.params.
module = AnsibleModule(argument_spec=argument_spec)Validierte Eingaben auslesen
Greifen Sie über module.params, ein gewöhnliches Dictionary, auf Ihre Argumente zu. Die Werte sind bereits typisiert und validiert, Sie können sie also direkt verwenden.
name = module.params['name']Regeln zwischen Argumenten
Müssen zwei Argumente gemeinsam angegeben werden oder dürfen sie niemals beide vorkommen? Übergeben Sie Regeln wie required_together oder mutually_exclusive an AnsibleModule, und es setzt sie durch.
mutually_exclusive=[['src', 'content']]Geheimnisse mit no_log verbergen
Kennzeichnen Sie vertrauliche Eingaben mit no_log=True, damit Passwörter niemals in Ansible-Protokollen oder in ausführlicher Ausgabe erscheinen.
password=dict(type='str', no_log=True)Die Spezifikation die Arbeit erledigen lassen
Ein gutes argument_spec ersetzt haufenweise manuelle Validierung. Beschreiben Sie Eingaben einmal, und Ansible übernimmt Typen, Fehler und Dokumentation gleich mit.
Kurzer Check
Überlegen Sie, wie Benutzereingaben Ihren Modulcode erreichen.
Zusammenfassung
Definieren Sie Eingaben in argument_spec mit Typen, Standardwerten, required und choices, erstellen Sie AnsibleModule und lesen Sie bereinigte Werte aus module.params. ✅
Lerne YAML mit einem KI-Tutor — kostenlos
Schreibe und führe echten Code in deinem Browser aus, bekomme sofortige Hilfe von einem 24/7 KI-Tutor und setze dein Lernen im Web oder in der App fort.
- Kurse
- 30
- Lektionen
- 120
Häufig gestellte Fragen
Ist die Lektion „AnsibleModule und Argument Spec“ kostenlos?
Ja — der vollständige Text von „AnsibleModule und Argument Spec“ ist hier im Web kostenlos zu lesen. Um sie interaktiv zu üben (integrierter Code-Editor und 24/7 KI-Tutor) und den Rest des Ansible Academy-Kurses freizuschalten, upgrade auf CoddyKit PRO. Der Ansible Academy-Kurs umfasst insgesamt 4 Lektionen.
Was lerne ich in „AnsibleModule und Argument Spec“?
Definieren und validieren Sie Moduleingaben. Du übst Ansible Academy mit praktischem Code, den du direkt im Browser ausführst, und ein 24/7 KI-Tutor beantwortet deine Fragen während du die Lektion bearbeitest.
Brauche ich Erfahrung, um Ansible Academy zu starten?
Keine Vorkenntnisse erforderlich. Ansible Academy auf CoddyKit ist für Anfänger bis fortgeschrittene Lernende strukturiert, sodass du hier starten oder von Anfang an beginnen und in deinem eigenen Tempo voranschreiten kannst. Dies ist Lektion 2 von 4.
Wie lange dauert die Lektion „AnsibleModule und Argument Spec“?
Die meisten CoddyKit-Lektionen dauern etwa 5–10 Minuten. Jede ist kompakt und interaktiv, sodass du stetig Fortschritte machst und genau dort weitermachst, wo du aufgehört hast – im Web und in der App.
Kann ich in dieser Ansible Academy-Lektion Code schreiben und ausführen?
Ja. Jede Ansible Academy-Lektion enthält einen integrierten Code-Editor, sodass du echten Code direkt in deinem Browser schreibst und ausführst und sofort KI-Feedback erhältst — ohne lokale Einrichtung erforderlich.
Alle Lektionen in diesem Kurs
- Wann Sie ein eigenes Modul erstellen sollten
- AnsibleModule und Argument Spec
- JSON zurückgeben und changed berücksichtigen
- Check Mode in Ihrem Modul unterstützen