fmgr_fsp_vlan¶

New in version 2.10.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiManager Version Compatibility ¶

	`6.0.0`	`6.2.1`	`6.2.3`	`6.2.5`	`6.4.0`	`6.4.2`	`6.4.5`	`7.0.0`	`7.2.0`
fsp_vlan	yes	yes	yes	yes	yes	yes	yes	yes	yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
state - The directive to create, update or delete an object type: str required: true choices: present, absent
adom - The parameter in requested url type: str required: true
fsp_vlan - no description type: dict

_dhcp-status - _Dhcp-Status. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

_dhcp-status True True True True True True True True True
auth - No description for the parameter type: str choices: [radius, usergroup] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

auth True True False False False False False False False
color - Color. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

color True True True True True True True True True
comments - No description for the parameter type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

comments True True False False False False False False False
dynamic_mapping - Dynamic_Mapping. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

dynamic_mapping True True True True True True True True True
- _dhcp-status - _Dhcp-Status. type: str choices: [disable, enable] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  _dhcp-status True True True True True True True True True
- _scope - _Scope. type: array more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  _scope True True True True True True True True True
  - name - Name. type: str more...
    
    6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
    
    name True True True True True True True True True
  - vdom - Vdom. type: str more...
    
    6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
    
    vdom True True True True True True True True True
- dhcp-server type: dict
- interface type: dict
name - Name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

name True True True True True True True True True
portal-message-override-group - No description for the parameter type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

portal-message-override-group True True False False False False False False False
radius-server - No description for the parameter type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

radius-server True True False False False False False False False
security - No description for the parameter type: str choices: [open, captive-portal, 8021x] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

security True True False False False False False False False
selected-usergroups - No description for the parameter type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

selected-usergroups True True False False False False False False False
usergroup - No description for the parameter type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

usergroup True True False False False False False False False
vdom - Vdom. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vdom True True True True True True True True True
vlanid - Vlanid. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

vlanid True True True True True True True True True
dhcp-server type: dict

auto-configuration - Enable/disable auto configuration. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

auto-configuration True True True
auto-managed-status - Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

auto-managed-status True True True
conflicted-ip-timeout - Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused. type: int more...

6.4.5 7.0.0 7.2.0

conflicted-ip-timeout True True True
ddns-auth - DDNS authentication mode. type: str choices: [disable, tsig] more...

6.4.5 7.0.0 7.2.0

ddns-auth True True True
ddns-key - DDNS update key (base 64 encoding). type: str more...

6.4.5 7.0.0 7.2.0

ddns-key True True True
ddns-keyname - DDNS update key name. type: str more...

6.4.5 7.0.0 7.2.0

ddns-keyname True True True
ddns-server-ip - DDNS server IP. type: str more...

6.4.5 7.0.0 7.2.0

ddns-server-ip True True True
ddns-ttl - TTL. type: int more...

6.4.5 7.0.0 7.2.0

ddns-ttl True True True
ddns-update - Enable/disable DDNS update for DHCP. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ddns-update True True True
ddns-update-override - Enable/disable DDNS update override for DHCP. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ddns-update-override True True True
ddns-zone - Zone of your domain name (ex. type: str more...

6.4.5 7.0.0 7.2.0

ddns-zone True True True
default-gateway - Default gateway IP address assigned by the DHCP server. type: str more...

6.4.5 7.0.0 7.2.0

default-gateway True True True
dhcp-settings-from-fortiipam - Enable/disable populating of DHCP server settings from FortiIPAM. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

dhcp-settings-from-fortiipam True True True
dns-server1 - DNS server 1. type: str more...

6.4.5 7.0.0 7.2.0

dns-server1 True True True
dns-server2 - DNS server 2. type: str more...

6.4.5 7.0.0 7.2.0

dns-server2 True True True
dns-server3 - DNS server 3. type: str more...

6.4.5 7.0.0 7.2.0

dns-server3 True True True
dns-server4 - DNS server 4. type: str more...

6.4.5 7.0.0 7.2.0

dns-server4 True True True
dns-service - Options for assigning DNS servers to DHCP clients. type: str choices: [default, specify, local] more...

6.4.5 7.0.0 7.2.0

dns-service True True True
domain - Domain name suffix for the IP addresses that the DHCP server assigns to clients. type: str more...

6.4.5 7.0.0 7.2.0

domain True True True
enable - Enable. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

enable True True True
exclude-range - Exclude-Range. type: array more...

6.4.5 7.0.0 7.2.0

exclude-range True True True
- end-ip - End of IP range. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  end-ip True True True
- id - ID. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  id True True True
- start-ip - Start of IP range. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  start-ip True True True
filename - Name of the boot file on the TFTP server. type: str more...

6.4.5 7.0.0 7.2.0

filename True True True
forticlient-on-net-status - Enable/disable FortiClient-On-Net service for this DHCP server. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

forticlient-on-net-status True True True
id - ID. type: int more...

6.4.5 7.0.0 7.2.0

id True True True
ip-mode - Method used to assign client IP. type: str choices: [range, usrgrp] more...

6.4.5 7.0.0 7.2.0

ip-mode True True True
ip-range - Ip-Range. type: array more...

6.4.5 7.0.0 7.2.0

ip-range True True True
- end-ip - End of IP range. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  end-ip True True True
- id - ID. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  id True True True
- start-ip - Start of IP range. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  start-ip True True True
ipsec-lease-hold - DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). type: int more...

6.4.5 7.0.0 7.2.0

ipsec-lease-hold True True True
lease-time - Lease time in seconds, 0 means unlimited. type: int more...

6.4.5 7.0.0 7.2.0

lease-time True True True
mac-acl-default-action - MAC access control default action (allow or block assigning IP settings). type: str choices: [assign, block] more...

6.4.5 7.0.0 7.2.0

mac-acl-default-action True True True
netmask - Netmask assigned by the DHCP server. type: str more...

6.4.5 7.0.0 7.2.0

netmask True True True
next-server - IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. type: str more...

6.4.5 7.0.0 7.2.0

next-server True True True
ntp-server1 - NTP server 1. type: str more...

6.4.5 7.0.0 7.2.0

ntp-server1 True True True
ntp-server2 - NTP server 2. type: str more...

6.4.5 7.0.0 7.2.0

ntp-server2 True True True
ntp-server3 - NTP server 3. type: str more...

6.4.5 7.0.0 7.2.0

ntp-server3 True True True
ntp-service - Options for assigning Network Time Protocol (NTP) servers to DHCP clients. type: str choices: [default, specify, local] more...

6.4.5 7.0.0 7.2.0

ntp-service True True True
option1 - Option1. type: str more...

6.4.5 7.0.0 7.2.0

option1 True True True
option2 - Option2. type: str more...

6.4.5 7.0.0 7.2.0

option2 True True True
option3 - Option3. type: str more...

6.4.5 7.0.0 7.2.0

option3 True True True
option4 - Option4. type: str more...

6.4.5 7.0.0 7.2.0

option4 True True True
option5 - Option5. type: str more...

6.4.5 7.0.0 7.2.0

option5 True True True
option6 - Option6. type: str more...

6.4.5 7.0.0 7.2.0

option6 True True True
options - Options. type: array more...

6.4.5 7.0.0 7.2.0

options True True True
- code - DHCP option code. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  code True True True
- id - ID. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  id True True True
- ip - DHCP option IPs. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  ip True True True
- type - DHCP option type. type: str choices: [hex, string, ip, fqdn] more...
  
  6.4.5 7.0.0 7.2.0
  
  type True True True
- value - DHCP option value. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  value True True True
reserved-address - Reserved-Address. type: array more...

6.4.5 7.0.0 7.2.0

reserved-address True True True
- action - Options for the DHCP server to configure the client with the reserved MAC address. type: str choices: [assign, block, reserved] more...
  
  6.4.5 7.0.0 7.2.0
  
  action True True True
- circuit-id - Option 82 circuit-ID of the client that will get the reserved IP address. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  circuit-id True True True
- circuit-id-type - DHCP option type. type: str choices: [hex, string] more...
  
  6.4.5 7.0.0 7.2.0
  
  circuit-id-type True True True
- description - Description. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  description True True True
- id - ID. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  id True True True
- ip - IP address to be reserved for the MAC address. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  ip True True True
- mac - MAC address of the client that will get the reserved IP address. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  mac True True True
- remote-id - Option 82 remote-ID of the client that will get the reserved IP address. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  remote-id True True True
- remote-id-type - DHCP option type. type: str choices: [hex, string] more...
  
  6.4.5 7.0.0 7.2.0
  
  remote-id-type True True True
- type - DHCP reserved-address type. type: str choices: [mac, option82] more...
  
  6.4.5 7.0.0 7.2.0
  
  type True True True
server-type - DHCP server can be a normal DHCP server or an IPsec DHCP server. type: str choices: [regular, ipsec] more...

6.4.5 7.0.0 7.2.0

server-type True True True
status - Enable/disable this DHCP configuration. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

status True True True
tftp-server - One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. type: str more...

6.4.5 7.0.0 7.2.0

tftp-server True True True
timezone - Select the time zone to be assigned to DHCP clients. type: str choices: [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] more...

6.4.5 7.0.0 7.2.0

timezone True True True
timezone-option - Options for the DHCP server to set the clients time zone. type: str choices: [disable, default, specify] more...

6.4.5 7.0.0 7.2.0

timezone-option True True True
vci-match - Enable/disable vendor class identifier (VCI) matching. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

vci-match True True True
vci-string - One or more VCI strings in quotes separated by spaces. type: str more...

6.4.5 7.0.0 7.2.0

vci-string True True True
wifi-ac-service - Options for assigning WiFi Access Controllers to DHCP clients type: str choices: [specify, local] more...

6.4.5 7.0.0 7.2.0

wifi-ac-service True True True
wifi-ac1 - WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). type: str more...

6.4.5 7.0.0 7.2.0

wifi-ac1 True True True
wifi-ac2 - WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). type: str more...

6.4.5 7.0.0 7.2.0

wifi-ac2 True True True
wifi-ac3 - WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). type: str more...

6.4.5 7.0.0 7.2.0

wifi-ac3 True True True
wins-server1 - WINS server 1. type: str more...

6.4.5 7.0.0 7.2.0

wins-server1 True True True
wins-server2 - WINS server 2. type: str more...

6.4.5 7.0.0 7.2.0

wins-server2 True True True

interface type: dict

ac-name - PPPoE server name. type: str more...

