Ken_McDonald
Cadet
Cadet
  • 136 Views

List of all playbook keywords from command line like ansible-doc for modules?

Other than web documentation, is there a command line way to access a list of all the available general playbook keywords similar to what the 'ansible-doc' command does for modules & their options, and how 'ansible-config dump' does it for ansible.cfg options?

Labels (1)
0 Kudos
3 Replies
Fran_Garcia
Flight Engineer Flight Engineer
Flight Engineer
  • 105 Views

Re: List of all playbook keywords from command line like ansible-doc for modules?

You have the "in-system" documentation provided by the `ansible-doc` RPM.

 

EG: /usr/share/doc/ansible-doc/rst/user_guide/

 

You have your HTML versions too, if you find that useful...

0 Kudos
Reply
Loading...
matteoclc
Flight Engineer
Flight Engineer
  • 102 Views

Re: List of all playbook keywords from command line like ansible-doc for modules?

That's not completely true.

It seems that since ansible-doc inclusion in ansible package the rst and html documentation in not installed anymore.

I was looking for the same answer some days ago and this is all that i found, but if you have better answer...you are welcome Smiley Happy

 

--
Matteo Calcagnini
0 Kudos
Reply
Loading...
Ken_McDonald
Cadet
Cadet
  • 93 Views

Re: List of all playbook keywords from command line like ansible-doc for modules?

I'm asking about generic play keywords like
changed_when
with_file
with_sequence
when
handlers
notify
ignore_errors
failed_when

My question might be trivial but I'm trying to understand how complete the "in-system" documentation is. Seems we get keyword/option docs for the ansible.cfg and modules but not for the paybook keywords themselves
https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html

0 Kudos
Reply
Loading...
Join the discussion
You must log in to join this conversation.