Модуль community.zabbix.zabbix_token — Создание/обновление/генерация/удаление токена Zabbix.

Примечание

Этот модуль входит в коллекцию community.zabbix (версия 2.5.1).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.zabbix. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

Чтобы использовать его в плейбуке, укажите: community.zabbix.zabbix_token.

Новая в community.zabbix 2.1.0

Описание
Требования
Параметры
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет создавать, обновлять, генерировать и удалять токен Zabbix.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 3.9

Параметры

Параметр	Комментарии
description строка	Описание токена.
expires_at целое число	Отметка времени истечения срока действия токена. Токен никогда не истекает, если `0`
generate_token логическое значение	Новая строка токена будет сгенерирована, если `true`. Варианты: `false` ← (по умолчанию) `true`
http_login_password строка	Пароль для аутентификации по протоколу Basic Auth.
http_login_user строка	Логин для аутентификации по протоколу Basic Auth.
name строка / обязательно	Имя токена.
state строка	Создание или удаление токена. Варианты: `"present"` ← (по умолчанию) `"absent"`
status логическое значение	Статус токена. Варианты: `false` `true`
username строка / обязательно	Имя пользователя, которому назначен токен.

Примеры

# 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

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
msg строка	Результат операции Возвращаемое значение: success Пример: `"Successfully created token"`
token строка	Сгенерированная строка токена Возвращаемое значение: generate_token=true Пример: `"8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895"`

Авторы

ONODERA Masaru(@masa-orca)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/zabbix/zabbix_token_module.html