community.general.kibana_plugin – Manage Kibana plugins

Note

This plugin is part of the community.general collection (version 2.5.1).

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.

Parameters

Parameter	Choices/Defaults	Comments
allow_root boolean added in 2.3.0 of community.general	Choices: no ← yes	Whether to allow kibana and kibana-plugin to be run as root. Passes the --allow-root flag to these commands.
force boolean	Choices: no ← yes	Delete and re-install the plugin. Can be useful for plugins update.
name string / required		Name of the plugin to install.
plugin_bin path	Default: "/opt/kibana/bin/kibana"	Location of the Kibana binary.
plugin_dir path	Default: "/opt/kibana/installedPlugins/"	Your configured plugin directory specified in Kibana.
state string	Choices: present ← absent	Desired state of a plugin.
timeout string	Default: "1m"	Timeout setting: 30s, 1m, 1h etc.
url string		Set exact URL to download the plugin from. For local file, prefix its absolute path with file://
version string		Version of the plugin to be installed. If plugin exists with previous version, plugin will NOT be updated unless force is set to yes.

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	Returned	Description
cmd string	success	the launched command during plugin management (install / remove)
name string	success	the plugin name to install or remove
state string	success	the state for the managed plugin
stderr string	success	the command stderr
stdout string	success	the command stdout
timeout string	success	the timeout for plugin download
url string	success	the url from where the plugin is installed from

Authors

• Thierno IB. BARRY (@barryib)