Spec-Zone.ru › Ansible

Модуль community.zabbix.zabbix_authentication — обновление аутентификации Zabbix

Примечание

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

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

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

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

Добавлено в community.zabbix 1.6.0

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

Краткое описание

  • Этот модуль позволяет изменять настройки аутентификации Zabbix.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 3.9

Параметры

Параметр

Комментарии

authentication_type

string

Выберите тип аутентификации по умолчанию.

Варианты:

  • "internal"
  • "ldap"

disabled_usrgroup

string

Имя группы пользователей, в которую будет помещен отключенный пользователь.

Группа пользователей должна быть отключена; после настройки ее нельзя будет включить или удалить.

Обязательно, если для saml_jit_status включен параметр ldap_jit_status.

Этот параметр доступен начиная с Zabbix 6.4.

http_auth_enabled

boolean

Аутентификация HTTP будет включена, если true.

Варианты:

  • false
  • true

http_case_sensitive

boolean

Учет регистра при входе с использованием аутентификации HTTP будет включен, если true.

Варианты:

  • false
  • true

http_login_form

string

Выберите форму входа по умолчанию.

Варианты:

  • "zabbix_login_form"
  • "http_login_form"

http_login_password

string

Пароль для Basic Auth

http_login_user

string

Имя пользователя для Basic Auth

http_strip_domains

list / elements=string

Список доменных имен, которые следует удалить из имени пользователя.

jit_provision_interval

string

Интервал между запросами JIT-подготовки для вошедшего в систему пользователя.

Принимает секунды или время с суффиксом, поддерживаются месяцы и годы (3600s,60m,1h,1d,1M,1y). Минимальное значение — 1h.

Доступен только для подготовки пользователей LDAP.

Этот параметр доступен начиная с Zabbix 6.4.

По умолчанию: "1h"

ldap_auth_enabled

boolean

Аутентификация LDAP будет включена, если true.

Этот параметр доступен начиная с Zabbix 6.4.

Варианты:

  • false
  • true

ldap_base_dn

string

Базовое DN LDAP.

Этот параметр необходимо задать, если текущее значение ldap_configured равно false.

Работает только с Zabbix <= 6.0; в более поздних версиях параметр молча игнорируется.

В Zabbix >= 7.0 вместо этого параметра используйте модуль community.zabbix.zabbix_user_directory.

ldap_bind_dn

string

DN привязки LDAP.

Работает только с Zabbix <= 6.0; в более поздних версиях параметр молча игнорируется.

В Zabbix >= 7.0 вместо этого параметра используйте модуль community.zabbix.zabbix_user_directory.

ldap_bind_password

string

Пароль привязки LDAP.

Работает только с Zabbix <= 6.0; в более поздних версиях параметр молча игнорируется.

В Zabbix >= 7.0 вместо этого параметра используйте модуль community.zabbix.zabbix_user_directory.

ldap_case_sensitive

boolean

Учет регистра при входе с использованием аутентификации LDAP будет включен, если true.

Варианты:

  • false
  • true

ldap_configured

boolean

Аутентификация LDAP будет включена, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

ldap_host

string

Имя сервера LDAP.

например ldap://ldap.zabbix.com

Этот параметр необходимо задать, если текущее значение ldap_configured равно false.

Работает только с Zabbix <= 6.0; в более поздних версиях параметр молча игнорируется.

В Zabbix >= 7.0 вместо этого параметра используйте модуль community.zabbix.zabbix_user_directory.

ldap_jit_status

boolean

Состояние подготовки пользователей LDAP.

Этот параметр доступен начиная с Zabbix 6.4.

Варианты:

  • false
  • true

ldap_port

integer

Номер порта сервера LDAP.

Этот параметр необходимо задать, если текущее значение ldap_configured равно false.

Работает только с Zabbix <= 6.0; в более поздних версиях параметр молча игнорируется.

В Zabbix >= 7.0 вместо этого параметра используйте модуль community.zabbix.zabbix_user_directory.

ldap_search_attribute

string

Атрибут поиска LDAP.

Этот параметр необходимо задать, если текущее значение ldap_configured равно false.

Работает только с Zabbix <= 6.0; в более поздних версиях параметр молча игнорируется.

В Zabbix >= 7.0 вместо этого параметра используйте модуль community.zabbix.zabbix_user_directory.

ldap_userdirectory

string

Имя каталога пользователей LDAP по умолчанию для групп пользователей, у которых параметр gui_access имеет значение LDAP или System default.

Обязательно, если для ldap_configured / ldap_auth_enabled задано значение 1.

passwd_check_rules

list / elements=string

Правила проверки пароля.

Выберите несколько вариантов из contain_uppercase_and_lowercase_letters, contain_digits, contain_special_characters и avoid_easy_to_guess.

Этот параметр доступен начиная с Zabbix 6.0.

passwd_min_length

integer

Минимальная длина пароля.

Выберите значение от 1 до 70.

Этот параметр доступен начиная с Zabbix 6.0.

saml_auth_enabled

boolean

Аутентификация SAML будет включена, если true.

Варианты:

  • false
  • true

saml_case_sensitive

boolean

Учет регистра при входе с использованием аутентификации SAML будет включен, если true.

Варианты:

  • false
  • true

saml_encrypt_assertions

boolean

