ansible.builtin.elasticsearch_plugin (v2.3.0.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.0.0.post1

Description

Manages Elasticsearch plugins.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Install Elasticsearch head plugin
- elasticsearch_plugin:
    state: present
    name: mobz/elasticsearch-head

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Install specific version of a plugin
- elasticsearch_plugin:
    state: present
    name: com.github.kzwang/elasticsearch-image
    version: '1.2.0'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Uninstall Elasticsearch head plugin
- elasticsearch_plugin:
    state: absent
    name: mobz/elasticsearch-head

Inputs

    
url:
    default: None
    description:
    - Set exact URL to download the plugin from (Only works for ES 1.x)
    required: false

name:
    description:
    - Name of the plugin to install. In ES 2.x, the name can be an url or file location
    required: true

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
    required: false

plugin_bin:
    default: /usr/share/elasticsearch/bin/plugin
    description:
    - Location of the plugin binary
    required: false

plugin_dir:
    default: /usr/share/elasticsearch/plugins/
    description:
    - Your configured plugin directory specified in Elasticsearch
    required: false

proxy_host:
    default: None
    description:
    - Proxy host to use during plugin installation
    required: false
    version_added: '2.1'
    version_added_collection: ansible.builtin

proxy_port:
    default: None
    description:
    - Proxy port to use during plugin installation
    required: false
    version_added: '2.1'
    version_added_collection: ansible.builtin