6.4.5 7.0.0 7.2.0

ac-name True True True
aggregate - Aggregate. type: str more...

6.4.5 7.0.0 7.2.0

aggregate True True True
algorithm - Frame distribution algorithm. type: str choices: [L2, L3, L4, LB] more...

6.4.5 7.0.0 7.2.0

algorithm True True True
alias - Alias will be displayed with the interface name to make it easier to distinguish. type: str more...

6.4.5 7.0.0 7.2.0

alias True True True
allowaccess - Permitted types of management access to this interface. type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...

6.4.5 7.0.0 7.2.0

allowaccess True True True
ap-discover - Enable/disable automatic registration of unknown FortiAP devices. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ap-discover True True True
arpforward - Enable/disable ARP forwarding. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

arpforward True True True
atm-protocol - ATM protocol. type: str choices: [none, ipoa] more...

6.4.5 7.0.0 7.2.0

atm-protocol True True True
auth-type - PPP authentication type to use. type: str choices: [auto, pap, chap, mschapv1, mschapv2] more...

6.4.5 7.0.0 7.2.0

auth-type True True True
auto-auth-extension-device - Enable/disable automatic authorization of dedicated Fortinet extension device on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

auto-auth-extension-device True True True
bandwidth-measure-time - Bandwidth measure time type: int more...

6.4.5 7.0.0 7.2.0

bandwidth-measure-time True True True
bfd - Bidirectional Forwarding Detection (BFD) settings. type: str choices: [global, enable, disable] more...

6.4.5 7.0.0 7.2.0

bfd True True True
bfd-desired-min-tx - BFD desired minimal transmit interval. type: int more...

6.4.5 7.0.0 7.2.0

bfd-desired-min-tx True True True
bfd-detect-mult - BFD detection multiplier. type: int more...

6.4.5 7.0.0 7.2.0

bfd-detect-mult True True True
bfd-required-min-rx - BFD required minimal receive interval. type: int more...

6.4.5 7.0.0 7.2.0

bfd-required-min-rx True True True
broadcast-forticlient-discovery - Broadcast-Forticlient-Discovery. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

broadcast-forticlient-discovery True True True
broadcast-forward - Enable/disable broadcast forwarding. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

broadcast-forward True True True
captive-portal - Enable/disable captive portal. type: int more...

6.4.5 7.0.0 7.2.0

captive-portal True True True
cli-conn-status - Cli-Conn-Status. type: int more...

6.4.5 7.0.0 7.2.0

cli-conn-status True True True
color - Color of icon on the GUI. type: int more...

6.4.5 7.0.0 7.2.0

color True True True
ddns - Ddns. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ddns True True True
ddns-auth - Ddns-Auth. type: str choices: [disable, tsig] more...

6.4.5 7.0.0 7.2.0

ddns-auth True True True
ddns-domain - Ddns-Domain. type: str more...

6.4.5 7.0.0 7.2.0

ddns-domain True True True
ddns-key - Ddns-Key. type: str more...

6.4.5 7.0.0 7.2.0

ddns-key True True True
ddns-keyname - Ddns-Keyname. type: str more...

6.4.5 7.0.0 7.2.0

ddns-keyname True True True
ddns-password - Ddns-Password. type: str more...

6.4.5 7.0.0 7.2.0

ddns-password True True True
ddns-server - Ddns-Server. type: str choices: [dhs.org, dyndns.org, dyns.net, tzo.com, ods.org, vavic.com, now.net.cn, dipdns.net, easydns.com, genericDDNS] more...

6.4.5 7.0.0 7.2.0

ddns-server True True True
ddns-server-ip - Ddns-Server-Ip. type: str more...

6.4.5 7.0.0 7.2.0

ddns-server-ip True True True
ddns-sn - Ddns-Sn. type: str more...

6.4.5 7.0.0 7.2.0

ddns-sn True True True
ddns-ttl - Ddns-Ttl. type: int more...

6.4.5 7.0.0 7.2.0

ddns-ttl True True True
ddns-username - Ddns-Username. type: str more...

6.4.5 7.0.0 7.2.0

ddns-username True True True
ddns-zone - Ddns-Zone. type: str more...

6.4.5 7.0.0 7.2.0

ddns-zone True True True
dedicated-to - Configure interface for single purpose. type: str choices: [none, management] more...

6.4.5 7.0.0 7.2.0

dedicated-to True True True
defaultgw - Enable to get the gateway IP from the DHCP or PPPoE server. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

defaultgw True True True
description - Description. type: str more...

6.4.5 7.0.0 7.2.0

description True True True
detected-peer-mtu - Detected-Peer-Mtu. type: int more...

6.4.5 7.0.0 7.2.0

detected-peer-mtu True True True
detectprotocol - Protocols used to detect the server. type: array choices: [ping, tcp-echo, udp-echo] more...

6.4.5 7.0.0 7.2.0

detectprotocol True True True
detectserver - Gateways ping server for this IP. type: str more...

6.4.5 7.0.0 7.2.0

detectserver True True True
device-access-list - Device-Access-List. type: str more...

6.4.5 7.0.0 7.2.0

device-access-list True True True
device-identification - Enable/disable passively gathering of device identity information about the devices on the network connected to this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

device-identification True True True
device-identification-active-scan - Device-Identification-Active-Scan. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

device-identification-active-scan True True True
device-netscan - Device-Netscan. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

device-netscan True True True
device-user-identification - Enable/disable passive gathering of user identity information about users on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

device-user-identification True True True
devindex - Devindex. type: int more...

6.4.5 7.0.0 7.2.0

devindex True True True
dhcp-client-identifier - DHCP client identifier. type: str more...

6.4.5 7.0.0 7.2.0

dhcp-client-identifier True True True
dhcp-relay-agent-option - Enable/disable DHCP relay agent option. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

dhcp-relay-agent-option True True True
dhcp-relay-interface - Specify outgoing interface to reach server. type: str more...

6.4.5 7.0.0 7.2.0

dhcp-relay-interface True True True
dhcp-relay-interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...

6.4.5 7.0.0 7.2.0

dhcp-relay-interface-select-method True True True
dhcp-relay-ip - DHCP relay IP address. type: str more...

6.4.5 7.0.0 7.2.0

dhcp-relay-ip True True True
dhcp-relay-service - Enable/disable allowing this interface to act as a DHCP relay. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

dhcp-relay-service True True True
dhcp-relay-type - DHCP relay type (regular or IPsec). type: str choices: [regular, ipsec] more...

6.4.5 7.0.0 7.2.0

dhcp-relay-type True True True
dhcp-renew-time - DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server. type: int more...

6.4.5 7.0.0 7.2.0

dhcp-renew-time True True True
disc-retry-timeout - Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout. type: int more...

6.4.5 7.0.0 7.2.0

disc-retry-timeout True True True
disconnect-threshold - Time in milliseconds to wait before sending a notification that this interface is down or disconnected. type: int more...

6.4.5 7.0.0 7.2.0

disconnect-threshold True True True
distance - Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route. type: int more...

6.4.5 7.0.0 7.2.0

distance True True True
dns-query - Dns-Query. type: str choices: [disable, recursive, non-recursive] more...

6.4.5 7.0.0 7.2.0

dns-query True True True
dns-server-override - Enable/disable use DNS acquired by DHCP or PPPoE. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

dns-server-override True True True
drop-fragment - Enable/disable drop fragment packets. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

drop-fragment True True True
drop-overlapped-fragment - Enable/disable drop overlapped fragment packets. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

drop-overlapped-fragment True True True
egress-cos - Override outgoing CoS in user VLAN tag. type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7] more...

6.4.5 7.0.0 7.2.0

egress-cos True True True
egress-shaping-profile - Outgoing traffic shaping profile. type: str more...

6.4.5 7.0.0 7.2.0

egress-shaping-profile True True True
eip - Eip. type: str more...

6.4.5 7.0.0 7.2.0

eip True True True
endpoint-compliance - Endpoint-Compliance. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

endpoint-compliance True True True
estimated-downstream-bandwidth - Estimated maximum downstream bandwidth (kbps). type: int more...

6.4.5 7.0.0 7.2.0

estimated-downstream-bandwidth True True True
estimated-upstream-bandwidth - Estimated maximum upstream bandwidth (kbps). type: int more...

6.4.5 7.0.0 7.2.0

estimated-upstream-bandwidth True True True
explicit-ftp-proxy - Enable/disable the explicit FTP proxy on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

explicit-ftp-proxy True True True
explicit-web-proxy - Enable/disable the explicit web proxy on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

explicit-web-proxy True True True
external - Enable/disable identifying the interface as an external interface (which usually means its connected to the Internet). type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

external True True True
fail-action-on-extender - Action on extender when interface fail . type: str choices: [soft-restart, hard-restart, reboot] more...

6.4.5 7.0.0 7.2.0

fail-action-on-extender True True True
fail-alert-interfaces - Names of the FortiGate interfaces to which the link failure alert is sent. type: str more...

6.4.5 7.0.0 7.2.0

fail-alert-interfaces True True True
fail-alert-method - Select link-failed-signal or link-down method to alert about a failed link. type: str choices: [link-failed-signal, link-down] more...

6.4.5 7.0.0 7.2.0

fail-alert-method True True True
fail-detect - Enable/disable fail detection features for this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

fail-detect True True True
fail-detect-option - Options for detecting that this interface has failed. type: array choices: [detectserver, link-down] more...

6.4.5 7.0.0 7.2.0

fail-detect-option True True True
fdp - Fdp. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

fdp True True True
fortiheartbeat - Fortiheartbeat. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

fortiheartbeat True True True
fortilink - Enable FortiLink to dedicate this interface to manage other Fortinet devices. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

fortilink True True True
fortilink-backup-link - Fortilink-Backup-Link. type: int more...

6.4.5 7.0.0 7.2.0

fortilink-backup-link True True True
fortilink-neighbor-detect - Protocol for FortiGate neighbor discovery. type: str choices: [lldp, fortilink] more...

6.4.5 7.0.0 7.2.0

fortilink-neighbor-detect True True True
fortilink-split-interface - Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

fortilink-split-interface True True True
fortilink-stacking - Enable/disable FortiLink switch-stacking on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

fortilink-stacking True True True
forward-domain - Transparent mode forward domain. type: int more...

6.4.5 7.0.0 7.2.0

forward-domain True True True
forward-error-correction - Enable/disable forward error correction (FEC Clause 91). type: str choices: [disable, enable, rs-fec, base-r-fec, fec-cl91, fec-cl74, rs-544, none, cl91-rs-fec, cl74-fc-fec] more...