Шифрование утверждений SAML будет включено, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

saml_encrypt_nameid

boolean

Шифрование идентификатора имени SAML будет включено, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

saml_idp_entityid

string

Идентификатор сущности поставщика идентификации SAML.

Этот параметр необходимо задать, если текущее значение saml_auth_enabled равно false.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

saml_jit_status

boolean

Состояние подготовки пользователей SAML.

Этот параметр доступен начиная с Zabbix 6.4.

Варианты:

  • false
  • true

saml_nameid_format

string

Формат идентификатора имени поставщика услуг SAML.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

saml_sign_assertions

boolean

Подписание утверждений SAML будет включено, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

saml_sign_authn_requests

boolean

Подписание запросов AuthN SAML будет включено, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

saml_sign_logout_requests

boolean

Подписание запросов выхода SAML будет включено, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

saml_sign_logout_responses

boolean

Подписание ответов выхода SAML будет включено, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

saml_sign_messages

boolean

Подписание сообщений SAML будет включено, если true.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Варианты:

  • false
  • true

saml_slo_url

string

URL службы единого выхода SAML.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

saml_sp_entityid

string

Идентификатор сущности поставщика услуг SAML.

Этот параметр необходимо задать, если текущее значение saml_auth_enabled равно false.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

saml_sso_url

string

URL службы единого входа SAML.

Этот параметр необходимо задать, если текущее значение saml_auth_enabled равно false.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

saml_username_attribute

string

Атрибут имени пользователя SAML.

Этот параметр необходимо задать, если текущее значение saml_auth_enabled равно false.

Работает только с Zabbix = 6.0; в более поздних версиях параметр молча игнорируется.

Примеры

# 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: Update all authentication setting (Zabbix <= 6.0)
  # 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_authentication:
    authentication_type: internal
    http_auth_enabled: true
    http_login_form: zabbix_login_form
    http_strip_domains:
      - comp
      - any
    http_case_sensitive: true
    ldap_configured: true
    ldap_host: "ldap://localhost"
    ldap_port: 389
    ldap_base_dn: "ou=Users,ou=system"
    ldap_search_attribute: "uid"
    ldap_bind_dn: "uid=ldap_search,ou=system"
    ldap_case_sensitive: true
    ldap_bind_password: "password"
    saml_auth_enabled: true
    saml_idp_entityid: ""
    saml_sso_url: "https://localhost/SAML2/SSO"
    saml_slo_url: "https://localhost/SAML2/SLO"
    saml_username_attribute: "uid"
    saml_sp_entityid: "https://localhost"
    saml_nameid_format: "urn:oasis:names:tc:SAML:2.0:nameid-format:entity"
    saml_sign_messages: true
    saml_sign_assertions: true
    saml_sign_authn_requests: true
    saml_sign_logout_requests: true
    saml_sign_logout_responses: true
    saml_encrypt_nameid: true
    saml_encrypt_assertions: true
    saml_case_sensitive: true
    passwd_min_length: 70
    passwd_check_rules:
      - contain_uppercase_and_lowercase_letters
      - contain_digits
      - contain_special_characters
      - avoid_easy_to_guess

- name: Update all authentication setting (Zabbix = 6.0)
  # 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_authentication:
    authentication_type: internal
    http_auth_enabled: true
    http_login_form: zabbix_login_form
    http_strip_domains:
      - comp
      - any
    http_case_sensitive: true
    ldap_configured: true
    ldap_case_sensitive: true
    saml_auth_enabled: true
    saml_idp_entityid: ""
    saml_sso_url: "https://localhost/SAML2/SSO"
    saml_slo_url: "https://localhost/SAML2/SLO"
    saml_username_attribute: "uid"
    saml_sp_entityid: "https://localhost"
    saml_nameid_format: "urn:oasis:names:tc:SAML:2.0:nameid-format:entity"
    saml_sign_messages: true
    saml_sign_assertions: true
    saml_sign_authn_requests: true
    saml_sign_logout_requests: true
    saml_sign_logout_responses: true
    saml_encrypt_nameid: true
    saml_encrypt_assertions: true
    saml_case_sensitive: true
    passwd_min_length: 70
    passwd_check_rules:
      - contain_uppercase_and_lowercase_letters
      - contain_digits
      - contain_special_characters
      - avoid_easy_to_guess

- name: Update all authentication setting (Zabbix >= 7.0)
  # 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_authentication:
    authentication_type: internal
    http_auth_enabled: true
    http_login_form: zabbix_login_form
    http_strip_domains:
      - comp
      - any
    http_case_sensitive: true
    ldap_auth_enabled: true
    ldap_userdirectory: TestUserDirectory
    ldap_case_sensitive: true
    saml_auth_enabled: true
    saml_case_sensitive: true
    ldap_jit_status: true
    saml_jit_status: true
    jit_provision_interval: 1h
    disabled_usrgrp: Disabled
    passwd_min_length: 70
    passwd_check_rules:
      - contain_uppercase_and_lowercase_letters
      - contain_digits
      - contain_special_characters
      - avoid_easy_to_guess

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

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

Ключ

Описание

msg

string

Результат операции

Возвращается: при успешном выполнении

Пример: "Successfully update authentication setting"

Авторы

  • ONODERA Masaru(@masa-orca)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API