fortinet.fortios.fortios_switch_controller_managed_switch 模块 – 在 Fortinet FortiOS 和 FortiGate 中配置由此 FortiGate 管理的 FortiSwitch 设备。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块,有关详细信息,请参阅 要求

要在 Playbook 中使用它,请指定:fortinet.fortios.fortios_switch_controller_managed_switch

在 fortinet.fortios 2.0.0 中新增

概要

  • 此模块能够通过允许用户设置和修改 switch_controller 功能和 managed_switch 类别来配置 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_managed_switch

字典

配置由此 FortiGate 管理的 FortiSwitch 设备。

access_profile

字符串

FortiSwitch 访问配置文件。源 switch-controller.security-policy.local-access.name。

custom_command

列表 / elements=字典

配置方法,用于编辑在重启 FortiGate 交换机控制器或 FortiSwitch 时要推送到此 FortiSwitch 设备的 FortiSwitch 命令。

command_entry

字符串 / 必需

FortiSwitch 命令列表。

command_name

字符串

要推送到此 FortiSwitch 设备的命令的名称,如在 config switch-controller custom-command 下配置的那样。源 switch-controller.custom-command.command-name。

delayed_restart_trigger

整数

为此 FortiSwitch 触发的延迟重启。

description

字符串

描述。

dhcp_server_access_list

字符串

DHCP 侦听服务器访问列表。

选项

  • "global"

  • "enable"

  • "disable"

dhcp_snooping_static_client

列表 / elements=字典

配置 FortiSwitch DHCP 侦听静态客户端。

ip

字符串

客户端静态 IP 地址。

mac

字符串

客户端 MAC 地址。

name

字符串 / 必需

客户端名称。

port

字符串

接口名称。

vlan

字符串

VLAN 名称。源 system.interface.name。

directly_connected

整数

直接连接的 FortiSwitch。

dynamic_capability

字符串

此 FortiSwitch 支持的功能列表(不可配置),该列表被发送到 FortiGate 设备,以便由 FortiGate 设备启动后续配置。

dynamically_discovered

整数

动态发现的 FortiSwitch。

firmware_provision

字符串

启用/禁用在加入连接时将固件配置到 FortiSwitch。

选项

  • "enable"

  • "disable"

firmware_provision_latest

字符串

启用/禁用一次性自动配置最新固件版本。

选项

  • "disable"

  • "once"

firmware_provision_version

字符串

要在启动时配置到此 FortiSwitch 的固件版本(major.minor.build,例如 6.2.1234)。

flow_identity

字符串

十六进制格式的流跟踪 netflow ipfix 交换机标识 (00000000-FFFFFFFF)。

fsw_wan1_admin

字符串

FortiSwitch WAN1 管理状态;启用以授权 FortiSwitch 作为托管交换机。

选项

  • "discovered"

  • "disable"

  • "enable"

fsw_wan1_peer

字符串

FortiSwitch WAN1 对等端口。源 system.interface.name。

fsw_wan2_admin

字符串

FortiSwitch WAN2 管理状态;启用以授权 FortiSwitch 作为托管交换机。

选项

  • "discovered"

  • "disable"

  • "enable"

fsw_wan2_peer

字符串

FortiSwitch WAN2 对等端口。

igmp_snooping

字典

配置 FortiSwitch IGMP 侦听全局设置。

aging_time

整数

保留未看到数据包的多播侦听条目的最长时间(15 - 3600 秒)。

flood_unknown_multicast

字符串

启用/禁用未知多播洪泛。

选项

  • "enable"

  • "disable"

local_override

字符串

启用/禁用覆盖全局 IGMP 侦听配置。

选项

  • "enable"

  • "disable"

vlans

列表 / elements=字典

配置 IGMP 侦听 VLAN。

proxy

字符串

VLAN 接口的 IGMP 侦听代理。

选项

  • "disable"

  • "enable"

  • "global"

querier

字符串

启用/禁用 VLAN 接口的 IGMP 侦听查询器。

选项

  • "disable"

  • "enable"

querier_addr

字符串

IGMP 侦听查询器地址。

version

整数

IGMP 侦听查询版本。

vlan_name

字符串 / 必需

FortiSwitch VLAN 列表。来源 system.interface.name。

ip_source_guard

列表 / elements=字典

IP 源保护。

binding_entry

列表 / elements=字典

IP 和 MAC 地址配置。

entry_name

字符串 / 必需

配置绑定对。

ip

字符串

此规则的源 IP。

mac

字符串

此规则的 MAC 地址。

description

字符串

描述。

port

字符串 / 必需

源保护绑定的入口接口。

l3_discovered

整数

已发现的第 3 层管理。

max_allowed_trunk_members

整数

FortiSwitch 允许的最大中继成员数。

mclag_igmp_snooping_aware

字符串

启用/禁用 MCLAG IGMP 侦听感知。

选项

  • "enable"

  • "disable"

mgmt_mode

整数

FortiLink 管理模式。

mirror

列表 / elements=字典

编辑 FortiSwitch 数据包镜像的配置方法。

dst

字符串

目标端口。

name

字符串 / 必需

镜像名称。

src_egress

