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

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_snmp_community。

fortinet.fortios 2.0.0 中的新增功能

概要

• 此模块能够通过允许用户设置和修改 system_snmp 功能和 community 类别来配置 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"
state 字符串 / 必需	指示是创建还是删除对象。 选项 "present" "absent"
system_snmp_community 字典	SNMP community 配置。
events 列表 / 元素=字符串	SNMP 陷阱事件。 选项 "cpu-high" "mem-low" "log-full" "intf-ip" "vpn-tun-up" "vpn-tun-down" "ha-switch" "ha-hb-failure" "ips-signature" "ips-anomaly" "av-virus" "av-oversize" "av-pattern" "av-fragmented" "fm-if-change" "fm-conf-change" "bgp-established" "bgp-backward-transition" "ha-member-up" "ha-member-down" "ent-conf-change" "av-conserve" "av-bypass" "av-oversize-passed" "av-oversize-blocked" "ips-pkg-update" "ips-fail-open" "faz-disconnect" "faz" "wc-ap-up" "wc-ap-down" "fswctl-session-up" "fswctl-session-down" "load-balance-real-server-down" "device-new" "per-cpu-high" "dhcp" "pool-usage" "ippool" "interface" "ospf-nbr-state-change" "ospf-virtnbr-state-change" "temperature-high" "voltage-alert" "power-supply" "fan-failure" "power-supply-failure"
hosts 列表 / 元素=字典	配置 IPv4 SNMP 管理器 (主机)。
ha_direct 字符串	启用/禁用 HA 集群成员的直接管理。 选项 "enable" "disable"
host_type 字符串	控制 SNMP 管理器是否发送 SNMP 查询、接收 SNMP 陷阱或同时进行两者操作。当 IP 类型为子网时，不会发送任何陷阱。 选项 "any" "query" "trap"
id 整数 / 必需	主机条目 ID。请参阅 注释。
interface 字符串	指定到达服务器的出站接口。源 system.interface.name。
interface_select_method 字符串	指定如何选择到达服务器的出站接口。 选项 "auto" "sdwan" "specify"
ip 字符串	SNMP 管理器 (主机) 的 IPv4 地址。
source_ip 字符串	SNMP 陷阱的源 IPv4 地址。
hosts6 列表 / 元素=字典	配置 IPv6 SNMP 管理器。
ha_direct 字符串	启用/禁用 HA 集群成员的直接管理。 选项 "enable" "disable"
host_type 字符串	控制 SNMP 管理器是否发送 SNMP 查询、接收 SNMP 陷阱或同时进行两者操作。 选项 "any" "query" "trap"
id 整数 / 必需	Host6 条目 ID。请参阅 注释。
interface 字符串	指定到达服务器的出站接口。源 system.interface.name。
interface_select_method 字符串	指定如何选择到达服务器的出站接口。 选项 "auto" "sdwan" "specify"
ipv6 字符串	SNMP 管理器 IPv6 地址前缀。
source_ipv6 字符串	SNMP 陷阱的源 IPv6 地址。
id 整数 / 必需	Community ID。请参阅 注释。
mib_view 字符串	SNMP 访问控制 MIB 视图。源 system.snmp.mib-view.name。
name 字符串	Community 名称。
query_v1_port 整数	SNMP v1 查询端口。
query_v1_status 字符串	启用/禁用 SNMP v1 查询。 选项 "enable" "disable"
query_v2c_port 整数	SNMP v2c 查询端口。
query_v2c_status 字符串	启用/禁用 SNMP v2c 查询。 选项 "enable" "disable"
status 字符串	启用/禁用此 SNMP community。 选项 "enable" "disable"
trap_v1_lport 整数	SNMP v1 陷阱本地端口。
trap_v1_rport 整数	SNMP v1 陷阱远程端口。
trap_v1_status 字符串	启用/禁用 SNMP v1 陷阱。 选项 "enable" "disable"
trap_v2c_lport 整数	SNMP v2c 陷阱本地端口。
trap_v2c_rport 整数	SNMP v2c 陷阱远程端口。
trap_v2c_status 字符串	启用/禁用 SNMP v2c 陷阱。 选项 "enable" "disable"
vdoms 列表 / 元素=字典	SNMP 访问控制 VDOM。
name 字符串 / 必需	VDOM 名称。源 system.vdom.name。
vdom 字符串	虚拟域，在先前定义的那些虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置和用作不同的单元。 默认值： "root"

注释

注意

• 我们强烈建议使用您自己的值作为 id，而不是 0，虽然“0”是一个特殊的占位符，允许后端为对象分配最新的可用编号，但它确实存在局限性。请在问答中查找更多详细信息。

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

• 该模块支持 check_mode。

示例

- name: SNMP community configuration.
  fortinet.fortios.fortios_system_snmp_community:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_community:
          events: "cpu-high"
          hosts:
              -
                  ha_direct: "enable"
                  host_type: "any"
                  id: "7"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  ip: "<your_own_value>"
                  source_ip: "84.230.14.43"
          hosts6:
              -
                  ha_direct: "enable"
                  host_type: "any"
                  id: "15"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  ipv6: "<your_own_value>"
                  source_ipv6: "<your_own_value>"
          id: "20"
          mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
          name: "default_name_22"
          query_v1_port: "161"
          query_v1_status: "enable"
          query_v2c_port: "161"
          query_v2c_status: "enable"
          status: "enable"
          trap_v1_lport: "162"
          trap_v1_rport: "162"
          trap_v1_status: "enable"
          trap_v2c_lport: "162"
          trap_v2c_rport: "162"
          trap_v2c_status: "enable"
          vdoms:
              -
                  name: "default_name_35 (source system.vdom.name)"

返回值

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

键	描述
build 字符串	FortiGate镜像的构建编号 返回值：始终返回 示例： "1547"
http_method 字符串	上次用于将内容置备到FortiGate的方法 返回值：始终返回 示例： "PUT"
http_status 字符串	FortiGate在上次应用的操作中给出的最后结果 返回值：始终返回 示例： "200"
mkey 字符串	上次调用FortiGate时使用的主密钥（ID） 返回值：成功 示例： "id"
name 字符串	name 返回值：始终返回 用于满足请求的表的名称
示例： "urlfilter" 字符串	path 返回值：始终返回 用于满足请求的表的路径
示例： "webfilter" 字符串	revision 返回值：始终返回 内部修订号
示例： "17.0.2.10658" 字符串	serial 返回值：始终返回 设备的序列号
status 字符串	示例： "FGVMEVYYQT3AB5352" 返回值：始终返回 result
vdom 字符串	操作结果指示 返回值：始终返回 示例： "success"
vdom 字符串	使用的虚拟域 返回值：始终返回 示例： "root"

version

• FortiGate的版本

• 示例： "v5.6.3"

• 作者

• 郑林 (@chillancezen)

• 薛杰 (@JieX19)

• 卢洪斌 (@fgtdev-hblu)

沈芳 (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)
• 资源链接