ansible.builtin.kibana_plugin (v2.3.2.0-1) — module

Manage Kibana plugins

| "added in version" 2.2 of ansible.builtin"

Authors: Thierno IB. BARRY (@barryib)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.2.0.post1

Description

Manages Kibana plugins.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Install Elasticsearch head plugin
  kibana_plugin:
    state: present
    name: elasticsearch/marvel
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Install specific version of a plugin
  kibana_plugin:
    state: present
    name: elasticsearch/marvel
    version: '2.3.3'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Uninstall Elasticsearch head plugin
  kibana_plugin:
    state: absent
    name: elasticsearch/marvel

Inputs

    
url:
    default: None
    description:
    - Set exact URL to download the plugin from. For local file, prefix its absolute path
      with file://
    required: false

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

force:
    choices:
    - 'yes'
    - 'no'
    default: false
    description:
    - Delete and re-install the plugin. Can be useful for plugins update
    required: false

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of a plugin.
    required: false

timeout:
    default: 1m
    description:
    - 'Timeout setting: 30s, 1m, 1h...'
    required: false

version:
    default: None
    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

plugin_bin:
    default: /opt/kibana/bin/kibana
    description:
    - Location of the plugin binary
    required: false

plugin_dir:
    default: /opt/kibana/installedPlugins/
    description:
    - Your configured plugin directory specified in Kibana
    required: false

Outputs

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