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

Requirements

• python >= 2.6
• zabbix-api >= 0.5.4

Usage examples

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
  community.zabbix.zabbix_proxy_info:
    server_url: "http://zabbix.example.com/zabbix/"
    login_user: admin
    login_password: secret
    proxy_name: zbx01.example.com
    proxy_hosts: True

Inputs

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

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

proxy_name:
    description:
    - Name of the Zabbix proxy.
    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

proxy_hosts:
    default: false
    description:
    - Also return list of hosts monitored by the proxy.
    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

http_login_user:
    description:
    - Basic Auth login
    type: str

http_login_password:
    description:
    - Basic Auth password
    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