community.zabbix.zabbix_proxy_info (2.3.1) — module

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 obtain detailed information about configured zabbix proxies.

Requirements

• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• 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

Scanned by Steampunk Spotter

• 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

Scanned by Steampunk Spotter

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

- name: Get zabbix proxy info alongside the list of hosts monitored by the proxy
  # 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_proxy_info:
    proxy_name: zbx01.example.com
    proxy_hosts: true

Inputs

    
proxy_name:
    description:
    - Name of the Zabbix proxy.
    required: true
    type: str

proxy_hosts:
    default: false
    description:
    - Also return list of hosts monitored by the proxy.
    required: false
    type: bool

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

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

Outputs

zabbix_proxy:
  description: example
  returned: always
  sample:
    auto_compress: '1'
    custom_interfaces: '0'
    description: ExampleProxy
    discover: '0'
    flags: '0'
    host: ExampleProxy
    hosts:
    - host: ExampleHost
      hostid: '10453'
    interface:
      available: '0'
      details: []
      disable_until: '0'
      dns: ExampleProxy.local
      error: ''
      errors_from: '0'
      hostid: '10452'
      interfaceid: '10'
      ip: 10.1.1.2
      main: '1'
      port: '10051'
      type: '0'
      useip: '1'
    ipmi_authtype: '-1'
    ipmi_password: ''
    ipmi_privilege: '2'
    ipmi_username: ''
    lastaccess: '0'
    maintenance_from: '0'
    maintenance_status: '0'
    maintenance_type: '0'
    maintenanceid: '0'
    name: ''
    proxy_address: ''
    proxy_hostid: '0'
    proxyid: '10452'
    status: '6'
    templateid: '0'
    tls_accept: '1'
    tls_connect: '1'
    tls_issuer: ''
    tls_subject: ''
    uuid: ''
  type: dict