Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

string

Канал LAN.

Этот параметр поддерживается только моделью M5.

Варианты:

  • "shared"
  • "dedicated"

destination

string

Адрес назначения оповещений. Адрес сервера, получающего сведения о ловушках, отправленные Trap.

Если тип — snmp, укажите IP-адрес.

Если тип — email, укажите имя пользователя.

Если тип — snmpdomain, укажите домен.

host

string

Задает DNS-имя узла или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.

id

integer / обязательный

Идентификатор оповещения. Настраивает канал отправки аварийных сигналов в Trap.

Для модулей M5 допустимы значения 1, 2, 3.

Для модулей M6 допустимы значения 1, 2, 3, 4.

Варианты:

  • 1
  • 2
  • 3
  • 4

password

string

Задает пароль для аутентификации при подключении к удаленному устройству. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_PASSWORD.

provider

dictionary

Объект dict, содержащий сведения о подключении.

host

string

Задает DNS-имя узла или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.

password

string

Задает пароль для аутентификации при подключении к удаленному устройству. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_PASSWORD.

username

string

Задает имя пользователя для аутентификации при подключении к удаленному устройству. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_USERNAME.

status

string

Состояние политики оповещений. Определяет, включен ли приемник для отправки сообщений в режиме ловушек.

Варианты:

  • "enable"
  • "disable"

trap_port

integer

Порт SNMP-ловушек (1–65535).

Этот параметр поддерживается только моделью M6.

type

string

Тип оповещения.

Этот параметр поддерживается только моделью M5.

Варианты:

  • "snmp"
  • "email"
  • "snmpdomain"

username

string

Задает имя пользователя для аутентификации при подключении к удаленному устройству. Если значение не указано в задаче, вместо него используется значение переменной среды 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 }}"

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

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

Ключ

Описание

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_alert_policy_module.html

Spec-Zone.ru

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