Documentation

elasticsearch_plugin - Manage Elasticsearch plugins

New in version 2.0.

Synopsis

  • Manages Elasticsearch plugins.

Parameters

Parameter Choices/Defaults Comments
name
required
Name of the plugin to install. In Eleasticsearch >= 2.0, the name can be an URL or file location.
plugin_bin
Location of the plugin binary. If this file is not found, the default plugin binaries will be used.
The default changed in Ansible 2.4 to None.
plugin_dir Default:
"/usr/share/elasticsearch/plugins/"
Your configured plugin directory specified in Elasticsearch
proxy_host
(added in 2.1)
Proxy host to use during plugin installation
proxy_port
(added in 2.1)
Proxy port to use during plugin installation
state
    Choices:
  • present ←
  • absent
Desired state of a plugin.
timeout Default:
"1m"
Timeout setting: 30s, 1m, 1h...
Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0.
url
Set exact URL to download the plugin from (Only works for ES 1.x)
version
Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated

Examples

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

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

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

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Mathew Davies (@ThePixelDeveloper)
  • Sam Doran (@samdoran)

Hint

If you notice any issues in this documentation you can edit this document to improve it.