fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping 模块 – Fsp vlan 动态映射

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping。

fortinet.fortimanager 2.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选择 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选择 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
fsp_vlan_dynamicmapping 字典	设置的顶层参数。
_dhcp_status 别名：_dhcp-status 字符串	DHCP 状态。 选择 "disable" "enable"
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
dhcp_server 别名：dhcp-server 字典	DHCP 服务器。
auto_configuration 别名：auto-configuration 字符串	启用/禁用自动配置。 选择 "disable" "enable"
auto_managed_status 别名：auto-managed-status 字符串	一旦此接口已从 FortiIPAM 分配到 IP 地址，则启用/禁用此 DHCP 服务器的使用。 选择 "disable" "enable"
conflicted_ip_timeout 别名：conflicted-ip-timeout 整数	在冲突的 IP 地址从 DHCP 范围中删除后，等待多少秒才能重复使用该地址。
ddns_auth 别名：ddns-auth 字符串	DDNS 身份验证模式。 选择 "disable" "tsig"
ddns_key 别名：ddns-key 任何	(列表或字符串) DDNS 更新密钥
ddns_keyname 别名：ddns-keyname 字符串	DDNS 更新密钥名称。
ddns_server_ip 别名：ddns-server-ip 字符串	DDNS 服务器 IP。
ddns_ttl 别名：ddns-ttl 整数	TTL。
ddns_update 别名：ddns-update 字符串	启用/禁用 DHCP 的 DDNS 更新。 选择 "disable" "enable"
ddns_update_override 别名：ddns-update-override 字符串	启用/禁用 DHCP 的 DDNS 更新覆盖。 选择 "disable" "enable"
ddns_zone 别名：ddns-zone 字符串	您的域名区域
default_gateway 别名：default-gateway 字符串	DHCP 服务器分配的默认网关 IP 地址。
dhcp_settings_from_fortiipam 别名：dhcp-settings-from-fortiipam 字符串	启用/禁用从 FortiIPAM 填充 DHCP 服务器设置。 选择 "disable" "enable"
dns_server1 别名：dns-server1 字符串	DNS 服务器 1。
dns_server2 别名：dns-server2 字符串	DNS 服务器 2。
dns_server3 别名: dns-server3 字符串	DNS 服务器 3。
dns_server4 别名: dns-server4 字符串	DNS 服务器 4。
dns_service 别名: dns-service 字符串	为 DHCP 客户端分配 DNS 服务器的选项。 选择 "default" "specify" "local"
domain 字符串	DHCP 服务器分配给客户端的 IP 地址的域名后缀。
enable 字符串	启用。 选择 "disable" "enable"
exclude_range 别名: exclude-range 列表 / 元素=字典	排除范围。
end_ip 别名: end-ip 字符串	IP 范围的结束地址。
id 整数	ID。
lease_time 别名: lease-time 整数	租约时间（秒），0 表示默认租约时间。
start_ip 别名: start-ip 字符串	IP 范围的起始地址。
uci_match 别名: uci-match 字符串	启用/禁用用户类标识符。 选择 "disable" "enable"
uci_string 别名: uci-string 任何	（列表）一个或多个 UCI 字符串，用空格分隔并用引号引起来。
vci_match 别名: vci-match 字符串	启用/禁用供应商类标识符。 选择 "disable" "enable"
vci_string 别名: vci-string 任何	（列表）一个或多个 VCI 字符串，用空格分隔并用引号引起来。
filename 字符串	TFTP 服务器上的引导文件名。
forticlient_on_net_status 别名: forticlient-on-net-status 字符串	为此 DHCP 服务器启用/禁用 FortiClient-On-Net 服务。 选择 "disable" "enable"
id 整数	ID。
ip_mode 别名: ip-mode 字符串	用于分配客户端 IP 的方法。 选择 "range" "usrgrp"
ip_range 别名: ip-range 列表 / 元素=字典	IP 范围。
end_ip 别名: end-ip 字符串	IP 范围的结束地址。
id 整数	ID。
lease_time 别名: lease-time 整数	租约时间（秒），0 表示默认租约时间。
start_ip 别名: start-ip 字符串	IP 范围的起始地址。
uci_match 别名: uci-match 字符串	启用/禁用用户类标识符。 选择 "disable" "enable"
uci_string 别名: uci-string 任何	（列表）一个或多个 UCI 字符串，用空格分隔并用引号引起来。
vci_match 别名: vci-match 字符串	启用/禁用供应商类标识符。 选择 "disable" "enable"
vci_string 别名: vci-string 任何	（列表）一个或多个 VCI 字符串，用空格分隔并用引号引起来。
ipsec_lease_hold 别名: ipsec-lease-hold 整数	DHCP over IPsec 租约在隧道关闭后此秒数到期。
lease_time 别名: lease-time 整数	租约时间（秒），0 表示无限期。
mac_acl_default_action 别名: mac-acl-default-action 字符串	MAC 访问控制默认操作。 选择 "assign" "block"
netmask 字符串	DHCP 服务器分配的子网掩码。
next_server 别名: next-server 字符串	服务器的 IP 地址。
ntp_server1 别名: ntp-server1 字符串	NTP 服务器 1。
ntp_server2 别名: ntp-server2 字符串	NTP 服务器 2。
ntp_server3 别名: ntp-server3 字符串	NTP 服务器 3。
ntp_service 别名: ntp-service 字符串	用于分配网络时间协议的选项。 选择 "default" "specify" "local"
option1 任何	（列表）选项 1。
option2 任何	（列表）选项 2。
option3 任何	（列表）选项 3。
option4 字符串	选项 4。
option5 字符串	选项 5。
option6 字符串	选项 6。
options 列表 / 元素=字典	选项。
code 整数	DHCP 选项代码。
id 整数	ID。
ip 任何	（列表）DHCP 选项 IP。
type 字符串	DHCP 选项类型。 选择 "hex" "string" "ip" "fqdn"
uci_match 别名: uci-match 字符串	启用/禁用用户类标识符。 选择 "disable" "enable"
uci_string 别名: uci-string 任何	（列表）一个或多个 UCI 字符串，用空格分隔并用引号引起来。
value 字符串	DHCP 选项值。
vci_match 别名: vci-match 字符串	启用/禁用供应商类标识符。 选择 "disable" "enable"
vci_string 别名: vci-string 任何	（列表）一个或多个 VCI 字符串，用空格分隔并用引号引起来。
relay_agent 别名: relay-agent 字符串	中继代理 IP。
reserved_address 别名: reserved-address 列表 / 元素=字典	保留地址。
action 字符串	用于配置具有保留 MAC 地址的客户端的 DHCP 服务器的选项。 选择 "assign" "block" "reserved"
circuit_id 别名: circuit-id 字符串	将获得保留 IP 地址的客户端的选项 82 电路 ID。
circuit_id_type 别名: circuit-id-type 字符串	DHCP 选项类型。 选择 "hex" "string"
description 字符串	描述。
id 整数	ID。
ip 字符串	要为 MAC 地址保留的 IP 地址。
mac 字符串	将获得保留 IP 地址的客户端的 MAC 地址。
remote_id 别名: remote-id 字符串	将获得保留 IP 地址的客户端的选项 82 远程 ID。
remote_id_type 别名: remote-id-type 字符串	DHCP 选项类型。 选择 "hex" "string"
type 字符串	DHCP 保留地址类型。 选择 "mac" "option82"
server_type 别名: server-type 字符串	DHCP 服务器可以是普通 DHCP 服务器或 IPsec DHCP 服务器。 选择 "regular" "ipsec"
shared_subnet 别名: shared-subnet 字符串	启用/禁用共享子网。 选择 "disable" "enable"
status 字符串	启用/禁用此 DHCP 配置。 选择 "disable" "enable"
tftp_server 别名: tftp-server 任何	(列表) 一个或多个 TFTP 服务器的主机名或 IP 地址，用空格分隔并用引号引起来。
timezone 字符串	选择要分配给 DHCP 客户端的时区。 选择 "00" "01" "02" "03" "04" "05" "06" "07" "08" "09" "10" "11" "12" "13" "14" "15" "16" "17" "18" "19" "20" "21" "22" "23" "24" "25" "26" "27" "28" "29" "30" "31" "32" "33" "34" "35" "36" "37" "38" "39" "40" "41" "42" "43" "44" "45" "46" "47" "48" "49" "50" "51" "52" "53" "54" "55" "56" "57" "58" "59" "60" "61" "62" "63" "64" "65" "66" "67" "68" "69" "70" "71" "72" "73" "74" "75" "76" "77" "78" "79" "80" "81" "82" "83" "84" "85" "86" "87"
timezone_option 别名: timezone-option 字符串	DHCP 服务器设置客户端时区的选项。 选择 "disable" "default" "specify"
vci_match 别名: vci-match 字符串	启用/禁用供应商类标识符。 选择 "disable" "enable"
vci_string 别名: vci-string 任何	（列表）一个或多个 VCI 字符串，用空格分隔并用引号引起来。
wifi_ac1 别名: wifi-ac1 字符串	WiFi 接入控制器 1 IP 地址
wifi_ac2 别名: wifi-ac2 字符串	WiFi 接入控制器 2 IP 地址
wifi_ac3 别名: wifi-ac3 字符串	WiFi 接入控制器 3 IP 地址
wifi_ac_service 别名: wifi-ac-service 字符串	将 WiFi 接入控制器分配给 DHCP 客户端的选项 选择 "specify" "local"
wins_server1 别名: wins-server1 字符串	WINS 服务器 1。
wins_server2 别名: wins-server2 字符串	WINS 服务器 2。
interface 字典	接口。
dhcp_relay_agent_option 别名: dhcp-relay-agent-option 字符串	DHCP 中继代理选项。 选择 "disable" "enable"
dhcp_relay_interface_select_method 别名: dhcp-relay-interface-select-method 字符串	DHCP 中继接口选择方法。 选择 "auto" "sdwan" "specify"
dhcp_relay_ip 别名: dhcp-relay-ip 任何	(列表) DHCP 中继 IP。
dhcp_relay_service 别名: dhcp-relay-service 字符串	DHCP 中继服务。 选择 "disable" "enable"
dhcp_relay_type 别名: dhcp-relay-type 字符串	DHCP 中继类型。 选择 "regular" "ipsec"
ip 字符串	IP。
ipv6 字典	IPv6。
autoconf 字符串	启用/禁用地址自动配置。 选择 "disable" "enable"
cli_conn6_status 别名: cli-conn6-status 整数	Cli conn6 状态。
dhcp6_client_options 别名: dhcp6-client-options 列表 / 元素=字符串	DHCPv6 客户端选项。 选择 "rapid" "iapd" "iana" "dns" "dnsname"
dhcp6_information_request 别名: dhcp6-information-request 字符串	启用/禁用 DHCPv6 信息请求。 选择 "disable" "enable"
dhcp6_prefix_delegation 别名: dhcp6-prefix-delegation 字符串	启用/禁用 DHCPv6 前缀委派。 选择 "disable" "enable"
dhcp6_prefix_hint 别名: dhcp6-prefix-hint 字符串	将用作上游 DHCPv6 服务器提示的 DHCPv6 前缀。
dhcp6_prefix_hint_plt 别名: dhcp6-prefix-hint-plt 整数	DHCPv6 前缀提示首选生存时间
dhcp6_prefix_hint_vlt 别名: dhcp6-prefix-hint-vlt 整数	DHCPv6 前缀提示有效生存时间
dhcp6_relay_interface_id 别名: dhcp6-relay-interface-id 字符串	DHCP6 中继接口 ID。
dhcp6_relay_ip 别名: dhcp6-relay-ip 字符串	DHCPv6 中继 IP 地址。
dhcp6_relay_service 别名: dhcp6-relay-service 字符串	启用/禁用 DHCPv6 中继。 选择 "disable" "enable"
dhcp6_relay_source_interface 别名: dhcp6-relay-source-interface 字符串	启用/禁用使用此接口上的地址作为中继消息的源地址。 选择 "disable" "enable"
dhcp6_relay_source_ip 别名: dhcp6-relay-source-ip 字符串	DHCP6 中继用作其源 IP 的 IPv6 地址。
dhcp6_relay_type 别名: dhcp6-relay-type 字符串	DHCPv6 中继类型。 选择 "regular"
icmp6_send_redirect 别名: icmp6-send-redirect 字符串	启用/禁用发送 ICMPv6 重定向。 选择 "disable" "enable"
interface_identifier 别名: interface-identifier 字符串	IPv6 接口标识符。
ip6_address 别名: ip6-address 字符串	主要 IPv6 地址前缀，语法
ip6_allowaccess 别名: ip6-allowaccess 列表 / 元素=字符串	允许对接口进行管理访问。 选择 "https" "ping" "ssh" "snmp" "http" "telnet" "fgfm" "capwap" "fabric"
ip6_default_life 别名: ip6-default-life 整数	默认生存时间
ip6_delegated_prefix_iaid 别名: ip6-delegated-prefix-iaid 整数	从上游接口获取的委派前缀的 IAID。
ip6_delegated_prefix_list 别名: ip6-delegated-prefix-list 列表 / 元素=字典	Ip6 委派前缀列表。
autonomous_flag 别名: autonomous-flag 字符串	启用/禁用自主标志。 选择 "disable" "enable"
delegated_prefix_iaid 别名: delegated-prefix-iaid 整数	从上游接口获取的委派前缀的 IAID。
onlink_flag 别名: onlink-flag 字符串	启用/禁用链路上标志。 选择 "disable" "enable"
prefix_id 别名: prefix-id 整数	前缀 ID。
rdnss 任何	(列表) 递归 DNS 服务器选项。
rdnss_service 别名: rdnss-service 字符串	递归 DNS 服务选项。 选择 "delegated" "default" "specify"
subnet 字符串	将子网 ID 添加到路由前缀。
upstream_interface 别名: upstream-interface 字符串	提供委派信息的接口的名称。
ip6_dns_server_override 别名: ip6-dns-server-override 字符串	启用/禁用使用通过 DHCP 获取的 DNS 服务器。 选择 "disable" "enable"
ip6_extra_addr 别名: ip6-extra-addr 列表 / 元素=字典	Ip6 额外地址。
prefix 字符串	IPv6 地址前缀。
ip6_hop_limit 别名: ip6-hop-limit 整数	跃点限制
ip6_link_mtu 别名: ip6-link-mtu 整数	IPv6 链路 MTU。
ip6_manage_flag 别名: ip6-manage-flag 字符串	启用/禁用管理标志。 选择 "disable" "enable"
ip6_max_interval 别名: ip6-max-interval 整数	IPv6 最大间隔
ip6_min_interval 别名: ip6-min-interval 整数	IPv6 最小间隔
ip6_mode 别名: ip6-mode 字符串	寻址模式 选择 "static" "dhcp" "pppoe" "delegated"
ip6_other_flag 别名: ip6-other-flag 字符串	启用/禁用其他 IPv6 标志。 选择 "disable" "enable"
ip6_prefix_list 别名: ip6-prefix-list 列表 / 元素=字典	Ip6 前缀列表。
autonomous_flag 别名: autonomous-flag 字符串	启用/禁用自主标志。 选择 "disable" "enable"
dnssl 任何	(列表) DNS 搜索列表选项。
onlink_flag 别名: onlink-flag 字符串	启用/禁用链路上标志。 选择 "disable" "enable"
preferred_life_time 别名: preferred-life-time 整数	首选生命周期
prefix 字符串	IPv6 前缀。
rdnss 任何	(列表) 递归 DNS 服务器选项。
valid_life_time 别名: valid-life-time 整数	有效生命周期
ip6_prefix_mode 别名: ip6-prefix-mode 字符串	从 DHCP 或 RA 分配前缀。 选择 "dhcp6" "ra"
ip6_reachable_time 别名: ip6-reachable-time 整数	IPv6 可达时间
ip6_retrans_time 别名: ip6-retrans-time 整数	IPv6 重传时间
ip6_send_adv 别名: ip6-send-adv 字符串	启用/禁用发送有关接口的通告。 选择 "disable" "enable"
ip6_subnet 别名: ip6-subnet 字符串	子网到路由前缀，语法
ip6_upstream_interface 别名: ip6-upstream-interface 字符串	提供委派信息的接口名称。
nd_cert 别名: nd-cert 字符串	邻居发现证书。
nd_cga_modifier 别名: nd-cga-modifier 字符串	邻居发现 CGA 修饰符。
nd_mode 别名: nd-mode 字符串	邻居发现模式。 选择 "basic" "SEND-compatible"
nd_security_level 别名: nd-security-level 整数	邻居发现安全级别
nd_timestamp_delta 别名: nd-timestamp-delta 整数	邻居发现时间戳增量值
nd_timestamp_fuzz 别名: nd-timestamp-fuzz 整数	邻居发现时间戳模糊因子
ra_send_mtu 别名: ra-send-mtu 字符串	启用/禁用在 RA 数据包中发送链路 MTU。 选择 "disable" "enable"
unique_autoconf_addr 别名: unique-autoconf-addr 字符串	启用/禁用唯一自动配置地址。 选择 "disable" "enable"
vrip6_link_local 字符串	虚拟路由器的链路本地 IPv6 地址。
vrrp6 列表 / 元素=字典	Vrrp6。
accept_mode 别名: accept-mode 字符串	启用/禁用接受模式。 选择 "disable" "enable"
adv_interval 别名: adv-interval 整数	通告间隔
ignore_default_route 别名: ignore-default-route 字符串	启用/禁用在检查目标时忽略默认路由。 选择 "disable" "enable"
preempt 字符串	启用/禁用抢占模式。 选择 "disable" "enable"
priority 整数	虚拟路由器的优先级
start_time 别名: start-time 整数	启动时间
status 字符串	启用/禁用 VRRP。 选择 "disable" "enable"
vrdst6 字符串	监视到此目标的路由。
vrdst_priority 别名: vrdst-priority 整数	当虚拟路由器目标变为不可达时，虚拟路由器的优先级
vrgrp 整数	VRRP 组 ID
vrid 整数	虚拟路由器标识符
vrip6 字符串	虚拟路由器的 IPv6 地址。
vrrp_virtual_mac6 别名: vrrp-virtual-mac6 字符串	启用/禁用 VRRP 的虚拟 MAC。 选择 "disable" "enable"
secondary_IP 别名: secondary-IP 字符串	辅助 IP。 选择 "disable" "enable"
secondaryip 列表 / 元素=字典	辅助 IP。
allowaccess 列表 / 元素=字符串	辅助 IP 地址的管理访问设置。 选择 "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 字符串	此 IP 的网关 ping 服务器。
gwdetect 字符串	启用/禁用首先检测网关活动。 选择 "disable" "enable"
ha_priority 别名: ha-priority 整数	PING 服务器的 HA 选举优先级。
id 整数	ID。
ip 字符串	接口的辅助 IP 地址。
ping_serv_status 别名: ping-serv-status 整数	Ping 服务器状态。
secip_relay_ip 别名: secip-relay-ip 字符串	DHCP 中继 IP 地址。
seq 整数	Seq。
vlanid 整数	Vlanid。
vrrp 列表 / 元素=字典	Vrrp。
accept_mode 别名: accept-mode 字符串	启用/禁用接受模式。 选择 "disable" "enable"
adv_interval 别名: adv-interval 整数	通告间隔
ignore_default_route 别名: ignore-default-route 字符串	启用/禁用在检查目标时忽略默认路由。 选择 "disable" "enable"
preempt 字符串	启用/禁用抢占模式。 选择 "disable" "enable"
priority 整数	虚拟路由器的优先级
proxy_arp 别名: proxy-arp 列表 / 元素=字典	代理 ARP。
id 整数	ID。
ip 字符串	设置代理 ARP 的 IP 地址。
start_time 别名: start-time 整数	启动时间
status 字符串	启用/禁用此 VRRP 配置。 选择 "disable" "enable"
version 字符串	VRRP 版本。 选择 "2" "3"
vrdst 任何	(列表) 监视到此目标的路由。
vrdst_priority 别名: vrdst-priority 整数	当虚拟路由器目标变为不可达时，虚拟路由器的优先级
vrgrp 整数	VRRP 组 ID
vrid 整数	虚拟路由器标识符
vrip 字符串	虚拟路由器的 IP 地址。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选择 "update" "set" "add"
rc_failed 列表 / elements=integer	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=integer	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	用于创建、更新或删除对象的指令。 选择 "present" "absent"
vlan 字符串 / 必需	请求 URL 中的参数 (vlan)。
workspace_locking_adom 字符串	在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他值，包括 root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁定的最长时间（以秒为单位）。 默认值: 300

备注

注意

• 从 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: Fsp vlan dynamic mapping
      fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping:
        # 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>
        vlan: <your own value>
        state: present # <value in [present, absent]>
        fsp_vlan_dynamicmapping:
          _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>

返回值

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

键	描述
meta 字典	请求的结果。 返回: 总是
request_url 字符串	完整的请求 URL。 返回: 总是 示例: "/sys/login/user"
response_code 整数	API 请求的状态码。 返回: 总是 示例: 0
response_data 列表 / 元素=字符串	API 响应的数据。 返回: 总是
response_message 字符串	API 响应的描述性消息。 返回: 总是 示例: "OK."
system_information 字典	目标系统的相关信息。 返回: 总是
rc 整数	请求的状态。 返回: 总是 示例: 0
version_check_warning 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回: 复杂数据

作者

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

集合链接

• 问题跟踪器
• 主页
• 代码仓库 (源代码)