community.zabbix.zabbix_housekeeping (1.8.0) — module

Install collection

Install with ansible-galaxy collection install community.zabbix:==1.8.0

Add to requirements.yml

  collections:
    - name: community.zabbix
      version: 1.8.0

Description

This module allows you to modify Zabbix housekeeping setting.

Requirements

• zabbix-api >= 0.5.4

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update housekeeping all parameter
  community.zabbix.zabbix_housekeeping:
    server_url: "http://zabbix.example.com/zabbix/"
    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

Inputs

    
timeout:
    default: 10
    description:
    - The timeout of API request (seconds).
    type: int

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

login_user:
    description:
    - Zabbix user name.
    - If not set the environment variable C(ZABBIX_USERNAME) will be used.
    required: true
    type: str

server_url:
    aliases:
    - url
    description:
    - URL of Zabbix server, with protocol (http or https). C(url) is an alias for C(server_url).
    - If not set the environment variable C(ZABBIX_SERVER) will be used.
    required: true
    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

login_password:
    description:
    - Zabbix user password.
    - If not set the environment variable C(ZABBIX_PASSWORD) will be used.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If set to False, SSL certificates will not be validated. This should only be used
      on personally controlled sites using self-signed certificates.
    - If not set the environment variable C(ZABBIX_VALIDATE_CERTS) will be used.
    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
    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).
    - This parameter is available since Zabbix 6.0.
    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
    type: str

Outputs

msg:
  description: The result of the operation
  returned: success
  sample: Successfully update housekeeping setting
  type: str