6.4.5 7.0.0 7.2.0

forward-error-correction True True True
fp-anomaly - Fp-Anomaly. type: array choices: [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] more...

6.4.5 7.0.0 7.2.0

fp-anomaly True True True
fp-disable - Fp-Disable. type: array choices: [all, ipsec, none] more...

6.4.5 7.0.0 7.2.0

fp-disable True True True
gateway-address - Gateway address type: str more...

6.4.5 7.0.0 7.2.0

gateway-address True True True
gi-gk - Enable/disable Gi Gatekeeper. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

gi-gk True True True
gwaddr - Gateway address type: str more...

6.4.5 7.0.0 7.2.0

gwaddr True True True
gwdetect - Enable/disable detect gateway alive for first. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

gwdetect True True True
ha-priority - HA election priority for the PING server. type: int more...

6.4.5 7.0.0 7.2.0

ha-priority True True True
icmp-accept-redirect - Enable/disable ICMP accept redirect. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

icmp-accept-redirect True True True
icmp-redirect - Icmp-Redirect. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

icmp-redirect True True True
icmp-send-redirect - Enable/disable sending of ICMP redirects. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

icmp-send-redirect True True True
ident-accept - Enable/disable authentication for this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ident-accept True True True
idle-timeout - PPPoE auto disconnect after idle timeout seconds, 0 means no timeout. type: int more...

6.4.5 7.0.0 7.2.0

idle-timeout True True True
if-mdix - If-Mdix. type: str choices: [auto, normal, crossover] more...

6.4.5 7.0.0 7.2.0

if-mdix True True True
if-media - If-Media. type: str choices: [auto, copper, fiber] more...

6.4.5 7.0.0 7.2.0

if-media True True True
in-force-vlan-cos - In-Force-Vlan-Cos. type: int more...

6.4.5 7.0.0 7.2.0

in-force-vlan-cos True True True
inbandwidth - Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited. type: int more...

6.4.5 7.0.0 7.2.0

inbandwidth True True True
ingress-cos - Override incoming CoS in user VLAN tag on VLAN interface or assign a priority VLAN tag on physical interface. type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7] more...

6.4.5 7.0.0 7.2.0

ingress-cos True True True
ingress-shaping-profile - Incoming traffic shaping profile. type: str more...

6.4.5 7.0.0 7.2.0

ingress-shaping-profile True True True
ingress-spillover-threshold - Ingress Spillover threshold (0 - 16776000 kbps), 0 means unlimited. type: int more...

6.4.5 7.0.0 7.2.0

ingress-spillover-threshold True True True
internal - Implicitly created. type: int more...

6.4.5 7.0.0 7.2.0

internal True True True
ip - Interface IPv4 address and subnet mask, syntax: X. type: str more...

6.4.5 7.0.0 7.2.0

ip True True True
ip-managed-by-fortiipam - Enable/disable automatic IP address assignment of this interface by FortiIPAM. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ip-managed-by-fortiipam True True True
ipmac - Enable/disable IP/MAC binding. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ipmac True True True
ips-sniffer-mode - Enable/disable the use of this interface as a one-armed sniffer. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ips-sniffer-mode True True True
ipunnumbered - Unnumbered IP used for PPPoE interfaces for which no unique local address is provided. type: str more...

6.4.5 7.0.0 7.2.0

ipunnumbered True True True
ipv6 type: dict

autoconf - Enable/disable address auto config. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

autoconf True True True
dhcp6-client-options - Dhcp6-Client-Options. type: array choices: [rapid, iapd, iana, dns, dnsname] more...

6.4.5 7.0.0 7.2.0

dhcp6-client-options True True True
dhcp6-information-request - Enable/disable DHCPv6 information request. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

dhcp6-information-request True True True
dhcp6-prefix-delegation - Enable/disable DHCPv6 prefix delegation. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

dhcp6-prefix-delegation True True True
dhcp6-prefix-hint - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server. type: str more...

6.4.5 7.0.0 7.2.0

dhcp6-prefix-hint True True True
dhcp6-prefix-hint-plt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int more...

6.4.5 7.0.0 7.2.0

dhcp6-prefix-hint-plt True True True
dhcp6-prefix-hint-vlt - DHCPv6 prefix hint valid life time (sec). type: int more...

6.4.5 7.0.0 7.2.0

dhcp6-prefix-hint-vlt True True True
dhcp6-relay-ip - DHCPv6 relay IP address. type: str more...

6.4.5 7.0.0 7.2.0

dhcp6-relay-ip True True True
dhcp6-relay-service - Enable/disable DHCPv6 relay. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

dhcp6-relay-service True True True
dhcp6-relay-type - DHCPv6 relay type. type: str choices: [regular] more...

6.4.5 7.0.0 7.2.0

dhcp6-relay-type True True True
icmp6-send-redirect - Enable/disable sending of ICMPv6 redirects. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

icmp6-send-redirect True True True
interface-identifier - IPv6 interface identifier. type: str more...

6.4.5 7.0.0 7.2.0

interface-identifier True True True
ip6-address - Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...

6.4.5 7.0.0 7.2.0

ip6-address True True True
ip6-allowaccess - Allow management access to the interface. type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...

6.4.5 7.0.0 7.2.0

ip6-allowaccess True True True
ip6-default-life - Default life (sec). type: int more...

6.4.5 7.0.0 7.2.0

ip6-default-life True True True
ip6-delegated-prefix-list - Ip6-Delegated-Prefix-List. type: array more...

6.4.5 7.0.0 7.2.0

ip6-delegated-prefix-list True True True
- autonomous-flag - Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  autonomous-flag True True True
- onlink-flag - Enable/disable the onlink flag. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  onlink-flag True True True
- prefix-id - Prefix ID. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  prefix-id True True True
- rdnss - Recursive DNS server option. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  rdnss True True True
- rdnss-service - Recursive DNS service option. type: str choices: [delegated, default, specify] more...
  
  6.4.5 7.0.0 7.2.0
  
  rdnss-service True True True
- subnet - Add subnet ID to routing prefix. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  subnet True True True
- upstream-interface - Name of the interface that provides delegated information. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  upstream-interface True True True
- delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
  
  7.2.0
  
  delegated-prefix-iaid True
ip6-dns-server-override - Enable/disable using the DNS server acquired by DHCP. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ip6-dns-server-override True True True
ip6-extra-addr - Ip6-Extra-Addr. type: array more...

6.4.5 7.0.0 7.2.0

ip6-extra-addr True True True
- prefix - IPv6 address prefix. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  prefix True True True
ip6-hop-limit - Hop limit (0 means unspecified). type: int more...

6.4.5 7.0.0 7.2.0

ip6-hop-limit True True True
ip6-link-mtu - IPv6 link MTU. type: int more...

6.4.5 7.0.0 7.2.0

ip6-link-mtu True True True
ip6-manage-flag - Enable/disable the managed flag. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ip6-manage-flag True True True
ip6-max-interval - IPv6 maximum interval (4 to 1800 sec). type: int more...

6.4.5 7.0.0 7.2.0

ip6-max-interval True True True
ip6-min-interval - IPv6 minimum interval (3 to 1350 sec). type: int more...

6.4.5 7.0.0 7.2.0

ip6-min-interval True True True
ip6-mode - Addressing mode (static, DHCP, delegated). type: str choices: [static, dhcp, pppoe, delegated] more...

6.4.5 7.0.0 7.2.0

ip6-mode True True True
ip6-other-flag - Enable/disable the other IPv6 flag. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ip6-other-flag True True True
ip6-prefix-list - Ip6-Prefix-List. type: array more...

6.4.5 7.0.0 7.2.0

ip6-prefix-list True True True
- autonomous-flag - Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  autonomous-flag True True True
- dnssl - DNS search list option. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  dnssl True True True
- onlink-flag - Enable/disable the onlink flag. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  onlink-flag True True True
- preferred-life-time - Preferred life time (sec). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  preferred-life-time True True True
- prefix - IPv6 prefix. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  prefix True True True
- rdnss - Recursive DNS server option. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  rdnss True True True
- valid-life-time - Valid life time (sec). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  valid-life-time True True True
ip6-reachable-time - IPv6 reachable time (milliseconds; 0 means unspecified). type: int more...

6.4.5 7.0.0 7.2.0

ip6-reachable-time True True True
ip6-retrans-time - IPv6 retransmit time (milliseconds; 0 means unspecified). type: int more...

6.4.5 7.0.0 7.2.0

ip6-retrans-time True True True
ip6-send-adv - Enable/disable sending advertisements about the interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ip6-send-adv True True True
ip6-subnet - Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str more...

6.4.5 7.0.0 7.2.0

ip6-subnet True True True
ip6-upstream-interface - Interface name providing delegated information. type: str more...

6.4.5 7.0.0 7.2.0

ip6-upstream-interface True True True
nd-cert - Neighbor discovery certificate. type: str more...

6.4.5 7.0.0 7.2.0

nd-cert True True True
nd-cga-modifier - Neighbor discovery CGA modifier. type: str more...

6.4.5 7.0.0 7.2.0

nd-cga-modifier True True True
nd-mode - Neighbor discovery mode. type: str choices: [basic, SEND-compatible] more...

6.4.5 7.0.0 7.2.0

nd-mode True True True
nd-security-level - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). type: int more...

6.4.5 7.0.0 7.2.0

nd-security-level True True True
nd-timestamp-delta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). type: int more...

6.4.5 7.0.0 7.2.0

nd-timestamp-delta True True True
nd-timestamp-fuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). type: int more...

6.4.5 7.0.0 7.2.0

nd-timestamp-fuzz True True True
unique-autoconf-addr - Enable/disable unique auto config address. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

unique-autoconf-addr True True True
vrip6_link_local - Link-local IPv6 address of virtual router. type: str more...

6.4.5 7.0.0 7.2.0

vrip6_link_local True True True
vrrp-virtual-mac6 - Enable/disable virtual MAC for VRRP. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

vrrp-virtual-mac6 True True True
vrrp6 - Vrrp6. type: array more...

6.4.5 7.0.0 7.2.0

