community / community.zabbix / 2.3.1 / module / zabbix_housekeeping Update Zabbix housekeeping | "added in version" 1.6.0 of community.zabbix" Authors: ONODERA Masaru(@masa-orca)community.zabbix.zabbix_housekeeping (2.3.1) — module
Install with ansible-galaxy collection install community.zabbix:==2.3.1
collections: - name: community.zabbix version: 2.3.1
This module allows you to modify Zabbix housekeeping setting.
# 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
hk_audit: description: - Storage period of audit data (e.g. 365d). required: false type: str hk_trends: description: - Storage priod of trends data (e.g. 365d). required: false type: str hk_history: description: - Storage priod of history data (e.g. 365d). required: false type: str hk_services: description: - Storage period of services data (e.g. 365d). required: false type: str hk_sessions: description: - Storage period of sessions data (e.g. 365d). required: false type: str hk_audit_mode: description: - Internal housekeeping for audit will be enabled if C(true). required: false type: bool compress_older: description: - Compress history and trends records older than this period if I(compression_status=true). required: false type: str hk_events_mode: description: - Internal housekeeping for events and alerts will be enabled if C(true). required: false type: bool hk_trends_mode: description: - Internal housekeeping for trends will be enabled if C(true). required: false type: bool hk_history_mode: description: - Internal housekeeping for history will be enabled if C(true). required: false type: bool http_login_user: description: - Basic Auth login required: false type: str hk_services_mode: description: - Internal housekeeping for services will be enabled if C(true). required: false type: bool hk_sessions_mode: description: - Internal housekeeping for sessions will be enabled if C(true). required: false type: bool hk_trends_global: description: - Overriding trend period of each items will be enabled if C(true). required: false type: bool hk_events_autoreg: description: - Storage period of autoregistration data (e.g. 365d). required: false type: str hk_events_service: description: - Storage period of service data (e.g. 365d). required: false type: str hk_events_trigger: description: - Storage period of trigger data (e.g. 365d). required: false type: str hk_history_global: description: - Overriding history period of each items will be enabled if C(true). required: false type: bool compression_status: description: - TimescaleDB compression for history and trends will be enabled if C(true). required: false type: bool hk_events_internal: description: - Storage period of internal data (e.g. 365d). required: false type: str hk_events_discovery: description: - Storage period of network discovery (e.g. 365d). required: false type: str http_login_password: description: - Basic Auth password required: false type: str
msg: description: The result of the operation returned: success sample: Successfully update housekeeping setting type: str