New in version 2.2.
parameter | required | default | choices | comments |
---|---|---|---|---|
force |
no |
|
Delete and re-install the plugin. Can be useful for plugins update | |
name |
yes | Name of the plugin to install | ||
plugin_bin |
no | /opt/kibana/bin/kibana | Location of the plugin binary | |
plugin_dir |
no | /opt/kibana/installedPlugins/ | Your configured plugin directory specified in Kibana | |
state |
no | present |
|
Desired state of a plugin. |
timeout |
no | 1m | Timeout setting: 30s, 1m, 1h... | |
url |
no | None | Set exact URL to download the plugin from. For local file, prefix its absolute path with file:// | |
version |
no | None | Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated if force is not set to yes |
- name: Install Elasticsearch head plugin kibana_plugin: state: present name: elasticsearch/marvel - name: Install specific version of a plugin kibana_plugin: state: present name: elasticsearch/marvel version: '2.3.3' - name: Uninstall Elasticsearch head plugin kibana_plugin: state: absent name: elasticsearch/marvel
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
state | the state for the managed plugin | success | string | |
name | the plugin name to install or remove | success | string | |
timeout | the timout for plugin download | success | string | |
stdout | the command stdout | success | string | |
url | the url from where the plugin is installed from | success | string | |
cmd | the launched command during plugin mangement (install / remove) | success | string | |
stderr | the command stderr | success | string |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.