community.general.kibana_plugin module – Manage Kibana plugins
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.kibana_plugin
.
Synopsis
This module can be used to manage Kibana plugins.
Aliases: database.misc.kibana_plugin
Parameters
Parameter |
Comments |
---|---|
Whether to allow Choices:
|
|
Delete and re-install the plugin. Can be useful for plugins update. Choices:
|
|
Name of the plugin to install. |
|
Location of the Kibana binary. Default: |
|
Your configured plugin directory specified in Kibana. Default: |
|
Desired state of a plugin. Choices:
|
|
Timeout setting: 30s, 1m, 1h etc. Default: |
|
Set exact URL to download the plugin from. For local file, prefix its absolute path with file:// |
|
Version of the plugin to be installed. If plugin exists with previous version, plugin will not be updated unless |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Install Elasticsearch head plugin
community.general.kibana_plugin:
state: present
name: elasticsearch/marvel
- name: Install specific version of a plugin
community.general.kibana_plugin:
state: present
name: elasticsearch/marvel
version: '2.3.3'
- name: Uninstall Elasticsearch head plugin
community.general.kibana_plugin:
state: absent
name: elasticsearch/marvel
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
the launched command during plugin management (install / remove) Returned: success |
|
the plugin name to install or remove Returned: success |
|
the state for the managed plugin Returned: success |
|
the command stderr Returned: success |
|
the command stdout Returned: success |
|
the timeout for plugin download Returned: success |
|
the url from where the plugin is installed from Returned: success |