/examples/DOCUMENTATION.yml

https://github.com/ajanthanm/ansible · YAML · 29 lines · 25 code · 0 blank · 4 comment · 0 complexity · 380d9b10e52143c44934bcda6cb2ebcd MD5 · raw file

  1. ---
  2. # If a key doesn't apply to your module (ex: choices, default, or
  3. # aliases) you can use the word 'null', or an empty list, [], where
  4. # appropriate.
  5. module: modulename
  6. short_description: This is a sentence describing the module
  7. description:
  8. - Longer description of the module
  9. - You might include instructions
  10. version_added: "X.Y"
  11. author: Your AWESOME name here
  12. notes:
  13. - Other things consumers of your module should know
  14. requirements:
  15. - list of required things
  16. - like the factor package
  17. - or a specic platform
  18. options:
  19. # One or more of the following
  20. option_name:
  21. description:
  22. - Words go here
  23. - that describe
  24. - this option
  25. required: true or false
  26. default: a string or the word null
  27. choices: [list, of, choices]
  28. aliases: [list, of, aliases]
  29. version_added: 1.X