Docs4dev
Docs
ansible / 2.4 / elasticsearch_plugin_module.html

elasticsearch_plugin - Manage Elasticsearch plugins

New in version 2.0.

Synopsis

  • Manages Elasticsearch plugins.

Options

parameter required default choices comments
name
 yes
Name of the plugin to install. In Eleasticsearch >= 2.0, the name can be an URL or file location.
plugin_bin
 no None
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
 no /usr/share/elasticsearch/plugins/
Your configured plugin directory specified in Elasticsearch
proxy_host
(added in 2.1)
no None
Proxy host to use during plugin installation
proxy_port
(added in 2.1)
no None
Proxy port to use during plugin installation
state
 no present
  • present
  • absent
Desired state of a plugin.
timeout
 no 1m
Timeout setting: 30s, 1m, 1h...
Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0.
url
 no None
Set exact URL to download the plugin from (Only works for ES 1.x)
version
 no None
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
    versino: 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.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/elasticsearch_plugin_module.html