fortinet.fortimanager.fmgr_fsp_vlan_interface module – Configure interfaces.
Note
This module is part of the fortinet.fortimanager collection (version 2.3.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_fsp_vlan_interface.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
the parameter (adom) in requested url |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
the top level parameters set |
|
no description |
|
no description |
|
Type of aggregation. Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
HTTPS server certificate. |
|
Address of captive portal. |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
(list or str) no description |
|
no description |
|
(list) no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
default purdue level of device detected on this interface. Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
(list or str) no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
Enable/disable setting of the broadcast flag in messages sent by the DHCP client Choices:
|
|
Enable/disable addition of classless static routes retrieved from DHCP server. Choices:
|
|
no description |
|
no description Choices:
|
|
DHCP relay circuit ID. |
|
no description |
|
no description Choices:
|
|
(list) no description |
|
DHCP relay link selection. |
|
Enable/disable sending of DHCP requests to all servers. Choices:
|
|
no description Choices:
|
|
IP address used by the DHCP relay as its source IP. |
|
no description Choices:
|
|
no description |
|
Enable/disable DHCP smart relay. Choices:
|
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
EAP CA certificate name. |
|
EAP identity. |
|
EAP method. Choices:
|
|
(list) no description |
|
Enable/disable EAP-Supplicant. Choices:
|
|
EAP user certificate name. |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
(list or str) no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
Configure IKE authentication SAML server. |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
Set interconnect profile. Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
DHCP6 relay interface ID. |
|
no description |
|
no description Choices:
|
|
Enable/disable use of address on this interface as the source address of the relay message. Choices:
|
|
IPv6 address used by the DHCP6 relay as its source IP. |
|
no description Choices:
|
|
Enable/disable sending of ICMPv6 redirects. Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
IAID of obtained delegated-prefix from the upstream interface. |
|
no description |
|
no description Choices:
|
|
IAID of obtained delegated-prefix from the upstream interface. |
|
no description Choices:
|
|
no description |
|
(list) no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
(list) no description |
|
no description Choices:
|
|
no description |
|
no description |
|
(list) no description |
|
no description |
|
Assigning a prefix from DHCP or RA. Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
Enable/disable sending link MTU in RA packet. Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
(list or str) no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
NP QoS profile ID. |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
(list) no description |
|
(list or str) no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
(list) no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
SFP-DSL ADSL Fallback PVC ATM QoS. Choices:
|
|
SFP-DSL ADSL Fallback PVC Channel. |
|
SFP-DSL ADSL Fallback PVC CRC Option |
|
SFP-DSL ADSL Fallback PVC Packet Cell Rate in cells |
|
SFP-DSL ADSL Fallback PVC Sustainable Cell Rate in cells |
|
SFP-DSL ADSL Fallback PVC VLAN ID. |
|
SFP-DSL ADSL Fallback PVC VLANID RX. |
|
SFP-DSL ADSL Fallback PVC VLAN RX op. Choices:
|
|
SFP-DSL ADSL Fallback PVC VLAN ID TX. |
|
SFP-DSL ADSL Fallback PVC VLAN TX op. Choices:
|
|
IPv4 reachable time in milliseconds |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
DHCP relay IP address. |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
(list or str) no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
Select VDSL Profile 30a or 35b. Choices:
|
|
no description |
|
no description Choices:
|
|
Enable/disable SFP DSL. Choices:
|
|
Enable/disable SFP DSL ADSL fallback. Choices:
|
|
Enable/disable SFP DSL MAC address autodetect. Choices:
|
|
SFP DSL MAC address. |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
Control STP behaviour on HA secondary. Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
Frame distribution algorithm for switch. Choices:
|
|
Initial create for switch-controller VLANs. |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
Integrated FortiLink settings for managed FortiSwitch. |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
Enable/disable managed FortiSwitch IoT scanning. Choices:
|
|
no description |
|
no description |
|
no description |
|
NetFlow collection and processing. Choices:
|
|
Enable/disable managed FortiSwitch routing offload. Choices:
|
|
Enable/disable managed FortiSwitch routing offload gateway. Choices:
|
|
IP for routing offload on FortiSwitch. |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
Source IP address used in FortiLink over L3 connections. Choices:
|
|
no description |
|
Define a system ID for the aggregate interface. |
|
Method in which system ID is generated. Choices:
|
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
Vlan ID |
|
Configure DSL 802. Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
ID. |
|
Set IP addresses of proxy ARP. |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
(list) no description |
|
no description |
|
no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
DNS server 1. |
|
DNS server 2. |
|
no description Choices:
|
|
no description |
|
IPv4 default gateway IP address. |
|
(list) no description |
|
no description |
|
no description Choices:
|
|
(list) no description |
|
no description |
|
no description |
|
no description Choices:
|
|
no description |
|
no description |
|
no description |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
the parameter (vlan) in requested url |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure interfaces.
fmgr_fsp_vlan_interface:
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>
fsp_vlan_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]>
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-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>
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-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-spillover-threshold: <integer>
internal: <integer>
ip: <string>
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]>
ip6-address: <string>
ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6-default-life: <integer>
ip6-dns-server-override: <value in [disable, enable]>
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-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>
vrip6_link_local: <string>
vrrp-virtual-mac6: <value in [disable, enable]>
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-extra-addr:
-
prefix: <string>
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>
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>
interface-identifier: <string>
unique-autoconf-addr: <value in [disable, enable]>
icmp6-send-redirect: <value in [disable, enable]>
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>
management-ip: <string>
max-egress-burst-rate: <integer>
max-egress-rate: <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, ...]>
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, ...]>
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]>
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
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>
switch: <string>
switch-controller-access-vlan: <value in [disable, enable]>
switch-controller-arp-inspection: <value in [disable, enable]>
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-igmp-snooping: <value in [disable, enable]>
switch-controller-learning-limit: <integer>
switch-controller-radius-server: <string>
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>
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>
eip: <string>
fortilink-neighbor-detect: <value in [lldp, fortilink]>
ingress-shaping-profile: <string>
ring-rx: <integer>
ring-tx: <integer>
switch-controller-igmp-snooping-fast-leave: <value in [disable, enable]>
switch-controller-igmp-snooping-proxy: <value in [disable, enable]>
switch-controller-rspan-mode: <value in [disable, enable]>
bandwidth-measure-time: <integer>
ip-managed-by-fortiipam: <value in [disable, enable, inherit-global]>
managed-subnetwork-size: <value in [256, 512, 1024, ...]>
measured-downstream-bandwidth: <integer>
measured-upstream-bandwidth: <integer>
monitor-bandwidth: <value in [disable, enable]>
swc-vlan: <integer>
switch-controller-feature: <value in [none, default-vlan, quarantine, ...]>
switch-controller-mgmt-vlan: <integer>
switch-controller-nac: <string>
vlan-protocol: <value in [8021q, 8021ad]>
dhcp-relay-interface: <string>
dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>
np-qos-profile: <integer>
swc-first-create: <integer>
switch-controller-iot-scanning: <value in [disable, enable]>
switch-controller-source-ip: <value in [outbound, fixed]>
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]>
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>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |