Модуль community.general.elasticsearch_plugin – Управление плагинами Elasticsearch

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать коллекцию в плейбуке, укажите: community.general.elasticsearch_plugin.

Краткое описание
Параметры
Атрибуты
Примеры

Краткое описание

Управляет плагинами Elasticsearch.

Параметры

Параметр	Комментарии
force логическое значение	Принудительно использовать пакетный режим при установке плагинов. Это необходимо только в том случае, если плагину требуются дополнительные разрешения и автоматическое определение консоли не срабатывает. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательный	Название устанавливаемого плагина.
plugin_bin путь	Расположение исполняемого файла плагина. Если этот файл не найден, используются исполняемые файлы плагинов по умолчанию.
plugin_dir путь	Настроенный каталог плагинов, указанный в Elasticsearch. По умолчанию: `"/usr/share/elasticsearch/plugins/"`
proxy_host строка	Узел прокси-сервера, используемый при установке плагина.
proxy_port строка	Порт прокси-сервера, используемый при установке плагина.
src строка	Необязательное расположение источника, из которого нужно получить плагин. Это может быть URL `file://` для установки из локального файла или удаленный 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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/elasticsearch_plugin_module.html