fortinet.fortios.fortios_wireless_controller_snmp 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 SNMP。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

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

要安装它,请使用: ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在 playbook 中使用它,请指定: fortinet.fortios.fortios_wireless_controller_snmp

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 wireless_controller 功能和 snmp 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,在使用前需要将值调整为数据源。已在 FOS v6.0.0 版本上进行了测试。

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性,则以斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时,将忽略 state 选项。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域,在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。

默认值: "root"

wireless_controller_snmp

字典

配置 SNMP。

community

列表 / 元素=字典

SNMP 社区配置。

hosts

列表 / 元素=字典

配置 IPv4 SNMP 管理器 (主机)。

id

整数 / 必需

主机条目 ID。参见 <a href=’#notes’>备注</a>。

ip

字符串

SNMP 管理器 (主机) 的 IPv4 地址。

id

整数 / 必需

社区 ID。参见 <a href=’#notes’>备注</a>。

name

字符串

社区名称。

query_v1_status

字符串

启用/禁用 SNMP v1 查询。

选项

  • "enable"

  • "disable"

query_v2c_status

字符串

启用/禁用 SNMP v2c 查询。

选项

  • "enable"

  • "disable"

status

字符串

启用/禁用此 SNMP 社区。

选项

  • "enable"

  • "disable"

trap_v1_status

字符串

启用/禁用 SNMP v1 陷阱。

选项

  • "enable"

  • "disable"

trap_v2c_status

字符串

启用/禁用 SNMP v2c 陷阱。

选项

  • "enable"

  • "disable"

contact_info

字符串

联系信息。

engine_id

字符串

AC SNMP engineID 字符串(最多 24 个字符)。

trap_high_cpu_threshold

整数

发送陷阱时的 CPU 使用率。

trap_high_mem_threshold

整数

发送陷阱时的内存使用率。

user

列表 / 元素=字典

SNMP 用户配置。

auth_proto

字符串

身份验证协议。

选项

  • "md5"

  • "sha"

auth_pwd

字符串

身份验证协议的密码。

name

字符串 / 必需

SNMP 用户名。

notify_hosts

列表 / 元素=字符串

配置 SNMP 用户通知主机。

priv_proto

字符串

隐私(加密)协议。

选项

  • "aes"

  • "des"

  • "aes256"

  • "aes256cisco"

priv_pwd

字符串

隐私(加密)协议的密码。

queries

字符串

启用/禁用此用户的 SNMP 查询。

选项

  • "enable"

  • "disable"

security_level

字符串

消息身份验证和加密的安全级别。

选项

  • "no-auth-no-priv"

  • "auth-no-priv"

  • "auth-priv"

status

字符串

SNMP 用户启用。

选项

  • "enable"

  • "disable"

trap_status

字符串

启用/禁用此 SNMP 用户的陷阱。

选项

  • "enable"

  • "disable"

备注

注意

  • 旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方法。

示例

- name: Configure SNMP.
  fortinet.fortios.fortios_wireless_controller_snmp:
      vdom: "{{ vdom }}"
      wireless_controller_snmp:
          community:
              -
                  hosts:
                      -
                          id: "5"
                          ip: "<your_own_value>"
                  id: "7"
                  name: "default_name_8"
                  query_v1_status: "enable"
                  query_v2c_status: "enable"
                  status: "enable"
                  trap_v1_status: "enable"
                  trap_v2c_status: "enable"
          contact_info: "<your_own_value>"
          engine_id: "<your_own_value>"
          trap_high_cpu_threshold: "80"
          trap_high_mem_threshold: "80"
          user:
              -
                  auth_proto: "md5"
                  auth_pwd: "<your_own_value>"
                  name: "default_name_21"
                  notify_hosts: "<your_own_value>"
                  priv_proto: "aes"
                  priv_pwd: "<your_own_value>"
                  queries: "enable"
                  security_level: "no-auth-no-priv"
                  status: "enable"
                  trap_status: "enable"

返回值

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

描述

build

字符串

FortiGate 镜像的版本号

返回:始终

示例: "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法

返回:始终

示例: "PUT"

http_status

字符串

FortiGate 在上次应用的操作上给出的最后结果

返回:始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (ID)

返回:成功

示例: "id"

name

字符串

用于完成请求的表的名称

返回:始终

示例: "urlfilter"

path

字符串

用于完成请求的表的路径

返回:始终

示例: "webfilter"

版本号

字符串

内部版本号

返回:始终

示例: "17.0.2.10658"

序列号

字符串

设备序列号

返回:始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回:始终

示例: "success"

vdom

字符串

使用的虚拟域

返回:始终

示例: "root"

版本

字符串

FortiGate版本

返回:始终

示例: "v5.6.3"

作者

  • 郑林 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)