Модуль kaytus.ksmanage.edit_snmp_trap — Настройка SNMP-ловушки

Примечание

Этот модуль входит в коллекцию kaytus.ksmanage (версия 2.0.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: kaytus.ksmanage.edit_snmp_trap.

Добавлено в kaytus.ksmanage 1.0.0

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

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

Настройка SNMP-ловушки на сервере kaytus.

Требования

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

Python 3.7+
inManage

Параметры

Параметр	Комментарии
auth_password string	Задает пароль аутентификации для ловушки V3. Пароль должен представлять собой строку из 8–16 буквенно-цифровых символов. Обязателен, если auth_protocol имеет значение `SHA` или `MD5`.
auth_protocol string	Выберите протокол аутентификации для ловушки V3. Варианты: `"NONE"` `"SHA"` `"MD5"`
community string	Community для v1/v2c.
contact string	Задает контактные данные; значение может быть NULL. Этот параметр поддерживается только моделью M5.
engine_id string	Задает идентификатор механизма для ловушки V3. Значение должно представлять собой строку из 10–48 шестнадцатеричных символов чётной длины; значение может быть NULL.
event_severity string	Серьёзность события. Варианты: `"all"` `"warning"` `"critical"`
host string	Задает DNS-имя или адрес узла для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
host_id string	Идентификатор узла. Этот параметр поддерживается только моделью M6. Варианты: `"HostName"` `"SerialNum"` `"AssertTag"`
location string	Задает местоположение узла; значение может быть NULL. Этот параметр поддерживается только моделью M5.
os string	Задает операционную систему узла; значение может быть NULL. Этот параметр поддерживается только моделью M5.
password string	Задает пароль для аутентификации при подключении к удалённому устройству. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ANSIBLE_NET_PASSWORD`.
priv_password string	Задает пароль конфиденциальности для ловушки V3. Пароль должен представлять собой строку из 8–16 буквенно-цифровых символов. Обязателен, если priv_protocol имеет значение `DES` или `AES`.
priv_protocol string	Выберите протокол конфиденциальности для ловушки V3. Варианты: `"NONE"` `"DES"` `"AES"`
provider dictionary	Объект dict, содержащий сведения для подключения.
host string	Задает DNS-имя или адрес узла для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password string	Задает пароль для аутентификации при подключении к удалённому устройству. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ANSIBLE_NET_PASSWORD`.
username string	Задает имя пользователя для аутентификации при подключении к удалённому устройству. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ANSIBLE_NET_USERNAME`.
system_id string	Задает идентификатор системы; значение может быть NULL. Этот параметр поддерживается только моделью M5.
system_name string	Задает имя системы; значение может быть NULL. Этот параметр поддерживается только моделью M5.
trap_port integer	Задает порт для SNMP-ловушки в диапазоне от 1 до 65535. Этот параметр поддерживается только моделью M5.
username string	Задает имя пользователя для аутентификации при подключении к удалённому устройству. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ANSIBLE_NET_USERNAME`.
v3username string	Задает имя пользователя для ловушки V3.
version integer	Версия SNMP-ловушки: 1 — v1, 2 — v2c(v2), 3 — v3, 0 — отключение SNMP-ловушки. Настройки `0` поддерживаются только моделью M6. Варианты: `0` `1` `2` `3`

Примечания

Примечание

Не поддерживает check_mode.

Примеры

- name: Trap test
  hosts: ksmanage
  no_log: true
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set snmp trap v2c"
    kaytus.ksmanage.edit_snmp_trap:
      version: 2
      event_severity: "warning"
      community: "test"
      system_name: "ieisystem"
      provider: "{{ ksmanage }}"

  - name: "Set snmp trap v3"
    kaytus.ksmanage.edit_snmp_trap:
      version: 3
      event_severity: "all"
      v3username: "ieisystem"
      engine_id: "1234567890"
      auth_protocol: "SHA"
      auth_password: "12345678"
      priv_protocol: "AES"
      priv_password: "123454678"
      trap_port: 162
      provider: "{{ ksmanage }}"

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

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

Ключ	Описание
changed boolean	Проверка наличия изменений на устройстве. Возвращается: всегда
message string	Сообщения, возвращаемые после выполнения модуля. Возвращается: всегда
state string	Состояние после выполнения модуля. Возвращается: всегда

Авторы

WangBaoshan (@ieisystem)

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

© 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/kaytus/ksmanage/edit_snmp_trap_module.html