fortinet.fortios.fortios_system_snmp_community 模块 – 在 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_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 社区配置。
events 列表 / 元素=字符串	SNMP trap 事件。 选项 "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 trap，还是两者都执行。当 IP 类型为子网时，将不会发送 trap。 选项 "any" "query" "trap"
id 整数 / 必需	主机条目 ID。请参阅 <a href=’#notes’>注意事项</a>。
interface 字符串	指定用于访问服务器的传出接口。来源 system.interface.name。
interface_select_method 字符串	指定如何选择用于访问服务器的传出接口。 选项 "auto" "sdwan" "specify"
ip 字符串	SNMP 管理器（主机）的 IPv4 地址。
source_ip 字符串	SNMP trap 的源 IPv4 地址。
hosts6 列表 / 元素=字典	配置 IPv6 SNMP 管理器。
ha_direct 字符串	启用/禁用 HA 集群成员的直接管理。 选项 "enable" "disable"
host_type 字符串	控制 SNMP 管理器是发送 SNMP 查询、接收 SNMP trap，还是两者都执行。 选项 "any" "query" "trap"
id 整数 / 必需	Host6 条目 ID。请参阅 <a href=’#notes’>注意事项</a>。
interface 字符串	指定用于访问服务器的传出接口。来源 system.interface.name。
interface_select_method 字符串	指定如何选择用于访问服务器的传出接口。 选项 "auto" "sdwan" "specify"
ipv6 字符串	SNMP 管理器 IPv6 地址前缀。
source_ipv6 字符串	SNMP trap 的源 IPv6 地址。
id 整数 / 必需	社区 ID。请参阅 <a href=’#notes’>注意事项</a>。
mib_view 字符串	SNMP 访问控制 MIB 视图。来源 system.snmp.mib-view.name。
name 字符串	社区名称。
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 社区。 选项 "enable" "disable"
trap_v1_lport 整数	SNMP v1 trap 本地端口。
trap_v1_rport 整数	SNMP v1 trap 远程端口。
trap_v1_status 字符串	启用/禁用 SNMP v1 trap。 选项 "enable" "disable"
trap_v2c_lport 整数	SNMP v2c trap 本地端口。
trap_v2c_rport 整数	SNMP v2c trap 远程端口。
trap_v2c_status 字符串	启用/禁用 SNMP v2c trap。 选项 "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) 返回: success 示例: "id"
name 字符串	用于满足请求的表的名称 已返回：始终 示例: "urlfilter"
path 字符串	用于满足请求的表的路径 已返回：始终 示例: "webfilter"
revision 字符串	内部修订号 已返回：始终 示例: "17.0.2.10658"
serial 字符串	设备的序列号 已返回：始终 示例: "FGVMEVYYQT3AB5352"
status 字符串	操作结果的指示 已返回：始终 示例: "success"
vdom 字符串	使用的虚拟域 已返回：始终 示例: "root"
version 字符串	FortiGate 的版本 已返回：始终 示例: "v5.6.3"

作者

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）