community.general.elasticsearch_plugin 模块 – 管理 Elasticsearch 插件

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.elasticsearch_plugin。

概要

  • 管理 Elasticsearch 插件。

参数

参数

注释

force

布尔值

安装插件时强制使用批处理模式。只有当插件需要其他权限并且控制台检测失败时才需要这样做。

选项

  • false ← (默认)

  • true

name

字符串 / 必填

要安装的插件的名称。

plugin_bin

路径

插件二进制文件的位置。如果找不到此文件，将使用默认的插件二进制文件。

plugin_dir

路径

您在 Elasticsearch 中指定的已配置插件目录

默认值： "/usr/share/elasticsearch/plugins/"

proxy_host

字符串

安装插件期间使用的代理主机

proxy_port

字符串

安装插件期间使用的代理端口

src

字符串

可以选择设置源位置以从中检索插件。这可以是 file:// URL，用于从本地文件安装，也可以是远程 URL。如果未设置此项，插件位置仅基于名称。

name 参数必须与插件 ZIP 中指定的描述符匹配。

仅当状态发生更改时才使用，而状态仅基于 name 参数进行检查。例如，如果插件已安装，则更改此项无效。

对于 ES 1.x，使用 url。

state

字符串

插件的所需状态。

选项

  • "present" ← (默认)

  • "absent"

timeout

字符串

超时设置：30s、1m、1h…

仅适用于 Elasticsearch < 5.0。此选项对于 Elasticsearch > 5.0 将被忽略。

默认值： "1m"

url

字符串

设置要从中下载插件的确切 URL（仅适用于 ES 1.x）。

对于 ES 2.x 及更高版本，请使用 src。

version

字符串

要安装的插件版本。如果插件已存在于之前的版本，则不会更新。

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- 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

作者

  • Mathew Davies (@ThePixelDeveloper)

  • Sam Doran (@samdoran)