community.zabbix.zabbix_token 模块 – 创建/更新/生成/删除 Zabbix 令牌。
注意
此模块是 community.zabbix 集合 (版本 3.2.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install community.zabbix
。您需要其他要求才能使用此模块,请参阅 需求 获取详细信息。
要在 playbook 中使用它,请指定: community.zabbix.zabbix_token
。
community.zabbix 2.1.0 中的新增功能
概要
此模块允许您创建、更新、生成和删除 Zabbix 令牌。
需求
执行此模块的主机需要以下需求。
python >= 3.9
参数
参数 |
注释 |
---|---|
令牌的描述。 |
|
令牌过期的时间戳。 如果为 |
|
如果为 选项
|
|
基本身份验证密码 |
|
基本身份验证用户名 |
|
令牌的名称。 |
|
创建或删除令牌。 选项
|
|
令牌的状态。 选项
|
|
分配令牌的用户名称。 |
示例
# 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: Create Zabbix token and generate token string
# 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_token:
name: test token
description: Admin test token
username: Admin
status: true
expires_at: 1700000000
generate_token: true
state: present
返回值
常见返回值已在此处记录 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
操作的结果 返回:成功 示例: |
|
生成的令牌字符串 返回: generate_token=true 示例: |