Blog

Ansible community forum

Documentation

Ansible Logo
Ansible Community Documentation
Ansible
9
Select version:
Search docs:

Ansible getting started

Getting started with Ansible

Getting started with Execution Environments

Installation, Upgrade & Configuration

Installation Guide
Ansible Porting Guides

Using Ansible

Building Ansible inventories

Using Ansible command line tools
Using Ansible playbooks
Protecting sensitive data with Ansible vault
Using Ansible modules and plugins
Using Ansible collections
Using Ansible on Windows and BSD
Ansible tips and tricks

Contributing to Ansible

Ansible Community Guide

Ansible Collections Contributor Guide
ansible-core Contributors Guide
Advanced Contributor Guide
Ansible documentation style guide

Extending Ansible

Developer Guide

Common Ansible Scenarios

Legacy Public Cloud Guides

Network Technology Guides
Virtualization and Containerization Guides

Network Automation

Network Getting Started

Network Advanced Topics
Network Developer Guide

Ansible Galaxy
 Galaxy User Guide
Galaxy Developer Guide

Reference & Appendices

Collection Index

Collections in the Amazon Namespace

Collections in the Ansible Namespace
Collections in the Arista Namespace
Collections in the Awx Namespace
Collections in the Azure Namespace
Collections in the Check_point Namespace
Collections in the Chocolatey Namespace
Collections in the Cisco Namespace
Collections in the Cloud Namespace
Collections in the Cloudscale_ch Namespace

Collections in the Community Namespace

Community.Aws
Community.Azure
Community.Ciscosmb
Community.Crypto
Community.Digitalocean
Community.Dns
Community.Docker

Community.General
Description
Communication
Changelog
Guides
Cloud Guides
Plugin Index
Community.Grafana
Community.Hashi_Vault
Community.Hrobot
Community.Library_Inventory_Filtering_V1
Community.Libvirt
Community.Mongodb
Community.Mysql
Community.Network
Community.Okd
Community.Postgresql
Community.Proxysql
Community.Rabbitmq
Community.Routeros
Community.Sap
Community.Sap_Libs
Community.Sops
Community.Vmware
Community.Windows
Community.Zabbix
Collections in the Containers Namespace
Collections in the Cyberark Namespace
Collections in the Dellemc Namespace
Collections in the F5networks Namespace
 Collections in the Fortinet Namespace
Collections in the Frr Namespace
Collections in the Gluster Namespace
Collections in the Google Namespace
Collections in the Grafana Namespace
Collections in the Hetzner Namespace
Collections in the Hpe Namespace
Collections in the Ibm Namespace
Collections in the Infinidat Namespace
Collections in the Infoblox Namespace
Collections in the Inspur Namespace
Collections in the Junipernetworks Namespace
Collections in the Kaytus Namespace
Collections in the Kubernetes Namespace
Collections in the Lowlydba Namespace
Collections in the Microsoft Namespace
Collections in the Netapp Namespace
Collections in the Netapp_eseries Namespace
Collections in the Netbox Namespace
Collections in the Ngine_io Namespace
Collections in the Openstack Namespace
Collections in the Openvswitch Namespace
Collections in the Ovirt Namespace
Collections in the Purestorage Namespace
Collections in the Sensu Namespace
Collections in the Splunk Namespace
Collections in the T_systems_mms Namespace
Collections in the Telekom_mms Namespace
Collections in the Theforeman Namespace
Collections in the Vmware Namespace
Collections in the Vultr Namespace
Collections in the Vyos Namespace
Collections in the Wti Namespace
Indexes of all modules and plugins
Playbook Keywords
Return Values
Ansible Configuration Settings
Controlling how Ansible behaves: precedence rules
YAML Syntax
Python 3 Support
Interpreter Discovery
Releases and maintenance
Testing Strategies
Sanity Tests
Frequently Asked Questions
Glossary
Ansible Reference: Module Utilities
Special Variables
Red Hat Ansible Automation Platform
Ansible Automation Hub
Logging Ansible output

Roadmaps

Ansible Roadmap
ansible-core Roadmaps
 Collection Index Collections in the Community Namespace Community.General
community.general.elasticsearch_plugin module – Manage Elasticsearch plugins
Edit on GitHub

This is the latest (stable) Ansible community documentation. For Red Hat Ansible
Automation Platform subscriptions, see Life Cycle for version details.
community.general.elasticsearch_plugin module – Manage Elasticsearch plugins

Note

This module is part of the community.general collection (version 8.6.1).

You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core. To check whether it is installed, run
ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.elasticsearch_plugin.

Synopsis

Parameters

Attributes

Examples

Synopsis

Manages Elasticsearch plugins.

Aliases: database.misc.elasticsearch_plugin
Parameters

Parameter

Comments

force

boolean

Force batch mode when installing plugins. This is only necessary if a plugin
requires additional permissions and console detection fails.

Choices:

false ← (default)

true

name

string / required
Name of the plugin to install.

plugin_bin

path

Location of the plugin binary. If this file is not found, the default plugin
binaries will be used.

plugin_dir

path

Your configured plugin directory specified in Elasticsearch

Default: "/usr/share/elasticsearch/plugins/"

proxy_host

string

Proxy host to use during plugin installation

proxy_port

string

Proxy port to use during plugin installation

src

string

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.

state

string

Desired state of a plugin.

Choices:

"present" ← (default)

"absent"

timeout

string

Timeout setting: 30s, 1m, 1h…

Only valid for Elasticsearch < 5.0. This option is ignored for Elasticsearch > 5.0.

Default: "1m"

url

string

Set exact URL to download the plugin from (Only works for ES 1.x).

For ES 2.x and higher, use src.

version

string

Version of the plugin to be installed. If plugin exists with previous version, it

will NOT be updated
Attributes

Attribute

Support

Description

check_mode

full

Can run in check_mode and return changed status prediction without modifying
target.

diff_mode

none

Will return details on what has changed (or possibly needs changing in check_mode),
when in diff mode.
Examples

- name: Install Elasticsearch Head plugin in Elasticsearch 2.x

community.general.elasticsearch_plugin:
name: mobz/elasticsearch-head
state: present

- name: Install a specific version of Elasticsearch Head in Elasticsearch 2.x

community.general.elasticsearch_plugin:
name: mobz/elasticsearch-head
version: 2.0.0

- name: Uninstall Elasticsearch head plugin in Elasticsearch 2.x

community.general.elasticsearch_plugin:
name: mobz/elasticsearch-head
state: absent

- name: Install a specific plugin in Elasticsearch >= 5.0

community.general.elasticsearch_plugin:
name: analysis-icu
state: present

- name: Install the ingest-geoip plugin with a forced installation

community.general.elasticsearch_plugin:
name: ingest-geoip
state: present
force: true

Authors

Mathew Davies (@ThePixelDeveloper)

Sam Doran (@samdoran)

Collection links

Issue Tracker
Repository (Sources)
Submit a bug report
Request a feature
Communication

© Copyright Ansible project contributors. Last updated on May 23, 2024.

Search this site