列表 / elements=字典

源出口接口。

name

字符串 / 必需

接口名称。

src_ingress

列表 / elements=字典

源入口接口。

name

字符串 / 必需

接口名称。

status

字符串

激活/非激活镜像配置。

选项

  • "active"

  • "inactive"

switching_packet

字符串

启用/禁用镜像时的交换功能。

选项

  • "enable"

  • "disable"

name

字符串

受管交换机名称。

override_snmp_community

字符串

启用/禁用覆盖全局 SNMP 团体。

选项

  • "enable"

  • "disable"

override_snmp_sysinfo

字符串

启用/禁用覆盖全局 SNMP 系统信息。

选项

  • "disable"

  • "enable"

override_snmp_trap_threshold

字符串

启用/禁用覆盖全局 SNMP 陷阱阈值。

选项

  • "enable"

  • "disable"

override_snmp_user

字符串

启用/禁用覆盖全局 SNMP 用户。

选项

  • "enable"

  • "disable"

owner_vdom

字符串

端口所属的 VDOM。

poe_detection_type

整数

FortiSwitch 的 PoE 检测类型。

poe_lldp_detection

字符串

启用/禁用 PoE LLDP 检测。

选项

  • "enable"

  • "disable"

poe_pre_standard_detection

字符串

启用/禁用 PoE 预标准检测。

选项

  • "enable"

  • "disable"

ports

列表 / elements=字典

受管交换机端口列表。

access_mode

字符串

端口的访问模式。

选项

  • "dynamic"

  • "nac"

  • "static"

  • "normal"

acl_group

列表 / elements=字典

此端口上的 ACL 组。

name

字符串 / 必需

ACL 组名称。来源 switch-controller.acl.group.name。

aggregator_mode

字符串

LACP 成员选择模式。

选项

  • "bandwidth"

  • "count"

allow_arp_monitor

字符串

启用/禁用允许 ARP 监视。

选项

  • "disable"

  • "enable"

allowed_vlans

列表 / elements=字典

配置交换机端口标记的 VLAN。

vlan_name

字符串 / 必需

VLAN 名称。源 system.interface.name。

allowed_vlans_all

字符串

启用/禁用此端口上的所有已定义 VLAN。

选项

  • "enable"

  • "disable"

arp_inspection_trust

字符串

受信任或不受信任的动态 ARP 检查。

选项

  • "untrusted"

  • "trusted"

bundle

字符串

启用/禁用非 FortiLink 接口的链路聚合组 (LAG) 绑定。

选项

  • "enable"

  • "disable"

description

字符串

端口的描述。

dhcp_snoop_option82_override

列表 / elements=字典

配置 DHCP 侦听选项 82 覆盖。

circuit_id

字符串

电路 ID 字符串。

remote_id

字符串

远程 ID 字符串。

vlan_name

字符串 / 必需

DHCP 侦听选项 82 VLAN。来源 system.interface.name。

dhcp_snoop_option82_trust

字符串

启用/禁用在不受信任的接口上允许使用选项 82 的 DHCP。

选项

  • "enable"

  • "disable"

dhcp_snooping

字符串

受信任或不受信任的 DHCP 侦听接口。

选项

  • "untrusted"

  • "trusted"

discard_mode

字符串

配置端口的丢弃模式。

选项

  • "none"

  • "all-untagged"

  • "all-tagged"

edge_port

字符串

启用/禁用此接口作为边缘端口,桥接工作站和/或计算机之间的连接。

选项

  • "enable"

  • "disable"

export_tags

列表 / elements=字典

配置导出到虚拟端口池时 FortiSwitch 端口的导出标签。

tag_name

字符串 / 必需

导出到虚拟端口池时 FortiSwitch 端口的标签名称。来源 switch-controller.switch-interface-tag.name。

export_to

字符串

将受管交换机端口导出到租户 VDOM。来源 system.vdom.name。

export_to_pool

字符串

交换机控制器将端口导出到池列表。来源 switch-controller.virtual-port-pool.name。

export_to_pool_flag

整数

交换机控制器将端口导出到池列表。

fallback_port

字符串

LACP 备用端口。

fec_capable

整数

FEC 功能。

fec_state

字符串

前向纠错的状态。

选项

  • "disabled"

  • "cl74"

  • "cl91"

  • "detect-by-module"

fgt_peer_device_name

字符串

FGT 对等设备名称。

fgt_peer_port_name

字符串

FGT 对等端口名称。

fiber_port

整数

光纤端口。

flags

整数

端口属性标志。

flap_duration

整数

计算抖动事件的时间段(秒)。

flap_rate

整数

抖动持续时间内需要的状态更改事件数。

flap_timeout

整数

抖动保护禁用保护(分钟)。

flapguard

字符串

启用/禁用抖动保护。

选项

  • "enable"

  • "disable"

flow_control

字符串

流控制方向。

选项

  • "disable"

  • "tx"

  • "rx"

  • "both"

整数

FortiLink 上行链路端口。

fortiswitch_acls

列表 / elements=字典

此端口上的 ACL。

id

integer / required

ACL ID。请参阅 <a href=’#notes’>备注</a>。

igmp_snooping