vrrp6 True True True
- accept-mode - Enable/disable accept mode. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  accept-mode True True True
- adv-interval - Advertisement interval (1 - 255 seconds). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  adv-interval True True True
- preempt - Enable/disable preempt mode. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  preempt True True True
- priority - Priority of the virtual router (1 - 255). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  priority True True True
- start-time - Startup time (1 - 255 seconds). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  start-time True True True
- status - Enable/disable VRRP. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  status True True True
- vrdst6 - Monitor the route to this destination. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  vrdst6 True True True
- vrgrp - VRRP group ID (1 - 65535). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  vrgrp True True True
- vrid - Virtual router identifier (1 - 255). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  vrid True True True
- vrip6 - IPv6 address of the virtual router. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  vrip6 True True True
cli-conn6-status - Cli-Conn6-Status. type: int more...

7.0.0 7.2.0

cli-conn6-status True True
ip6-prefix-mode - Assigning a prefix from DHCP or RA. type: str choices: [dhcp6, ra] more...

7.0.0 7.2.0

ip6-prefix-mode True True
ra-send-mtu - Enable/disable sending link MTU in RA packet. type: str choices: [disable, enable] more...

7.0.0 7.2.0

ra-send-mtu True True
ip6-delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...

7.2.0

ip6-delegated-prefix-iaid True

l2forward - Enable/disable l2 forwarding. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

l2forward True True True
l2tp-client - Enable/disable this interface as a Layer 2 Tunnelling Protocol (L2TP) client. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

l2tp-client True True True
lacp-ha-slave - LACP HA slave. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

lacp-ha-slave True True True
lacp-mode - LACP mode. type: str choices: [static, passive, active] more...

6.4.5 7.0.0 7.2.0

lacp-mode True True True
lacp-speed - How often the interface sends LACP messages. type: str choices: [slow, fast] more...

6.4.5 7.0.0 7.2.0

lacp-speed True True True
lcp-echo-interval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. type: int more...

6.4.5 7.0.0 7.2.0

lcp-echo-interval True True True
lcp-max-echo-fails - Maximum missed LCP echo messages before disconnect. type: int more...

6.4.5 7.0.0 7.2.0

lcp-max-echo-fails True True True
link-up-delay - Number of milliseconds to wait before considering a link is up. type: int more...

6.4.5 7.0.0 7.2.0

link-up-delay True True True
listen-forticlient-connection - Listen-Forticlient-Connection. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

listen-forticlient-connection True True True
lldp-network-policy - LLDP-MED network policy profile. type: str more...

6.4.5 7.0.0 7.2.0

lldp-network-policy True True True
lldp-reception - Enable/disable Link Layer Discovery Protocol (LLDP) reception. type: str choices: [disable, enable, vdom] more...

6.4.5 7.0.0 7.2.0

lldp-reception True True True
lldp-transmission - Enable/disable Link Layer Discovery Protocol (LLDP) transmission. type: str choices: [enable, disable, vdom] more...

6.4.5 7.0.0 7.2.0

lldp-transmission True True True
log - Log. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

log True True True
macaddr - Change the interfaces MAC address. type: str more...

6.4.5 7.0.0 7.2.0

macaddr True True True
managed-subnetwork-size - Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate units DHCP server settings. type: str choices: [256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 32, 64, 128] more...

6.4.5 7.0.0 7.2.0

managed-subnetwork-size True True True
management-ip - High Availability in-band management IP address of this interface. type: str more...

6.4.5 7.0.0 7.2.0

management-ip True True True
max-egress-burst-rate - Max-Egress-Burst-Rate. type: int more...

6.4.5 7.0.0 7.2.0

max-egress-burst-rate True True True
max-egress-rate - Max-Egress-Rate. type: int more...

6.4.5 7.0.0 7.2.0

max-egress-rate True True True
measured-downstream-bandwidth - Measured downstream bandwidth (kbps). type: int more...

6.4.5 7.0.0 7.2.0

measured-downstream-bandwidth True True True
measured-upstream-bandwidth - Measured upstream bandwidth (kbps). type: int more...

6.4.5 7.0.0 7.2.0

measured-upstream-bandwidth True True True
mediatype - Select SFP media interface type type: str choices: [serdes-sfp, sgmii-sfp, cfp2-sr10, cfp2-lr4, serdes-copper-sfp, sr, cr, lr, qsfp28-sr4, qsfp28-lr4, qsfp28-cr4, sr4, cr4, lr4, none, gmii, sgmii] more...

6.4.5 7.0.0 7.2.0

mediatype True True True
member - Physical interfaces that belong to the aggregate or redundant interface. type: str more...

6.4.5 7.0.0 7.2.0

member True True True
min-links - Minimum number of aggregated ports that must be up. type: int more...

6.4.5 7.0.0 7.2.0

min-links True True True
min-links-down - Action to take when less than the configured minimum number of links are active. type: str choices: [operational, administrative] more...

6.4.5 7.0.0 7.2.0

min-links-down True True True
mode - Addressing mode (static, DHCP, PPPoE). type: str choices: [static, dhcp, pppoe, pppoa, ipoa, eoa] more...

6.4.5 7.0.0 7.2.0

mode True True True
monitor-bandwidth - Enable monitoring bandwidth on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

monitor-bandwidth True True True
mtu - MTU value for this interface. type: int more...

6.4.5 7.0.0 7.2.0

mtu True True True
mtu-override - Enable to set a custom MTU for this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

mtu-override True True True
mux-type - Multiplexer type type: str choices: [llc-encaps, vc-encaps] more...

6.4.5 7.0.0 7.2.0

mux-type True True True
name - Name. type: str more...

6.4.5 7.0.0 7.2.0

name True True True
ndiscforward - Enable/disable NDISC forwarding. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ndiscforward True True True
netbios-forward - Enable/disable NETBIOS forwarding. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

netbios-forward True True True
netflow-sampler - Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both). type: str choices: [disable, tx, rx, both] more...

6.4.5 7.0.0 7.2.0

netflow-sampler True True True
np-qos-profile - Np-Qos-Profile. type: int more...

6.4.5 7.0.0 7.2.0

np-qos-profile True True True
npu-fastpath - Npu-Fastpath. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

npu-fastpath True True True
nst - Nst. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

nst True True True
out-force-vlan-cos - Out-Force-Vlan-Cos. type: int more...

6.4.5 7.0.0 7.2.0

out-force-vlan-cos True True True
outbandwidth - Bandwidth limit for outgoing traffic (0 - 16776000 kbps), 0 means unlimited. type: int more...

6.4.5 7.0.0 7.2.0

outbandwidth True True True
padt-retry-timeout - PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time. type: int more...

6.4.5 7.0.0 7.2.0

padt-retry-timeout True True True
password - PPPoE accounts password. type: str more...

6.4.5 7.0.0 7.2.0

password True True True
peer-interface - Peer-Interface. type: str more...

6.4.5 7.0.0 7.2.0

peer-interface True True True
phy-mode - DSL physical mode. type: str choices: [auto, adsl, vdsl, adsl-auto, vdsl2, adsl2+, adsl2, g.dmt, t1.413, g.lite] more...

6.4.5 7.0.0 7.2.0

phy-mode True True True
ping-serv-status - Ping-Serv-Status. type: int more...

6.4.5 7.0.0 7.2.0

ping-serv-status True True True
poe - Enable/disable PoE status. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

poe True True True
polling-interval - sFlow polling interval (1 - 255 sec). type: int more...

6.4.5 7.0.0 7.2.0

polling-interval True True True
pppoe-unnumbered-negotiate - Enable/disable PPPoE unnumbered negotiation. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

pppoe-unnumbered-negotiate True True True
pptp-auth-type - PPTP authentication type. type: str choices: [auto, pap, chap, mschapv1, mschapv2] more...

6.4.5 7.0.0 7.2.0

pptp-auth-type True True True
pptp-client - Enable/disable PPTP client. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

pptp-client True True True
pptp-password - PPTP password. type: str more...

6.4.5 7.0.0 7.2.0

pptp-password True True True
pptp-server-ip - PPTP server IP address. type: str more...

6.4.5 7.0.0 7.2.0

pptp-server-ip True True True
pptp-timeout - Idle timer in minutes (0 for disabled). type: int more...

6.4.5 7.0.0 7.2.0

pptp-timeout True True True
pptp-user - PPTP user name. type: str more...

6.4.5 7.0.0 7.2.0

pptp-user True True True
preserve-session-route - Enable/disable preservation of session route when dirty. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

preserve-session-route True True True
priority - Priority of learned routes. type: int more...

6.4.5 7.0.0 7.2.0

priority True True True
priority-override - Enable/disable fail back to higher priority port once recovered. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

priority-override True True True
proxy-captive-portal - Enable/disable proxy captive portal on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

proxy-captive-portal True True True
redundant-interface - Redundant-Interface. type: str more...

6.4.5 7.0.0 7.2.0

redundant-interface True True True
remote-ip - Remote IP address of tunnel. type: str more...

6.4.5 7.0.0 7.2.0

remote-ip True True True
replacemsg-override-group - Replacement message override group. type: str more...

6.4.5 7.0.0 7.2.0

replacemsg-override-group True True True
retransmission - Enable/disable DSL retransmission. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

retransmission True True True
ring-rx - RX ring size. type: int more...

6.4.5 7.0.0 7.2.0

ring-rx True True True
ring-tx - TX ring size. type: int more...

6.4.5 7.0.0 7.2.0

ring-tx True True True
role - Interface role. type: str choices: [lan, wan, dmz, undefined] more...

6.4.5 7.0.0 7.2.0

role True True True
sample-direction - Data that NetFlow collects (rx, tx, or both). type: str choices: [rx, tx, both] more...

6.4.5 7.0.0 7.2.0

sample-direction True True True
sample-rate - sFlow sample rate (10 - 99999). type: int more...

6.4.5 7.0.0 7.2.0

sample-rate True True True
scan-botnet-connections - Scan-Botnet-Connections. type: str choices: [disable, block, monitor] more...

6.4.5 7.0.0 7.2.0

scan-botnet-connections True True True
secondary-IP - Enable/disable adding a secondary IP to this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

secondary-IP True True True
secondaryip - Secondaryip. type: array more...

6.4.5 7.0.0 7.2.0

secondaryip True True True
- allowaccess - Management access settings for the secondary IP address. type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
  
  6.4.5 7.0.0 7.2.0
  
  allowaccess True True True
- detectprotocol - Protocols used to detect the server. type: array choices: [ping, tcp-echo, udp-echo] more...
  
  6.4.5 7.0.0 7.2.0
  
  detectprotocol True True True
