community.zabbix.zabbix_settings 模块 – 更新 Zabbix 全局设置。

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.zabbix。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:community.zabbix.zabbix_settings

community.zabbix 2.1.0 中的新功能

概要

  • 此模块允许您更新 Zabbix 全局设置。

要求

执行此模块的主机需要满足以下要求。

  • python >= 3.9

参数

参数

注释

alert_usrgrp

字符串

当数据库宕机时,接收警报消息的用户组的名称。

auditlog_enabled

布尔值

如果为 true,则启用审计日志。

选项

  • false

  • true

字符串

状态更改触发器闪烁的时间段。

接受秒和带有后缀的时间单位(例如 5m)。

connect_timeout

字符串

与 Zabbix 服务器的连接超时时间。

custom_color

布尔值

如果为 true,则将激活自定义事件颜色设置。

选项

  • false

  • true

default_inventory_mode

字符串

主机清单模式的默认值。

选项

  • "disabled"

  • "manual"

  • "automatic"

default_lang

字符串

用户的默认语言。

default_theme

字符串

用户的默认主题。

选项

  • "blue-theme"

  • "dark-theme"

  • "hc-light"

  • "hc-dark"

default_timezone

字符串

用户的默认时区。

如果要使用系统时区,请设置 system

discovery_group

字符串

发现的主机将属于的主机组。

frontend_url

字符串

前端的 URL。

此参数用于设置 API 的 url 参数。

geomaps_attribution

字符串

地理地图属性的文本。

geomaps_max_zoom

字符串

地理地图的最大缩放级别。

geomaps_tile_provider

字符串

地理地图瓦片的提供者。

如果要使用非默认提供者,请设置 another

选项

  • "OpenStreetMap.Mapnik"

  • "OpenTopoMap"

  • "Stamen.TonerLite"

  • "Stamen.Terrain"

  • "USGS.USTopo"

  • "USGS.USImagery"

  • "another"

geomaps_tile_url

字符串

地理地图瓦片的 URL。

history_period

字符串

显示历史数据的最大期限。

接受秒和带有后缀的时间单位(例如 24h)。

http_login_password

字符串

基本身份验证密码

http_login_user

字符串

基本身份验证登录名

iframe_sandboxing_enabled

布尔值

如果为 true,则 Zabbix 使用 iframe 沙箱。

选项

  • false

  • true

iframe_sandboxing_exceptions

字符串

iframe 沙箱异常的文本。

item_test_timeout

字符串

项目测试的网络超时时间。

login_attempts

整数

您可以在未被阻止的情况下尝试的登录尝试次数。

login_block

字符串

用户被阻止时重置登录尝试的间隔时间。

接受秒和带有后缀的时间单位(例如 5m)。

max_in_table

整数

在表格单元格内显示的最大元素计数

max_overview_table_size

整数

概览表格中的最大列数和行数

max_period

字符串

时间过滤器的最大期限。

接受秒和带有后缀的时间单位(例如 1y)。

media_type_test_timeout

字符串

媒体类型测试的网络超时时间。

ok_ack_color

字符串

已确认的已解决事件的自定义颜色。

如果 custom_color=true,则将激活此设置。

请设置十六进制颜色代码(例如 00FF00)。

ok_ack_style

布尔值

如果为 true,则已确认的已解决事件会闪烁。

选项

  • false

  • true

ok_period

字符串

显示 OK 触发器的时间段。

接受秒和带有后缀的时间单位(例如 5m)。

ok_unack_color

字符串

未确认的已解决事件的自定义颜色。

如果 custom_color=true,则将激活此设置。

请设置十六进制颜色代码(例如 00FF00)。

ok_unack_style

布尔值

如果为 true,则未确认的已解决事件会闪烁。

选项

  • false

  • true

period_default

字符串

时间过滤器的默认期限值。

接受秒和带有后缀的时间单位(例如 1h)。

problem_ack_color

