Documentation

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 ES 2.x, the name can be an url or file location
    plugin_bin
    		 no /usr/share/elasticsearch/bin/plugin
      Location of the plugin binary
      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...
              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
- elasticsearch_plugin: state=present name="mobz/elasticsearch-head"

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

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

                  This is an Extras Module

                  For more information on what this means please read Extras Modules

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