community.zabbix.zabbix_api_info 模块 – 获取 Zabbix API 信息

注意

此模块是 community.zabbix 集合（版本 3.2.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.zabbix。您需要进一步的要求才能使用此模块，请参阅要求获取详细信息。

要在 playbook 中使用它，请指定： community.zabbix.zabbix_api_info。

community.zabbix 2.1.0 中的新增功能

概要 

此模块允许您检索 Zabbix api 信息。

要求 

执行此模块的主机需要以下要求。

python >= 3.9

参数 

参数	注释
http_login_password 字符串	基本身份验证密码
http_login_user 字符串	基本身份验证登录名

示例 

# 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: Retrieve API information
  # 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_api_info:
  register: zbx_api_info

返回值 

常见的返回值记录在此处，以下是此模块特有的字段

键	描述
api 字典	Zabbix API 信息摘要返回：成功
version 字符串	API 版本返回：成功示例： `"6.0.18"`

作者

ONODERA Masaru(@masa-orca)