ieisystem.inmanage.edit_alert_policy 模块 – 设置告警策略

注意

此模块是 ieisystem.inmanage 集合(版本 3.0.0)的一部分。

如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install ieisystem.inmanage。您需要更多要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:ieisystem.inmanage.edit_alert_policy

ieisystem.inmanage 1.0.0 中的新增功能

概要

  • 在 ieisystem 服务器上设置告警策略。

要求

执行此模块的主机需要满足以下要求。

  • Python 3.7+

  • inManage

参数

参数

注释

通道

字符串

LAN 通道。

仅 M5 型号支持此参数。

选择

  • "共享"

  • "专用"

目的地

字符串

告警目的地。接收 Trap 发送的 trap 信息的服务器地址。

当类型为 snmp 时,请指定 IP 地址。

当类型为 email 时,请指定用户名。

当类型为 snmpdomain 时,请指定域名。

主机

字符串

指定 DNS 主机名或地址,以便通过指定的传输连接到远程设备。主机的值用作传输的目标地址。

ID

整数 / 必填

告警 ID。自定义 Trap 中发送告警的通道。

M5 模块的值为 1、2、3。

M6 模块的值为 1、2、3、4。

选择

  • 1

  • 2

  • 3

  • 4

密码

字符串

指定用于验证与远程设备连接的密码。如果未在任务中指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值。

提供程序

字典

包含连接详细信息的 dict 对象。

主机

字符串

指定 DNS 主机名或地址,以便通过指定的传输连接到远程设备。主机的值用作传输的目标地址。

密码

字符串

指定用于验证与远程设备连接的密码。如果未在任务中指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值。

用户名

字符串

配置用于验证与远程设备连接的用户名。如果未在任务中指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值。

状态

字符串

告警策略状态。是否启用接收端以在 trap 模式下发送消息。

选择

  • "启用"

  • "禁用"

trap_port

整数

SNMP trap 端口 (1-65535)。

仅 M6 型号支持此参数。

类型

字符串

告警类型。

仅 M5 型号支持此参数。

选择

  • "snmp"

  • "email"

  • "snmpdomain"

用户名

字符串

配置用于验证与远程设备连接的用户名。如果未在任务中指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值。

说明

注意

  • 不支持 check_mode

示例

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

  tasks:

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

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

返回值

常见的返回值记录在 此处,以下是此模块特有的字段

描述

已更改

布尔值

检查设备上是否进行了更改。

返回: 总是

消息

字符串

模块执行后返回的消息。

返回: 总是

状态

字符串

模块执行后的状态。

返回: 总是

作者

  • WangBaoshan (@ieisystem)