Spec-Zone.ru › Ansible 2.9

zabbix_host – Создание/обновление/удаление хостов Zabbix

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Статус

Описание

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

Требования

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

  • python >= 2.6
  • zabbix-api >= 0.5.4

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ca_cert
строка
добавлен в 2.5
Требуемый сертификат издателя.
Работает только с >= Zabbix 3.0

алиасы: tls_issuer
description
строка
добавлен в 2.5
Описание хоста в Zabbix.
force
логическое
    Варианты:
  • нет
  • да ←
Перезаписать конфигурацию хоста, даже если она уже существует.
host_groups
список / элементы=строка
Список групп хостов, к которым принадлежит хост.
host_name
строка / обязательно
Имя хоста в Zabbix.
host_name является уникальным идентификатором и не может быть обновлен с помощью этого модуля.
http_login_password
строка
Пароль для Basic Auth.
http_login_user
строка / обязательно
Логин для Basic Auth.
interfaces
список / элементы=словарь
Значение по умолчанию:
[]
Список интерфейсов, которые необходимо создать для хоста (см. пример ниже).
Дополнительную информацию см. в документации по интерфейсам хоста по адресу
https://www.zabbix.com/documentation/4.0/manual/api/reference/hostinterface/object
bulk
целое число
    Варианты:
  • 0
  • 1 ←
Использовать ли пакетные запросы SNMP.
0 (не использовать пакетные запросы), 1 (использовать пакетные запросы)
dns
строка
Значение по умолчанию:
""
Имя домена интерфейса хоста.
Требуется, если useip=0.
ip
строка
Значение по умолчанию:
""
IP-адрес, используемый интерфейсом хоста.
Требуется, если useip=1.
main
целое число
    Варианты:
  • 0 ←
  • 1
Является ли интерфейс основным.
Если предоставлено несколько интерфейсов одного типа, только один может быть основным.
0 (не основной), 1 (основной)
port
строка
Порт, используемый интерфейсом хоста.
Если не указан, используется стандартный порт для каждого типа интерфейса
10050, если type='agent'
161, если type='snmp'
623, если type='ipmi'
12345, если type='jmx'
type
- / обязательно
    Варианты:
  • agent
  • snmp
  • ipmi
  • jmx
Тип интерфейса для добавления
Также принимаются числовые значения для типа интерфейса
1 = agent
2 = snmp
3 = ipmi
4 = jmx
useip
целое число
    Варианты:
  • 0 ←
  • 1
Подключение к интерфейсу хоста по IP-адресу вместо имени домена.
0 (не использовать ip), 1 (использовать ip)
inventory_mode
строка
    Варианты:
  • automatic
  • manual
  • disabled
Настройка режима инвентаризации.
inventory_zabbix
словарь
добавлен в 2.5
Добавить факты для инвентаризации zabbix (например, тэги) (см. пример ниже).
Для получения дополнительной информации ознакомьтесь с документацией по интерфейсу
https://www.zabbix.com/documentation/3.2/manual/api/reference/host/object#host_inventory
ipmi_authtype
целое число
добавлен в 2.5
Алгоритм аутентификации IPMI.
Для получения дополнительной информации см. документацию по объекту хоста
https://www.zabbix.com/documentation/3.4/manual/api/reference/host/object
Возможные значения: 0 (нет), 1 (MD2), 2 (MD5), 4 (прямой), 5 (OEM), 6 (RMCP+), где -1 — значение по умолчанию API.
Обратите внимание, что Zabbix API будет использовать значения по умолчанию для отсутствующих настроек при обновлении любых параметров ipmi_; это означает, что если вы попытаетесь установить любое из четырех значений индивидуально, остальные будут сброшены до значений по умолчанию.
ipmi_password
строка
добавлен в 2.5
Пароль IPMI.
также см. последнее примечание в документации к ipmi_authtype
ipmi_privilege
целое число
добавлен в 2.5
Уровень привилегий IPMI.
Для получения дополнительной информации см. документацию по объекту хоста
https://www.zabbix.com/documentation/3.4/manual/api/reference/host/object
Возможные значения: 1 (обратный вызов), 2 (пользователь), 3 (оператор), 4 (администратор), 5 (OEM), где 2 — значение по умолчанию API.
также см. последнее примечание в документации к ipmi_authtype
ipmi_username
строка
добавлен в 2.5
Имя пользователя IPMI.
также см. последнее примечание в документации к ipmi_authtype
link_templates
список / элементы=строка
Список шаблонов, связанных с хостом.
login_password
строка / обязательно
Пароль пользователя Zabbix.
login_user
строка / обязательно
Имя пользователя Zabbix.
proxy
строка
Имя прокси-сервера Zabbix, который необходимо использовать.
server_url
строка / обязательно
URL сервера Zabbix с протоколом (http или https). url — псевдоним для server_url.

