community.zabbix.zabbix_housekeeping 模块 – 更新 Zabbix 后台维护

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.zabbix。您需要其他要求才能使用此模块，有关详细信息，请参阅需求。

要在剧本中使用它，请指定：community.zabbix.zabbix_housekeeping。

community.zabbix 1.6.0 新增功能

概要 

此模块允许您修改 Zabbix 后台维护设置。

需求 

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

python >= 3.9

参数 

参数	注释
compress_older 字符串	如果 compression_status=true，则压缩早于此期间的历史记录和趋势记录。
compression_status 布尔值	如果为 `true`，则将启用历史记录和趋势的 TimescaleDB 压缩。选项 `false` `true`
hk_audit 字符串	审计数据的存储期限 (例如 365d)。
hk_audit_mode 布尔值	如果为 `true`，则将启用审计的内部后台维护。选项 `false` `true`
hk_events_autoreg 字符串	自动注册数据的存储期限 (例如 365d)。
hk_events_discovery 字符串	网络发现的存储期限 (例如 365d)。
hk_events_internal 字符串	内部数据的存储期限 (例如 365d)。
hk_events_mode 布尔值	如果为 `true`，则将启用事件和警报的内部后台维护。选项 `false` `true`
hk_events_service 字符串	服务数据的存储期限 (例如 365d)。
hk_events_trigger 字符串	触发器数据的存储期限 (例如 365d)。
hk_history 字符串	历史数据的存储期限 (例如 365d)。
hk_history_global 布尔值	如果为 `true`，则将启用覆盖每个项目的历史记录期限。选项 `false` `true`
hk_history_mode 布尔值	如果为 `true`，则将启用历史记录的内部后台维护。选项 `false` `true`
hk_services 字符串	服务数据的存储期限 (例如 365d)。
hk_services_mode 布尔值	如果为 `true`，则将启用服务的内部后台维护。选项 `false` `true`
hk_sessions 字符串	会话数据的存储期限 (例如 365d)。
hk_sessions_mode 布尔值	如果为 `true`，则将启用会话的内部后台维护。选项 `false` `true`
hk_trends 字符串	趋势数据的存储期限 (例如 365d)。
hk_trends_global 布尔值	如果为 `true`，则将启用覆盖每个项目的趋势期限。选项 `false` `true`
hk_trends_mode 布尔值	如果为 `true`，则将启用趋势的内部后台维护。选项 `false` `true`
http_login_password 字符串	基本身份验证密码
http_login_user 字符串	基本身份验证登录

示例 

# 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 housekeeping all parameter
  # 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_housekeeping:
    login_user: Admin
    login_password: secret
    hk_events_mode: yes
    hk_events_trigger: 365d
    hk_events_service: 365d
    hk_events_internal: 365d
    hk_events_discovery: 365d
    hk_events_autoreg: 365d
    hk_services_mode: yes
    hk_services: 365d
    hk_audit_mode: yes
    hk_audit: 365d
    hk_sessions_mode: yes
    hk_sessions: 365d
    hk_history_mode: yes
    hk_history_global: yes
    hk_history: 365d
    hk_trends_mode: yes
    hk_trends_global: yes
    hk_trends: 365d
    compression_status: off
    compress_older: 7d

返回值 

公共返回值已记录在此处，以下是此模块特有的字段

键	描述
msg 字符串	操作结果返回：成功示例：`"Successfully update housekeeping setting"`

作者

ONODERA Masaru(@masa-orca)