字符串

已确认的 PROBLEM 事件的自定义颜色。

如果 custom_color=true,则将激活此设置。

请设置十六进制颜色代码(例如 00FF00)。

problem_ack_style

布尔值

如果为 true,则已确认的 PROBLEM 事件会闪烁。

选项

  • false

  • true

problem_unack_color

字符串

未确认的 PROBLEM 事件的自定义颜色。

如果 custom_color=true,则将激活此设置。

请设置十六进制颜色代码(例如 00FF00)。

problem_unack_style

布尔值

如果为 true,则未确认的 PROBLEM 事件会闪烁。

选项

  • false

  • true

report_test_timeout

字符串

计划报表测试的网络超时时间。

script_timeout

字符串

脚本执行的网络超时时间。

search_limit

整数

搜索和过滤结果的限制数量。

server_check_interval

布尔值

如果为 true,则 Zabbix 会显示“Zabbix 服务器已关闭”警告。

选项

  • false

  • true

severity_color_0

字符串

未分类严重性的自定义颜色。

请设置十六进制颜色代码(例如 00FF00)。

severity_color_1

字符串

信息严重性的自定义颜色。

请设置十六进制颜色代码(例如 00FF00)。

severity_color_2

字符串

警告严重性的自定义颜色。

请设置十六进制颜色代码(例如 00FF00)。

severity_color_3

字符串

平均严重性的自定义颜色。

请设置十六进制颜色代码(例如 00FF00)。

severity_color_4

字符串

高严重性的自定义颜色。

请设置十六进制颜色代码(例如 00FF00)。

severity_color_5

字符串

灾难严重程度的自定义颜色。

请设置十六进制颜色代码(例如 00FF00)。

severity_name_0

字符串

未分类严重程度的自定义名称。

severity_name_1

字符串

信息严重程度的自定义名称。

severity_name_2

字符串

警告严重程度的自定义名称。

severity_name_3

字符串

平均严重程度的自定义名称。

severity_name_4

字符串

高严重程度的自定义名称。

severity_name_5

字符串

灾难严重程度的自定义名称。

show_technical_errors

布尔值

如果 true,Zabbix 将向非超级管理员或未启用调试模式的用户组显示 PHP 和 SQL 技术错误。

选项

  • false

  • true

snmptrap_logging

布尔值

如果 true,将启用记录不匹配的 SNMP traps。

选项

  • false

  • true

socket_timeout

字符串

网络默认超时时间。

uri_valid_schemes

列表 / 元素=字符串

有效的 URI 方案列表。

validate_uri_schemes

布尔值

如果 true,则验证 URI 方案。

选项

  • false

  • true

vault_provider

字符串

Vault 提供者的名称。

此参数自 Zabbix 6.2 起可用。

选项

  • "HashiCorp_Vault"

  • "CyberArk_Vault"

work_period

字符串

x_frame_options

字符串

HTTP 标头的 X-Frame-Options 的文本。

备注

注意

  • 此模块管理与设置 API 相关的设置,除了 ha_failover_delay。

示例

# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
  ansible.builtin.set_fact:
    ansible_user: Admin
    ansible_httpapi_pass: zabbix

# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
  ansible.builtin.set_fact:
    ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895

- name: Update settings
  # set task level variables as we change ansible_connection plugin here
  vars:
    ansible_network_os: community.zabbix.zabbix
    ansible_connection: httpapi
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_zabbix_url_path: "zabbixeu"  # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
    ansible_host: zabbix-example-fqdn.org
  community.zabbix.zabbix_settings:
    alert_usrgrp: "0"
    auditlog_enabled: false
    blink_period: "10m"
    connect_timeout: "30s"
    custom_color: false
    default_inventory_mode: automatic

返回值

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

描述

msg

字符串

操作的结果

已返回: 成功

示例: "成功更新全局设置"

作者

  • ONODERA Masaru(@masa-orca)