community.general.kibana_plugin 模块 – 管理 Kibana 插件

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.general

要在剧本中使用它,请指定:community.general.kibana_plugin

概要

  • 此模块可用于管理 Kibana 插件。

参数

参数

注释

allow_root

布尔值

在 community.general 2.3.0 中添加

是否允许以 root 身份运行 kibanakibana-plugin。 将 --allow-root 标志传递给这些命令。

选择

  • false ← (默认)

  • true

force

布尔值

删除并重新安装插件。 对于插件更新很有用。

选择

  • false ← (默认)

  • true

name

字符串 / 必需

要安装的插件的名称。

plugin_bin

路径

Kibana 二进制文件的位置。

默认值: "/opt/kibana/bin/kibana"

plugin_dir

路径

您在 Kibana 中配置的插件目录。

默认值: "/opt/kibana/installedPlugins/"

state

字符串

插件的期望状态。

选择

  • "present" ← (默认)

  • "absent"

timeout

字符串

超时设置:30s、1m、1h 等。

默认值: "1m"

url

字符串

设置从哪里下载插件的准确 URL。

对于本地文件,请在绝对路径前加上 file://

version

字符串

要安装的插件的版本。

如果插件已存在且版本较旧,则除非将 force 设置为 true,否则插件将不会更新。

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 下运行并返回已更改状态预测,而无需修改目标。

diff_mode

支持:

当处于 diff 模式时,将返回有关已更改的内容(或可能需要在 check_mode 中更改的内容)的详细信息。

示例

- name: Install Elasticsearch head plugin
  community.general.kibana_plugin:
    state: present
    name: elasticsearch/marvel

- name: Install specific version of a plugin
  community.general.kibana_plugin:
    state: present
    name: elasticsearch/marvel
    version: '2.3.3'

- name: Uninstall Elasticsearch head plugin
  community.general.kibana_plugin:
    state: absent
    name: elasticsearch/marvel

返回值

常见的返回值记录在 这里,以下是此模块独有的字段

描述

cmd

字符串

插件管理(安装/删除)期间启动的命令

返回: 成功

name

字符串

要安装或删除的插件名称

返回: 成功

state

字符串

托管插件的状态

返回: 成功

stderr

字符串

命令 stderr

返回: 成功

stdout

字符串

命令 stdout

返回: 成功

timeout

字符串

插件下载的超时时间

返回: 成功

url

字符串

从中安装插件的 URL

返回: 成功

作者

  • Thierno IB. BARRY (@barryib)