- detectserver - Gateways ping server for this IP. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  detectserver True True True
- gwdetect - Enable/disable detect gateway alive for first. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  gwdetect True True True
- ha-priority - HA election priority for the PING server. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  ha-priority True True True
- id - ID. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  id True True True
- ip - Secondary IP address of the interface. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  ip True True True
- ping-serv-status - Ping-Serv-Status. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  ping-serv-status True True True
- seq - Seq. type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  seq True True True
security-8021x-dynamic-vlan-id - VLAN ID for virtual switch. type: int more...

6.4.5 7.0.0 7.2.0

security-8021x-dynamic-vlan-id True True True
security-8021x-master - 802. type: str more...

6.4.5 7.0.0 7.2.0

security-8021x-master True True True
security-8021x-mode - 802. type: str choices: [default, dynamic-vlan, fallback, slave] more...

6.4.5 7.0.0 7.2.0

security-8021x-mode True True True
security-exempt-list - Name of security-exempt-list. type: str more...

6.4.5 7.0.0 7.2.0

security-exempt-list True True True
security-external-logout - URL of external authentication logout server. type: str more...

6.4.5 7.0.0 7.2.0

security-external-logout True True True
security-external-web - URL of external authentication web server. type: str more...

6.4.5 7.0.0 7.2.0

security-external-web True True True
security-groups - User groups that can authenticate with the captive portal. type: str more...

6.4.5 7.0.0 7.2.0

security-groups True True True
security-mac-auth-bypass - Enable/disable MAC authentication bypass. type: str choices: [disable, enable, mac-auth-only] more...

6.4.5 7.0.0 7.2.0

security-mac-auth-bypass True True True
security-mode - Turn on captive portal authentication for this interface. type: str choices: [none, captive-portal, 802.1X] more...

6.4.5 7.0.0 7.2.0

security-mode True True True
security-redirect-url - URL redirection after disclaimer/authentication. type: str more...

6.4.5 7.0.0 7.2.0

security-redirect-url True True True
service-name - PPPoE service name. type: str more...

6.4.5 7.0.0 7.2.0

service-name True True True
sflow-sampler - Enable/disable sFlow on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

sflow-sampler True True True
speed - Interface speed. type: str choices: [auto, 10full, 10half, 100full, 100half, 1000full, 1000half, 10000full, 1000auto, 10000auto, 40000full, 100Gfull, 25000full, 40000auto, 25000auto, 100Gauto, 400Gfull, 400Gauto] more...

6.4.5 7.0.0 7.2.0

speed True True True
spillover-threshold - Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited. type: int more...

6.4.5 7.0.0 7.2.0

spillover-threshold True True True
src-check - Enable/disable source IP check. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

src-check True True True
status - Bring the interface up or shut the interface down. type: str choices: [down, up] more...

6.4.5 7.0.0 7.2.0

status True True True
stp - Enable/disable STP. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

stp True True True
stp-ha-slave - Control STP behaviour on HA slave. type: str choices: [disable, enable, priority-adjust] more...

6.4.5 7.0.0 7.2.0

stp-ha-slave True True True
stpforward - Enable/disable STP forwarding. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

stpforward True True True
stpforward-mode - Configure STP forwarding mode. type: str choices: [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing] more...

6.4.5 7.0.0 7.2.0

stpforward-mode True True True
strip-priority-vlan-tag - Strip-Priority-Vlan-Tag. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

strip-priority-vlan-tag True True True
subst - Enable to always send packets from this interface to a destination MAC address. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

subst True True True
substitute-dst-mac - Destination MAC address that all packets are sent to from this interface. type: str more...

6.4.5 7.0.0 7.2.0

substitute-dst-mac True True True
swc-first-create - Initial create for switch-controller VLANs. type: int more...

6.4.5 7.0.0 7.2.0

swc-first-create True True True
swc-vlan - Swc-Vlan. type: int more...

6.4.5 7.0.0 7.2.0

swc-vlan True True True
switch - Switch. type: str more...

6.4.5 7.0.0 7.2.0

switch True True True
switch-controller-access-vlan - Block FortiSwitch port-to-port traffic. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-access-vlan True True True
switch-controller-arp-inspection - Enable/disable FortiSwitch ARP inspection. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-arp-inspection True True True
switch-controller-auth - Switch-Controller-Auth. type: str choices: [radius, usergroup] more...

6.4.5 7.0.0 7.2.0

switch-controller-auth True True True
switch-controller-dhcp-snooping - Switch controller DHCP snooping. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-dhcp-snooping True True True
switch-controller-dhcp-snooping-option82 - Switch controller DHCP snooping option82. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-dhcp-snooping-option82 True True True
switch-controller-dhcp-snooping-verify-mac - Switch controller DHCP snooping verify MAC. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-dhcp-snooping-verify-mac True True True
switch-controller-feature - Interfaces purpose when assigning traffic (read only). type: str choices: [none, default-vlan, quarantine, sniffer, voice, camera, rspan, video, nac, nac-segment] more...

6.4.5 7.0.0 7.2.0

switch-controller-feature True True True
switch-controller-igmp-snooping - Switch controller IGMP snooping. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-igmp-snooping True True True
switch-controller-igmp-snooping-fast-leave - Switch controller IGMP snooping fast-leave. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-igmp-snooping-fast-leave True True True
switch-controller-igmp-snooping-proxy - Switch controller IGMP snooping proxy. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-igmp-snooping-proxy True True True
switch-controller-iot-scanning - Enable/disable managed FortiSwitch IoT scanning. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-iot-scanning True True True
switch-controller-learning-limit - Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default). type: int more...

6.4.5 7.0.0 7.2.0

switch-controller-learning-limit True True True
switch-controller-mgmt-vlan - VLAN to use for FortiLink management purposes. type: int more...

6.4.5 7.0.0 7.2.0

switch-controller-mgmt-vlan True True True
switch-controller-nac - Integrated NAC settings for managed FortiSwitch. type: str more...

6.4.5 7.0.0 7.2.0

switch-controller-nac True True True
switch-controller-radius-server - Switch-Controller-Radius-Server. type: str more...

6.4.5 7.0.0 7.2.0

switch-controller-radius-server True True True
switch-controller-rspan-mode - Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

switch-controller-rspan-mode True True True
switch-controller-source-ip - Source IP address used in FortiLink over L3 connections. type: str choices: [outbound, fixed] more...

6.4.5 7.0.0 7.2.0

switch-controller-source-ip True True True
switch-controller-traffic-policy - Switch controller traffic policy for the VLAN. type: str more...

6.4.5 7.0.0 7.2.0

switch-controller-traffic-policy True True True
tc-mode - DSL transfer mode. type: str choices: [ptm, atm] more...

6.4.5 7.0.0 7.2.0

tc-mode True True True
tcp-mss - TCP maximum segment size. type: int more...

6.4.5 7.0.0 7.2.0

tcp-mss True True True
trunk - Enable/disable VLAN trunk. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

trunk True True True
trust-ip-1 - Trusted host for dedicated management traffic (0. type: str more...

6.4.5 7.0.0 7.2.0

trust-ip-1 True True True
trust-ip-2 - Trusted host for dedicated management traffic (0. type: str more...

6.4.5 7.0.0 7.2.0

trust-ip-2 True True True
trust-ip-3 - Trusted host for dedicated management traffic (0. type: str more...

6.4.5 7.0.0 7.2.0

trust-ip-3 True True True
trust-ip6-1 - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). type: str more...

6.4.5 7.0.0 7.2.0

trust-ip6-1 True True True
trust-ip6-2 - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). type: str more...

6.4.5 7.0.0 7.2.0

trust-ip6-2 True True True
trust-ip6-3 - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). type: str more...

6.4.5 7.0.0 7.2.0

trust-ip6-3 True True True
type - Interface type. type: str choices: [physical, vlan, aggregate, redundant, tunnel, wireless, vdom-link, loopback, switch, hard-switch, hdlc, vap-switch, wl-mesh, fortilink, switch-vlan, fctrl-trunk, tdm, fext-wan, vxlan, emac-vlan, geneve, ssl, lan-extension] more...

6.4.5 7.0.0 7.2.0

type True True True
username - Username of the PPPoE account, provided by your ISP. type: str more...

6.4.5 7.0.0 7.2.0

username True True True
vci - Virtual Channel ID type: int more...

6.4.5 7.0.0 7.2.0

vci True True True
vectoring - Enable/disable DSL vectoring. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

vectoring True True True
vindex - Vindex. type: int more...

6.4.5 7.0.0 7.2.0

vindex True True True
vlan-protocol - Ethernet protocol of VLAN. type: str choices: [8021q, 8021ad] more...

6.4.5 7.0.0 7.2.0

vlan-protocol True True True
vlanforward - Enable/disable traffic forwarding between VLANs on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

vlanforward True True True
vlanid - VLAN ID (1 - 4094). type: int more...

6.4.5 7.0.0 7.2.0

vlanid True True True
vpi - Virtual Path ID type: int more...

6.4.5 7.0.0 7.2.0

vpi True True True
vrf - Virtual Routing Forwarding ID. type: int more...

6.4.5 7.0.0 7.2.0

vrf True True True
vrrp - Vrrp. type: array more...

6.4.5 7.0.0 7.2.0

vrrp True True True
- accept-mode - Enable/disable accept mode. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  accept-mode True True True
- adv-interval - Advertisement interval (1 - 255 seconds). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  adv-interval True True True
- ignore-default-route - Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  ignore-default-route True True True
- preempt - Enable/disable preempt mode. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  preempt True True True
- priority - Priority of the virtual router (1 - 255). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  priority True True True
- start-time - Startup time (1 - 255 seconds). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  start-time True True True
- status - Enable/disable this VRRP configuration. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0 7.2.0
  
  status True True True
- version - VRRP version. type: str choices: [2, 3] more...
  
  6.4.5 7.0.0 7.2.0
  
  version True True True
- vrdst - Monitor the route to this destination. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  vrdst True True True
- vrdst-priority - Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  vrdst-priority True True True
- vrgrp - VRRP group ID (1 - 65535). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  vrgrp True True True
- vrid - Virtual router identifier (1 - 255). type: int more...
  
  6.4.5 7.0.0 7.2.0
  
  vrid True True True
- vrip - IP address of the virtual router. type: str more...
  
  6.4.5 7.0.0 7.2.0
  
  vrip True True True
vrrp-virtual-mac - Enable/disable use of virtual MAC for VRRP. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

vrrp-virtual-mac True True True
wccp - Enable/disable WCCP on this interface. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

wccp True True True
weight - Default weight for static routes (if route has no weight configured). type: int more...

