/ home / community / community.general / 8.5.0 / module / kibana_plugin

community.general.kibana_plugin (8.5.0) — module

Manage Kibana plugins

Authors: Thierno IB. BARRY (@barryib)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module can be used to manage Kibana plugins.

Usage examples

Scanned by Steampunk Spotter

- name: Install Elasticsearch head plugin
  community.general.kibana_plugin:
    state: present
    name: elasticsearch/marvel

Scanned by Steampunk Spotter

- name: Install specific version of a plugin
  community.general.kibana_plugin:
    state: present
    name: elasticsearch/marvel
    version: '2.3.3'

Scanned by Steampunk Spotter

- name: Uninstall Elasticsearch head plugin
  community.general.kibana_plugin:
    state: absent
    name: elasticsearch/marvel

Inputs

    
url:
    description:
    - Set exact URL to download the plugin from.
    - For local file, prefix its absolute path with file://
    type: str

name:
    description:
    - Name of the plugin to install.
    required: true
    type: str

force:
    default: false
    description:
    - Delete and re-install the plugin. Can be useful for plugins update.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of a plugin.
    type: str

timeout:
    default: 1m
    description:
    - 'Timeout setting: 30s, 1m, 1h etc.'
    type: str

version:
    description:
    - Version of the plugin to be installed.
    - If plugin exists with previous version, plugin will B(not) be updated unless O(force)
      is set to V(true).
    type: str

allow_root:
    default: false
    description:
    - Whether to allow C(kibana) and C(kibana-plugin) to be run as root. Passes the C(--allow-root)
      flag to these commands.
    type: bool
    version_added: 2.3.0
    version_added_collection: community.general

plugin_bin:
    default: /opt/kibana/bin/kibana
    description:
    - Location of the Kibana binary.
    type: path

plugin_dir:
    default: /opt/kibana/installedPlugins/
    description:
    - Your configured plugin directory specified in Kibana.
    type: path

Outputs

cmd:
  description: the launched command during plugin management (install / remove)
  returned: success
  type: str
name:
  description: the plugin name to install or remove
  returned: success
  type: str
state:
  description: the state for the managed plugin
  returned: success
  type: str
stderr:
  description: the command stderr
  returned: success
  type: str
stdout:
  description: the command stdout
  returned: success
  type: str
timeout:
  description: the timeout for plugin download
  returned: success
  type: str
url:
  description: the url from where the plugin is installed from
  returned: success
  type: str