Lese dokumentasjonen med ansible-doc

Resultatet viser hvert alternativ med en beskrivelse, standardverdi og valgmuligheter. Dette forteller Dem nøyaktig hvilke nøkler en modul godtar.

Legg til -s for å skrive ut et kodeeksempel med modulens argumenter, klart til å kopieres. Det er et perfekt utgangspunkt for en ny oppgave.

Kjør med -l for å liste opp alle installerte moduler med sammendrag på én linje. Send resultatet gjennom grep for å finne det De trenger.

Er De usikker på navnet? List opp modulene og filtrer etter emne. Et søk etter service finner raskt de relevante modulene.

Fordi ansible-doc leser modulene som er installert lokalt, samsvarer dokumentasjonen alltid med den nøyaktige versjonen Deres. Det er ingen fare for utdaterte nettsider.

Dokumentasjonen beskriver også hva en modul returnerer, for eksempel changed eller stdout. Det er nyttig når De registrerer resultater for å bruke dem senere.

Bruk -t for å lese dokumentasjon for andre typer programtillegg, ikke bare moduler. De kan for eksempel slå opp et lookup- eller filter-programtillegg på samme måte.

Dokumentasjonsoverskriften viser modulens collection og korte formål, slik at De kjenner det fullstendig kvalifiserte navnet før De skriver en oppgave.

Før De gjetter på et argument, bør De først sjekke ansible-doc. Et oppslag på ti sekunder sparer Dem for en mislykket kjøring og en forvirrende feilmelding.

ansible-doc gir Dem versjonstilpasset dokumentasjon i terminalen: slå opp en modul, bruk -s for et kodeeksempel og -l for å liste opp og søke. 📚