fortinet.fortimanager.fmgr_fsp_vlan 模块 – FortiSwitch VLAN 模板。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。
要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_fsp_vlan。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括需要在使用前调整为数据源的所有参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块继续执行而不验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
设置的顶级参数。 |
|
DHCP 状态。 选项
|
|
身份验证。 选项
|
|
颜色。 |
|
注释。 |
|
DHCP 服务器。 |
|
启用/禁用自动配置。 选项
|
|
启用/禁用此接口从 FortiIPAM 分配 IP 地址后使用此 DHCP 服务器。 选项
|
|
从 DHCP 范围中移除冲突的 IP 地址后等待的时间（以秒为单位），然后才能重用它。 |
|
DDNS 身份验证模式。 选项
|
|
(列表或字符串) DDNS 更新密钥 |
|
DDNS 更新密钥名称。 |
|
DDNS 服务器 IP。 |
|
TTL。 |
|
启用/禁用 DHCP 的 DDNS 更新。 选项
|
|
启用/禁用 DHCP 的 DDNS 更新覆盖。 选项
|
|
您域名所在的区域。 |
|
DHCP 服务器分配的默认网关 IP 地址。 |
|
启用/禁用从 FortiIPAM 获取 DHCP 服务器设置。 选项
|
|
DNS 服务器 1。 |
|
DNS 服务器 2。 |
|
DNS 服务器 3。 |
|
DNS 服务器 4。 |
|
为 DHCP 客户端分配 DNS 服务器的选项。 选项
|
|
DHCP 服务器分配给客户端的 IP 地址的域名后缀。 |
|
启用。 选项
|
|
排除范围。 |
|
IP 范围的结束。 |
|
ID。 |
|
租约时间（秒），0 表示默认租约时间。 |
|
IP 范围的起始地址。 |
|
启用/禁用用户类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 UCI 字符串。 |
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
TFTP 服务器上引导文件的名称。 |
|
为该 DHCP 服务器启用/禁用 FortiClient-On-Net 服务。 选项
|
|
ID。 |
|
用于分配客户端 IP 的方法。 选项
|
|
IP 范围。 |
|
IP 范围的结束。 |
|
ID。 |
|
租约时间（秒），0 表示默认租约时间。 |
|
IP 范围的起始地址。 |
|
启用/禁用用户类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 UCI 字符串。 |
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
隧道断开后，DHCP 通过 IPsec 的租约将在这么多秒后过期。 |
|
租约时间（秒），0 表示无限期。 |
|
MAC 访问控制默认操作。 选项
|
|
DHCP 服务器分配的子网掩码。 |
|
服务器的 IP 地址。 |
|
NTP 服务器 1。 |
|
NTP 服务器 2。 |
|
NTP 服务器 3。 |
|
分配网络时间协议的选项。 选项
|
|
(列表) Option1。 |
|
(列表) Option2。 |
|
(列表) Option3。 |
|
Option4。 |
|
Option5。 |
|
Option6。 |
|
选项。 |
|
DHCP 选项代码。 |
|
ID。 |
|
(列表) DHCP 选项 IP。 |
|
DHCP 选项类型。 选项
|
|
启用/禁用用户类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 UCI 字符串。 |
|
DHCP 选项值。 |
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
中继代理 IP。 |
|
保留地址。 |
|
DHCP 服务器使用保留的 MAC 地址配置客户端的选项。 选项
|
|
将获得保留 IP 地址的客户端的 Option 82 电路 ID。 |
|
DHCP 选项类型。 选项
|
|
描述。 |
|
ID。 |
|
为 MAC 地址保留的 IP 地址。 |
|
将获得保留 IP 地址的客户端的 MAC 地址。 |
|
将获得保留 IP 地址的客户端的 Option 82 远程 ID。 |
|
DHCP 选项类型。 选项
|
|
DHCP 保留地址类型。 选项
|
|
DHCP 服务器可以是普通的 DHCP 服务器或 IPsec DHCP 服务器。 选项
|
|
启用/禁用共享子网。 选项
|
|
启用/禁用此 DHCP 配置。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 TFTP 服务器的主机名或 IP 地址。 |
|
选择要分配给 DHCP 客户端的时区。 选项
|
|
DHCP 服务器设置客户端时区的选项。 选项
|
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
WiFi 接入控制器 1 IP 地址。 |
|
WiFi 接入控制器 2 IP 地址。 |
|
WiFi 接入控制器 3 IP 地址。 |
|
为 DHCP 客户端分配 WiFi 接入控制器 (WiFi Access Controller) 的选项 选项
|
|
WINS 服务器 1。 |
|
WINS 服务器 2。 |
|
动态映射。 |
|
DHCP 状态。 选项
|
|
范围。 |
|
名称。 |
|
虚拟域 (Vdom)。 |
|
DHCP 服务器。 |
|
启用/禁用自动配置。 选项
|
|
启用/禁用此接口从 FortiIPAM 分配 IP 地址后使用此 DHCP 服务器。 选项
|
|
从 DHCP 范围中移除冲突的 IP 地址后等待的时间（以秒为单位），然后才能重用它。 |
|
DDNS 身份验证模式。 选项
|
|
(列表或字符串) DDNS 更新密钥 |
|
DDNS 更新密钥名称。 |
|
DDNS 服务器 IP。 |
|
TTL。 |
|
启用/禁用 DHCP 的 DDNS 更新。 选项
|
|
启用/禁用 DHCP 的 DDNS 更新覆盖。 选项
|
|
您域名所在的区域。 |
|
DHCP 服务器分配的默认网关 IP 地址。 |
|
启用/禁用从 FortiIPAM 获取 DHCP 服务器设置。 选项
|
|
DNS 服务器 1。 |
|
DNS 服务器 2。 |
|
DNS 服务器 3。 |
|
DNS 服务器 4。 |
|
为 DHCP 客户端分配 DNS 服务器的选项。 选项
|
|
DHCP 服务器分配给客户端的 IP 地址的域名后缀。 |
|
启用。 选项
|
|
排除范围。 |
|
IP 范围的结束。 |
|
ID。 |
|
租约时间（秒），0 表示默认租约时间。 |
|
IP 范围的起始地址。 |
|
启用/禁用用户类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 UCI 字符串。 |
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
TFTP 服务器上引导文件的名称。 |
|
为该 DHCP 服务器启用/禁用 FortiClient-On-Net 服务。 选项
|
|
ID。 |
|
用于分配客户端 IP 的方法。 选项
|
|
IP 范围。 |
|
IP 范围的结束。 |
|
ID。 |
|
租约时间（秒），0 表示默认租约时间。 |
|
IP 范围的起始地址。 |
|
启用/禁用用户类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 UCI 字符串。 |
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
隧道断开后，DHCP 通过 IPsec 的租约将在这么多秒后过期。 |
|
租约时间（秒），0 表示无限期。 |
|
MAC 访问控制默认操作。 选项
|
|
DHCP 服务器分配的子网掩码。 |
|
服务器的 IP 地址。 |
|
NTP 服务器 1。 |
|
NTP 服务器 2。 |
|
NTP 服务器 3。 |
|
分配网络时间协议的选项。 选项
|
|
(列表) Option1。 |
|
(列表) Option2。 |
|
(列表) Option3。 |
|
Option4。 |
|
Option5。 |
|
Option6。 |
|
选项。 |
|
DHCP 选项代码。 |
|
ID。 |
|
(列表) DHCP 选项 IP。 |
|
DHCP 选项类型。 选项
|
|
启用/禁用用户类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 UCI 字符串。 |
|
DHCP 选项值。 |
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
中继代理 IP。 |
|
保留地址。 |
|
DHCP 服务器使用保留的 MAC 地址配置客户端的选项。 选项
|
|
将获得保留 IP 地址的客户端的 Option 82 电路 ID。 |
|
DHCP 选项类型。 选项
|
|
描述。 |
|
ID。 |
|
为 MAC 地址保留的 IP 地址。 |
|
将获得保留 IP 地址的客户端的 MAC 地址。 |
|
将获得保留 IP 地址的客户端的 Option 82 远程 ID。 |
|
DHCP 选项类型。 选项
|
|
DHCP 保留地址类型。 选项
|
|
DHCP 服务器可以是普通的 DHCP 服务器或 IPsec DHCP 服务器。 选项
|
|
启用/禁用共享子网。 选项
|
|
启用/禁用此 DHCP 配置。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 TFTP 服务器的主机名或 IP 地址。 |
|
选择要分配给 DHCP 客户端的时区。 选项
|
|
DHCP 服务器设置客户端时区的选项。 选项
|
|
启用/禁用供应商类标识符。 选项
|
|
(列表) 一个或多个用空格分隔的带引号的 VCI 字符串。 |
|
WiFi 接入控制器 1 IP 地址。 |
|
WiFi 接入控制器 2 IP 地址。 |
|
WiFi 接入控制器 3 IP 地址。 |
|
为 DHCP 客户端分配 WiFi 接入控制器 (WiFi Access Controller) 的选项 选项
|
|
WINS 服务器 1。 |
|
WINS 服务器 2。 |
|
接口 (Interface). |
|
DHCP中继代理选项。 选项
|
|
DHCP中继接口选择方法。 选项
|
|
(列表) DHCP中继IP。 |
|
DHCP中继服务。 选项
|
|
DHCP中继类型。 选项
|
|
IPv4。 |
|
IPv6。 |
|
启用/禁用地址自动配置。 选项
|
|
CLI Conn6状态。 |
|
DHCPv6客户端选项。 选项
|
|
启用/禁用DHCPv6信息请求。 选项
|
|
启用/禁用DHCPv6前缀委派。 选项
|
|
将用作上游DHCPv6服务器提示的DHCPv6前缀。 |
|
DHCPv6前缀提示首选生存期 |
|
DHCPv6前缀提示有效生存期 |
|
DHCPv6中继接口ID。 |
|
DHCPv6中继IP地址。 |
|
启用/禁用DHCPv6中继。 选项
|
|
启用/禁用将此接口上的地址用作中继消息的源地址。 选项
|
|
DHCPv6中继用作其源IP的IPv6地址。 |
|
DHCPv6中继类型。 选项
|
|
启用/禁用发送ICMPv6重定向。 选项
|
|
IPv6接口标识符。 |
|
主IPv6地址前缀，语法 |
|
允许管理访问接口。 选项
|
|
默认生存期 |
|
从上游接口获得的委派前缀的IAID。 |
|
IPv6委派前缀列表。 |
|
启用/禁用自主标志。 选项
|
|
从上游接口获得的委派前缀的IAID。 |
|
启用/禁用在线标志。 选项
|
|
前缀ID。 |
|
(列表) 递归DNS服务器选项。 |
|
递归DNS服务选项。 选项
|
|
添加子网ID到路由前缀。 |
|
提供委派信息的接口名称。 |
|
启用/禁用使用DHCP获取的DNS服务器。 选项
|
|
IPv6额外地址。 |
|
IPv6地址前缀。 |
|
跳数限制 |
|
IPv6链路MTU。 |
|
启用/禁用管理标志。 选项
|
|
IPv6最大间隔 |
|
IPv6最小间隔 |
|
寻址模式 选项
|
|
启用/禁用其他IPv6标志。 选项
|
|
IPv6前缀列表。 |
|
启用/禁用自主标志。 选项
|
|
(列表) DNS 搜索列表选项。 |
|
启用/禁用在线标志。 选项
|
|
首选生存时间 |
|
IPv6 前缀。 |
|
(列表) 递归DNS服务器选项。 |
|
有效生存时间 |
|
从 DHCP 或 RA 分配前缀。 选项
|
|
IPv6 可达时间 |
|
IPv6 重传时间 |
|
启用/禁用发送关于接口的广告。 选项
|
|
子网到路由前缀，语法 |
|
提供委托信息的接口名称。 |
|
邻居发现证书。 |
|
邻居发现 CGA 修饰符。 |
|
邻居发现模式。 选项
|
|
邻居发现安全级别 |
|
邻居发现时间戳增量值 |
|
邻居发现时间戳模糊因子 |
|
启用/禁用在 RA 数据包中发送链路 MTU。 选项
|
|
启用/禁用唯一的自动配置地址。 选项
|
|
虚拟路由器的链路本地 IPv6 地址。 |
|
Vrrp6。 |
|
启用/禁用接受模式。 选项
|
|
广告间隔 |
|
启用/禁用在检查目标时忽略默认路由。 选项
|
|
启用/禁用抢占模式。 选项
|
|
虚拟路由器的优先级 |
|
启动时间 |
|
启用/禁用 VRRP。 选项
|
|
监控到此目的地的路由。 |
|
当虚拟路由器目的地变得不可达时，虚拟路由器的优先级 |
|
VRRP 组 ID |
|
虚拟路由器标识符 |
|
虚拟路由器的 IPv6 地址。 |
|
启用/禁用 VRRP 的虚拟 MAC。 选项
|
|
辅助 IP。 选项
|
|
辅助 IP。 |
|
辅助 IP 地址的管理访问设置。 选项
|
|
用于检测服务器的协议。 选项
|
|
网关为此 IP ping 服务器。 |
|
启用/禁用检测第一个网关是否存活。 选项
|
|
PING 服务器的 HA 选举优先级。 |
|
ID。 |
|
接口的辅助 IP 地址。 |
|
Ping 服务状态。 |
|
DHCP 中继 IP 地址。 |
|
序号。 |
|
VLAN ID。 |
|
VRRP。 |
|
启用/禁用接受模式。 选项
|
|
广告间隔 |
|
启用/禁用在检查目标时忽略默认路由。 选项
|
|
启用/禁用抢占模式。 选项
|
|
虚拟路由器的优先级 |
|
代理 ARP。 |
|
ID。 |
|
设置代理 ARP 的 IP 地址。 |
|
启动时间 |
|
启用/禁用此 VRRP 配置。 选项
|
|
VRRP 版本。 选项
|
|
(列表) 监控到此目的地的路由。 |
|
当虚拟路由器目的地变得不可达时，虚拟路由器的优先级 |
|
VRRP 组 ID |
|
虚拟路由器标识符 |
|
虚拟路由器的 IP 地址。 |
|
接口 (Interface). |
|
PPPoE 服务器名称。 |
|
聚合。 |
|
聚合类型。 选项
|
|
帧分发算法。 选项
|
|
别名将与接口名称一起显示，以便更容易区分。 |
|
此接口允许的管理访问类型。 选项
|
|
设置 xDSL 附加类型。 选项
|
|
启用/禁用自动注册未知的 FortiAP 设备。 选项
|
|
启用/禁用 ARP 转发。 选项
|
|
ATM 协议。 选项
|
|
HTTPS 服务器证书。 |
|
受限门户的地址。 |
|
要使用的 PPP 身份验证类型。 选项
|
|
启用/禁用在此接口上自动授权专用 Fortinet 扩展设备。 选项
|
|
带宽测量时间 |
|
双向转发检测 选项
|
|
BFD 期望的最小发送间隔。 |
|
BFD 检测乘数。 |
|
BFD 需要的最小接收间隔。 |
|
启用/禁用广播 FortiClient 发现消息。 选项
|
|
启用/禁用广播转发。 选项
|
|
启用/禁用网络登录页面。 |
|
CLI 连接状态。 |
|
GUI 上图标的颜色。 |
|
动态域名服务 (DDNS)。 选项
|
|
DDNS 认证。 选项
|
|
DDNS 域名。 |
|
(列表或字符串) DDNS 密钥。 |
|
DDNS 密钥名称。 |
|
(列表) DDNS 密码。 |
|
DDNS 服务器。 选项
|
|
DDNS 服务器 IP。 |
|
DDNS 序列号。 |
|
DDNS TTL (生存时间)。 |
|
DDNS 用户名。 |
|
DDNS 区域。 |
|
配置接口用于单一用途。 选项
|
|
在此接口上检测到的设备的默认 Purdue 等级。 选项
|
|
启用从 DHCP 或 PPPoE 服务器获取网关 IP。 选项
|
|
描述。 |
|
检测到的对端 MTU。 |
|
用于检测服务器的协议。 选项
|
|
网关为此 IP ping 服务器。 |
|
(列表或字符串) 设备访问列表。 |
|
启用/禁用被动收集有关连接到此网络的设备的设备身份信息… 选项
|
|
启用/禁用主动收集有关连接到此接口的网络上的设备的设备身份信息… 选项
|
|
启用/禁用将在此接口上检测到的设备包含在网络漏洞扫描中。 选项
|
|
启用/禁用被动收集有关此接口上用户的用户身份信息。 选项
|
|
设备索引。 |
|
启用/禁用在 DHCP 客户端发送的消息中设置广播标志。 选项
|
|
启用/禁用添加从 DHCP 服务器检索到的无类别静态路由。 选项
|
|
DHCP 客户端标识符。 |
|
启用/禁用 DHCP 中继代理选项。 选项
|
|
启用/禁用中继没有结束选项的 DHCP 消息。 选项
|
|
DHCP 中继电路 ID。 |
|
指定到达服务器的出站接口。 |
|
指定如何选择到达服务器的出站接口。 选项
|
|
(列表) DHCP 中继 IP 地址。 |
|
DHCP 中继链路选择。 |
|
启用/禁用将 DHCP 请求发送到所有服务器。 选项
|
|
启用/禁用允许此接口充当 DHCP 中继。 选项
|
|
DHCP 中继用作其源 IP 的 IP 地址。 |
|
DHCP 中继类型。 选项
|
|
DHCP 续约时间（秒）。 |
|
启用/禁用 DHCP 智能中继。 选项
|
|
等待重新尝试启动 PPPoE 发现的时间（秒），0 表示无超时。 |
|
等待发送此接口已关闭或断开连接的通知的时间（毫秒）。 |
|
通过 PPPoE 或 DHCP 学习的路由的距离，较低的距离表示首选路由。 |
|
DNS 查询。 选项
|
|
启用/禁用使用 DHCP 或 PPPoE 获取的 DNS。 选项
|
|
DNS 传输协议。 选项
|
|
启用/禁用丢弃碎片数据包。 选项
|
|
启用/禁用丢弃重叠的碎片数据包。 选项
|
|
EAP CA 证书名称。 |
|
EAP 身份。 |
|
EAP 方法。 选项
|
|
(列表) EAP 密码。 |
|
启用/禁用 EAP-Supplicant。 选项
|
|
EAP 用户证书名称。 |
|
覆盖用户 VLAN 标签中的出站 CoS。 选项
|
|
出站流量整形配置文件。 |
|
弹性公网 IP (EIP)。 |
|
启用/禁用端点合规性强制执行。 选项
|
|
估计的最大下行带宽。 |
|
估计的最大上行带宽。 |
|
启用/禁用此接口上的显式 FTP 代理。 选项
|
|
启用/禁用此接口上的显式 Web 代理。 选项
|
|
启用/禁用将接口标识为外部接口。 选项
|
|
接口故障时扩展器的操作。 选项
|
|
(列表或字符串) 发送链路故障警报的 FortiGate 接口名称。 |
|
选择 link-failed-signal 或 link-down 方法来告警链路故障。 选项
|
|
启用/禁用此接口的故障检测功能。 选项
|
|
检测此接口故障的选项。 选项
|
|
Fdp。 选项
|
|
启用/禁用 FortiHeartBeat 选项
|
|
启用 FortiLink 将此接口专用于管理其他 Fortinet 设备。 选项
|
|
Fortilink 备份链路。 |
|
FortiGate 邻居发现协议。 选项
|
|
启用/禁用 FortiLink 分割接口，将成员链路连接到堆叠中的不同 FortiSwitch 以实现上行链路冗余… 选项
|
|
启用/禁用此接口上的 FortiLink 交换机堆叠。 选项
|
|
透明模式转发域。 |
|
启用/禁用前向纠错 选项
|
|
使用快速路径传递或丢弃不同类型的异常。 选项
|
|
Fp 禁用。 选项
|
|
网关地址 |
|
通用接收卸载。 选项
|
|
启用/禁用 Gi Gatekeeper。 选项
|
|
网关地址 |
|
启用/禁用检测第一个网关是否存活。 选项
|
|
PING 服务器的 HA 选举优先级。 |
|
启用/禁用 ICMP 接受重定向。 选项
|
|
启用/禁用 ICMP 重定向。 选项
|
|
启用/禁用发送 ICMP 重定向。 选项
|
|
启用/禁用此接口的认证。 选项
|
|
空闲超时秒数后 PPPoE 自动断开连接，0 表示无超时。 |
|
接口 MDIX 模式 选项
|
|
选择接口媒体类型 选项
|
|
配置 IKE 认证 SAML 服务器。 |
|
强制 VLAN cos。 |
|
入站流量带宽限制 |
|
覆盖用户 VLAN 标签中的入站 CoS，或在物理接口上分配优先级 VLAN 标签。 选项
|
|
入站流量整形配置文件。 |
|
入站溢出阈值 |
|
设置互连配置文件。 选项
|
|
隐式创建。 |
|
接口 IPv4 地址和子网掩码，语法 |
|
启用/禁用 FortiIPAM 自动分配此接口的 IP 地址。 选项
|
|
启用/禁用 IP/MAC 绑定。 选项
|
|
启用/禁用将此接口用作单臂嗅探器。 选项
|
|
用于未提供唯一本地地址的 PPPoE 接口的无编号 IP。 |
|
IPv6。 |
|
启用/禁用地址自动配置。 选项
|
|
CLI Conn6状态。 |
|
DHCPv6客户端选项。 选项
|
|
启用/禁用DHCPv6信息请求。 选项
|
|
启用/禁用DHCPv6前缀委派。 选项
|
|
将用作上游DHCPv6服务器提示的DHCPv6前缀。 |
|
DHCPv6前缀提示首选生存期 |
|
DHCPv6前缀提示有效生存期 |
|
DHCPv6中继接口ID。 |
|
DHCPv6中继IP地址。 |
|
启用/禁用DHCPv6中继。 选项
|
|
启用/禁用将此接口上的地址用作中继消息的源地址。 选项
|
|
DHCPv6中继用作其源IP的IPv6地址。 |
|
DHCPv6中继类型。 选项
|
|
启用/禁用发送ICMPv6重定向。 选项
|
|
IPv6接口标识符。 |
|
主IPv6地址前缀，语法 |
|
允许管理访问接口。 选项
|
|
默认生存期 |
|
从上游接口获得的委派前缀的IAID。 |
|
IPv6委派前缀列表。 |
|
启用/禁用自主标志。 选项
|
|
从上游接口获得的委派前缀的IAID。 |
|
启用/禁用在线标志。 选项
|
|
前缀ID。 |
|
(列表) 递归DNS服务器选项。 |
|
递归DNS服务选项。 选项
|
|
添加子网ID到路由前缀。 |
|
提供委派信息的接口名称。 |
|
启用/禁用使用DHCP获取的DNS服务器。 选项
|
|
IPv6额外地址。 |
|
IPv6地址前缀。 |
|
跳数限制 |
|
IPv6链路MTU。 |
|
启用/禁用管理标志。 选项
|
|
IPv6最大间隔 |
|
IPv6最小间隔 |
|
寻址模式 选项
|
|
启用/禁用其他IPv6标志。 选项
|
|
IPv6前缀列表。 |
|
启用/禁用自主标志。 选项
|
|
(列表) DNS 搜索列表选项。 |
|
启用/禁用在线标志。 选项
|
|
首选生存时间 |
|
IPv6 前缀。 |
|
(列表) 递归DNS服务器选项。 |
|
有效生存时间 |
|
从 DHCP 或 RA 分配前缀。 选项
|
|
IPv6 可达时间 |
|
IPv6 重传时间 |
|
启用/禁用发送关于接口的广告。 选项
|
|
子网到路由前缀，语法 |
|
提供委托信息的接口名称。 |
|
邻居发现证书。 |
|
邻居发现 CGA 修饰符。 |
|
邻居发现模式。 选项
|
|
邻居发现安全级别 |
|
邻居发现时间戳增量值 |
|
邻居发现时间戳模糊因子 |
|
启用/禁用在 RA 数据包中发送链路 MTU。 选项
|
|
启用/禁用唯一的自动配置地址。 选项
|
|
虚拟路由器的链路本地 IPv6 地址。 |
|
Vrrp6。 |
|
启用/禁用接受模式。 选项
|
|
广告间隔 |
|
启用/禁用在检查目标时忽略默认路由。 选项
|
|
启用/禁用抢占模式。 选项
|
|
虚拟路由器的优先级 |
|
启动时间 |
|
启用/禁用 VRRP。 选项
|
|
监控到此目的地的路由。 |
|
当虚拟路由器目的地变得不可达时，虚拟路由器的优先级 |
|
VRRP 组 ID |
|
虚拟路由器标识符 |
|
虚拟路由器的 IPv6 地址。 |
|
启用/禁用 VRRP 的虚拟 MAC。 选项
|
|
启用/禁用二层转发。 选项
|
|
启用/禁用此接口作为二层隧道协议。 选项
|
|
LACP HA辅助接口。 选项
|
|
LACP HA从接口。 选项
|
|
LACP模式。 选项
|
|
接口发送LACP消息的频率。 选项
|
|
大接收卸载。 选项
|
|
PPPoE链路控制协议之间的时间间隔（秒）。 |
|
断开连接之前允许的最大丢失LCP回显消息数。 |
|
在认为链路已连接之前等待的毫秒数。 |
|
监听FortiClient连接。 选项
|
|
LLDP-MED网络策略配置文件。 |
|
启用/禁用链路层发现协议。 选项
|
|
启用/禁用链路层发现协议。 选项
|
|
日志。 选项
|
|
更改接口的MAC地址。 |
|
FortiIPAM分配并由此FortiGate单元的DHCP服务器设置使用的IP地址数。 选项
|
|
此接口的高可用性带内管理IP地址。 |
|
最大出站突发速率。 |
|
最大出站速率。 |
|
测量的下行带宽。 |
|
测量的上行带宽。 |
|
选择SFP介质接口类型。 选项
|
|
（列表或字符串）属于聚合或冗余接口的物理接口。 |
|
必须处于活动状态的最小聚合端口数。 |
|
当活动链路数少于配置的最小链路数时采取的操作。 选项
|
|
端口镜像方向。 选项
|
|
镜像端口。 |
|
寻址模式 选项
|
|
启用在此接口上监控带宽。 选项
|
|
此接口的MTU值。 |
|
启用以为此接口设置自定义MTU。 选项
|
|
多路复用器类型。 选项
|
|
名称。 |
|
启用/禁用NDISC转发。 选项
|
|
启用/禁用NETBIOS转发。 选项
|
|
NetFlow采样率。 |
|
启用/禁用此接口上的NetFlow并设置NetFlow收集的数据。 选项
|
|
Netflow采样器ID。 |
|
NP QoS配置文件ID。 |
|
NPU快速路径。 选项
|
|
NST。 选项
|
|
输出强制VLAN CoS。 |
|
出站流量的带宽限制。 |
|
PPPoE主动发现终止。 |
|
（列表）PPPoE账户密码。 |
|
（列表或字符串）对等接口。 |
|
DSL物理模式。 选项
|
|
Ping 服务状态。 |
|
启用/禁用PoE状态。 选项
|
|
SFlow轮询间隔。 |
|
启用/禁用NP端口镜像。 选项
|
|
出站PPPoE/PPP数据包的VLAN标记中的CoS。 选项
|
|
启用/禁用PPPoE无编号协商。 选项
|
|
PPTP 认证类型。 选项
|
|
启用/禁用 PPTP 客户端。 选项
|
|
(列表) PPTP 密码。 |
|
PPTP 服务器 IP 地址。 |
|
空闲计时器（分钟）。 |
|
PPTP 用户名。 |
|
在数据修改时启用/禁用会话路由的保留。 选项
|
|
学习路由的优先级。 |
|
恢复后启用/禁用回退到更高优先级端口。 选项
|
|
在此接口上启用/禁用代理受限门户。 选项
|
|
SFP-DSL ADSL 备用 PVC ATM QoS。 选项
|
|
SFP-DSL ADSL 备用 PVC 通道。 |
|
SFP-DSL ADSL 备用 PVC CRC 选项。 |
|
SFP-DSL ADSL 备用 PVC 数据包单元速率（单元）。 |
|
SFP-DSL ADSL 备用 PVC 可持续单元速率（单元）。 |
|
SFP-DSL ADSL 备用 PVC VLAN ID。 |
|
SFP-DSL ADSL 备用 PVC VLAN ID RX。 |
|
SFP-DSL ADSL 备用 PVC VLAN RX 操作。 选项
|
|
SFP-DSL ADSL 备用 PVC VLAN ID TX。 |
|
SFP-DSL ADSL 备用 PVC VLAN TX 操作。 选项
|
|
IPv4 可达时间（毫秒）。 |
|
冗余接口。 |
|
隧道的远程 IP 地址。 |
|
替换消息覆盖组。 |
|
启用/禁用 DSL 重传。 选项
|
|
RX 环大小。 |
|
TX 环大小。 |
|
接口角色。 选项
|
|
NetFlow 收集的数据。 选项
|
|
SFlow 采样率。 |
|
启用通过此接口监控或阻止与僵尸网络服务器的连接。 选项
|
|
启用/禁用为此接口添加辅助 IP。 选项
|
|
辅助 IP。 |
|
辅助 IP 地址的管理访问设置。 选项
|
|
用于检测服务器的协议。 选项
|
|
网关为此 IP ping 服务器。 |
|
启用/禁用检测第一个网关是否存活。 选项
|
|
PING 服务器的 HA 选举优先级。 |
|
ID。 |
|
接口的辅助 IP 地址。 |
|
Ping 服务状态。 |
|
DHCP 中继 IP 地址。 |
|
序号。 |
|
虚拟交换机的 VLAN ID。 |
|
选项
|
|
选项
|
|
安全豁免列表的名称。 |
|
外部认证注销服务器的URL。 |
|
外部认证Web服务器的URL。 |
|
(列表或字符串) 可以使用受限门户进行身份验证的用户组。 |
|
启用/禁用 IP 身份验证绕过。 选项
|
|
启用/禁用 MAC 身份验证绕过。 选项
|
|
为此接口打开受限门户身份验证。 选项
|
|
免责声明/身份验证后的 URL 重定向。 |
|
选择 VDSL 配置文件 30a 或 35b。 选项
|
|
PPPoE 服务名称。 |
|
在此接口上启用/禁用 sFlow。 选项
|
|
启用/禁用 SFP DSL。 选项
|
|
启用/禁用 SFP DSL ADSL 备用。 选项
|
|
启用/禁用 SFP DSL MAC 地址自动检测。 选项
|
|
SFP DSL MAC 地址。 |
|
接口速度。 选项
|
|
出站溢出阈值。 |
|
启用/禁用源 IP 检查。 选项
|
|
启动或关闭接口。 选项
|
|
启用/禁用 STP。 选项
|
|
启用/禁用 STP 边缘端口。 选项
|
|
控制 HA 辅助设备上的 STP 行为。 选项
|
|
控制 HA 从设备上的 STP 行为。 选项
|
|
启用/禁用 STP 转发。 选项
|
|
配置 STP 转发模式。 选项
|
|
剥离优先级 VLAN 标签。 选项
|
|
启用始终将数据包从该接口发送到目标 MAC 地址。 选项
|
|
从该接口发送的所有数据包的目标 MAC 地址。 |
|
交换机的帧分发算法。 选项
|
|
交换机控制器 VLAN 的初始创建。 |
|
Swc vlan。 |
|
交换机。 |
|
阻止 FortiSwitch 的端口到端口流量。 选项
|
|
启用/禁用 FortiSwitch ARP 检查。 选项
|
|
交换机控制器身份验证。 选项
|
|
交换机控制器 DHCP 侦听。 选项
|
|
交换机控制器 DHCP 侦听 option82。 选项
|
|
交换机控制器 DHCP 侦听 MAC 验证。 选项
|
|
受管 FortiSwitch 的集成 FortiLink 设置。 |
|
分配流量时的接口用途 选项
|
|
交换机控制器 IGMP 侦听。 选项
|
|
交换机控制器 IGMP 侦听快速离开。 选项
|
|
交换机控制器 IGMP 侦听代理。 选项
|
|
启用/禁用受管 FortiSwitch IoT 扫描。 选项
|
|
限制此 VLAN 上动态 MAC 地址的数量 |
|
用于 FortiLink 管理目的的 VLAN。 |
|
受管 FortiSwitch 的集成 NAC 设置。 |
|
NetFlow 收集和处理。 选项
|
|
启用/禁用受管 FortiSwitch 路由卸载。 选项
|
|
启用/禁用受管 FortiSwitch 路由卸载网关。 选项
|
|
FortiSwitch 上路由卸载的 IP。 |
|
交换机控制器卸载。 选项
|
|
交换机控制器卸载网关。 选项
|
|
交换机控制器卸载 IP。 |
|
此 FortiSwitch VLAN 的 RADIUS 服务器名称。 |
|
停止此接口上的第 2 层 MAC 学习和 BPDUs 及其他数据包的拦截。 选项
|
|
在 L3 连接上通过 FortiLink 使用的源 IP 地址。 选项
|
|
VLAN 的交换机控制器流量策略。 |
|
为聚合接口定义系统 ID。 |
|
生成系统 ID 的方法。 选项
|
|
DSL 传输模式。 选项
|
|
TCP 最大分段大小。 |
|
启用/禁用 VLAN 中继。 选项
|
|
用于专用管理流量的受信任 IPv6 主机 |
|
用于专用管理流量的受信任 IPv6 主机 |
|
用于专用管理流量的受信任 IPv6 主机 |
|
用于专用管理流量的受信任主机 |
|
用于专用管理流量的受信任主机 |
|
用于专用管理流量的受信任主机 |
|
接口类型。 选项
|
|
您的 ISP 提供的 PPPoE 帐户用户名。 |
|
虚拟信道 ID |
|
启用/禁用 DSL 矢量化。 选项
|
|
Vindex。 |
|
更改接口的虚拟 MAC 地址。 |
|
VLAN ID |
|
配置 DSL 802。 选项
|
|
VLAN 的以太网协议。 选项
|
|
启用/禁用此接口上 VLAN 之间的流量转发。 选项
|
|
VLAN ID |
|
虚拟路径 ID |
|
虚拟路由转发 ID。 |
|
VRRP。 |
|
启用/禁用接受模式。 选项
|
|
广告间隔 |
|
启用/禁用在检查目标时忽略默认路由。 选项
|
|
启用/禁用抢占模式。 选项
|
|
虚拟路由器的优先级 |
|
代理 ARP。 |
|
ID。 |
|
设置代理 ARP 的 IP 地址。 |
|
启动时间 |
|
启用/禁用此 VRRP 配置。 选项
|
|
VRRP 版本。 选项
|
|
(列表) 监控到此目的地的路由。 |
|
当虚拟路由器目的地变得不可达时，虚拟路由器的优先级 |
|
VRRP 组 ID |
|
虚拟路由器标识符 |
|
虚拟路由器的 IP 地址。 |
|
启用/禁用使用虚拟 MAC 进行 VRRP。 选项
|
|
启用/禁用此接口上的 WCCP。 选项
|
|
静态路由的默认权重 |
|
被视为良好 5G AP 的最小信号强度。 |
|
MAC 列表中 MAC 地址的访问控制。 选项
|
|
如何选择要连接的 AP。 选项
|
|
WiFi 身份验证。 选项
|
|
启用/禁用 WiFi 网络自动连接。 选项
|
|
启用/禁用 WiFi 网络自动保存。 选项
|
|
启用/禁用信标中的 SSID 广播。 选项
|
|
DNS 服务器 1。 |
|
DNS 服务器 2。 |
|
数据加密。 选项
|
|
WiFi 分片阈值 |
|
IPv4 默认网关 IP 地址。 |
|
(列表) WiFi WEP 密钥。 |
|
WEP 密钥索引 |
|
启用/禁用 MAC 过滤状态。 选项
|
|
(列表) WiFi 用于 WPA 的预共享密钥。 |
|
用于 WPA 的 WiFi RADIUS 服务器。 |
|
WiFi RTS 阈值 |
|
SSID 的无线访问安全性。 选项
|
|
IEEE 802。 |
|
用于 WPA 的 WiFi 用户组。 |
|
WINS 服务器 IP。 |
|
名称。 |
|
Portal 消息覆盖组。 |
|
Radius 服务器。 |
|
安全性。 选项
|
|
选择的 用户组。 |
|
用户组。 |
|
虚拟域 (Vdom)。 |
|
VLAN ID。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将被覆盖的失败条件的 rc 代码列表。 |
|
将被覆盖的成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是全局和其他值，包括 root。 |
|
等待其他用户释放工作区锁的最大时间（秒）。 默认值: |
注释
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。
示例
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: FortiSwitch VLAN template.
fortinet.fortimanager.fmgr_fsp_vlan:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
fsp_vlan:
_dhcp_status: <value in [disable, enable]>
auth: <value in [radius, usergroup]>
color: <integer>
comments: <string>
dynamic_mapping:
-
_dhcp_status: <value in [disable, enable]>
_scope:
-
name: <string>
vdom: <string>
dhcp_server:
auto_configuration: <value in [disable, enable]>
auto_managed_status: <value in [disable, enable]>
conflicted_ip_timeout: <integer>
ddns_auth: <value in [disable, tsig]>
ddns_key: <list or string>
ddns_keyname: <string>
ddns_server_ip: <string>
ddns_ttl: <integer>
ddns_update: <value in [disable, enable]>
ddns_update_override: <value in [disable, enable]>
ddns_zone: <string>
default_gateway: <string>
dhcp_settings_from_fortiipam: <value in [disable, enable]>
dns_server1: <string>
dns_server2: <string>
dns_server3: <string>
dns_server4: <string>
dns_service: <value in [default, specify, local]>
domain: <string>
enable: <value in [disable, enable]>
exclude_range:
-
end_ip: <string>
id: <integer>
start_ip: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
lease_time: <integer>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
filename: <string>
forticlient_on_net_status: <value in [disable, enable]>
id: <integer>
ip_mode: <value in [range, usrgrp]>
ip_range:
-
end_ip: <string>
id: <integer>
start_ip: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
lease_time: <integer>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
ipsec_lease_hold: <integer>
lease_time: <integer>
mac_acl_default_action: <value in [assign, block]>
netmask: <string>
next_server: <string>
ntp_server1: <string>
ntp_server2: <string>
ntp_server3: <string>
ntp_service: <value in [default, specify, local]>
option1: <list or string>
option2: <list or string>
option3: <list or string>
option4: <string>
option5: <string>
option6: <string>
options:
-
code: <integer>
id: <integer>
ip: <list or string>
type: <value in [hex, string, ip, ...]>
value: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
reserved_address:
-
action: <value in [assign, block, reserved]>
circuit_id: <string>
circuit_id_type: <value in [hex, string]>
description: <string>
id: <integer>
ip: <string>
mac: <string>
remote_id: <string>
remote_id_type: <value in [hex, string]>
type: <value in [mac, option82]>
server_type: <value in [regular, ipsec]>
status: <value in [disable, enable]>
tftp_server: <list or string>
timezone: <value in [00, 01, 02, ...]>
timezone_option: <value in [disable, default, specify]>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
wifi_ac_service: <value in [specify, local]>
wifi_ac1: <string>
wifi_ac2: <string>
wifi_ac3: <string>
wins_server1: <string>
wins_server2: <string>
relay_agent: <string>
shared_subnet: <value in [disable, enable]>
interface:
dhcp_relay_agent_option: <value in [disable, enable]>
dhcp_relay_ip: <list or string>
dhcp_relay_service: <value in [disable, enable]>
dhcp_relay_type: <value in [regular, ipsec]>
ip: <string>
ipv6:
autoconf: <value in [disable, enable]>
dhcp6_client_options:
- "rapid"
- "iapd"
- "iana"
- "dns"
- "dnsname"
dhcp6_information_request: <value in [disable, enable]>
dhcp6_prefix_delegation: <value in [disable, enable]>
dhcp6_prefix_hint: <string>
dhcp6_prefix_hint_plt: <integer>
dhcp6_prefix_hint_vlt: <integer>
dhcp6_relay_ip: <string>
dhcp6_relay_service: <value in [disable, enable]>
dhcp6_relay_type: <value in [regular]>
icmp6_send_redirect: <value in [disable, enable]>
interface_identifier: <string>
ip6_address: <string>
ip6_allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
- "fgfm"
- "capwap"
- "fabric"
ip6_default_life: <integer>
ip6_delegated_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
onlink_flag: <value in [disable, enable]>
prefix_id: <integer>
rdnss: <list or string>
rdnss_service: <value in [delegated, default, specify]>
subnet: <string>
upstream_interface: <string>
delegated_prefix_iaid: <integer>
ip6_dns_server_override: <value in [disable, enable]>
ip6_extra_addr:
-
prefix: <string>
ip6_hop_limit: <integer>
ip6_link_mtu: <integer>
ip6_manage_flag: <value in [disable, enable]>
ip6_max_interval: <integer>
ip6_min_interval: <integer>
ip6_mode: <value in [static, dhcp, pppoe, ...]>
ip6_other_flag: <value in [disable, enable]>
ip6_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
dnssl: <list or string>
onlink_flag: <value in [disable, enable]>
preferred_life_time: <integer>
prefix: <string>
rdnss: <list or string>
valid_life_time: <integer>
ip6_reachable_time: <integer>
ip6_retrans_time: <integer>
ip6_send_adv: <value in [disable, enable]>
ip6_subnet: <string>
ip6_upstream_interface: <string>
nd_cert: <string>
nd_cga_modifier: <string>
nd_mode: <value in [basic, SEND-compatible]>
nd_security_level: <integer>
nd_timestamp_delta: <integer>
nd_timestamp_fuzz: <integer>
unique_autoconf_addr: <value in [disable, enable]>
vrip6_link_local: <string>
vrrp_virtual_mac6: <value in [disable, enable]>
vrrp6:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
preempt: <value in [disable, enable]>
priority: <integer>
start_time: <integer>
status: <value in [disable, enable]>
vrdst6: <string>
vrgrp: <integer>
vrid: <integer>
vrip6: <string>
ignore_default_route: <value in [disable, enable]>
vrdst_priority: <integer>
cli_conn6_status: <integer>
ip6_prefix_mode: <value in [dhcp6, ra]>
ra_send_mtu: <value in [disable, enable]>
ip6_delegated_prefix_iaid: <integer>
dhcp6_relay_source_interface: <value in [disable, enable]>
dhcp6_relay_interface_id: <string>
dhcp6_relay_source_ip: <string>
secondary_IP: <value in [disable, enable]>
secondaryip:
-
allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
- "fgfm"
- "auto-ipsec"
- "radius-acct"
- "probe-response"
- "capwap"
- "dnp"
- "ftm"
- "fabric"
- "speed-test"
- "icond"
- "scim"
detectprotocol:
- "ping"
- "tcp-echo"
- "udp-echo"
detectserver: <string>
gwdetect: <value in [disable, enable]>
ha_priority: <integer>
id: <integer>
ip: <string>
ping_serv_status: <integer>
seq: <integer>
secip_relay_ip: <string>
vlanid: <integer>
dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
vrrp:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
ignore_default_route: <value in [disable, enable]>
preempt: <value in [disable, enable]>
priority: <integer>
proxy_arp:
-
id: <integer>
ip: <string>
start_time: <integer>
status: <value in [disable, enable]>
version: <value in [2, 3]>
vrdst: <list or string>
vrdst_priority: <integer>
vrgrp: <integer>
vrid: <integer>
vrip: <string>
name: <string>
portal_message_override_group: <string>
radius_server: <string>
security: <value in [open, captive-portal, 8021x]>
selected_usergroups: <string>
usergroup: <string>
vdom: <string>
vlanid: <integer>
dhcp_server:
auto_configuration: <value in [disable, enable]>
auto_managed_status: <value in [disable, enable]>
conflicted_ip_timeout: <integer>
ddns_auth: <value in [disable, tsig]>
ddns_key: <list or string>
ddns_keyname: <string>
ddns_server_ip: <string>
ddns_ttl: <integer>
ddns_update: <value in [disable, enable]>
ddns_update_override: <value in [disable, enable]>
ddns_zone: <string>
default_gateway: <string>
dhcp_settings_from_fortiipam: <value in [disable, enable]>
dns_server1: <string>
dns_server2: <string>
dns_server3: <string>
dns_server4: <string>
dns_service: <value in [default, specify, local]>
domain: <string>
enable: <value in [disable, enable]>
exclude_range:
-
end_ip: <string>
id: <integer>
start_ip: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
lease_time: <integer>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
filename: <string>
forticlient_on_net_status: <value in [disable, enable]>
id: <integer>
ip_mode: <value in [range, usrgrp]>
ip_range:
-
end_ip: <string>
id: <integer>
start_ip: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
lease_time: <integer>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
ipsec_lease_hold: <integer>
lease_time: <integer>
mac_acl_default_action: <value in [assign, block]>
netmask: <string>
next_server: <string>
ntp_server1: <string>
ntp_server2: <string>
ntp_server3: <string>
ntp_service: <value in [default, specify, local]>
option1: <list or string>
option2: <list or string>
option3: <list or string>
option4: <string>
option5: <string>
option6: <string>
options:
-
code: <integer>
id: <integer>
ip: <list or string>
type: <value in [hex, string, ip, ...]>
value: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
reserved_address:
-
action: <value in [assign, block, reserved]>
circuit_id: <string>
circuit_id_type: <value in [hex, string]>
description: <string>
id: <integer>
ip: <string>
mac: <string>
remote_id: <string>
remote_id_type: <value in [hex, string]>
type: <value in [mac, option82]>
server_type: <value in [regular, ipsec]>
status: <value in [disable, enable]>
tftp_server: <list or string>
timezone: <value in [00, 01, 02, ...]>
timezone_option: <value in [disable, default, specify]>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
wifi_ac_service: <value in [specify, local]>
wifi_ac1: <string>
wifi_ac2: <string>
wifi_ac3: <string>
wins_server1: <string>
wins_server2: <string>
relay_agent: <string>
shared_subnet: <value in [disable, enable]>
interface:
ac_name: <string>
aggregate: <string>
algorithm: <value in [L2, L3, L4, ...]>
alias: <string>
allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
- "fgfm"
- "auto-ipsec"
- "radius-acct"
- "probe-response"
- "capwap"
- "dnp"
- "ftm"
- "fabric"
- "speed-test"
ap_discover: <value in [disable, enable]>
arpforward: <value in [disable, enable]>
atm_protocol: <value in [none, ipoa]>
auth_type: <value in [auto, pap, chap, ...]>
auto_auth_extension_device: <value in [disable, enable]>
bandwidth_measure_time: <integer>
bfd: <value in [global, enable, disable]>
bfd_desired_min_tx: <integer>
bfd_detect_mult: <integer>
bfd_required_min_rx: <integer>
broadcast_forticlient_discovery: <value in [disable, enable]>
broadcast_forward: <value in [disable, enable]>
captive_portal: <integer>
cli_conn_status: <integer>
color: <integer>
ddns: <value in [disable, enable]>
ddns_auth: <value in [disable, tsig]>
ddns_domain: <string>
ddns_key: <list or string>
ddns_keyname: <string>
ddns_password: <list or string>
ddns_server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
ddns_server_ip: <string>
ddns_sn: <string>
ddns_ttl: <integer>
ddns_username: <string>
ddns_zone: <string>
dedicated_to: <value in [none, management]>
defaultgw: <value in [disable, enable]>
description: <string>
detected_peer_mtu: <integer>
detectprotocol:
- "ping"
- "tcp-echo"
- "udp-echo"
detectserver: <string>
device_access_list: <list or string>
device_identification: <value in [disable, enable]>
device_identification_active_scan: <value in [disable, enable]>
device_netscan: <value in [disable, enable]>
device_user_identification: <value in [disable, enable]>
devindex: <integer>
dhcp_client_identifier: <string>
dhcp_relay_agent_option: <value in [disable, enable]>
dhcp_relay_interface: <string>
dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
dhcp_relay_ip: <list or string>
dhcp_relay_service: <value in [disable, enable]>
dhcp_relay_type: <value in [regular, ipsec]>
dhcp_renew_time: <integer>
disc_retry_timeout: <integer>
disconnect_threshold: <integer>
distance: <integer>
dns_query: <value in [disable, recursive, non-recursive]>
dns_server_override: <value in [disable, enable]>
drop_fragment: <value in [disable, enable]>
drop_overlapped_fragment: <value in [disable, enable]>
egress_cos: <value in [disable, cos0, cos1, ...]>
egress_shaping_profile: <string>
eip: <string>
endpoint_compliance: <value in [disable, enable]>
estimated_downstream_bandwidth: <integer>
estimated_upstream_bandwidth: <integer>
explicit_ftp_proxy: <value in [disable, enable]>
explicit_web_proxy: <value in [disable, enable]>
external: <value in [disable, enable]>
fail_action_on_extender: <value in [soft-restart, hard-restart, reboot]>
fail_alert_interfaces: <list or string>
fail_alert_method: <value in [link-failed-signal, link-down]>
fail_detect: <value in [disable, enable]>
fail_detect_option:
- "detectserver"
- "link-down"
fdp: <value in [disable, enable]>
fortiheartbeat: <value in [disable, enable]>
fortilink: <value in [disable, enable]>
fortilink_backup_link: <integer>
fortilink_neighbor_detect: <value in [lldp, fortilink]>
fortilink_split_interface: <value in [disable, enable]>
fortilink_stacking: <value in [disable, enable]>
forward_domain: <integer>
forward_error_correction: <value in [disable, enable, rs-fec, ...]>
fp_anomaly:
- "drop_tcp_fin_noack"
- "pass_winnuke"
- "pass_tcpland"
- "pass_udpland"
- "pass_icmpland"
- "pass_ipland"
- "pass_iprr"
- "pass_ipssrr"
- "pass_iplsrr"
- "pass_ipstream"
- "pass_ipsecurity"
- "pass_iptimestamp"
- "pass_ipunknown_option"
- "pass_ipunknown_prot"
- "pass_icmp_frag"
- "pass_tcp_no_flag"
- "pass_tcp_fin_noack"
- "drop_winnuke"
- "drop_tcpland"
- "drop_udpland"
- "drop_icmpland"
- "drop_ipland"
- "drop_iprr"
- "drop_ipssrr"
- "drop_iplsrr"
- "drop_ipstream"
- "drop_ipsecurity"
- "drop_iptimestamp"
- "drop_ipunknown_option"
- "drop_ipunknown_prot"
- "drop_icmp_frag"
- "drop_tcp_no_flag"
fp_disable:
- "all"
- "ipsec"
- "none"
gateway_address: <string>
gi_gk: <value in [disable, enable]>
gwaddr: <string>
gwdetect: <value in [disable, enable]>
ha_priority: <integer>
icmp_accept_redirect: <value in [disable, enable]>
icmp_redirect: <value in [disable, enable]>
icmp_send_redirect: <value in [disable, enable]>
ident_accept: <value in [disable, enable]>
idle_timeout: <integer>
if_mdix: <value in [auto, normal, crossover]>
if_media: <value in [auto, copper, fiber]>
in_force_vlan_cos: <integer>
inbandwidth: <integer>
ingress_cos: <value in [disable, cos0, cos1, ...]>
ingress_shaping_profile: <string>
ingress_spillover_threshold: <integer>
internal: <integer>
ip: <string>
ip_managed_by_fortiipam: <value in [disable, enable, inherit-global]>
ipmac: <value in [disable, enable]>
ips_sniffer_mode: <value in [disable, enable]>
ipunnumbered: <string>
ipv6:
autoconf: <value in [disable, enable]>
dhcp6_client_options:
- "rapid"
- "iapd"
- "iana"
- "dns"
- "dnsname"
dhcp6_information_request: <value in [disable, enable]>
dhcp6_prefix_delegation: <value in [disable, enable]>
dhcp6_prefix_hint: <string>
dhcp6_prefix_hint_plt: <integer>
dhcp6_prefix_hint_vlt: <integer>
dhcp6_relay_ip: <string>
dhcp6_relay_service: <value in [disable, enable]>
dhcp6_relay_type: <value in [regular]>
icmp6_send_redirect: <value in [disable, enable]>
interface_identifier: <string>
ip6_address: <string>
ip6_allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
- "fgfm"
- "capwap"
- "fabric"
ip6_default_life: <integer>
ip6_delegated_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
onlink_flag: <value in [disable, enable]>
prefix_id: <integer>
rdnss: <list or string>
rdnss_service: <value in [delegated, default, specify]>
subnet: <string>
upstream_interface: <string>
delegated_prefix_iaid: <integer>
ip6_dns_server_override: <value in [disable, enable]>
ip6_extra_addr:
-
prefix: <string>
ip6_hop_limit: <integer>
ip6_link_mtu: <integer>
ip6_manage_flag: <value in [disable, enable]>
ip6_max_interval: <integer>
ip6_min_interval: <integer>
ip6_mode: <value in [static, dhcp, pppoe, ...]>
ip6_other_flag: <value in [disable, enable]>
ip6_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
dnssl: <list or string>
onlink_flag: <value in [disable, enable]>
preferred_life_time: <integer>
prefix: <string>
rdnss: <list or string>
valid_life_time: <integer>
ip6_reachable_time: <integer>
ip6_retrans_time: <integer>
ip6_send_adv: <value in [disable, enable]>
ip6_subnet: <string>
ip6_upstream_interface: <string>
nd_cert: <string>
nd_cga_modifier: <string>
nd_mode: <value in [basic, SEND-compatible]>
nd_security_level: <integer>
nd_timestamp_delta: <integer>
nd_timestamp_fuzz: <integer>
unique_autoconf_addr: <value in [disable, enable]>
vrip6_link_local: <string>
vrrp_virtual_mac6: <value in [disable, enable]>
vrrp6:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
preempt: <value in [disable, enable]>
priority: <integer>
start_time: <integer>
status: <value in [disable, enable]>
vrdst6: <string>
vrgrp: <integer>
vrid: <integer>
vrip6: <string>
ignore_default_route: <value in [disable, enable]>
vrdst_priority: <integer>
cli_conn6_status: <integer>
ip6_prefix_mode: <value in [dhcp6, ra]>
ra_send_mtu: <value in [disable, enable]>
ip6_delegated_prefix_iaid: <integer>
dhcp6_relay_source_interface: <value in [disable, enable]>
dhcp6_relay_interface_id: <string>
dhcp6_relay_source_ip: <string>
l2forward: <value in [disable, enable]>
l2tp_client: <value in [disable, enable]>
lacp_ha_slave: <value in [disable, enable]>
lacp_mode: <value in [static, passive, active]>
lacp_speed: <value in [slow, fast]>
lcp_echo_interval: <integer>
lcp_max_echo_fails: <integer>
link_up_delay: <integer>
listen_forticlient_connection: <value in [disable, enable]>
lldp_network_policy: <string>
lldp_reception: <value in [disable, enable, vdom]>
lldp_transmission: <value in [enable, disable, vdom]>
log: <value in [disable, enable]>
macaddr: <string>
managed_subnetwork_size: <value in [256, 512, 1024, ...]>
management_ip: <string>
max_egress_burst_rate: <integer>
max_egress_rate: <integer>
measured_downstream_bandwidth: <integer>
measured_upstream_bandwidth: <integer>
mediatype: <value in [serdes-sfp, sgmii-sfp, cfp2-sr10, ...]>
member: <list or string>
min_links: <integer>
min_links_down: <value in [operational, administrative]>
mode: <value in [static, dhcp, pppoe, ...]>
monitor_bandwidth: <value in [disable, enable]>
mtu: <integer>
mtu_override: <value in [disable, enable]>
mux_type: <value in [llc-encaps, vc-encaps]>
name: <string>
ndiscforward: <value in [disable, enable]>
netbios_forward: <value in [disable, enable]>
netflow_sampler: <value in [disable, tx, rx, ...]>
np_qos_profile: <integer>
npu_fastpath: <value in [disable, enable]>
nst: <value in [disable, enable]>
out_force_vlan_cos: <integer>
outbandwidth: <integer>
padt_retry_timeout: <integer>
password: <list or string>
peer_interface: <list or string>
phy_mode: <value in [auto, adsl, vdsl, ...]>
ping_serv_status: <integer>
poe: <value in [disable, enable]>
polling_interval: <integer>
pppoe_unnumbered_negotiate: <value in [disable, enable]>
pptp_auth_type: <value in [auto, pap, chap, ...]>
pptp_client: <value in [disable, enable]>
pptp_password: <list or string>
pptp_server_ip: <string>
pptp_timeout: <integer>
pptp_user: <string>
preserve_session_route: <value in [disable, enable]>
priority: <integer>
priority_override: <value in [disable, enable]>
proxy_captive_portal: <value in [disable, enable]>
redundant_interface: <string>
remote_ip: <string>
replacemsg_override_group: <string>
retransmission: <value in [disable, enable]>
ring_rx: <integer>
ring_tx: <integer>
role: <value in [lan, wan, dmz, ...]>
sample_direction: <value in [rx, tx, both]>
sample_rate: <integer>
scan_botnet_connections: <value in [disable, block, monitor]>
secondary_IP: <value in [disable, enable]>
secondaryip:
-
allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
- "fgfm"
- "auto-ipsec"
- "radius-acct"
- "probe-response"
- "capwap"
- "dnp"
- "ftm"
- "fabric"
- "speed-test"
- "icond"
- "scim"
detectprotocol:
- "ping"
- "tcp-echo"
- "udp-echo"
detectserver: <string>
gwdetect: <value in [disable, enable]>
ha_priority: <integer>
id: <integer>
ip: <string>
ping_serv_status: <integer>
seq: <integer>
secip_relay_ip: <string>
security_8021x_dynamic_vlan_id: <integer>
security_8021x_master: <string>
security_8021x_mode: <value in [default, dynamic-vlan, fallback, ...]>
security_exempt_list: <string>
security_external_logout: <string>
security_external_web: <string>
security_groups: <list or string>
security_mac_auth_bypass: <value in [disable, enable, mac-auth-only]>
security_mode: <value in [none, captive-portal, 802.1X]>
security_redirect_url: <string>
service_name: <string>
sflow_sampler: <value in [disable, enable]>
speed: <value in [auto, 10full, 10half, ...]>
spillover_threshold: <integer>
src_check: <value in [disable, enable]>
status: <value in [down, up]>
stp: <value in [disable, enable]>
stp_ha_slave: <value in [disable, enable, priority-adjust]>
stpforward: <value in [disable, enable]>
stpforward_mode: <value in [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing]>
strip_priority_vlan_tag: <value in [disable, enable]>
subst: <value in [disable, enable]>
substitute_dst_mac: <string>
swc_first_create: <integer>
swc_vlan: <integer>
switch: <string>
switch_controller_access_vlan: <value in [disable, enable]>
switch_controller_arp_inspection: <value in [disable, enable, monitor]>
switch_controller_auth: <value in [radius, usergroup]>
switch_controller_dhcp_snooping: <value in [disable, enable]>
switch_controller_dhcp_snooping_option82: <value in [disable, enable]>
switch_controller_dhcp_snooping_verify_mac: <value in [disable, enable]>
switch_controller_feature: <value in [none, default-vlan, quarantine, ...]>
switch_controller_igmp_snooping: <value in [disable, enable]>
switch_controller_igmp_snooping_fast_leave: <value in [disable, enable]>
switch_controller_igmp_snooping_proxy: <value in [disable, enable]>
switch_controller_iot_scanning: <value in [disable, enable]>
switch_controller_learning_limit: <integer>
switch_controller_mgmt_vlan: <integer>
switch_controller_nac: <string>
switch_controller_radius_server: <string>
switch_controller_rspan_mode: <value in [disable, enable]>
switch_controller_source_ip: <value in [outbound, fixed]>
switch_controller_traffic_policy: <string>
tc_mode: <value in [ptm, atm]>
tcp_mss: <integer>
trunk: <value in [disable, enable]>
trust_ip_1: <string>
trust_ip_2: <string>
trust_ip_3: <string>
trust_ip6_1: <string>
trust_ip6_2: <string>
trust_ip6_3: <string>
type: <value in [physical, vlan, aggregate, ...]>
username: <string>
vci: <integer>
vectoring: <value in [disable, enable]>
vindex: <integer>
vlan_protocol: <value in [8021q, 8021ad]>
vlanforward: <value in [disable, enable]>
vlanid: <integer>
vpi: <integer>
vrf: <integer>
vrrp:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
ignore_default_route: <value in [disable, enable]>
preempt: <value in [disable, enable]>
priority: <integer>
start_time: <integer>
status: <value in [disable, enable]>
version: <value in [2, 3]>
vrdst: <list or string>
vrdst_priority: <integer>
vrgrp: <integer>
vrid: <integer>
vrip: <string>
proxy_arp:
-
id: <integer>
ip: <string>
vrrp_virtual_mac: <value in [disable, enable]>
wccp: <value in [disable, enable]>
weight: <integer>
wifi_5g_threshold: <string>
wifi_acl: <value in [deny, allow]>
wifi_ap_band: <value in [any, 5g-preferred, 5g-only]>
wifi_auth: <value in [PSK, RADIUS, radius, ...]>
wifi_auto_connect: <value in [disable, enable]>
wifi_auto_save: <value in [disable, enable]>
wifi_broadcast_ssid: <value in [disable, enable]>
wifi_encrypt: <value in [TKIP, AES]>
wifi_fragment_threshold: <integer>
wifi_key: <list or string>
wifi_keyindex: <integer>
wifi_mac_filter: <value in [disable, enable]>
wifi_passphrase: <list or string>
wifi_radius_server: <string>
wifi_rts_threshold: <integer>
wifi_security: <value in [None, WEP64, wep64, ...]>
wifi_ssid: <string>
wifi_usergroup: <string>
wins_ip: <string>
dhcp_relay_request_all_server: <value in [disable, enable]>
stp_ha_secondary: <value in [disable, enable, priority-adjust]>
switch_controller_dynamic: <string>
auth_cert: <string>
auth_portal_addr: <string>
dhcp_classless_route_addition: <value in [disable, enable]>
dhcp_relay_link_selection: <string>
dns_server_protocol:
- "cleartext"
- "dot"
- "doh"
eap_ca_cert: <string>
eap_identity: <string>
eap_method: <value in [tls, peap]>
eap_password: <list or string>
eap_supplicant: <value in [disable, enable]>
eap_user_cert: <string>
ike_saml_server: <string>
lacp_ha_secondary: <value in [disable, enable]>
pvc_atm_qos: <value in [cbr, rt-vbr, nrt-vbr, ...]>
pvc_chan: <integer>
pvc_crc: <integer>
pvc_pcr: <integer>
pvc_scr: <integer>
pvc_vlan_id: <integer>
pvc_vlan_rx_id: <integer>
pvc_vlan_rx_op: <value in [pass-through, replace, remove]>
pvc_vlan_tx_id: <integer>
pvc_vlan_tx_op: <value in [pass-through, replace, remove]>
reachable_time: <integer>
select_profile_30a_35b: <value in [30A, 35B]>
sfp_dsl: <value in [disable, enable]>
sfp_dsl_adsl_fallback: <value in [disable, enable]>
sfp_dsl_autodetect: <value in [disable, enable]>
sfp_dsl_mac: <string>
sw_algorithm: <value in [l2, l3, eh, ...]>
system_id: <string>
system_id_type: <value in [auto, user]>
vlan_id: <integer>
vlan_op_mode: <value in [tag, untag, passthrough]>
generic_receive_offload: <value in [disable, enable]>
interconnect_profile: <value in [default, profile1, profile2]>
large_receive_offload: <value in [disable, enable]>
annex: <value in [a, b, j, ...]>
aggregate_type: <value in [physical, vxlan]>
switch_controller_netflow_collect: <value in [disable, enable]>
wifi_dns_server1: <string>
wifi_dns_server2: <string>
wifi_gateway: <string>
default_purdue_level: <value in [1, 2, 3, ...]>
dhcp_broadcast_flag: <value in [disable, enable]>
dhcp_smart_relay: <value in [disable, enable]>
switch_controller_offloading: <value in [disable, enable]>
switch_controller_offloading_gw: <value in [disable, enable]>
switch_controller_offloading_ip: <string>
dhcp_relay_circuit_id: <string>
dhcp_relay_source_ip: <string>
switch_controller_offload: <value in [disable, enable]>
switch_controller_offload_gw: <value in [disable, enable]>
switch_controller_offload_ip: <string>
mirroring_direction: <value in [rx, tx, both]>
mirroring_port: <string>
port_mirroring: <value in [disable, enable]>
security_8021x_member_mode: <value in [disable, switch]>
stp_edge: <value in [disable, enable]>
dhcp_relay_allow_no_end_option: <value in [disable, enable]>
netflow_sample_rate: <integer>
netflow_sampler_id: <integer>
pppoe_egress_cos: <value in [cos0, cos1, cos2, ...]>
security_ip_auth_bypass: <value in [disable, enable]>
virtual_mac: <string>
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 始终 |
|
请求的完整 URL。 返回: 始终 示例: |
|
API 请求的状态。 返回: 始终 示例: |
|
API 响应。 返回: 始终 |
|
API 响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回: 复杂 |