fortinet.fortios.fortios_switch_controller_snmp_community 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中全局配置 FortiSwitch SNMP v1/v2c 团体。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新功能

概要

  • 此模块能够通过允许用户设置和修改 switch_controller 功能和 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"

switch_controller_snmp_community

字典

全局配置 FortiSwitch SNMP v1/v2c 团体。

events

列表 / 元素=字符串

要发送的 SNMP 通知（陷阱）。

选项

  • "cpu-high"

  • "mem-low"

  • "log-full"

  • "intf-ip"

  • "ent-conf-change"

  • "l2mac"

hosts

列表 / 元素=字典

配置 IPv4 SNMP 管理器（主机）。

id

整数 / 必需

主机条目 ID。请参阅 <a href=’#notes’>说明</a>。

ip

字符串

SNMP 管理器（主机）的 IPv4 地址。

id

整数 / 必需

SNMP 团体 ID。请参阅 <a href=’#notes’>说明</a>。

name

字符串

SNMP 团体名称。

query_v1_port

整数

SNMP v1 查询端口。

query_v1_status

字符串

启用/禁用 SNMP v1 查询。

选项

  • "disable"

  • "enable"

query_v2c_port

整数

SNMP v2c 查询端口。

query_v2c_status

字符串

启用/禁用 SNMP v2c 查询。

选项

  • "disable"

  • "enable"

status

字符串

启用/禁用此 SNMP 团体。

选项

  • "disable"

  • "enable"

trap_v1_lport

整数

SNMP v2c 陷阱本地端口。

trap_v1_rport

整数

SNMP v2c 陷阱远程端口。

trap_v1_status

字符串

启用/禁用 SNMP v1 陷阱。

选项

  • "disable"

  • "enable"

trap_v2c_lport

整数

SNMP v2c 陷阱本地端口。

trap_v2c_rport

整数

SNMP v2c 陷阱远程端口。

trap_v2c_status

字符串

启用/禁用 SNMP v2c 陷阱。

选项

  • "disable"

  • "enable"

vdom

字符串

虚拟域，在之前定义的那些中。vdom 是 FortiGate 的一个虚拟实例，可以将其配置并用作不同的单元。

默认值： "root"

说明

注意

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

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

  • 该模块支持 check_mode。

示例

- name: Configure FortiSwitch SNMP v1/v2c communities globally.
  fortinet.fortios.fortios_switch_controller_snmp_community:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_snmp_community:
          events: "cpu-high"
          hosts:
              -
                  id: "5"
                  ip: "<your_own_value>"
          id: "7"
          name: "default_name_8"
          query_v1_port: "161"
          query_v1_status: "disable"
          query_v2c_port: "161"
          query_v2c_status: "disable"
          status: "disable"
          trap_v1_lport: "162"
          trap_v1_rport: "162"
          trap_v1_status: "disable"
          trap_v2c_lport: "162"
          trap_v2c_rport: "162"
          trap_v2c_status: "disable"

返回值

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

键

描述

build

字符串

fortigate 镜像的内部版本号

已返回： 始终

示例： "1547"

http_method

字符串

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

已返回： 始终

示例： "PUT"

http_status

字符串

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

已返回： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主键 (id)

已返回： 成功

示例： "id"

name

字符串

用于满足请求的表的名称

已返回： 始终

示例： "urlfilter"

path

字符串

用于满足请求的表的路径

已返回： 始终

示例： "webfilter"

revision

字符串

内部修订号

已返回： 始终

示例： "17.0.2.10658"

serial

字符串

单元的序列号

已返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

已返回： 始终

示例: "success"

vdom

字符串

使用的虚拟域

已返回： 始终

示例: "root"

版本

字符串

飞塔 (FortiGate) 的版本

已返回： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)