Leggere la documentazione con ansible-doc

Il comando ansible-doc mostra la documentazione completa dei moduli direttamente nella shell, così non deve mai uscire dal terminale per cercare informazioni.

Indichi il nome di un modulo per leggerne la documentazione: ogni opzione, il relativo tipo e l'eventuale obbligatorietà. È il modo più rapido per imparare a usare un modulo.

L'output elenca ogni option con una descrizione, un valore predefinito e le scelte disponibili. In questo modo sa esattamente quali chiavi accetta un modulo.

Aggiunga -s per stampare un frammento pronto da copiare con gli argomenti del modulo. È un punto di partenza perfetto per una nuova attività.

Esegua il comando con -l per elencare tutti i moduli installati con un riepilogo di una riga. Utilizzi grep per filtrare l'elenco e trovare ciò che le serve.

Non è sicuro del nome? Elenchi i moduli e li filtri per argomento. Cercando service, troverà rapidamente i modules pertinenti.

Poiché ansible-doc legge i moduli installati localmente, la documentazione corrisponde sempre esattamente alla sua version. Non rischia di consultare pagine online obsolete.

La documentazione descrive anche cosa returns un modulo, ad esempio changed o stdout. Questo è utile quando registra i risultati per usarli in seguito.

Utilizzi -t per leggere la documentazione di altri tipi di plugin, non solo dei moduli. Ad esempio, può cercare un plugin lookup o filter nello stesso modo.

L'intestazione della documentazione mostra la collection del modulo e il suo breve scopo, così conosce il nome completo da usare prima di scrivere un'attività.

Prima di indovinare un argomento, controlli sempre ansible-doc. Una ricerca di dieci secondi evita un'esecuzione non riuscita e un messaggio di errore difficile da interpretare.

ansible-doc porta nel terminale una documentazione corrispondente alla versione installata: cerchi un modulo, utilizzi -s per un frammento e -l per elencare e cercare. 📚