kaytus.ksmanage.edit_snmp_trap 模块 – 设置 SNMP Trap

注意

此模块是 kaytus.ksmanage 集合 (版本 2.0.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install kaytus.ksmanage。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：kaytus.ksmanage.edit_snmp_trap。

kaytus.ksmanage 1.0.0 中的新增功能

概要 

在 kaytus 服务器上设置 SNMP trap。

要求 

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

Python 3.7+
inManage

参数 

参数	注释
auth_password 字符串	设置 V3 trap 的身份验证密码。密码是 8 到 16 个字母数字字符的字符串。当 auth_protocol 为 `SHA` 或 `MD5` 时是必需的。
auth_protocol 字符串	选择 V3 trap 的身份验证协议。选择 `"NONE"` `"SHA"` `"MD5"`
community 字符串	v1/v2c 的 community。
contact 字符串	设置联系人，可以为 NULL。只有 M5 型号支持此参数。
engine_id 字符串	指定 V3 trap 的引擎标识符。该值应该是 10 到 48 个十六进制字符的字符串，必须是偶数，可以为 NULL。
event_severity 字符串	事件严重性。选择 `"all"` `"warning"` `"critical"`
host 字符串	指定 DNS 主机名或地址，用于通过指定的传输连接到远程设备。主机的值用作传输的目标地址。
host_id 字符串	主机 ID。只有 M6 型号支持此参数。选择 `"HostName"` `"SerialNum"` `"AssertTag"`
location 字符串	设置主机位置，可以为 NULL。只有 M5 型号支持此参数。
os 字符串	设置主机操作系统，可以为 NULL。只有 M5 型号支持此参数。
password 字符串	指定用于验证与远程设备连接的密码。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_PASSWORD` 的值。
priv_password 字符串	设置 V3 trap 的隐私密码。密码是 8 到 16 个字母数字字符的字符串。当 priv_protocol 为 `DES` 或 `AES` 时是必需的。
priv_protocol 字符串	选择 V3 trap 的隐私协议。选择 `"NONE"` `"DES"` `"AES"`
provider 字典	包含连接详细信息的字典对象。
host 字符串	指定 DNS 主机名或地址，用于通过指定的传输连接到远程设备。主机的值用作传输的目标地址。
password 字符串	指定用于验证与远程设备连接的密码。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_PASSWORD` 的值。
username 字符串	配置用于验证与远程设备连接的用户名。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_USERNAME` 的值。
system_id 字符串	设置系统 ID，可以为 NULL。只有 M5 型号支持此参数。
system_name 字符串	设置系统名称，可以为 NULL。只有 M5 型号支持此参数。
trap_port 整数	设置 SNMP trap 的端口，范围为 1 到 65535。只有 M5 型号支持此参数。
username 字符串	配置用于验证与远程设备连接的用户名。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_USERNAME` 的值。
v3username 字符串	设置 V3 trap 的用户名。
version 整数	SNMP trap 版本，1 是 v1，2 是 v2c(v2)，3 是 v3，0 是禁用 SNMP trap。只有 M6 型号支持 `0` 设置。选择 `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 布尔值	检查设备上是否进行了更改。已返回：始终
message 字符串	模块执行后返回的消息。已返回：始终
state 字符串	模块执行后的状态。已返回：始终

作者

WangBaoshan (@ieisystem)