mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 14:22:46 +00:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
@@ -31,42 +31,33 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Desired state of a plugin.
|
||||
required: False
|
||||
choices: ["present", "absent"]
|
||||
default: present
|
||||
url:
|
||||
description:
|
||||
- Set exact URL to download the plugin from.
|
||||
For local file, prefix its absolute path with file://
|
||||
required: False
|
||||
default: None
|
||||
timeout:
|
||||
description:
|
||||
- "Timeout setting: 30s, 1m, 1h..."
|
||||
required: False
|
||||
default: 1m
|
||||
plugin_bin:
|
||||
description:
|
||||
- Location of the plugin binary
|
||||
required: False
|
||||
default: /opt/kibana/bin/kibana
|
||||
plugin_dir:
|
||||
description:
|
||||
- Your configured plugin directory specified in Kibana
|
||||
required: False
|
||||
default: /opt/kibana/installedPlugins/
|
||||
version:
|
||||
description:
|
||||
- Version of the plugin to be installed.
|
||||
If plugin exists with previous version, it will NOT be updated if C(force) is not set to yes
|
||||
required: False
|
||||
default: None
|
||||
force:
|
||||
description:
|
||||
- Delete and re-install the plugin. Can be useful for plugins update
|
||||
required: False
|
||||
choices: ["yes", "no"]
|
||||
default: no
|
||||
type: bool
|
||||
default: 'no'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
Reference in New Issue
Block a user