字符串

为物理端口接口设置 IGMP 侦听模式。

选项

  • "enable"

  • "disable"

igmp_snooping_flood_reports

字符串

启用/禁用在启用 IGMP 侦听时将 IGMP 报告泛洪到此接口。

选项

  • "enable"

  • "disable"

igmps_flood_reports

字符串

启用/禁用在启用 IGMP 侦听时将 IGMP 报告泛洪到此接口。

选项

  • "enable"

  • "disable"

igmps_flood_traffic

字符串

启用/禁用将 IGMP 侦听流量泛洪到此接口。

选项

  • "enable"

  • "disable"

interface_tags

列表 / elements=字典

与接口关联的标签,用于包括虚拟端口池、动态端口策略在内的各种功能。

tag_name

字符串 / 必需

导出到虚拟端口池或匹配到动态端口策略时,FortiSwitch 端口的标签名称。来源 switch-controller.switch-interface-tag.name。

ip_source_guard

字符串

启用/禁用 IP 源保护。

选项

  • "disable"

  • "enable"

isl_local_trunk_name

字符串

ISL 本地中继名称。

isl_peer_device_name

字符串

ISL 对等设备名称。

isl_peer_port_name

字符串

ISL 对等端口名称。

lacp_speed

字符串

每 30 秒(慢速)或每秒(快速)发送一次链路聚合控制协议 (LACP) 消息。

选项

  • "slow"

  • "fast"

learning_limit

整数

限制此端口上的动态 MAC 地址数量 (1 - 128,0 = 无限制,默认)。

lldp_profile

字符串

LLDP 端口 TLV 配置文件。来源 switch-controller.lldp-profile.name。

lldp_status

字符串

LLDP 传输和接收状态。

选项

  • "disable"

  • "rx-only"

  • "tx-only"

  • "tx-rx"

log_mac_event

字符串

启用/禁用动态 MAC 地址事件的日志记录。

选项

  • "disable"

  • "enable"

loop_guard

字符串

启用/禁用此接口上的环路保护,这是一种用于防止网络环路的 STP 优化。

选项

  • "enabled"

  • "disabled"

loop_guard_timeout

整数

环路保护超时(0 - 120 分钟)。

mac_addr

字符串

端口/中继 MAC。

matched_dpp_intf_tags

字符串

动态端口策略中匹配的接口标签。

matched_dpp_policy

字符串

动态端口策略中匹配的子策略。

max_bundle

整数

LAG 捆绑的最大大小 (1 - 24)。

mcast_snooping_flood_traffic

字符串

启用/禁用将 IGMP 侦听流量泛洪到此接口。

选项

  • "enable"

  • "disable"

mclag

字符串

启用/禁用多机箱链路聚合 (MCLAG)。

选项

  • "enable"

  • "disable"

mclag_icl_port

整数

MCLAG-ICL 端口。

media_type

字符串

介质类型。

member_withdrawal_behavior

字符串

端口因丢失控制数据包而撤回后的行为。

选项

  • "forward"

  • "block"

members

列表 / elements=字典

聚合的 LAG 捆绑接口。

member_name

字符串 / 必需

来自可用选项的接口名称。

min_bundle

整数

LAG 捆绑的最小大小 (1 - 24)。

mode

字符串

LACP 模式:忽略且不发送控制消息,或被动或主动协商 802.3ad 聚合。

选项

  • "static"

  • "lacp-passive"

  • "lacp-active"

p2p_port

整数

通用对等隧道端口。

packet_sample_rate

整数

数据包采样率 (0 - 99999 p/秒)。

packet_sampler

字符串

启用/禁用此接口上的数据包采样。

选项

  • "enabled"

  • "disabled"

pause_meter

整数

配置入口暂停计量速率,单位为 kbps。

pause_meter_resume

字符串

恢复入口端口上流量的恢复阈值。

选项

  • "75%"

  • "50%"

  • "25%"

pd_capable

整数

受电设备功能。

poe_capable

整数

PoE 功能。

poe_max_power

字符串

PoE 最大功率。

poe_mode_bt_cabable

整数

PoE 模式 IEEE 802.3BT 功能。

poe_port_mode

字符串

配置 PoE 端口模式。

选项

  • "ieee802-3af"

  • "ieee802-3at"

  • "ieee802-3bt"

poe_port_power

字符串

配置 PoE 端口功率。

选项

  • "normal"

  • "perpetual"

  • "perpetual-fast"

poe_port_priority

字符串

配置 PoE 端口优先级。

选项

  • "critical-priority"

  • "high-priority"

  • "low-priority"

  • "medium-priority"

poe_pre_standard_detection

字符串

启用/禁用 PoE 预标准检测。

选项

  • "enable"

  • "disable"

poe_standard

字符串

支持的 PoE 标准。

poe_status

字符串

启用/禁用 PoE 状态。

选项

  • "enable"

  • "disable"

port_name

字符串 / 必需

交换机端口名称。

port_number

整数

端口号。

port_owner

字符串

交换机端口名称。

port_policy

字符串

来自可用选项的交换机控制器动态端口策略。来源 switch-controller.dynamic-port-policy.name。

