Læs dokumentationen med ansible-doc

Uddataene viser hver indstilling med en beskrivelse, en standardværdi og mulige valg. Det fortæller dig præcis, hvilke nøgler et modul accepterer.

Tilføj -s for at udskrive et eksempel på modulets argumenter, som du kan kopiere direkte. Det er et perfekt udgangspunkt for en ny opgave.

Kør med -l for at vise alle installerede moduler med korte beskrivelser på én linje. Kør uddataene gennem grep for at finde det, du har brug for.

Er du usikker på navnet? Vis modulerne, og filtrér efter emne. Hvis du søger efter service, dukker de relevante moduler hurtigt op.

Da ansible-doc læser de moduler, der er installeret lokalt, passer dokumentationen altid til netop din version. Du risikerer ikke at bruge forældede sider fra internettet.

Dokumentationen beskriver også, hvad et modul returnerer, f.eks. changed eller stdout. Det er nyttigt, når du registrerer resultater, som skal bruges senere.

Brug -t til at læse dokumentation for andre plugin-typer, ikke kun moduler. Du kan f.eks. slå et lookup- eller filter-plugin op på samme måde.

Dokumentationshovedet viser modulets samling og korte formål, så du kender det fuldt kvalificerede navn, før du skriver en opgave.

Før du gætter på et argument, skal du først tjekke ansible-doc. Et opslag på ti sekunder sparer dig for en mislykket kørsel og en forvirrende fejlmeddelelse.

ansible-doc giver dig versionssvarende dokumentation i terminalen: slå et modul op, brug -s til et kodestykke og -l til at vise og søge i moduler. 📚