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 设备。
示例包含所有需要在使用前根据数据源调整的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
设置的顶级参数。 |
|
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 字符串。 |
|
隧道断开后，基于 IPsec 的 DHCP 租约在此时间（秒）后过期。 |
|
租赁时间（秒），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 地址 |
|
将 WiFi 接入控制器分配给 DHCP 客户端的选项 选项
|
|
WINS 服务器 1。 |
|
WINS 服务器 2。 |
|
接口。 |
|
DHCP 中继代理选项。 选项
|
|
DHCP 中继接口选择方法。 选项
|
|
(列表) DHCP 中继 IP。 |
|
DHCP 中继服务。 选项
|
|
DHCP 中继类型。 选项
|
|
IP。 |
|
IPv6。 |
|
启用/禁用地址自动配置。 选项
|
|
Cli conn6 状态。 |
|
DHCP6 客户端选项。 选项
|
|
启用/禁用 DHCPv6 信息请求。 选项
|
|
启用/禁用 DHCPv6 前缀委派。 选项
|
|
将用作上游 DHCPv6 服务器提示的 DHCPv6 前缀。 |
|
DHCPv6 前缀提示首选生命周期 |
|
DHCPv6 前缀提示有效生命周期 |
|
DHCP6 中继接口 ID。 |
|
DHCPv6 中继 IP 地址。 |
|
启用/禁用 DHCPv6 中继。 选项
|
|
启用/禁用使用此接口上的地址作为中继消息的源地址。 选项
|
|
DHCP6 中继用作其源 IP 的 IPv6 地址。 |
|
DHCPv6 中继类型。 选项
|
|
启用/禁用发送 ICMPv6 重定向。 选项
|
|
IPv6 接口标识符。 |
|
主 IPv6 地址前缀，语法 |
|
允许管理访问接口。 选项
|
|
默认生命周期 |
|
从上游接口获得的委派前缀的 IAID。 |
|
IPv6 委派前缀列表。 |
|
启用/禁用自主标志。 选项
|
|
从上游接口获得的委派前缀的 IAID。 |
|
启用/禁用 onlink 标志。 选项
|
|
前缀 ID。 |
|
(列表) 递归 DNS 服务器选项。 |
|
递归 DNS 服务选项。 选项
|
|
将子网 ID 添加到路由前缀。 |
|
提供委派信息的接口名称。 |
|
启用/禁用使用 DHCP 获取的 DNS 服务器。 选项
|
|
IPv6 额外地址。 |
|
IPv6 地址前缀。 |
|
跳数限制 |
|
IPv6 链路 MTU。 |
|
启用/禁用管理标志。 选项
|
|
IPv6 最大间隔 |
|
IPv6 最小间隔 |
|
寻址模式 选项
|
|
启用/禁用其他 IPv6 标志。 选项
|
|
IPv6 前缀列表。 |
|
启用/禁用自主标志。 选项
|
|
(列表) DNS 搜索列表选项。 |
|
启用/禁用 onlink 标志。 选项
|
|
首选生存时间 |
|
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 地址。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
请求 URL 中的参数 (vlan)。 |
|
在工作区模式下运行 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: 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>
返回值
常见的返回值已在 此处 记录，以下是此模块独有的字段
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整 URL。 返回：始终 示例： |
|
API 请求的状态。 返回：始终 示例： |
|
API 响应。 返回：始终 |
|
API 响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
警告：如果剧本中使用的参数不受当前 FortiManager 版本支持。 返回： complex |