port_prefix_type

整数

端口前缀类型。

port_security_policy

字符串

来自可用选项的交换机控制器身份验证策略,以应用于此受管交换机。来源 switch-controller .security-policy.802-1X.name。

port_selection_criteria

字符串

聚合端口选择的算法。

选项

  • "src-mac"

  • "dst-mac"

  • "src-dst-mac"

  • "src-ip"

  • "dst-ip"

  • "src-dst-ip"

ptp_policy

字符串

PTP 策略配置。来源 switch-controller.ptp.interface-policy.name。

ptp_status

字符串

启用/禁用此 FortiSwitch 端口上的 PTP 策略。

选项

  • "disable"

  • "enable"

qnq

字符串

VDOM 中的 802.1AD VLAN。来源 system.interface.name。

qos_policy

字符串

来自可用选项的交换机控制器 QoS 策略。来源 switch-controller.qos.qos-policy.name。

rpvst_port

字符串

启用/禁用此接口上与快速 PVST 的互操作性。

选项

  • "disabled"

  • "enabled"

sample_direction

字符串

数据包采样方向。

选项

  • "tx"

  • "rx"

  • "both"

sflow_counter_interval

整数

sFlow 采样计数器轮询间隔(秒)(0 - 255)。

sflow_sample_rate

整数

sFlow 采样器采样率(0 - 99999 p/秒)。

sflow_sampler

字符串

启用/禁用此接口上的 sFlow 协议。

选项

  • "enabled"

  • "disabled"

speed

字符串

交换机端口速度;默认设置和可用设置取决于硬件。

选项

  • "10half"

  • "10full"

  • "100half"

  • "100full"

  • "1000full"

  • "10000full"

  • "auto"

  • "1000auto"

  • "1000full-fiber"

  • "40000full"

  • "auto-module"

  • "100FX-half"

  • "100FX-full"

  • "100000full"

  • "2500auto"

  • "2500full"

  • "25000full"

  • "50000full"

  • "10000cr"

  • "10000sr"

  • "100000sr4"

  • "100000cr4"

  • "40000sr4"

  • "40000cr4"

  • "40000auto"

  • "25000cr"

  • "25000sr"

  • "50000cr"

  • "50000sr"

  • "5000auto"

  • "1000fiber"

  • "10000"

  • "40000"

  • "25000cr4"

  • "25000sr4"

  • "5000full"

speed_mask

整数

交换机端口速度掩码。

stacking_port

整数

堆叠端口。

status

字符串

交换机端口管理状态:up 或 down。

选项

  • "up"

  • "down"

sticky_mac

字符串

启用或禁用接口上的粘性 MAC。

选项

  • "enable"

  • "disable"

storm_control_policy

字符串

来自可用选项的交换机控制器风暴控制策略。来源 switch-controller.storm-control-policy.name。

stp_bpdu_guard

字符串

启用/禁用此接口上的 STP BPDU 保护。

选项

  • "enabled"

  • "disabled"

stp_bpdu_guard_timeout

整数

BPDU 保护禁用保护(0 - 120 分钟)。

stp_root_guard

字符串

启用/禁用此接口上的 STP 根保护。

选项

  • "enabled"

  • "disabled"

stp_state

字符串

启用/禁用此接口上的生成树协议 (STP)。

选项

  • "enabled"

  • "disabled"

switch_id

字符串

交换机 ID。

type

字符串

接口类型:物理端口或中继端口。

选项

  • "physical"

  • "trunk"

untagged_vlans

列表 / elements=字典

配置交换机端口的未标记 VLAN。

vlan_name

字符串 / 必需

VLAN 名称。源 system.interface.name。

virtual_port

整数

虚拟化交换机端口。

vlan

字符串

将交换机端口分配给 VLAN。源系统.接口.名称。

pre_provisioned

整数

预配置的托管交换机。

ptp_profile

字符串

PTP 配置文件配置。源 switch-controller.ptp.profile.name。

ptp_status

字符串

在此 FortiSwitch 上启用/禁用 PTP 配置文件。

选项

  • "disable"

  • "enable"

purdue_level

字符串

此 FortiSwitch 的 Purdue 等级。

选项

  • "1"

  • "1.5"

  • "2"

  • "2.5"

  • "3"

  • "3.5"

  • "4"

  • "5"

  • "5.5"

qos_drop_policy

字符串

设置 QoS 丢弃策略。

选项

  • "taildrop"

  • "random-early-detection"

qos_red_probability

整数

设置 QoS RED/WRED 丢弃概率。

radius_nas_ip

字符串

NAS-IP 地址。

radius_nas_ip_override

字符串

使用本地定义的 NAS-IP。

选项

  • "disable"

  • "enable"

remote_log

列表 / elements=字典

配置 FortiSwitch 设备将日志记录到远程 syslog 服务器。

csv

字符串

启用/禁用逗号分隔值 (CSV) 字符串。

选项

  • "enable"

  • "disable"

facility

字符串

记录到远程 syslog 服务器的工具。