6.4.5 7.0.0 7.2.0

weight True True True
wifi-5g-threshold - Minimal signal strength to be considered as a good 5G AP. type: str more...

6.4.5 7.0.0 7.2.0

wifi-5g-threshold True True True
wifi-acl - Access control for MAC addresses in the MAC list. type: str choices: [deny, allow] more...

6.4.5 7.0.0 7.2.0

wifi-acl True True True
wifi-ap-band - How to select the AP to connect. type: str choices: [any, 5g-preferred, 5g-only] more...

6.4.5 7.0.0 7.2.0

wifi-ap-band True True True
wifi-auth - WiFi authentication. type: str choices: [PSK, RADIUS, radius, usergroup] more...

6.4.5 7.0.0 7.2.0

wifi-auth True True True
wifi-auto-connect - Enable/disable WiFi network auto connect. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

wifi-auto-connect True True True
wifi-auto-save - Enable/disable WiFi network automatic save. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

wifi-auto-save True True True
wifi-broadcast-ssid - Enable/disable SSID broadcast in the beacon. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

wifi-broadcast-ssid True True True
wifi-encrypt - Data encryption. type: str choices: [TKIP, AES] more...

6.4.5 7.0.0 7.2.0

wifi-encrypt True True True
wifi-fragment-threshold - WiFi fragment threshold (800 - 2346). type: int more...

6.4.5 7.0.0 7.2.0

wifi-fragment-threshold True True True
wifi-key - WiFi WEP Key. type: str more...

6.4.5 7.0.0 7.2.0

wifi-key True True True
wifi-keyindex - WEP key index (1 - 4). type: int more...

6.4.5 7.0.0 7.2.0

wifi-keyindex True True True
wifi-mac-filter - Enable/disable MAC filter status. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

wifi-mac-filter True True True
wifi-passphrase - WiFi pre-shared key for WPA. type: str more...

6.4.5 7.0.0 7.2.0

wifi-passphrase True True True
wifi-radius-server - WiFi RADIUS server for WPA. type: str more...

6.4.5 7.0.0 7.2.0

wifi-radius-server True True True
wifi-rts-threshold - WiFi RTS threshold (256 - 2346). type: int more...

6.4.5 7.0.0 7.2.0

wifi-rts-threshold True True True
wifi-security - Wireless access security of SSID. type: str choices: [None, WEP64, wep64, WEP128, wep128, WPA_PSK, WPA_RADIUS, WPA, WPA2, WPA2_AUTO, open, wpa-personal, wpa-enterprise, wpa-only-personal, wpa-only-enterprise, wpa2-only-personal, wpa2-only-enterprise] more...

6.4.5 7.0.0 7.2.0

wifi-security True True True
wifi-ssid - IEEE 802. type: str more...

6.4.5 7.0.0 7.2.0

wifi-ssid True True True
wifi-usergroup - WiFi user group for WPA. type: str more...

6.4.5 7.0.0 7.2.0

wifi-usergroup True True True
wins-ip - WINS server IP. type: str more...

6.4.5 7.0.0 7.2.0

wins-ip True True True
dhcp-relay-request-all-server - Enable/disable sending of DHCP requests to all servers. type: str choices: [disable, enable] more...

7.0.0 7.2.0

dhcp-relay-request-all-server True True
stp-ha-secondary - Control STP behaviour on HA secondary. type: str choices: [disable, enable, priority-adjust] more...

7.0.0 7.2.0

stp-ha-secondary True True
switch-controller-dynamic - Integrated FortiLink settings for managed FortiSwitch. type: str more...

7.0.0 7.2.0

switch-controller-dynamic True True
auth-cert - HTTPS server certificate. type: str more...

7.2.0

auth-cert True
auth-portal-addr - Address of captive portal. type: str more...

7.2.0

auth-portal-addr True
dhcp-classless-route-addition - Enable/disable addition of classless static routes retrieved from DHCP server. type: str choices: [disable, enable] more...

7.2.0

dhcp-classless-route-addition True
dhcp-relay-link-selection - DHCP relay link selection. type: str more...

7.2.0

dhcp-relay-link-selection True
dns-server-protocol - No description for the parameter type: array choices: [cleartext, dot, doh] more...

7.2.0

dns-server-protocol True
eap-ca-cert - EAP CA certificate name. type: str more...

7.2.0

eap-ca-cert True
eap-identity - EAP identity. type: str more...

7.2.0

eap-identity True
eap-method - EAP method. type: str choices: [tls, peap] more...

7.2.0

eap-method True
eap-password - No description for the parameter type: str more...

7.2.0

eap-password True
eap-supplicant - Enable/disable EAP-Supplicant. type: str choices: [disable, enable] more...

7.2.0

eap-supplicant True
eap-user-cert - EAP user certificate name. type: str more...

7.2.0

eap-user-cert True
ike-saml-server - Configure IKE authentication SAML server. type: str more...

7.2.0

ike-saml-server True
lacp-ha-secondary - No description for the parameter type: str choices: [disable, enable] more...

7.2.0

lacp-ha-secondary True
pvc-atm-qos - SFP-DSL ADSL Fallback PVC ATM QoS. type: str choices: [cbr, rt-vbr, nrt-vbr] more...

7.2.0

pvc-atm-qos True
pvc-chan - SFP-DSL ADSL Fallback PVC Channel. type: int more...

7.2.0

pvc-chan True
pvc-crc - SFP-DSL ADSL Fallback PVC CRC Option: bit0: sar LLC preserve, bit1: ream LLC preserve, bit2: ream VC-MUX has crc. type: int more...

7.2.0

pvc-crc True
pvc-pcr - SFP-DSL ADSL Fallback PVC Packet Cell Rate in cells (0 - 5500). type: int more...

7.2.0

pvc-pcr True
pvc-scr - SFP-DSL ADSL Fallback PVC Sustainable Cell Rate in cells (0 - 5500). type: int more...

7.2.0

pvc-scr True
pvc-vlan-id - SFP-DSL ADSL Fallback PVC VLAN ID. type: int more...

7.2.0

pvc-vlan-id True
pvc-vlan-rx-id - SFP-DSL ADSL Fallback PVC VLANID RX. type: int more...

7.2.0

pvc-vlan-rx-id True
pvc-vlan-rx-op - SFP-DSL ADSL Fallback PVC VLAN RX op. type: str choices: [pass-through, replace, remove] more...

7.2.0

pvc-vlan-rx-op True
pvc-vlan-tx-id - SFP-DSL ADSL Fallback PVC VLAN ID TX. type: int more...

7.2.0

pvc-vlan-tx-id True
pvc-vlan-tx-op - SFP-DSL ADSL Fallback PVC VLAN TX op. type: str choices: [pass-through, replace, remove] more...

7.2.0

pvc-vlan-tx-op True
reachable-time - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000). type: int more...

7.2.0

reachable-time True
select-profile-30a-35b - No description for the parameter type: str choices: [30A, 35B] more...

7.2.0

select-profile-30a-35b True
sfp-dsl - Enable/disable SFP DSL. type: str choices: [disable, enable] more...

7.2.0

sfp-dsl True
sfp-dsl-adsl-fallback - Enable/disable SFP DSL ADSL fallback. type: str choices: [disable, enable] more...

7.2.0

sfp-dsl-adsl-fallback True
sfp-dsl-autodetect - Enable/disable SFP DSL MAC address autodetect. type: str choices: [disable, enable] more...

7.2.0

sfp-dsl-autodetect True
sfp-dsl-mac - SFP DSL MAC address. type: str more...

7.2.0

sfp-dsl-mac True
sw-algorithm - Frame distribution algorithm for switch. type: str choices: [l2, l3, eh] more...

7.2.0

sw-algorithm True
system-id - Define a system ID for the aggregate interface. type: str more...

7.2.0

system-id True
system-id-type - Method in which system ID is generated. type: str choices: [auto, user] more...

7.2.0

system-id-type True
vlan-id - No description for the parameter type: int more...

7.2.0

vlan-id True
vlan-op-mode - No description for the parameter type: str choices: [tag, untag, passthrough] more...

7.2.0

