As I’ve been exploring Ansible, I sometimes run into situations where I’m not sure if some certain syntax is allowed in certain situations, or conversely I’ll discover in an unrelated example some new syntax combination I’d never considered before.
So what I was wondering was whether there exists anywhere–or if there’s a way to construct–a detailed list of what keywords are available for use in which elements of the playbook/task/role syntax.
For example, in a playbook, you have a YAML list. Each item in that list must contain a “hosts:” key. Other keys are optional, and many are well-known, such as “name:”, “tasks:”, “handlers:”, “roles:”, but others are not as easily discovered, like “connection:” and “serial:”.
Similarly in tasks, there are many kinds of loops and conditionals and extra features like “register:” and “changed_when:”.
Ultimately most if not all of these are documented and generally explained well, but best I can tell there’s no reference listing all of the possible keywords for a particular section of the playbook format.
Other than the module index, the current documentation of the playbook format is all done tutorial style. Is there a reference I’m missing, or are there plans for one? I’d be happy to try to contribute to such an effort, though I wouldn’t know where to start building something like this.
Thanks.
-dave