选项

  • "kernel"

  • "user"

  • "mail"

  • "daemon"

  • "auth"

  • "syslog"

  • "lpr"

  • "news"

  • "uucp"

  • "cron"

  • "authpriv"

  • "ftp"

  • "ntp"

  • "audit"

  • "alert"

  • "clock"

  • "local0"

  • "local1"

  • "local2"

  • "local3"

  • "local4"

  • "local5"

  • "local6"

  • "local7"

name

字符串 / 必需

远程日志名称。

port

整数

远程 syslog 服务器侦听端口。

server

字符串

远程 syslog 服务器的 IPv4 地址。

severity

字符串

要传输到远程日志服务器的日志的严重性。

选项

  • "emergency"

  • "alert"

  • "critical"

  • "error"

  • "warning"

  • "notification"

  • "information"

  • "debug"

status

字符串

启用/禁用 FortiSwitch 设备将日志记录到远程 syslog 服务器。

选项

  • "enable"

  • "disable"

route_offload

字符串

在此 FortiSwitch 上启用/禁用路由卸载。

选项

  • "disable"

  • "enable"

route_offload_mclag

字符串

在此 FortiSwitch 上启用/禁用路由卸载 MCLAG。

选项

  • "disable"

  • "enable"

route_offload_router

列表 / elements=字典

配置路由卸载 MCLAG IP 地址。

router_ip

字符串

路由器 IP 地址。

vlan_name

字符串 / 必需

VLAN 名称。源 system.interface.name。

settings_802_1X

字典

编辑 FortiSwitch 802.1X 全局设置的配置方法。

字符串

如果链路断开,要设置的身份验证状态。

选项

  • "set-unauth"

  • "no-action"

local_override

字符串

启用以覆盖各个 FortiSwitch 上的全局 802.1X 设置。

选项

  • "enable"

  • "disable"

mab_reauth

字符串

启用或禁用 MAB 重新身份验证设置。

选项

  • "disable"

  • "enable"

mac_called_station_delimiter

字符串

MAC 被叫站分隔符。

选项

  • "colon"

  • "hyphen"

  • "none"

  • "single-hyphen"

mac_calling_station_delimiter

字符串

MAC 主叫站分隔符。

选项

  • "colon"

  • "hyphen"

  • "none"

  • "single-hyphen"

mac_case

字符串

MAC 大小写。

选项

  • "lowercase"

  • "uppercase"

mac_password_delimiter

字符串

MAC 身份验证密码分隔符。

选项

  • "colon"

  • "hyphen"

  • "none"

  • "single-hyphen"

mac_username_delimiter

字符串

MAC 身份验证用户名分隔符。

选项

  • "colon"

  • "hyphen"

  • "none"

  • "single-hyphen"

max_reauth_attempt

整数

最大身份验证尝试次数 (0 - 15)。

reauth_period

整数

重新身份验证时间间隔 (1 - 1440 分钟)。

tx_period

整数

802.1X Tx 周期(秒)。

sn

字符串

托管交换机的序列号。

snmp_community

列表 / elements=字典

编辑简单网络管理协议 (SNMP) 社区的配置方法。

events

列表 / 元素=字符串

要发送的 SNMP 通知(陷阱)。

选项

  • "cpu-high"

  • "mem-low"

  • "log-full"

  • "intf-ip"

  • "ent-conf-change"

  • "l2mac"

hosts

列表 / elements=字典

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

id

integer / required

主机条目 ID。请参阅 注释

ip

字符串

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

id

integer / required

SNMP 社区 ID。请参阅 注释

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"

snmp_sysinfo

字典

编辑简单网络管理协议 (SNMP) 系统信息的配置方法。

contact_info

字符串

联系信息。

description

字符串

系统描述。

engine_id

字符串

本地 SNMP 引擎 ID 字符串(最大 24 个字符)。

location

字符串

系统位置。

status

字符串

启用/禁用 SNMP。

选项

  • "disable"

  • "enable"

snmp_trap_threshold

字典

编辑简单网络管理协议 (SNMP) 陷阱阈值的配置方法。

trap_high_cpu_threshold

整数

发送陷阱时的 CPU 使用率。

trap_log_full_threshold

整数

发送陷阱时的日志磁盘使用率。

trap_low_memory_threshold

整数

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

snmp_user

列表 / elements=字典

编辑简单网络管理协议 (SNMP) 用户的配置方法。

auth_proto

字符串

身份验证协议。

选项

  • "md5"

  • "sha1"

  • "sha224"

  • "sha256"

  • "sha384"

  • "sha512"

  • "sha"

auth_pwd

字符串

身份验证协议的密码。

name

字符串 / 必需

SNMP 用户名。

priv_proto

字符串

隐私(加密)协议。

选项

  • "aes128"

  • "aes192"

  • "aes192c"

  • "aes256"

  • "aes256c"

  • "des"

  • "aes"

priv_pwd

字符串

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

queries

字符串

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

选项

  • "disable"

  • "enable"

query_port

整数

SNMPv3 查询端口。

security_level

字符串

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

选项

  • "no-auth-no-priv"

  • "auth-no-priv"

  • "auth-priv"

staged_image_version

字符串

FortiSwitch 的暂存映像版本。

static_mac

列表 / elements=字典

编辑 FortiSwitch 静态和粘性 MAC 的配置方法。

