mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
30 lines
931 B
YAML
30 lines
931 B
YAML
---
|
|
# If a key doesn't apply to your module (ex: choices, default, or
|
|
# aliases) you can use the word 'null', or an empty list, [], where
|
|
# appropriate.
|
|
module: modulename
|
|
short_description: This is a sentence describing the module
|
|
description:
|
|
- Longer description of the module
|
|
- You might include instructions
|
|
version_added: "X.Y"
|
|
author: "Your AWESOME name, @awesome-github-id"
|
|
notes:
|
|
- Other things consumers of your module should know
|
|
- Additional setting requirements
|
|
requirements:
|
|
- list of required things
|
|
- like the factor package
|
|
- or a specific platform
|
|
options:
|
|
# One or more of the following
|
|
option_name:
|
|
description:
|
|
- Words go here
|
|
- that describe
|
|
- this option
|
|
required: true or false
|
|
default: a string or the word null
|
|
choices: [list, of, choices]
|
|
aliases: [list, of, aliases]
|
|
version_added: 1.X
|