community.zabbix.zabbix_token (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 create, update, generate and delete Zabbix token.

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: 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

Inputs

    
name:
    description:
    - Name of the token.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Create or delete token.
    type: str

status:
    description:
    - Status of the token.
    required: false
    type: bool

username:
    description:
    - Name of user who is the token assinged to.
    required: true
    type: str

expires_at:
    description:
    - A timestamp of the token will be expired.
    - The token will never expire if C(0)
    required: false
    type: int

description:
    description:
    - Description of the token.
    required: false
    type: str

generate_token:
    default: false
    description:
    - New token string will be generated if C(true).
    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

msg:
  description: The result of the operation
  returned: success
  sample: Successfully created token
  type: str
token:
  description: Generated token string
  returned: I(generate_token=true)
  sample: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895
  type: str