description

字符串

描述。

id

integer / required

ID。请参阅 注释

interface

字符串

接口名称。

mac

字符串

MAC 地址。

type

字符串

类型。

选项

  • "static"

  • "sticky"

vlan

字符串

Vlan。源系统.接口.名称。

storm_control

字典

编辑 FortiSwitch 风暴控制的配置方法,用于使用数据速率测量流量活动,以防止流量中断。

broadcast

字符串

启用/禁用风暴控制以丢弃广播流量。

选项

  • "enable"

  • "disable"

local_override

字符串

启用以覆盖此 FortiSwitch 的全局 FortiSwitch 风暴控制设置。

选项

  • "enable"

  • "disable"

rate

整数

风暴控制丢弃过多流量的速率(每秒数据包数)(0-10000000)。

unknown_multicast

字符串

启用/禁用风暴控制以丢弃未知组播流量。

选项

  • "enable"

  • "disable"

unknown_unicast

字符串

启用/禁用风暴控制以丢弃未知单播流量。

选项

  • "enable"

  • "disable"

stp_instance

列表 / elements=字典

编辑生成树协议 (STP) 实例的配置方法。

id

字符串 / 必需

实例 ID。

priority

字符串

优先级。

选项

  • "0"

  • "4096"

  • "8192"

  • "12288"

  • "16384"

  • "20480"

  • "24576"

  • "28672"

  • "32768"

  • "36864"

  • "40960"

  • "45056"

  • "49152"

  • "53248"

  • "57344"

  • "61440"

stp_settings

字典

编辑用于防止网桥环路的生成树协议 (STP) 设置的配置方法。

forward_time

整数

端口处于侦听和学习状态的时间段 (4 - 30 秒)。

hello_time

整数

在端口上发送的连续 STP 帧网桥协议数据单元 (BPDU) 之间的时间段 (1 - 10 秒)。

local_override

字符串

启用以配置覆盖全局 STP 设置的本地 STP 设置。

选项

  • "enable"

  • "disable"

max_age

整数

网桥端口保存其配置 BPDU 信息之前的最长时间 (6 - 40 秒)。

max_hops

整数

根网桥与最远网桥之间的最大跃点数 (1-40)。

name

字符串

本地 STP 设置配置的名称。

pending_timer

整数

挂起时间 (1 - 15 秒)。

revision

整数

STP 修订号 (0 - 65535)。

status

字符串

启用/禁用 STP。

选项

  • "enable"

  • "disable"

switch_device_tag

字符串

用户可定义的标签/标记。

switch_dhcp_opt43_key

字符串

DHCP option43 密钥。

switch_id

字符串 / 必需

受管交换机名称。

switch_log

字典

编辑 FortiSwitch 日志记录设置的配置方法(日志传输到并插入到 FortiGate 事件日志中)。

local_override

字符串

启用以配置覆盖全局日志记录设置的本地日志记录设置。

选项

  • "enable"

  • "disable"

severity

字符串

添加到 FortiGate 事件日志的 FortiSwitch 日志的严重性。

选项

  • "emergency"

  • "alert"

  • "critical"

  • "error"

  • "warning"

  • "notification"

  • "information"

  • "debug"

status

字符串

启用/禁用将 FortiSwitch 日志添加到 FortiGate 事件日志。

选项

  • "enable"

  • "disable"

switch_profile

字符串

FortiSwitch 配置文件。源 switch-controller.switch-profile.name。

switch_stp_settings

字典

配置生成树协议 (STP)。

status

字符串

启用/禁用 STP。

选项

  • "enable"

  • "disable"

tdr_supported

字符串

支持 TDR。

type

字符串

交换机类型的指示,物理或虚拟。

选项

  • "virtual"

  • "physical"

version

整数

FortiSwitch 版本。

vlan

列表 / elements=字典

配置 VLAN 分配优先级。

assignment_priority

整数

802.1x Radius (Tunnel-Private-Group-Id) VLANID 按名称分配优先级。较小的值具有较高的优先级。

vlan_name

字符串 / 必需

VLAN 名称。源 system.interface.name。

vdom

字符串

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

