community.general.elasticsearch_plugin (8.5.0) — module

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

Manages Elasticsearch plugins.

Usage examples

Scanned by Steampunk Spotter

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

- name: Install Elasticsearch Head plugin in Elasticsearch 2.x
  community.general.elasticsearch_plugin:
    name: mobz/elasticsearch-head
    state: present

Scanned by Steampunk Spotter

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

- name: Install a specific version of Elasticsearch Head in Elasticsearch 2.x
  community.general.elasticsearch_plugin:
    name: mobz/elasticsearch-head
    version: 2.0.0

Scanned by Steampunk Spotter

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

- name: Uninstall Elasticsearch head plugin in Elasticsearch 2.x
  community.general.elasticsearch_plugin:
    name: mobz/elasticsearch-head
    state: absent

Scanned by Steampunk Spotter

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

- name: Install a specific plugin in Elasticsearch >= 5.0
  community.general.elasticsearch_plugin:
    name: analysis-icu
    state: present

Scanned by Steampunk Spotter

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

- name: Install the ingest-geoip plugin with a forced installation
  community.general.elasticsearch_plugin:
    name: ingest-geoip
    state: present
    force: true

Inputs

    
src:
    description:
    - Optionally set the source location to retrieve the plugin from. This can be a file://
      URL to install from a local file, or a remote URL. If this is not set, the plugin
      location is just based on the name.
    - The name parameter must match the descriptor in the plugin ZIP specified.
    - Is only used if the state would change, which is solely checked based on the name
      parameter. If, for example, the plugin is already installed, changing this has no
      effect.
    - For ES 1.x use url.
    required: false
    type: str

url:
    description:
    - Set exact URL to download the plugin from (Only works for ES 1.x).
    - For ES 2.x and higher, use src.
    required: false
    type: str

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

force:
    default: false
    description:
    - Force batch mode when installing plugins. This is only necessary if a plugin requires
      additional permissions and console detection fails.
    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...'
    - Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0.
    type: str

version:
    description:
    - Version of the plugin to be installed. If plugin exists with previous version, it
      will NOT be updated
    type: str

plugin_bin:
    description:
    - Location of the plugin binary. If this file is not found, the default plugin binaries
      will be used.
    type: path

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

proxy_host:
    description:
    - Proxy host to use during plugin installation
    type: str

proxy_port:
    description:
    - Proxy port to use during plugin installation
    type: str