Модуль kaytus.ksmanage.edit_snmp_trap – Установка ловушек snmp

Примечание

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

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

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

Для использования в playbook, укажите: kaytus.ksmanage.edit_snmp_trap.

Новая функция в kaytus.ksmanage 1.0.0

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

Описание

Устанавливает ловушки snmp на сервере kaytus.

Требования

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

Python 3.7+
inManage

Параметры

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

END_OF_DOCUMENT_MARKER

version

integer

Версия SNMP-ловушки, 1 — v1, 2 — v2c(v2), 3 — v3, 0 — отключение SNMP-ловушки.

Только модель M6 поддерживает 0 Настройки.

Варианты:

Примечания

Примечание

Не поддерживает 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/kaytus/ksmanage/edit_snmp_trap_module.html