默认值: "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure FortiSwitch devices that are managed by this FortiGate.
  fortinet.fortios.fortios_switch_controller_managed_switch:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_managed_switch:
          settings_802_1X:
              link_down_auth: "set-unauth"
              local_override: "enable"
              mab_reauth: "disable"
              mac_called_station_delimiter: "colon"
              mac_calling_station_delimiter: "colon"
              mac_case: "lowercase"
              mac_password_delimiter: "colon"
              mac_username_delimiter: "colon"
              max_reauth_attempt: "3"
              reauth_period: "60"
              tx_period: "30"
          access_profile: "<your_own_value> (source switch-controller.security-policy.local-access.name)"
          custom_command:
              -
                  command_entry: "<your_own_value>"
                  command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
          delayed_restart_trigger: "0"
          description: "<your_own_value>"
          dhcp_server_access_list: "global"
          dhcp_snooping_static_client:
              -
                  ip: "<your_own_value>"
                  mac: "<your_own_value>"
                  name: "default_name_25"
                  port: "<your_own_value>"
                  vlan: "<your_own_value> (source system.interface.name)"
          directly_connected: "0"
          dynamic_capability: "<your_own_value>"
          dynamically_discovered: "0"
          firmware_provision: "enable"
          firmware_provision_latest: "disable"
          firmware_provision_version: "<your_own_value>"
          flow_identity: "<your_own_value>"
          fsw_wan1_admin: "discovered"
          fsw_wan1_peer: "<your_own_value> (source system.interface.name)"
          fsw_wan2_admin: "discovered"
          fsw_wan2_peer: "<your_own_value>"
          igmp_snooping:
              aging_time: "300"
              flood_unknown_multicast: "enable"
              local_override: "enable"
              vlans:
                  -
                      proxy: "disable"
                      querier: "disable"
                      querier_addr: "<your_own_value>"
                      version: "2"
                      vlan_name: "<your_own_value> (source system.interface.name)"
          ip_source_guard:
              -
                  binding_entry:
                      -
                          entry_name: "<your_own_value>"
                          ip: "<your_own_value>"
                          mac: "<your_own_value>"
                  description: "<your_own_value>"
                  port: "<your_own_value>"
          l3_discovered: "0"
          max_allowed_trunk_members: "0"
          mclag_igmp_snooping_aware: "enable"
          mgmt_mode: "0"
          mirror:
              -
                  dst: "<your_own_value>"
                  name: "default_name_62"
                  src_egress:
                      -
                          name: "default_name_64"
                  src_ingress:
                      -
                          name: "default_name_66"
                  status: "active"
                  switching_packet: "enable"
          name: "default_name_69"
          override_snmp_community: "enable"
          override_snmp_sysinfo: "disable"
          override_snmp_trap_threshold: "enable"
          override_snmp_user: "enable"
          owner_vdom: "<your_own_value>"
          poe_detection_type: "0"
          poe_lldp_detection: "enable"
          poe_pre_standard_detection: "enable"
          ports:
              -
                  access_mode: "dynamic"
                  acl_group:
                      -
                          name: "default_name_81 (source switch-controller.acl.group.name)"
                  aggregator_mode: "bandwidth"
                  allow_arp_monitor: "disable"
                  allowed_vlans:
                      -
                          vlan_name: "<your_own_value> (source system.interface.name)"
                  allowed_vlans_all: "enable"
                  arp_inspection_trust: "untrusted"
                  bundle: "enable"
                  description: "<your_own_value>"
                  dhcp_snoop_option82_override:
                      -
                          circuit_id: "<your_own_value>"
                          remote_id: "<your_own_value>"
                          vlan_name: "<your_own_value> (source system.interface.name)"
                  dhcp_snoop_option82_trust: "enable"
                  dhcp_snooping: "untrusted"
                  discard_mode: "none"
                  edge_port: "enable"
                  export_tags:
                      -
                          tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
                  export_to: "<your_own_value> (source system.vdom.name)"
                  export_to_pool: "<your_own_value> (source switch-controller.virtual-port-pool.name)"
                  export_to_pool_flag: "0"
                  fallback_port: "<your_own_value>"
                  fec_capable: "0"
                  fec_state: "disabled"
                  fgt_peer_device_name: "<your_own_value>"
                  fgt_peer_port_name: "<your_own_value>"
                  fiber_port: "0"
                  flags: "0"
                  flap_duration: "30"
                  flap_rate: "5"
                  flap_timeout: "0"
                  flapguard: "enable"
                  flow_control: "disable"
                  fortilink_port: "0"
                  fortiswitch_acls:
                      -
                          id: "117"
                  igmp_snooping: "enable"
                  igmp_snooping_flood_reports: "enable"
                  igmps_flood_reports: "enable"
                  igmps_flood_traffic: "enable"
                  interface_tags:
                      -
                          tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
                  ip_source_guard: "disable"
                  isl_local_trunk_name: "<your_own_value>"
                  isl_peer_device_name: "<your_own_value>"
                  isl_peer_port_name: "<your_own_value>"
                  lacp_speed: "slow"
                  learning_limit: "0"
                  lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
                  lldp_status: "disable"
                  log_mac_event: "disable"
                  loop_guard: "enabled"
                  loop_guard_timeout: "45"
                  mac_addr: "<your_own_value>"
                  matched_dpp_intf_tags: "<your_own_value>"
                  matched_dpp_policy: "<your_own_value>"
                  max_bundle: "24"
                  mcast_snooping_flood_traffic: "enable"
                  mclag: "enable"
                  mclag_icl_port: "0"
                  media_type: "<your_own_value>"
                  member_withdrawal_behavior: "forward"
                  members:
                      -
                          member_name: "<your_own_value>"
                  min_bundle: "1"
                  mode: "static"
                  p2p_port: "0"
                  packet_sample_rate: "512"
                  packet_sampler: "enabled"
                  pause_meter: "0"
                  pause_meter_resume: "75%"
                  pd_capable: "0"
                  poe_capable: "0"
                  poe_max_power: "<your_own_value>"
                  poe_mode_bt_cabable: "0"
                  poe_port_mode: "ieee802-3af"
                  poe_port_power: "normal"
                  poe_port_priority: "critical-priority"
                  poe_pre_standard_detection: "enable"
                  poe_standard: "<your_own_value>"
                  poe_status: "enable"
                  port_name: "<your_own_value>"
                  port_number: "0"
                  port_owner: "<your_own_value>"
                  port_policy: "<your_own_value> (source switch-controller.dynamic-port-policy.name)"
                  port_prefix_type: "0"
                  port_security_policy: "<your_own_value> (source switch-controller.security-policy.802-1X.name)"
                  port_selection_criteria: "src-mac"
                  ptp_policy: "<your_own_value> (source switch-controller.ptp.interface-policy.name)"
                  ptp_status: "disable"
                  qnq: "<your_own_value> (source system.interface.name)"
                  qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
                  rpvst_port: "disabled"
                  sample_direction: "tx"
                  sflow_counter_interval: "0"
                  sflow_sample_rate: "49999"
                  sflow_sampler: "enabled"
                  speed: "10half"
                  speed_mask: "2147483647"
                  stacking_port: "0"
                  status: "up"
                  sticky_mac: "enable"
                  storm_control_policy: "<your_own_value> (source switch-controller.storm-control-policy.name)"
                  stp_bpdu_guard: "enabled"
                  stp_bpdu_guard_timeout: "5"
                  stp_root_guard: "enabled"
                  stp_state: "enabled"
                  switch_id: "<your_own_value>"
                  type: "physical"
                  untagged_vlans:
                      -
                          vlan_name: "<your_own_value> (source system.interface.name)"
                  virtual_port: "0"
                  vlan: "<your_own_value> (source system.interface.name)"
          pre_provisioned: "0"
          ptp_profile: "<your_own_value> (source switch-controller.ptp.profile.name)"
          ptp_status: "disable"
          purdue_level: "1"
          qos_drop_policy: "taildrop"
          qos_red_probability: "12"
          radius_nas_ip: "<your_own_value>"
          radius_nas_ip_override: "disable"
          remote_log:
              -
                  csv: "enable"
                  facility: "kernel"
                  name: "default_name_206"
                  port: "514"
                  server: "192.168.100.40"
                  severity: "emergency"
                  status: "enable"
          route_offload: "disable"
          route_offload_mclag: "disable"
          route_offload_router:
              -
                  router_ip: "<your_own_value>"
                  vlan_name: "<your_own_value> (source system.interface.name)"
          sn: "<your_own_value>"
          snmp_community:
              -
                  events: "cpu-high"
                  hosts:
                      -
                          id: "220"
                          ip: "<your_own_value>"
                  id: "222"
                  name: "default_name_223"
                  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"
          snmp_sysinfo:
              contact_info: "<your_own_value>"
              description: "<your_own_value>"
              engine_id: "<your_own_value>"
              location: "<your_own_value>"
              status: "disable"
          snmp_trap_threshold:
              trap_high_cpu_threshold: "80"
              trap_log_full_threshold: "90"
              trap_low_memory_threshold: "80"
          snmp_user:
              -
                  auth_proto: "md5"
                  auth_pwd: "<your_own_value>"
                  name: "default_name_248"
                  priv_proto: "aes128"
                  priv_pwd: "<your_own_value>"
                  queries: "disable"
                  query_port: "161"
                  security_level: "no-auth-no-priv"
          staged_image_version: "<your_own_value>"
          static_mac:
              -
                  description: "<your_own_value>"
                  id: "257"
                  interface: "<your_own_value>"
                  mac: "<your_own_value>"
                  type: "static"
                  vlan: "<your_own_value> (source system.interface.name)"
          storm_control:
              broadcast: "enable"
              local_override: "enable"
              rate: "500"
              unknown_multicast: "enable"
              unknown_unicast: "enable"
          stp_instance:
              -
                  id: "269"
                  priority: "0"
          stp_settings:
              forward_time: "15"
              hello_time: "2"
              local_override: "enable"
              max_age: "20"
              max_hops: "20"
              name: "default_name_277"
              pending_timer: "4"
              revision: "0"
              status: "enable"
          switch_device_tag: "<your_own_value>"
          switch_dhcp_opt43_key: "<your_own_value>"
          switch_id: "<your_own_value>"
          switch_log:
              local_override: "enable"
              severity: "emergency"
              status: "enable"
          switch_profile: "<your_own_value> (source switch-controller.switch-profile.name)"
          switch_stp_settings:
              status: "enable"
          tdr_supported: "<your_own_value>"
          type: "virtual"
          version: "0"
          vlan:
              -
                  assignment_priority: "128"
                  vlan_name: "<your_own_value> (source system.interface.name)"

返回值

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

描述

build

字符串

FortiGate 映像的内部版本号

返回值:始终

示例: "1547"

http_method

字符串

将内容配置到 FortiGate 中使用的最后方法

返回值:始终

示例: "PUT"

http_status

字符串

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

返回值:始终

示例: "200"

mkey

字符串

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

返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

返回值:始终

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

返回值:始终

示例: "webfilter"

revision

字符串

内部修订号

返回值:始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回值:始终

示例: "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)