Модуль kaytus.ksmanage.edit_alert_policy — Установка политики оповещения

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: kaytus.ksmanage.edit_alert_policy.

Новое в kaytus.ksmanage 1.0.0

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

Описание

Устанавливает политику оповещения на сервере kaytus.

Требования

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

Python 3.7+
inManage

Параметры

Параметр	Комментарии
channel строка	LAN канал. Этот параметр поддерживается только моделью M5. Варианты: `"shared"` `"dedicated"`
destination строка	Цель оповещения. Адрес сервера, получающего информацию об оповещении, отправленную Trap. При type snmp, укажите IP-адрес. При type email, укажите имя пользователя. При type snmpdomain, укажите домен.
host строка	Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
id целое число / обязательно	Идентификатор оповещения. Настройте канал для отправки оповещений в режиме Trap. Значения для модулей M5 — 1, 2, 3. Значения для модулей M6 — 1, 2, 3, 4. Варианты: `1` `2` `3` `4`
password строка	Указывает пароль для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
provider словарь	Объект типа dict, содержащий данные подключения.
host строка	Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password строка	Указывает пароль для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
username строка	Указывает имя пользователя для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
status строка	Статус политики оповещения. Включает ли получающая сторона отправку сообщений в режиме trap. Варианты: `"enable"` `"disable"`
trap_port целое число	SNMP порт trap(1-65535). Этот параметр поддерживается только моделью M6.
type строка	Тип оповещения. Этот параметр поддерживается только моделью M5. Варианты: `"snmp"` `"email"` `"snmpdomain"`
username строка	Указывает имя пользователя для аутентификации подключения к удалённому устройству. Если значение не указано в задаче, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.

Примечания

Примечание

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

Примеры

- name: Alert policy test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set alert policy"
    kaytus.ksmanage.edit_alert_policy:
      id: 1
      status: "enable"
      type: "snmp"
      destination: "100.2.2.2"
      channel: "shared"
      provider: "{{ ksmanage }}"

  - name: "Set alert policy"
    kaytus.ksmanage.edit_alert_policy:
      id: 1
      status: "disable"
      provider: "{{ ksmanage }}"

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
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_alert_policy_module.html