алиасы: url
state
строка
    Варианты:
  • present ←
  • absent
Состояние хоста.
На present, он будет создан, если хост не существует, или обновлен, если связанные данные отличаются.
На absent будет удален хост, если он существует.
status
строка
    Варианты:
  • enabled ←
  • disabled
Статус мониторинга хоста.
timeout
целое число
Значение по умолчанию:
10
Таймаут запроса API (секунды).
tls_accept
целое число
добавлено в 2.5
Значение по умолчанию:
1
Указывает типы соединений, разрешённых для входящих подключений.
Параметр tls_accept принимает значения от 1 до 7
Возможные значения: 1 (без шифрования), 2 (PSK), 4 (сертификат).
Значения могут быть объединены.
Работает только с >= Zabbix 3.0
tls_connect
целое число
добавлено в 2.5
Значение по умолчанию:
1
Указывает тип шифрования для исходящих подключений.
Возможные значения: 1 (без шифрования), 2 (PSK), 4 (сертификат).
Работает только с >= Zabbix 3.0
tls_psk
строка
добавлено в 2.5
Значение PSK — сложно угадываемая строка шестнадцатеричных цифр.
Предварительно согласованный ключ, по крайней мере, из 32 шестнадцатеричных цифр. Требуется, если параметр tls_connect или tls_accept имеет включённый PSK.
Работает только с >= Zabbix 3.0
tls_psk_identity
строка
добавлено в 2.5
Уникальное имя, используемое компонентами Zabbix для обозначения данного PSK.
Не вводите конфиденциальную информацию в строку идентификатора PSK, она передаётся по сети без шифрования.
Работает только с >= Zabbix 3.0
tls_subject
строка
добавлено в 2.5
Требуемый субъект сертификата.
Работает только с >= Zabbix 3.0
validate_certs
логическое значение
добавлено в 2.5
    Варианты:
  • нет
  • да ←
Если установлено в значение Ложь, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяемые сертификаты.
visible_name
строка
Видимое имя хоста в Zabbix.

Примечания

Примечание

  • Если вы используете login_password=zabbix, слово «zabbix» заменяется на «****» во всех результатах модуля, потому что login_password использует no_log. Дополнительную информацию см. в этом вопросах и ответах.

Примеры

- name: Create a new host or update an existing host's info
  local_action:
    module: zabbix_host
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    host_name: ExampleHost
    visible_name: ExampleName
    description: My ExampleHost Description
    host_groups:
      - Example group1
      - Example group2
    link_templates:
      - Example template1
      - Example template2
    status: enabled
    state: present
    inventory_mode: manual
    inventory_zabbix:
      tag: "{{ your_tag }}"
      alias: "{{ your_alias }}"
      notes: "Special Informations: {{ your_informations | default('None') }}"
      location: "{{ your_location }}"
      site_rack: "{{ your_site_rack }}"
      os: "{{ your_os }}"
      hardware: "{{ your_hardware }}"
    ipmi_authtype: 2
    ipmi_privilege: 4
    ipmi_username: username
    ipmi_password: password
    interfaces:
      - type: 1
        main: 1
        useip: 1
        ip: 10.xx.xx.xx
        dns: ""
        port: 10050
      - type: 4
        main: 1
        useip: 1
        ip: 10.xx.xx.xx
        dns: ""
        port: 12345
    proxy: a.zabbix.proxy
- name: Update an existing host's TLS settings
  local_action:
    module: zabbix_host
    server_url: http://monitor.example.com
    login_user: username
    login_password: password
    host_name: ExampleHost
    visible_name: ExampleName
    host_groups:
      - Example group1
    tls_psk_identity: test
    tls_connect: 2
    tls_psk: 123456789abcdef123456789abcdef12

Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Cove (@cove)
  • Tony Minfei Ding (!UNKNOWN)
  • Harrison Gu (@harrisongu)
  • Werner Dijkerman (@dj-wasabi)
  • Eike Frost (@eikef)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/zabbix_host_module.html

Spec-Zone.ru

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