vlan-op-mode True

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: no description
     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: <value in [present, absent]>
        fsp_vlan:
           _dhcp-status: <value in [disable, enable]>
           auth: <value in [radius, usergroup]>
           color: <value of integer>
           comments: <value of string>
           dynamic_mapping:
             -
                 _dhcp-status: <value in [disable, enable]>
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 dhcp-server:
                    auto-configuration: <value in [disable, enable]>
                    auto-managed-status: <value in [disable, enable]>
                    conflicted-ip-timeout: <value of integer>
                    ddns-auth: <value in [disable, tsig]>
                    ddns-key: <value of string>
                    ddns-keyname: <value of string>
                    ddns-server-ip: <value of string>
                    ddns-ttl: <value of integer>
                    ddns-update: <value in [disable, enable]>
                    ddns-update-override: <value in [disable, enable]>
                    ddns-zone: <value of string>
                    default-gateway: <value of string>
                    dhcp-settings-from-fortiipam: <value in [disable, enable]>
                    dns-server1: <value of string>
                    dns-server2: <value of string>
                    dns-server3: <value of string>
                    dns-server4: <value of string>
                    dns-service: <value in [default, specify, local]>
                    domain: <value of string>
                    enable: <value in [disable, enable]>
                    exclude-range:
                      -
                          end-ip: <value of string>
                          id: <value of integer>
                          start-ip: <value of string>
                    filename: <value of string>
                    forticlient-on-net-status: <value in [disable, enable]>
                    id: <value of integer>
                    ip-mode: <value in [range, usrgrp]>
                    ip-range:
                      -
                          end-ip: <value of string>
                          id: <value of integer>
                          start-ip: <value of string>
                    ipsec-lease-hold: <value of integer>
                    lease-time: <value of integer>
                    mac-acl-default-action: <value in [assign, block]>
                    netmask: <value of string>
                    next-server: <value of string>
                    ntp-server1: <value of string>
                    ntp-server2: <value of string>
                    ntp-server3: <value of string>
                    ntp-service: <value in [default, specify, local]>
                    option1: <value of string>
                    option2: <value of string>
                    option3: <value of string>
                    option4: <value of string>
                    option5: <value of string>
                    option6: <value of string>
                    options:
                      -
                          code: <value of integer>
                          id: <value of integer>
                          ip: <value of string>
                          type: <value in [hex, string, ip, ...]>
                          value: <value of string>
                    reserved-address:
                      -
                          action: <value in [assign, block, reserved]>
                          circuit-id: <value of string>
                          circuit-id-type: <value in [hex, string]>
                          description: <value of string>
                          id: <value of integer>
                          ip: <value of string>
                          mac: <value of string>
                          remote-id: <value of 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: <value of string>
                    timezone: <value in [00, 01, 02, ...]>
                    timezone-option: <value in [disable, default, specify]>
                    vci-match: <value in [disable, enable]>
                    vci-string: <value of string>
                    wifi-ac-service: <value in [specify, local]>
                    wifi-ac1: <value of string>
                    wifi-ac2: <value of string>
                    wifi-ac3: <value of string>
                    wins-server1: <value of string>
                    wins-server2: <value of string>
                 interface:
                    dhcp-relay-agent-option: <value in [disable, enable]>
                    dhcp-relay-ip: <value of string>
                    dhcp-relay-service: <value in [disable, enable]>
                    dhcp-relay-type: <value in [regular, ipsec]>
                    ip: <value of 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: <value of string>
                       dhcp6-prefix-hint-plt: <value of integer>
                       dhcp6-prefix-hint-vlt: <value of integer>
                       dhcp6-relay-ip: <value of string>
                       dhcp6-relay-service: <value in [disable, enable]>
                       dhcp6-relay-type: <value in [regular]>
                       icmp6-send-redirect: <value in [disable, enable]>
                       interface-identifier: <value of string>
                       ip6-address: <value of string>
                       ip6-allowaccess:
                         - https
                         - ping
                         - ssh
                         - snmp
                         - http
                         - telnet
                         - fgfm
                         - capwap
                         - fabric
                       ip6-default-life: <value of integer>
                       ip6-delegated-prefix-list:
                         -
                             autonomous-flag: <value in [disable, enable]>
                             onlink-flag: <value in [disable, enable]>
                             prefix-id: <value of integer>
                             rdnss: <value of string>
                             rdnss-service: <value in [delegated, default, specify]>
                             subnet: <value of string>
                             upstream-interface: <value of string>
                             delegated-prefix-iaid: <value of integer>
                       ip6-dns-server-override: <value in [disable, enable]>
                       ip6-extra-addr:
                         -
                             prefix: <value of string>
                       ip6-hop-limit: <value of integer>
                       ip6-link-mtu: <value of integer>
                       ip6-manage-flag: <value in [disable, enable]>
                       ip6-max-interval: <value of integer>
                       ip6-min-interval: <value of 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: <value of string>
                             onlink-flag: <value in [disable, enable]>
                             preferred-life-time: <value of integer>
                             prefix: <value of string>
                             rdnss: <value of string>
                             valid-life-time: <value of integer>
                       ip6-reachable-time: <value of integer>
                       ip6-retrans-time: <value of integer>
                       ip6-send-adv: <value in [disable, enable]>
                       ip6-subnet: <value of string>
                       ip6-upstream-interface: <value of string>
                       nd-cert: <value of string>
                       nd-cga-modifier: <value of string>
                       nd-mode: <value in [basic, SEND-compatible]>
                       nd-security-level: <value of integer>
                       nd-timestamp-delta: <value of integer>
                       nd-timestamp-fuzz: <value of integer>
                       unique-autoconf-addr: <value in [disable, enable]>
                       vrip6_link_local: <value of string>
                       vrrp-virtual-mac6: <value in [disable, enable]>
                       vrrp6:
                         -
                             accept-mode: <value in [disable, enable]>
                             adv-interval: <value of integer>
                             preempt: <value in [disable, enable]>
                             priority: <value of integer>
                             start-time: <value of integer>
                             status: <value in [disable, enable]>
                             vrdst6: <value of string>
                             vrgrp: <value of integer>
                             vrid: <value of integer>
                             vrip6: <value of string>
                       cli-conn6-status: <value of integer>
                       ip6-prefix-mode: <value in [dhcp6, ra]>
                       ra-send-mtu: <value in [disable, enable]>
                       ip6-delegated-prefix-iaid: <value of integer>
                    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: <value of string>
                          gwdetect: <value in [disable, enable]>
                          ha-priority: <value of integer>
                          id: <value of integer>
                          ip: <value of string>
                          ping-serv-status: <value of integer>
                          seq: <value of integer>
                    vlanid: <value of integer>
                    dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>
           name: <value of string>
           portal-message-override-group: <value of string>
           radius-server: <value of string>
           security: <value in [open, captive-portal, 8021x]>
           selected-usergroups: <value of string>
           usergroup: <value of string>
           vdom: <value of string>
           vlanid: <value of integer>
           dhcp-server:
              auto-configuration: <value in [disable, enable]>
              auto-managed-status: <value in [disable, enable]>
              conflicted-ip-timeout: <value of integer>
              ddns-auth: <value in [disable, tsig]>
              ddns-key: <value of string>
              ddns-keyname: <value of string>
              ddns-server-ip: <value of string>
              ddns-ttl: <value of integer>
              ddns-update: <value in [disable, enable]>
              ddns-update-override: <value in [disable, enable]>
              ddns-zone: <value of string>
              default-gateway: <value of string>
              dhcp-settings-from-fortiipam: <value in [disable, enable]>
              dns-server1: <value of string>
              dns-server2: <value of string>
              dns-server3: <value of string>
              dns-server4: <value of string>
              dns-service: <value in [default, specify, local]>
              domain: <value of string>
              enable: <value in [disable, enable]>
              exclude-range:
                -
                    end-ip: <value of string>
                    id: <value of integer>
                    start-ip: <value of string>
              filename: <value of string>
              forticlient-on-net-status: <value in [disable, enable]>
              id: <value of integer>
              ip-mode: <value in [range, usrgrp]>
              ip-range:
                -
                    end-ip: <value of string>
                    id: <value of integer>
                    start-ip: <value of string>
              ipsec-lease-hold: <value of integer>
              lease-time: <value of integer>
              mac-acl-default-action: <value in [assign, block]>
              netmask: <value of string>
              next-server: <value of string>
              ntp-server1: <value of string>
              ntp-server2: <value of string>
              ntp-server3: <value of string>
              ntp-service: <value in [default, specify, local]>
              option1: <value of string>
              option2: <value of string>
              option3: <value of string>
              option4: <value of string>
              option5: <value of string>
              option6: <value of string>
              options:
                -
                    code: <value of integer>
                    id: <value of integer>
                    ip: <value of string>
                    type: <value in [hex, string, ip, ...]>
                    value: <value of string>
              reserved-address:
                -
                    action: <value in [assign, block, reserved]>
                    circuit-id: <value of string>
                    circuit-id-type: <value in [hex, string]>
                    description: <value of string>
                    id: <value of integer>
                    ip: <value of string>
                    mac: <value of string>
                    remote-id: <value of 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: <value of string>
              timezone: <value in [00, 01, 02, ...]>
              timezone-option: <value in [disable, default, specify]>
              vci-match: <value in [disable, enable]>
              vci-string: <value of string>
              wifi-ac-service: <value in [specify, local]>
              wifi-ac1: <value of string>
              wifi-ac2: <value of string>
              wifi-ac3: <value of string>
              wins-server1: <value of string>
              wins-server2: <value of string>
           interface:
              ac-name: <value of string>
              aggregate: <value of string>
              algorithm: <value in [L2, L3, L4, ...]>
              alias: <value of 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: <value of integer>
              bfd: <value in [global, enable, disable]>
              bfd-desired-min-tx: <value of integer>
              bfd-detect-mult: <value of integer>
              bfd-required-min-rx: <value of integer>
              broadcast-forticlient-discovery: <value in [disable, enable]>
              broadcast-forward: <value in [disable, enable]>
              captive-portal: <value of integer>
              cli-conn-status: <value of integer>
              color: <value of integer>
              ddns: <value in [disable, enable]>
              ddns-auth: <value in [disable, tsig]>
              ddns-domain: <value of string>
              ddns-key: <value of string>
              ddns-keyname: <value of string>
              ddns-password: <value of string>
              ddns-server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
              ddns-server-ip: <value of string>
              ddns-sn: <value of string>
              ddns-ttl: <value of integer>
              ddns-username: <value of string>
              ddns-zone: <value of string>
              dedicated-to: <value in [none, management]>
              defaultgw: <value in [disable, enable]>
              description: <value of string>
              detected-peer-mtu: <value of integer>
              detectprotocol:
                - ping
                - tcp-echo
                - udp-echo
              detectserver: <value of string>
              device-access-list: <value of 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: <value of integer>
              dhcp-client-identifier: <value of string>
              dhcp-relay-agent-option: <value in [disable, enable]>
              dhcp-relay-interface: <value of string>
              dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>
              dhcp-relay-ip: <value of string>
              dhcp-relay-service: <value in [disable, enable]>
              dhcp-relay-type: <value in [regular, ipsec]>
              dhcp-renew-time: <value of integer>
              disc-retry-timeout: <value of integer>
              disconnect-threshold: <value of integer>
              distance: <value of 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: <value of string>
              eip: <value of string>
              endpoint-compliance: <value in [disable, enable]>
              estimated-downstream-bandwidth: <value of integer>
              estimated-upstream-bandwidth: <value of 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: <value of 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: <value of integer>
              fortilink-neighbor-detect: <value in [lldp, fortilink]>
              fortilink-split-interface: <value in [disable, enable]>
              fortilink-stacking: <value in [disable, enable]>
              forward-domain: <value of 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: <value of string>
              gi-gk: <value in [disable, enable]>
              gwaddr: <value of string>
              gwdetect: <value in [disable, enable]>
              ha-priority: <value of 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: <value of integer>
              if-mdix: <value in [auto, normal, crossover]>
              if-media: <value in [auto, copper, fiber]>
              in-force-vlan-cos: <value of integer>
              inbandwidth: <value of integer>
              ingress-cos: <value in [disable, cos0, cos1, ...]>
              ingress-shaping-profile: <value of string>
              ingress-spillover-threshold: <value of integer>
              internal: <value of integer>
              ip: <value of string>
              ip-managed-by-fortiipam: <value in [disable, enable]>
              ipmac: <value in [disable, enable]>
              ips-sniffer-mode: <value in [disable, enable]>
              ipunnumbered: <value of 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: <value of string>
                 dhcp6-prefix-hint-plt: <value of integer>
                 dhcp6-prefix-hint-vlt: <value of integer>
                 dhcp6-relay-ip: <value of string>
                 dhcp6-relay-service: <value in [disable, enable]>
                 dhcp6-relay-type: <value in [regular]>
                 icmp6-send-redirect: <value in [disable, enable]>
                 interface-identifier: <value of string>
                 ip6-address: <value of string>
                 ip6-allowaccess:
                   - https
                   - ping
                   - ssh
                   - snmp
                   - http
                   - telnet
                   - fgfm
                   - capwap
                   - fabric
                 ip6-default-life: <value of integer>
                 ip6-delegated-prefix-list:
                   -
                       autonomous-flag: <value in [disable, enable]>
                       onlink-flag: <value in [disable, enable]>
                       prefix-id: <value of integer>
                       rdnss: <value of string>
                       rdnss-service: <value in [delegated, default, specify]>
                       subnet: <value of string>
                       upstream-interface: <value of string>
                       delegated-prefix-iaid: <value of integer>
                 ip6-dns-server-override: <value in [disable, enable]>
                 ip6-extra-addr:
                   -
                       prefix: <value of string>
                 ip6-hop-limit: <value of integer>
                 ip6-link-mtu: <value of integer>
                 ip6-manage-flag: <value in [disable, enable]>
                 ip6-max-interval: <value of integer>
                 ip6-min-interval: <value of 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: <value of string>
                       onlink-flag: <value in [disable, enable]>
                       preferred-life-time: <value of integer>
                       prefix: <value of string>
                       rdnss: <value of string>
                       valid-life-time: <value of integer>
                 ip6-reachable-time: <value of integer>
                 ip6-retrans-time: <value of integer>
                 ip6-send-adv: <value in [disable, enable]>
                 ip6-subnet: <value of string>
                 ip6-upstream-interface: <value of string>
                 nd-cert: <value of string>
                 nd-cga-modifier: <value of string>
                 nd-mode: <value in [basic, SEND-compatible]>
                 nd-security-level: <value of integer>
                 nd-timestamp-delta: <value of integer>
                 nd-timestamp-fuzz: <value of integer>
                 unique-autoconf-addr: <value in [disable, enable]>
                 vrip6_link_local: <value of string>
                 vrrp-virtual-mac6: <value in [disable, enable]>
                 vrrp6:
                   -
                       accept-mode: <value in [disable, enable]>
                       adv-interval: <value of integer>
                       preempt: <value in [disable, enable]>
                       priority: <value of integer>
                       start-time: <value of integer>
                       status: <value in [disable, enable]>
                       vrdst6: <value of string>
                       vrgrp: <value of integer>
                       vrid: <value of integer>
                       vrip6: <value of string>
                 cli-conn6-status: <value of integer>
                 ip6-prefix-mode: <value in [dhcp6, ra]>
                 ra-send-mtu: <value in [disable, enable]>
                 ip6-delegated-prefix-iaid: <value of integer>
              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: <value of integer>
              lcp-max-echo-fails: <value of integer>
              link-up-delay: <value of integer>
              listen-forticlient-connection: <value in [disable, enable]>
              lldp-network-policy: <value of string>
              lldp-reception: <value in [disable, enable, vdom]>
              lldp-transmission: <value in [enable, disable, vdom]>
              log: <value in [disable, enable]>
              macaddr: <value of string>
              managed-subnetwork-size: <value in [256, 512, 1024, ...]>
              management-ip: <value of string>
              max-egress-burst-rate: <value of integer>
              max-egress-rate: <value of integer>
              measured-downstream-bandwidth: <value of integer>
              measured-upstream-bandwidth: <value of integer>
              mediatype: <value in [serdes-sfp, sgmii-sfp, cfp2-sr10, ...]>
              member: <value of string>
              min-links: <value of integer>
              min-links-down: <value in [operational, administrative]>
              mode: <value in [static, dhcp, pppoe, ...]>
              monitor-bandwidth: <value in [disable, enable]>
              mtu: <value of integer>
              mtu-override: <value in [disable, enable]>
              mux-type: <value in [llc-encaps, vc-encaps]>
              name: <value of string>
              ndiscforward: <value in [disable, enable]>
              netbios-forward: <value in [disable, enable]>
              netflow-sampler: <value in [disable, tx, rx, ...]>
              np-qos-profile: <value of integer>
              npu-fastpath: <value in [disable, enable]>
              nst: <value in [disable, enable]>
              out-force-vlan-cos: <value of integer>
              outbandwidth: <value of integer>
              padt-retry-timeout: <value of integer>
              password: <value of string>
              peer-interface: <value of string>
              phy-mode: <value in [auto, adsl, vdsl, ...]>
              ping-serv-status: <value of integer>
              poe: <value in [disable, enable]>
              polling-interval: <value of integer>
              pppoe-unnumbered-negotiate: <value in [disable, enable]>
              pptp-auth-type: <value in [auto, pap, chap, ...]>
              pptp-client: <value in [disable, enable]>
              pptp-password: <value of string>
              pptp-server-ip: <value of string>
              pptp-timeout: <value of integer>
              pptp-user: <value of string>
              preserve-session-route: <value in [disable, enable]>
              priority: <value of integer>
              priority-override: <value in [disable, enable]>
              proxy-captive-portal: <value in [disable, enable]>
              redundant-interface: <value of string>
              remote-ip: <value of string>
              replacemsg-override-group: <value of string>
              retransmission: <value in [disable, enable]>
              ring-rx: <value of integer>
              ring-tx: <value of integer>
              role: <value in [lan, wan, dmz, ...]>
              sample-direction: <value in [rx, tx, both]>
              sample-rate: <value of 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: <value of string>
                    gwdetect: <value in [disable, enable]>
                    ha-priority: <value of integer>
                    id: <value of integer>
                    ip: <value of string>
                    ping-serv-status: <value of integer>
                    seq: <value of integer>
              security-8021x-dynamic-vlan-id: <value of integer>
              security-8021x-master: <value of string>
              security-8021x-mode: <value in [default, dynamic-vlan, fallback, ...]>
              security-exempt-list: <value of string>
              security-external-logout: <value of string>
              security-external-web: <value of string>
              security-groups: <value of string>
              security-mac-auth-bypass: <value in [disable, enable, mac-auth-only]>
              security-mode: <value in [none, captive-portal, 802.1X]>
              security-redirect-url: <value of string>
              service-name: <value of string>
              sflow-sampler: <value in [disable, enable]>
              speed: <value in [auto, 10full, 10half, ...]>
              spillover-threshold: <value of 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: <value of string>
              swc-first-create: <value of integer>
              swc-vlan: <value of integer>
              switch: <value of 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-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: <value of integer>
              switch-controller-mgmt-vlan: <value of integer>
              switch-controller-nac: <value of string>
              switch-controller-radius-server: <value of string>
              switch-controller-rspan-mode: <value in [disable, enable]>
              switch-controller-source-ip: <value in [outbound, fixed]>
              switch-controller-traffic-policy: <value of string>
              tc-mode: <value in [ptm, atm]>
              tcp-mss: <value of integer>
              trunk: <value in [disable, enable]>
              trust-ip-1: <value of string>
              trust-ip-2: <value of string>
              trust-ip-3: <value of string>
              trust-ip6-1: <value of string>
              trust-ip6-2: <value of string>
              trust-ip6-3: <value of string>
              type: <value in [physical, vlan, aggregate, ...]>
              username: <value of string>
              vci: <value of integer>
              vectoring: <value in [disable, enable]>
              vindex: <value of integer>
              vlan-protocol: <value in [8021q, 8021ad]>
              vlanforward: <value in [disable, enable]>
              vlanid: <value of integer>
              vpi: <value of integer>
              vrf: <value of integer>
              vrrp:
                -
                    accept-mode: <value in [disable, enable]>
                    adv-interval: <value of integer>
                    ignore-default-route: <value in [disable, enable]>
                    preempt: <value in [disable, enable]>
                    priority: <value of integer>
                    start-time: <value of integer>
                    status: <value in [disable, enable]>
                    version: <value in [2, 3]>
                    vrdst: <value of string>
                    vrdst-priority: <value of integer>
                    vrgrp: <value of integer>
                    vrid: <value of integer>
                    vrip: <value of string>
              vrrp-virtual-mac: <value in [disable, enable]>
              wccp: <value in [disable, enable]>
              weight: <value of integer>
              wifi-5g-threshold: <value of 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: <value of integer>
              wifi-key: <value of string>
              wifi-keyindex: <value of integer>
              wifi-mac-filter: <value in [disable, enable]>
              wifi-passphrase: <value of string>
              wifi-radius-server: <value of string>
              wifi-rts-threshold: <value of integer>
              wifi-security: <value in [None, WEP64, wep64, ...]>
              wifi-ssid: <value of string>
              wifi-usergroup: <value of string>
              wins-ip: <value of string>
              dhcp-relay-request-all-server: <value in [disable, enable]>
              stp-ha-secondary: <value in [disable, enable, priority-adjust]>
              switch-controller-dynamic: <value of string>
              auth-cert: <value of string>
              auth-portal-addr: <value of string>
              dhcp-classless-route-addition: <value in [disable, enable]>
              dhcp-relay-link-selection: <value of string>
              dns-server-protocol:
                - cleartext
                - dot
                - doh
              eap-ca-cert: <value of string>
              eap-identity: <value of string>
              eap-method: <value in [tls, peap]>
              eap-password: <value of string>
              eap-supplicant: <value in [disable, enable]>
              eap-user-cert: <value of string>
              ike-saml-server: <value of string>
              lacp-ha-secondary: <value in [disable, enable]>
              pvc-atm-qos: <value in [cbr, rt-vbr, nrt-vbr]>
              pvc-chan: <value of integer>
              pvc-crc: <value of integer>
              pvc-pcr: <value of integer>
              pvc-scr: <value of integer>
              pvc-vlan-id: <value of integer>
              pvc-vlan-rx-id: <value of integer>
              pvc-vlan-rx-op: <value in [pass-through, replace, remove]>
              pvc-vlan-tx-id: <value of integer>
              pvc-vlan-tx-op: <value in [pass-through, replace, remove]>
              reachable-time: <value of 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: <value of string>
              sw-algorithm: <value in [l2, l3, eh]>
              system-id: <value of string>
              system-id-type: <value in [auto, user]>
              vlan-id: <value of integer>
              vlan-op-mode: <value in [tag, untag, passthrough]>

Return Values ¶

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

request_url - The full url requested returned: always type: str sample: /sys/login/user
response_code - The status of api request returned: always type: int sample: 0
response_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.