kaytus.ksmanage.edit_snmp 模块 – 设置 snmp

注意

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

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

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

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

kaytus.ksmanage 1.0.0 中的新增功能

概要 

在 kaytus 服务器上设置 snmp。

要求 

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

Python 3.7+
inManage

参数 

参数	注释
auth_password 字符串	设置 V3 陷阱或 v3get/v3set 的身份验证密码。密码是 8 到 16 个字母数字字符的字符串。当 auth_protocol 为 `SHA` 或 `MD5` 时是必需的。
auth_protocol 字符串	为 V3 陷阱或 v3get/v3set 选择身份验证协议。选项 `"NONE"` `"SHA"` `"MD5"`
community 字符串	v1/v2c 或 v1get/v1set/v2cget/v2cset 的团体。只有 M5 型号支持此功能。
host 字符串	指定 DNS 主机名或地址，用于通过指定的传输连接到远程设备。主机的值用作传输的目标地址。
password 字符串	指定用于验证与远程设备连接的密码。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_PASSWORD` 的值。
priv_password 字符串	设置 V3 陷阱或 v3get/v3set 的隐私密码。密码是 8 到 16 个字母数字字符的字符串。当 priv_protocol 为 `DES` 或 `AES` 时是必需的。
priv_protocol 字符串	为 V3 陷阱或 v3get/v3set 选择隐私协议。选项 `"NONE"` `"DES"` `"AES"`
provider 字典	包含连接详细信息的字典对象。
host 字符串	指定 DNS 主机名或地址，用于通过指定的传输连接到远程设备。主机的值用作传输的目标地址。
password 字符串	指定用于验证与远程设备连接的密码。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_PASSWORD` 的值。
username 字符串	配置用于验证与远程设备连接的用户名。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_USERNAME` 的值。
read_community 字符串	只读团体，团体应介于 1 到 16 个字符之间。只有 M6 型号支持此功能。
read_write_community 字符串	读写团体，团体应介于 1 到 16 个字符之间。只有 M6 型号支持此功能。
snmp_status 列表 / 元素=字符串	自定义的 NMP 读/写状态。输入参数为 'v1get'、'v1set'、'v2cget'、'v2cset'、'v3get'、'v3set'，用逗号分隔，例如 v1get, v1set, v2cget。只有 M5 型号支持此功能。
username 字符串	配置用于验证与远程设备连接的用户名。如果任务中未指定该值，则将使用环境变量 `ANSIBLE_NET_USERNAME` 的值。
v1status 字符串	SNMP V1 启用。选项 `"enable"` `"disable"`
v2status 字符串	SNMP V2 启用。选项 `"enable"` `"disable"`
v3status 字符串	SNMP V3 启用。选项 `"enable"` `"disable"`
v3username 字符串	为 V3 陷阱或 v3get/v3set 设置用户名。
version 整数	SNMP 陷阱版本选项，0 - 'v1'，1 - 'v2c'，2 - 'v3'，3 - 'all'，4 - 'customize'。只有 M5 型号支持此功能。选项 `0` `1` `2` `3` `4`

说明 

注意

不支持 check_mode。

示例 

- name: Snmp 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 get/set"
    kaytus.ksmanage.edit_snmp:
      community: "test"
      v3username: "test"
      provider: "{{ ksmanage }}"

返回值 

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

键	描述
changed 布尔值	检查设备是否进行了更改。返回: 始终
message 字符串	模块执行后返回的消息。返回: 始终
state 字符串	模块执行后的状态。返回: 始终

作者

WangBaoshan (@ieisystem)