community.zabbix.zabbix_settings (2.3.1) — module

Update Zabbix global settings.

| "added in version" 2.1.0 of community.zabbix"

Authors: ONODERA Masaru(@masa-orca)

Install collection

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


Add to requirements.yml

  collections:
    - name: community.zabbix
      version: 2.3.1

Description

This module allows you to update Zabbix global settings.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
ok_period:
    description:
    - A time of period for displaying OK triggers.
    - Accepts seconds and time unit with suffix (e.g. 5m).
    required: false
    type: str

max_period:
    description:
    - Max period for time filter.
    - Accepts seconds and time unit with suffix (e.g. 1y).
    required: false
    type: str

login_block:
    description:
    - A time of interval to reset login attempts when the user is blocked.
    - Accepts seconds and time unit with suffix (e.g. 5m).
    required: false
    type: str

work_period:
    description:
    - Working time setting.
    - U(https://www.zabbix.com/documentation/current/en/manual/appendix/time_period)
    required: false
    type: str

alert_usrgrp:
    description:
    - A name of user group which user belongs to receive an alerm message when database
      down.
    required: false
    type: str

blink_period:
    description:
    - A time of period for blinking status changed triggers.
    - Accepts seconds and time unit with suffix (e.g. 5m).
    required: false
    type: str

custom_color:
    description:
    - Custom event color settings will be activated if C(true).
    required: false
    type: bool

default_lang:
    description:
    - Default language for users.
    required: false
    type: str

frontend_url:
    description:
    - A URL of frontend.
    - This parameter is used for url parameter of settings API.
    required: false
    type: str

max_in_table:
    description:
    - Max count of elements to show inside table cell
    required: false
    type: int

ok_ack_color:
    description:
    - A custom color for acknowledged RESOLVED events.
    - This setting will be activated if I(custom_color=true).
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

ok_ack_style:
    description:
    - Acknowledged RESOLVED events blink if C(true).
    required: false
    type: bool

search_limit:
    description:
    - A number of search and filter results limit.
    required: false
    type: int

default_theme:
    choices:
    - blue-theme
    - dark-theme
    - hc-light
    - hc-dark
    description:
    - Default theme for users.
    required: false
    type: str

history_period:
    description:
    - Max period of displaying history data.
    - Accepts seconds and time unit with suffix (e.g. 24h).
    required: false
    type: str

login_attempts:
    description:
    - A number of login attempts you can try with non blocked.
    required: false
    type: int

ok_unack_color:
    description:
    - A custom color for unacknowledged RESOLVED events.
    - This setting will be activated if I(custom_color=true).
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

ok_unack_style:
    description:
    - Unacknowledged RESOLVED events blink if C(true).
    required: false
    type: bool

period_default:
    description:
    - Default period value for time filter.
    - Accepts seconds and time unit with suffix (e.g. 1h).
    required: false
    type: str

script_timeout:
    description:
    - A time of network timeout for script execution.
    required: false
    type: str

socket_timeout:
    description:
    - A time of network default timeout.
    required: false
    type: str

vault_provider:
    choices:
    - HashiCorp_Vault
    - CyberArk_Vault
    description:
    - A name of vault provider.
    - This parameter is available since Zabbix 6.2.
    required: false
    type: str

connect_timeout:
    description:
    - A time of connection timeout with Zabbix server.
    required: false
    type: str

discovery_group:
    description:
    - A hostgroup which discovered hosts will belong to.
    required: false
    type: str

http_login_user:
    description:
    - Basic Auth login
    required: false
    type: str

severity_name_0:
    description:
    - A custom name for not classified severity.
    required: false
    type: str

severity_name_1:
    description:
    - A custom name for information severity.
    required: false
    type: str

severity_name_2:
    description:
    - A custom name for warning severity.
    required: false
    type: str

severity_name_3:
    description:
    - A custom name for average severity.
    required: false
    type: str

severity_name_4:
    description:
    - A custom name for high severity.
    required: false
    type: str

severity_name_5:
    description:
    - A custom name for disaster severity.
    required: false
    type: str

x_frame_options:
    description:
    - A text of X-Frame-Options of HTTP header.
    required: false
    type: str

auditlog_enabled:
    description:
    - Enable audit logging if C(true).
    required: false
    type: bool

default_timezone:
    description:
    - Default time zone for users.
    - Please set C(system) if you want to use system time zone.
    required: false
    type: str

geomaps_max_zoom:
    description:
    - Max zoom level of geomap.
    required: false
    type: str

geomaps_tile_url:
    description:
    - A URL of geomap tile.
    required: false
    type: str

severity_color_0:
    description:
    - A custom color for not classified severity.
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

severity_color_1:
    description:
    - A custom color for information severity.
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

severity_color_2:
    description:
    - A custom color for warning severity.
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

severity_color_3:
    description:
    - A custom color for average severity.
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

severity_color_4:
    description:
    - A custom color for high severity.
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

severity_color_5:
    description:
    - A custom color for disaster severity.
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

snmptrap_logging:
    description:
    - Logging unmatched SNMP traps will be ebabled if C(true).
    required: false
    type: bool

item_test_timeout:
    description:
    - A time of network timeout for item tests.
    required: false
    type: str

problem_ack_color:
    description:
    - A custom color for acknowledged PROBLEM events.
    - This setting will be activated if I(custom_color=true).
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

problem_ack_style:
    description:
    - Acknowledged PROBLEM events blink if C(true).
    required: false
    type: bool

uri_valid_schemes:
    description:
    - A list of valid URI scheme.
    elements: str
    required: false
    type: list

geomaps_attribution:
    description:
    - A text of Geomap attribution.
    required: false
    type: str

http_login_password:
    description:
    - Basic Auth password
    required: false
    type: str

problem_unack_color:
    description:
    - A custom color for unacknowledged PROBLEM events.
    - This setting will be activated if I(custom_color=true).
    - Please set hexadecimal color code (e.g. 00FF00).
    required: false
    type: str

problem_unack_style:
    description:
    - Unacknowledged PROBLEM events blink if C(true).
    required: false
    type: bool

report_test_timeout:
    description:
    - A time of network timeout for scheduled report test.
    required: false
    type: str

validate_uri_schemes:
    description:
    - Validate URI schemes if C(true).
    required: false
    type: bool

geomaps_tile_provider:
    choices:
    - OpenStreetMap.Mapnik
    - OpenTopoMap
    - Stamen.TonerLite
    - Stamen.Terrain
    - USGS.USTopo
    - USGS.USImagery
    - another
    description:
    - A provider of Geomap tile.
    - Please set C(another) if you want use non default provider
    required: false
    type: str

server_check_interval:
    description:
    - The Zabbix shows "Zabbix server is down" warning if C(true).
    required: false
    type: bool

show_technical_errors:
    description:
    - The Zabbix shows PHP and SQL technical errors to users who are non-Super admin or
      belong to user groups with debug mode not enabled if C(true).
    required: false
    type: bool

default_inventory_mode:
    choices:
    - disabled
    - manual
    - automatic
    description:
    - A default value for host inventory mode.
    required: false
    type: str

max_overview_table_size:
    description:
    - Max number of columns and rows in overview tables
    required: false
    type: int

media_type_test_timeout:
    description:
    - A time of network timeout for media type test.
    required: false
    type: str

iframe_sandboxing_enabled:
    description:
    - The Zabbix uses iframe sandboxing if C(true).
    required: false
    type: bool

iframe_sandboxing_exceptions:
    description:
    - A text of iframe sandboxing exceptions.
    required: false
    type: str

Outputs

msg:
  description: The result of the operation
  returned: success
  sample: Successfully update global settings
  type: str