fortinet.fortimanager.fmgr_fsp_vlan module – Fsp vlan

Note

This module is part of the fortinet.fortimanager collection (version 2.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_fsp_vlan.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

fsp_vlan

dictionary

The top level parameters set.

_dhcp-status

string

Deprecated, please rename it to _dhcp_status. _Dhcp-Status.

Choices:

  • "disable"

  • "enable"

auth

string

No description.

Choices:

  • "radius"

  • "usergroup"

color

integer

Color.

comments

string

No description.

dhcp-server

dictionary

Deprecated, please rename it to dhcp_server.

auto-configuration

string

Deprecated, please rename it to auto_configuration. Enable/disable auto configuration.

Choices:

  • "disable"

  • "enable"

auto-managed-status

string

Deprecated, please rename it to auto_managed_status. Enable/disable use of this DHCP server once this interface ha…

Choices:

  • "disable"

  • "enable"

conflicted-ip-timeout

integer

Deprecated, please rename it to conflicted_ip_timeout. Time in seconds to wait after a conflicted IP address is re…

ddns-auth

string

Deprecated, please rename it to ddns_auth. DDNS authentication mode.

Choices:

  • "disable"

  • "tsig"

ddns-key

any

(list or str) Deprecated, please rename it to ddns_key. DDNS update key

ddns-keyname

string

Deprecated, please rename it to ddns_keyname. DDNS update key name.

ddns-server-ip

string

Deprecated, please rename it to ddns_server_ip. DDNS server IP.

ddns-ttl

integer

Deprecated, please rename it to ddns_ttl. TTL.

ddns-update

string

Deprecated, please rename it to ddns_update. Enable/disable DDNS update for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-update-override

string

Deprecated, please rename it to ddns_update_override. Enable/disable DDNS update override for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-zone

string

Deprecated, please rename it to ddns_zone. Zone of your domain name

default-gateway

string

Deprecated, please rename it to default_gateway. Default gateway IP address assigned by the DHCP server.

dhcp-settings-from-fortiipam

string

Deprecated, please rename it to dhcp_settings_from_fortiipam. Enable/disable populating of DHCP server settings fr…

Choices:

  • "disable"

  • "enable"

dns-server1

string

Deprecated, please rename it to dns_server1. DNS server 1.

dns-server2

string

Deprecated, please rename it to dns_server2. DNS server 2.

dns-server3

string

Deprecated, please rename it to dns_server3. DNS server 3.

dns-server4

string

Deprecated, please rename it to dns_server4. DNS server 4.

dns-service

string

Deprecated, please rename it to dns_service. Options for assigning DNS servers to DHCP clients.

Choices:

  • "default"

  • "specify"

  • "local"

domain

string

Domain name suffix for the IP addresses that the DHCP server assigns to clients.

enable

string

Enable.

Choices:

  • "disable"

  • "enable"

exclude-range

list / elements=dictionary

Deprecated, please rename it to exclude_range. Exclude-Range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

filename

string

Name of the boot file on the TFTP server.

forticlient-on-net-status

string

Deprecated, please rename it to forticlient_on_net_status. Enable/disable FortiClient-On-Net service for this DHCP…

Choices:

  • "disable"

  • "enable"

id

integer

ID.

ip-mode

string

Deprecated, please rename it to ip_mode. Method used to assign client IP.

Choices:

  • "range"

  • "usrgrp"

ip-range

list / elements=dictionary

Deprecated, please rename it to ip_range. Ip-Range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

ipsec-lease-hold

integer

Deprecated, please rename it to ipsec_lease_hold. DHCP over IPsec leases expire this many seconds after tunnel down

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means unlimited.

mac-acl-default-action

string

Deprecated, please rename it to mac_acl_default_action. MAC access control default action

Choices:

  • "assign"

  • "block"

netmask

string

Netmask assigned by the DHCP server.

next-server

string

Deprecated, please rename it to next_server. IP address of a server

ntp-server1

string

Deprecated, please rename it to ntp_server1. NTP server 1.

ntp-server2

string

Deprecated, please rename it to ntp_server2. NTP server 2.

ntp-server3

string

Deprecated, please rename it to ntp_server3. NTP server 3.

ntp-service

string

Deprecated, please rename it to ntp_service. Options for assigning Network Time Protocol

Choices:

  • "default"

  • "specify"

  • "local"

option1

any

(list) Option1.

option2

any

(list) Option2.

option3

any

(list) Option3.

option4

string

Option4.

option5

string

Option5.

option6

string

Option6.

options

list / elements=dictionary

Options.

code

integer

DHCP option code.

id

integer

ID.

ip

any

(list) DHCP option IPs.

type

string

DHCP option type.

Choices:

  • "hex"

  • "string"

  • "ip"

  • "fqdn"

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

value

string

DHCP option value.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

relay-agent

string

Deprecated, please rename it to relay_agent. Relay agent IP.

reserved-address

list / elements=dictionary

Deprecated, please rename it to reserved_address. Reserved-Address.

action

string

Options for the DHCP server to configure the client with the reserved MAC address.

Choices:

  • "assign"

  • "block"

  • "reserved"

circuit-id

string

Deprecated, please rename it to circuit_id. Option 82 circuit-ID of the client that will get the reserved …

circuit-id-type

string

Deprecated, please rename it to circuit_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

description

string

Description.

id

integer

ID.

ip

string

IP address to be reserved for the MAC address.

mac

string

MAC address of the client that will get the reserved IP address.

remote-id

string

Deprecated, please rename it to remote_id. Option 82 remote-ID of the client that will get the reserved IP…

remote-id-type

string

Deprecated, please rename it to remote_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

type

string

DHCP reserved-address type.

Choices:

  • "mac"

  • "option82"

server-type

string

Deprecated, please rename it to server_type. DHCP server can be a normal DHCP server or an IPsec DHCP server.

Choices:

  • "regular"

  • "ipsec"

shared-subnet

string

Deprecated, please rename it to shared_subnet. Enable/disable shared subnet.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable this DHCP configuration.

Choices:

  • "disable"

  • "enable"

tftp-server

any

(list) Deprecated, please rename it to tftp_server. One or more hostnames or IP addresses of the TFTP servers in q…

timezone

string

Select the time zone to be assigned to DHCP clients.

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"

timezone-option

string

Deprecated, please rename it to timezone_option. Options for the DHCP server to set the clients time zone.

Choices:

  • "disable"

  • "default"

  • "specify"

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string. One or more VCI strings in quotes separated by spaces.

wifi-ac-service

string

Deprecated, please rename it to wifi_ac_service. Options for assigning WiFi Access Controllers to DHCP clients

Choices:

  • "specify"

  • "local"

wifi-ac1

string

Deprecated, please rename it to wifi_ac1. WiFi Access Controller 1 IP address

wifi-ac2

string

Deprecated, please rename it to wifi_ac2. WiFi Access Controller 2 IP address

wifi-ac3

string

Deprecated, please rename it to wifi_ac3. WiFi Access Controller 3 IP address

wins-server1

string

Deprecated, please rename it to wins_server1. WINS server 1.

wins-server2

string

Deprecated, please rename it to wins_server2. WINS server 2.

dynamic_mapping

list / elements=dictionary

Dynamic_Mapping.

_dhcp-status

string

Deprecated, please rename it to _dhcp_status. _Dhcp-Status.

Choices:

  • "disable"

  • "enable"

_scope

list / elements=dictionary

_Scope.

name

string

Name.

vdom

string

Vdom.

dhcp-server

dictionary

Deprecated, please rename it to dhcp_server.

auto-configuration

string

Deprecated, please rename it to auto_configuration. Enable/disable auto configuration.

Choices:

  • "disable"

  • "enable"

auto-managed-status

string

Deprecated, please rename it to auto_managed_status. Enable/disable use of this DHCP server once this inte…

Choices:

  • "disable"

  • "enable"

conflicted-ip-timeout

integer

Deprecated, please rename it to conflicted_ip_timeout. Time in seconds to wait after a conflicted IP addre…

ddns-auth

string

Deprecated, please rename it to ddns_auth. DDNS authentication mode.

Choices:

  • "disable"

  • "tsig"

ddns-key

any

(list or str) Deprecated, please rename it to ddns_key. DDNS update key

ddns-keyname

string

Deprecated, please rename it to ddns_keyname. DDNS update key name.

ddns-server-ip

string

Deprecated, please rename it to ddns_server_ip. DDNS server IP.

ddns-ttl

integer

Deprecated, please rename it to ddns_ttl. TTL.

ddns-update

string

Deprecated, please rename it to ddns_update. Enable/disable DDNS update for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-update-override

string

Deprecated, please rename it to ddns_update_override. Enable/disable DDNS update override for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-zone

string

Deprecated, please rename it to ddns_zone. Zone of your domain name

default-gateway

string

Deprecated, please rename it to default_gateway. Default gateway IP address assigned by the DHCP server.

dhcp-settings-from-fortiipam

string

Deprecated, please rename it to dhcp_settings_from_fortiipam. Enable/disable populating of DHCP server set…

Choices:

  • "disable"

  • "enable"

dns-server1

string

Deprecated, please rename it to dns_server1. DNS server 1.

dns-server2

string

Deprecated, please rename it to dns_server2. DNS server 2.

dns-server3

string

Deprecated, please rename it to dns_server3. DNS server 3.

dns-server4

string

Deprecated, please rename it to dns_server4. DNS server 4.

dns-service

string

Deprecated, please rename it to dns_service. Options for assigning DNS servers to DHCP clients.

Choices:

  • "default"

  • "specify"

  • "local"

domain

string

Domain name suffix for the IP addresses that the DHCP server assigns to clients.

enable

string

Enable.

Choices:

  • "disable"

  • "enable"

exclude-range

list / elements=dictionary

Deprecated, please rename it to exclude_range. Exclude-Range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

filename

string

Name of the boot file on the TFTP server.

forticlient-on-net-status

string

Deprecated, please rename it to forticlient_on_net_status. Enable/disable FortiClient-On-Net service for t…

Choices:

  • "disable"

  • "enable"

id

integer

ID.

ip-mode

string

Deprecated, please rename it to ip_mode. Method used to assign client IP.

Choices:

  • "range"

  • "usrgrp"

ip-range

list / elements=dictionary

Deprecated, please rename it to ip_range. Ip-Range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

ipsec-lease-hold

integer

Deprecated, please rename it to ipsec_lease_hold. DHCP over IPsec leases expire this many seconds after tu…

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means unlimited.

mac-acl-default-action

string

Deprecated, please rename it to mac_acl_default_action. MAC access control default action

Choices:

  • "assign"

  • "block"

netmask

string

Netmask assigned by the DHCP server.

next-server

string

Deprecated, please rename it to next_server. IP address of a server

ntp-server1

string

Deprecated, please rename it to ntp_server1. NTP server 1.

ntp-server2

string

Deprecated, please rename it to ntp_server2. NTP server 2.

ntp-server3

string

Deprecated, please rename it to ntp_server3. NTP server 3.

ntp-service

string

Deprecated, please rename it to ntp_service. Options for assigning Network Time Protocol

Choices:

  • "default"

  • "specify"

  • "local"

option1

any

(list) Option1.

option2

any

(list) Option2.

option3

any

(list) Option3.

option4

string

Option4.

option5

string

Option5.

option6

string

Option6.

options

list / elements=dictionary

Options.

code

integer

DHCP option code.

id

integer

ID.

ip

any

(list) DHCP option IPs.

type

string

DHCP option type.

Choices:

  • "hex"

  • "string"

  • "ip"

  • "fqdn"

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string.

value

string

DHCP option value.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string.

relay-agent

string

Deprecated, please rename it to relay_agent. Relay agent IP.

reserved-address

list / elements=dictionary

Deprecated, please rename it to reserved_address. Reserved-Address.

action

string

Options for the DHCP server to configure the client with the reserved MAC address.

Choices:

  • "assign"

  • "block"

  • "reserved"

circuit-id

string

Deprecated, please rename it to circuit_id. Option 82 circuit-ID of the client that will get the r…

circuit-id-type

string

Deprecated, please rename it to circuit_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

description

string

Description.

id

integer

ID.

ip

string

IP address to be reserved for the MAC address.

mac

string

MAC address of the client that will get the reserved IP address.

remote-id

string

Deprecated, please rename it to remote_id. Option 82 remote-ID of the client that will get the res…

remote-id-type

string

Deprecated, please rename it to remote_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

type

string

DHCP reserved-address type.

Choices:

  • "mac"

  • "option82"

server-type

string

Deprecated, please rename it to server_type. DHCP server can be a normal DHCP server or an IPsec DHCP server.

Choices:

  • "regular"

  • "ipsec"

shared-subnet

string

Deprecated, please rename it to shared_subnet. Enable/disable shared subnet.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable this DHCP configuration.

Choices:

  • "disable"

  • "enable"

tftp-server

any

(list) Deprecated, please rename it to tftp_server. One or more hostnames or IP addresses of the TFTP serv…

timezone

string

Select the time zone to be assigned to DHCP clients.

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"

timezone-option

string

Deprecated, please rename it to timezone_option. Options for the DHCP server to set the clients time zone.

Choices:

  • "disable"

  • "default"

  • "specify"

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string. One or more VCI strings in quotes separated by spaces.

wifi-ac-service

string

Deprecated, please rename it to wifi_ac_service. Options for assigning WiFi Access Controllers to DHCP clients

Choices:

  • "specify"

  • "local"

wifi-ac1

string

Deprecated, please rename it to wifi_ac1. WiFi Access Controller 1 IP address

wifi-ac2

string

Deprecated, please rename it to wifi_ac2. WiFi Access Controller 2 IP address

wifi-ac3

string

Deprecated, please rename it to wifi_ac3. WiFi Access Controller 3 IP address

wins-server1

string

Deprecated, please rename it to wins_server1. WINS server 1.

wins-server2

string

Deprecated, please rename it to wins_server2. WINS server 2.

interface

dictionary

No description.

dhcp-relay-agent-option

string

Deprecated, please rename it to dhcp_relay_agent_option. Dhcp-Relay-Agent-Option.

Choices:

  • "disable"

  • "enable"

dhcp-relay-interface-select-method

string

Deprecated, please rename it to dhcp_relay_interface_select_method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

dhcp-relay-ip

any

(list) Deprecated, please rename it to dhcp_relay_ip. Dhcp-Relay-Ip.

dhcp-relay-service

string

Deprecated, please rename it to dhcp_relay_service. Dhcp-Relay-Service.

Choices:

  • "disable"

  • "enable"

dhcp-relay-type

string

Deprecated, please rename it to dhcp_relay_type. Dhcp-Relay-Type.

Choices:

  • "regular"

  • "ipsec"

ip

string

Ip.

ipv6

dictionary

No description.

autoconf

string

Enable/disable address auto config.

Choices:

  • "disable"

  • "enable"

cli-conn6-status

integer

Deprecated, please rename it to cli_conn6_status. Cli-Conn6-Status.

dhcp6-client-options

list / elements=string

Deprecated, please rename it to dhcp6_client_options. Dhcp6-Client-Options.

Choices:

  • "rapid"

  • "iapd"

  • "iana"

  • "dns"

  • "dnsname"

dhcp6-information-request

string

Deprecated, please rename it to dhcp6_information_request. Enable/disable DHCPv6 information request.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-delegation

string

Deprecated, please rename it to dhcp6_prefix_delegation. Enable/disable DHCPv6 prefix delegation.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-hint

string

Deprecated, please rename it to dhcp6_prefix_hint. DHCPv6 prefix that will be used as a hint to th…

dhcp6-prefix-hint-plt

integer

Deprecated, please rename it to dhcp6_prefix_hint_plt. DHCPv6 prefix hint preferred life time

dhcp6-prefix-hint-vlt

integer

Deprecated, please rename it to dhcp6_prefix_hint_vlt. DHCPv6 prefix hint valid life time

dhcp6-relay-interface-id

string

Deprecated, please rename it to dhcp6_relay_interface_id. DHCP6 relay interface ID.

dhcp6-relay-ip

string

Deprecated, please rename it to dhcp6_relay_ip. DHCPv6 relay IP address.

dhcp6-relay-service

string

Deprecated, please rename it to dhcp6_relay_service. Enable/disable DHCPv6 relay.

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-interface

string

Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable use of address on thi…

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-ip

string

Deprecated, please rename it to dhcp6_relay_source_ip. IPv6 address used by the DHCP6 relay as its…

dhcp6-relay-type

string

Deprecated, please rename it to dhcp6_relay_type. DHCPv6 relay type.

Choices:

  • "regular"

icmp6-send-redirect

string

Deprecated, please rename it to icmp6_send_redirect. Enable/disable sending of ICMPv6 redirects.

Choices:

  • "disable"

  • "enable"

interface-identifier

string

Deprecated, please rename it to interface_identifier. IPv6 interface identifier.

ip6-address

string

Deprecated, please rename it to ip6_address. Primary IPv6 address prefix, syntax

ip6-allowaccess

list / elements=string

Deprecated, please rename it to ip6_allowaccess. Allow management access to the interface.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6-default-life

integer

Deprecated, please rename it to ip6_default_life. Default life

ip6-delegated-prefix-iaid

integer

Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of obtained delegated-prefix from …

ip6-delegated-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_delegated_prefix_list. Ip6-Delegated-Prefix-List.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag. Enable/disable the autonomous flag.

Choices:

  • "disable"

  • "enable"

delegated-prefix-iaid

integer

Deprecated, please rename it to delegated_prefix_iaid. IAID of obtained delegated-prefix f…

string

Deprecated, please rename it to onlink_flag. Enable/disable the onlink flag.

Choices:

  • "disable"

  • "enable"

prefix-id

integer

Deprecated, please rename it to prefix_id. Prefix ID.

rdnss

any

(list) Recursive DNS server option.

rdnss-service

string

Deprecated, please rename it to rdnss_service. Recursive DNS service option.

Choices:

  • "delegated"

  • "default"

  • "specify"

subnet

string

Add subnet ID to routing prefix.

upstream-interface

string

Deprecated, please rename it to upstream_interface. Name of the interface that provides de…

ip6-dns-server-override

string

Deprecated, please rename it to ip6_dns_server_override. Enable/disable using the DNS server acqui…

Choices:

  • "disable"

  • "enable"

ip6-extra-addr

list / elements=dictionary

Deprecated, please rename it to ip6_extra_addr. Ip6-Extra-Addr.

prefix

string

IPv6 address prefix.

ip6-hop-limit

integer

Deprecated, please rename it to ip6_hop_limit. Hop limit

integer

Deprecated, please rename it to ip6_link_mtu. IPv6 link MTU.

ip6-manage-flag

string

Deprecated, please rename it to ip6_manage_flag. Enable/disable the managed flag.

Choices:

  • "disable"

  • "enable"

ip6-max-interval

integer

Deprecated, please rename it to ip6_max_interval. IPv6 maximum interval

ip6-min-interval

integer

Deprecated, please rename it to ip6_min_interval. IPv6 minimum interval

ip6-mode

string

Deprecated, please rename it to ip6_mode. Addressing mode

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6-other-flag

string

Deprecated, please rename it to ip6_other_flag. Enable/disable the other IPv6 flag.

Choices:

  • "disable"

  • "enable"

ip6-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_prefix_list. Ip6-Prefix-List.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag. Enable/disable the autonomous flag.

Choices:

  • "disable"

  • "enable"

dnssl

any

(list) DNS search list option.

string

Deprecated, please rename it to onlink_flag. Enable/disable the onlink flag.

Choices:

  • "disable"

  • "enable"

preferred-life-time

integer

Deprecated, please rename it to preferred_life_time. Preferred life time

prefix

string

IPv6 prefix.

rdnss

any

(list) Recursive DNS server option.

valid-life-time

integer

Deprecated, please rename it to valid_life_time. Valid life time

ip6-prefix-mode

string

Deprecated, please rename it to ip6_prefix_mode. Assigning a prefix from DHCP or RA.

Choices:

  • "dhcp6"

  • "ra"

ip6-reachable-time

integer

Deprecated, please rename it to ip6_reachable_time. IPv6 reachable time

ip6-retrans-time

integer

Deprecated, please rename it to ip6_retrans_time. IPv6 retransmit time

ip6-send-adv

string

Deprecated, please rename it to ip6_send_adv. Enable/disable sending advertisements about the inte…

Choices:

  • "disable"

  • "enable"

ip6-subnet

string

Deprecated, please rename it to ip6_subnet. Subnet to routing prefix, syntax

ip6-upstream-interface

string

Deprecated, please rename it to ip6_upstream_interface. Interface name providing delegated informa…

nd-cert

string

Deprecated, please rename it to nd_cert. Neighbor discovery certificate.

nd-cga-modifier

string

Deprecated, please rename it to nd_cga_modifier. Neighbor discovery CGA modifier.

nd-mode

string

Deprecated, please rename it to nd_mode. Neighbor discovery mode.

Choices:

  • "basic"

  • "SEND-compatible"

nd-security-level

integer

Deprecated, please rename it to nd_security_level. Neighbor discovery security level

nd-timestamp-delta

integer

Deprecated, please rename it to nd_timestamp_delta. Neighbor discovery timestamp delta value

nd-timestamp-fuzz

integer

Deprecated, please rename it to nd_timestamp_fuzz. Neighbor discovery timestamp fuzz factor

ra-send-mtu

string

Deprecated, please rename it to ra_send_mtu. Enable/disable sending link MTU in RA packet.

Choices:

  • "disable"

  • "enable"

unique-autoconf-addr

string

Deprecated, please rename it to unique_autoconf_addr. Enable/disable unique auto config address.

Choices:

  • "disable"

  • "enable"

string

Link-local IPv6 address of virtual router.

vrrp-virtual-mac6

string

Deprecated, please rename it to vrrp_virtual_mac6. Enable/disable virtual MAC for VRRP.

Choices:

  • "disable"

  • "enable"

vrrp6

list / elements=dictionary

Vrrp6.

accept-mode

string

Deprecated, please rename it to accept_mode. Enable/disable accept mode.

Choices:

  • "disable"

  • "enable"

adv-interval

integer

Deprecated, please rename it to adv_interval. Advertisement interval

ignore-default-route

string

Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default r…

Choices:

  • "disable"

  • "enable"

preempt

string

Enable/disable preempt mode.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority of the virtual router

start-time

integer

Deprecated, please rename it to start_time. Startup time

status

string

Enable/disable VRRP.

Choices:

  • "disable"

  • "enable"

vrdst6

string

Monitor the route to this destination.

vrgrp

integer

VRRP group ID

vrid

integer

Virtual router identifier

vrip6

string

IPv6 address of the virtual router.

secondary-IP

string

Deprecated, please rename it to secondary_IP. Secondary-Ip.

Choices:

  • "disable"

  • "enable"

secondaryip

list / elements=dictionary

Secondaryip.

allowaccess

list / elements=string

Management access settings for the secondary IP address.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "auto-ipsec"

  • "radius-acct"

  • "probe-response"

  • "capwap"

  • "dnp"

  • "ftm"

  • "fabric"

  • "speed-test"

detectprotocol

list / elements=string

Protocols used to detect the server.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

detectserver

string

Gateways ping server for this IP.

gwdetect

string

Enable/disable detect gateway alive for first.

Choices:

  • "disable"

  • "enable"

ha-priority

integer

Deprecated, please rename it to ha_priority. HA election priority for the PING server.

id

integer

ID.

ip

string

Secondary IP address of the interface.

ping-serv-status

integer

Deprecated, please rename it to ping_serv_status. Ping-Serv-Status.

secip-relay-ip

string

Deprecated, please rename it to secip_relay_ip. DHCP relay IP address.

seq

integer

Seq.

vlanid

integer

Vlanid.

vrrp

list / elements=dictionary

No description.

accept-mode

string

Deprecated, please rename it to accept_mode. Enable/disable accept mode.

Choices:

  • "disable"

  • "enable"

adv-interval

integer

Deprecated, please rename it to adv_interval. Advertisement interval

ignore-default-route

string

Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default route whe…

Choices:

  • "disable"

  • "enable"

preempt

string

Enable/disable preempt mode.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority of the virtual router

proxy-arp

list / elements=dictionary

Deprecated, please rename it to proxy_arp.

id

integer

ID.

ip

string

Set IP addresses of proxy ARP.

start-time

integer

Deprecated, please rename it to start_time. Startup time

status

string

Enable/disable this VRRP configuration.

Choices:

  • "disable"

  • "enable"

version

string

VRRP version.

Choices:

  • "2"

  • "3"

vrdst

any

(list) No description.

vrdst-priority

integer

Deprecated, please rename it to vrdst_priority. Priority of the virtual router when the virtual ro…

vrgrp

integer

VRRP group ID

vrid

integer

Virtual router identifier

vrip

string

IP address of the virtual router.

interface

dictionary

No description.

ac-name

string

Deprecated, please rename it to ac_name. PPPoE server name.

aggregate

string

Aggregate.

aggregate-type

string

Deprecated, please rename it to aggregate_type. Type of aggregation.

Choices:

  • "physical"

  • "vxlan"

algorithm

string

Frame distribution algorithm.

Choices:

  • "L2"

  • "L3"

  • "L4"

  • "LB"

  • "Source-MAC"

alias

string

Alias will be displayed with the interface name to make it easier to distinguish.

allowaccess

list / elements=string

Permitted types of management access to this interface.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "auto-ipsec"

  • "radius-acct"

  • "probe-response"

  • "capwap"

  • "dnp"

  • "ftm"

  • "fabric"

  • "speed-test"

annex

string

Set xDSL annex type.

Choices:

  • "a"

  • "b"

  • "j"

  • "bjm"

  • "i"

  • "al"

  • "m"

  • "aijlm"

  • "bj"

ap-discover

string

Deprecated, please rename it to ap_discover. Enable/disable automatic registration of unknown FortiAP devices.

Choices:

  • "disable"

  • "enable"

arpforward

string

Enable/disable ARP forwarding.

Choices:

  • "disable"

  • "enable"

atm-protocol

string

Deprecated, please rename it to atm_protocol. ATM protocol.

Choices:

  • "none"

  • "ipoa"

auth-cert

string

Deprecated, please rename it to auth_cert. HTTPS server certificate.

auth-portal-addr

string

Deprecated, please rename it to auth_portal_addr. Address of captive portal.

auth-type

string

Deprecated, please rename it to auth_type. PPP authentication type to use.

Choices:

  • "auto"

  • "pap"

  • "chap"

  • "mschapv1"

  • "mschapv2"

auto-auth-extension-device

string

Deprecated, please rename it to auto_auth_extension_device. Enable/disable automatic authorization of dedicated Fo…

Choices:

  • "disable"

  • "enable"

bandwidth-measure-time

integer

Deprecated, please rename it to bandwidth_measure_time. Bandwidth measure time

bfd

string

Bidirectional Forwarding Detection

Choices:

  • "global"

  • "enable"

  • "disable"

bfd-desired-min-tx

integer

Deprecated, please rename it to bfd_desired_min_tx. BFD desired minimal transmit interval.

bfd-detect-mult

integer

Deprecated, please rename it to bfd_detect_mult. BFD detection multiplier.

bfd-required-min-rx

integer

Deprecated, please rename it to bfd_required_min_rx. BFD required minimal receive interval.

broadcast-forticlient-discovery

string

Deprecated, please rename it to broadcast_forticlient_discovery. Enable/disable broadcasting FortiClient discovery…

Choices:

  • "disable"

  • "enable"

broadcast-forward

string

Deprecated, please rename it to broadcast_forward. Enable/disable broadcast forwarding.

Choices:

  • "disable"

  • "enable"

captive-portal

integer

Deprecated, please rename it to captive_portal. Enable/disable captive portal.

cli-conn-status

integer

Deprecated, please rename it to cli_conn_status. Cli-Conn-Status.

color

integer

Color of icon on the GUI.

ddns

string

Ddns.

Choices:

  • "disable"

  • "enable"

ddns-auth

string

Deprecated, please rename it to ddns_auth. Ddns-Auth.

Choices:

  • "disable"

  • "tsig"

ddns-domain

string

Deprecated, please rename it to ddns_domain. Ddns-Domain.

ddns-key

any

(list or str) Deprecated, please rename it to ddns_key. Ddns-Key.

ddns-keyname

string

Deprecated, please rename it to ddns_keyname. Ddns-Keyname.

ddns-password

any

(list) Deprecated, please rename it to ddns_password. Ddns-Password.

ddns-server

string

Deprecated, please rename it to ddns_server. Ddns-Server.

Choices:

  • "dhs.org"

  • "dyndns.org"

  • "dyns.net"

  • "tzo.com"

  • "ods.org"

  • "vavic.com"

  • "now.net.cn"

  • "dipdns.net"

  • "easydns.com"

  • "genericDDNS"

ddns-server-ip

string

Deprecated, please rename it to ddns_server_ip. Ddns-Server-Ip.

ddns-sn

string

Deprecated, please rename it to ddns_sn. Ddns-Sn.

ddns-ttl

integer

Deprecated, please rename it to ddns_ttl. Ddns-Ttl.

ddns-username

string

Deprecated, please rename it to ddns_username. Ddns-Username.

ddns-zone

string

Deprecated, please rename it to ddns_zone. Ddns-Zone.

dedicated-to

string

Deprecated, please rename it to dedicated_to. Configure interface for single purpose.

Choices:

  • "none"

  • "management"

default-purdue-level

string

Deprecated, please rename it to default_purdue_level. Default purdue level of device detected on this interface.

Choices:

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

  • "1.5"

  • "2.5"

  • "3.5"

  • "5.5"

defaultgw

string

Enable to get the gateway IP from the DHCP or PPPoE server.

Choices:

  • "disable"

  • "enable"

description

string

Description.

detected-peer-mtu

integer

Deprecated, please rename it to detected_peer_mtu. Detected-Peer-Mtu.

detectprotocol

list / elements=string

Protocols used to detect the server.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

detectserver

string

Gateways ping server for this IP.

device-access-list

any

(list or str) Deprecated, please rename it to device_access_list. Device access list.

device-identification

string

Deprecated, please rename it to device_identification. Enable/disable passively gathering of device identity infor…

Choices:

  • "disable"

  • "enable"

device-identification-active-scan

string

Deprecated, please rename it to device_identification_active_scan. Enable/disable active gathering of device ident…

Choices:

  • "disable"

  • "enable"

device-netscan

string

Deprecated, please rename it to device_netscan. Enable/disable inclusion of devices detected on this interface in …

Choices:

  • "disable"

  • "enable"

device-user-identification

string

Deprecated, please rename it to device_user_identification. Enable/disable passive gathering of user identity info…

Choices:

  • "disable"

  • "enable"

devindex

integer

Devindex.

dhcp-broadcast-flag

string

Deprecated, please rename it to dhcp_broadcast_flag. Enable/disable setting of the broadcast flag in messages sent…

Choices:

  • "disable"

  • "enable"

dhcp-classless-route-addition

string

Deprecated, please rename it to dhcp_classless_route_addition. Enable/disable addition of classless static routes …

Choices:

  • "disable"

  • "enable"

dhcp-client-identifier

string

Deprecated, please rename it to dhcp_client_identifier. DHCP client identifier.

dhcp-relay-agent-option

string

Deprecated, please rename it to dhcp_relay_agent_option. Enable/disable DHCP relay agent option.

Choices:

  • "disable"

  • "enable"

dhcp-relay-circuit-id

string

Deprecated, please rename it to dhcp_relay_circuit_id. DHCP relay circuit ID.

dhcp-relay-interface

string

Deprecated, please rename it to dhcp_relay_interface. Specify outgoing interface to reach server.

dhcp-relay-interface-select-method

string

Deprecated, please rename it to dhcp_relay_interface_select_method. Specify how to select outgoing interface to re…

Choices:

  • "auto"

  • "sdwan"

  • "specify"

dhcp-relay-ip

any

(list) Deprecated, please rename it to dhcp_relay_ip. DHCP relay IP address.

string

Deprecated, please rename it to dhcp_relay_link_selection. DHCP relay link selection.

dhcp-relay-request-all-server

string

Deprecated, please rename it to dhcp_relay_request_all_server. Enable/disable sending of DHCP requests to all servers.

Choices:

  • "disable"

  • "enable"

dhcp-relay-service

string

Deprecated, please rename it to dhcp_relay_service. Enable/disable allowing this interface to act as a DHCP relay.

Choices:

  • "disable"

  • "enable"

dhcp-relay-source-ip

string

Deprecated, please rename it to dhcp_relay_source_ip. IP address used by the DHCP relay as its source IP.

dhcp-relay-type

string

Deprecated, please rename it to dhcp_relay_type. DHCP relay type

Choices:

  • "regular"

  • "ipsec"

dhcp-renew-time

integer

Deprecated, please rename it to dhcp_renew_time. DHCP renew time in seconds

dhcp-smart-relay

string

Deprecated, please rename it to dhcp_smart_relay. Enable/disable DHCP smart relay.

Choices:

  • "disable"

  • "enable"

disc-retry-timeout

integer

Deprecated, please rename it to disc_retry_timeout. Time in seconds to wait before retrying to start a PPPoE disco…

disconnect-threshold

integer

Deprecated, please rename it to disconnect_threshold. Time in milliseconds to wait before sending a notification t…

distance

integer

Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.

dns-query

string

Deprecated, please rename it to dns_query. Dns-Query.

Choices:

  • "disable"

  • "recursive"

  • "non-recursive"

dns-server-override

string

Deprecated, please rename it to dns_server_override. Enable/disable use DNS acquired by DHCP or PPPoE.

Choices:

  • "disable"

  • "enable"

dns-server-protocol

list / elements=string

Deprecated, please rename it to dns_server_protocol.

Choices:

  • "cleartext"

  • "dot"

  • "doh"

drop-fragment

string

Deprecated, please rename it to drop_fragment. Enable/disable drop fragment packets.

Choices:

  • "disable"

  • "enable"

drop-overlapped-fragment

string

Deprecated, please rename it to drop_overlapped_fragment. Enable/disable drop overlapped fragment packets.

Choices:

  • "disable"

  • "enable"

eap-ca-cert

string

Deprecated, please rename it to eap_ca_cert. EAP CA certificate name.

eap-identity

string

Deprecated, please rename it to eap_identity. EAP identity.

eap-method

string

Deprecated, please rename it to eap_method. EAP method.

Choices:

  • "tls"

  • "peap"

eap-password

any

(list) Deprecated, please rename it to eap_password.

eap-supplicant

string

Deprecated, please rename it to eap_supplicant. Enable/disable EAP-Supplicant.

Choices:

  • "disable"

  • "enable"

eap-user-cert

string

Deprecated, please rename it to eap_user_cert. EAP user certificate name.

egress-cos

string

Deprecated, please rename it to egress_cos. Override outgoing CoS in user VLAN tag.

Choices:

  • "disable"

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

egress-shaping-profile

string

Deprecated, please rename it to egress_shaping_profile. Outgoing traffic shaping profile.

eip

string

Eip.

endpoint-compliance

string

Deprecated, please rename it to endpoint_compliance. Enable/disable endpoint compliance enforcement.

Choices:

  • "disable"

  • "enable"

estimated-downstream-bandwidth

integer

Deprecated, please rename it to estimated_downstream_bandwidth. Estimated maximum downstream bandwidth

estimated-upstream-bandwidth

integer

Deprecated, please rename it to estimated_upstream_bandwidth. Estimated maximum upstream bandwidth

explicit-ftp-proxy

string

Deprecated, please rename it to explicit_ftp_proxy. Enable/disable the explicit FTP proxy on this interface.

Choices:

  • "disable"

  • "enable"

explicit-web-proxy

string

Deprecated, please rename it to explicit_web_proxy. Enable/disable the explicit web proxy on this interface.

Choices:

  • "disable"

  • "enable"

external

string

Enable/disable identifying the interface as an external interface

Choices:

  • "disable"

  • "enable"

fail-action-on-extender

string

Deprecated, please rename it to fail_action_on_extender. Action on extender when interface fail .

Choices:

  • "soft-restart"

  • "hard-restart"

  • "reboot"

fail-alert-interfaces

any

(list or str) Deprecated, please rename it to fail_alert_interfaces. Names of the FortiGate interfaces to which th…

fail-alert-method

string

Deprecated, please rename it to fail_alert_method. Select link-failed-signal or link-down method to alert about a …

Choices:

  • "link-failed-signal"

  • "link-down"

fail-detect

string

Deprecated, please rename it to fail_detect. Enable/disable fail detection features for this interface.

Choices:

  • "disable"

  • "enable"

fail-detect-option

list / elements=string

Deprecated, please rename it to fail_detect_option. Options for detecting that this interface has failed.

Choices:

  • "detectserver"

  • "link-down"

fdp

string

Fdp.

Choices:

  • "disable"

  • "enable"

fortiheartbeat

string

Enable/disable FortiHeartBeat

Choices:

  • "disable"

  • "enable"

string

Enable FortiLink to dedicate this interface to manage other Fortinet devices.

Choices:

  • "disable"

  • "enable"

integer

Deprecated, please rename it to fortilink_backup_link. Fortilink-Backup-Link.

string

Deprecated, please rename it to fortilink_neighbor_detect. Protocol for FortiGate neighbor discovery.

Choices:

  • "lldp"

  • "fortilink"

string

Deprecated, please rename it to fortilink_split_interface. Enable/disable FortiLink split interface to connect mem…

Choices:

  • "disable"

  • "enable"

string

Deprecated, please rename it to fortilink_stacking. Enable/disable FortiLink switch-stacking on this interface.

Choices:

  • "disable"

  • "enable"

forward-domain

integer

Deprecated, please rename it to forward_domain. Transparent mode forward domain.

forward-error-correction

string

Deprecated, please rename it to forward_error_correction. Enable/disable forward error correction

Choices:

  • "disable"

  • "enable"

  • "rs-fec"

  • "base-r-fec"

  • "fec-cl91"

  • "fec-cl74"

  • "rs-544"

  • "none"

  • "cl91-rs-fec"

  • "cl74-fc-fec"

  • "auto"

fp-anomaly

list / elements=string

Deprecated, please rename it to fp_anomaly. Fp-Anomaly.

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"

fp-disable

list / elements=string

Deprecated, please rename it to fp_disable. Fp-Disable.

Choices:

  • "all"

  • "ipsec"

  • "none"

gateway-address

string

Deprecated, please rename it to gateway_address. Gateway address

generic-receive-offload

string

Deprecated, please rename it to generic_receive_offload.

Choices:

  • "disable"

  • "enable"

gi-gk

string

Deprecated, please rename it to gi_gk. Enable/disable Gi Gatekeeper.

Choices:

  • "disable"

  • "enable"

gwaddr

string

Gateway address

gwdetect

string

Enable/disable detect gateway alive for first.

Choices:

  • "disable"

  • "enable"

ha-priority

integer

Deprecated, please rename it to ha_priority. HA election priority for the PING server.

icmp-accept-redirect

string

Deprecated, please rename it to icmp_accept_redirect. Enable/disable ICMP accept redirect.

Choices:

  • "disable"

  • "enable"

icmp-redirect

string

Deprecated, please rename it to icmp_redirect. Enable/disable ICMP redirect.

Choices:

  • "disable"

  • "enable"

icmp-send-redirect

string

Deprecated, please rename it to icmp_send_redirect. Enable/disable sending of ICMP redirects.

Choices:

  • "disable"

  • "enable"

ident-accept

string

Deprecated, please rename it to ident_accept. Enable/disable authentication for this interface.

Choices:

  • "disable"

  • "enable"

idle-timeout

integer

Deprecated, please rename it to idle_timeout. PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.

if-mdix

string

Deprecated, please rename it to if_mdix. Interface MDIX mode

Choices:

  • "auto"

  • "normal"

  • "crossover"

if-media

string

Deprecated, please rename it to if_media. Select interface media type

Choices:

  • "auto"

  • "copper"

  • "fiber"

ike-saml-server

string

Deprecated, please rename it to ike_saml_server. Configure IKE authentication SAML server.

in-force-vlan-cos

integer

Deprecated, please rename it to in_force_vlan_cos. In-Force-Vlan-Cos.

inbandwidth

integer

Bandwidth limit for incoming traffic

ingress-cos

string

Deprecated, please rename it to ingress_cos. Override incoming CoS in user VLAN tag on VLAN interface or assign a …

Choices:

  • "disable"

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

ingress-shaping-profile

string

Deprecated, please rename it to ingress_shaping_profile. Incoming traffic shaping profile.

ingress-spillover-threshold

integer

Deprecated, please rename it to ingress_spillover_threshold. Ingress Spillover threshold

interconnect-profile

string

Deprecated, please rename it to interconnect_profile. Set interconnect profile.

Choices:

  • "default"

  • "profile1"

  • "profile2"

internal

integer

Implicitly created.

ip

string

Interface IPv4 address and subnet mask, syntax

ip-managed-by-fortiipam

string

Deprecated, please rename it to ip_managed_by_fortiipam. Enable/disable automatic IP address assignment of this in…

Choices:

  • "disable"

  • "enable"

  • "inherit-global"

ipmac

string

Enable/disable IP/MAC binding.

Choices:

  • "disable"

  • "enable"

ips-sniffer-mode

string

Deprecated, please rename it to ips_sniffer_mode. Enable/disable the use of this interface as a one-armed sniffer.

Choices:

  • "disable"

  • "enable"

ipunnumbered

string

Unnumbered IP used for PPPoE interfaces for which no unique local address is provided.

ipv6

dictionary

No description.

autoconf

string

Enable/disable address auto config.

Choices:

  • "disable"

  • "enable"

cli-conn6-status

integer

Deprecated, please rename it to cli_conn6_status. Cli-Conn6-Status.

dhcp6-client-options

list / elements=string

Deprecated, please rename it to dhcp6_client_options. Dhcp6-Client-Options.

Choices:

  • "rapid"

  • "iapd"

  • "iana"

  • "dns"

  • "dnsname"

dhcp6-information-request

string

Deprecated, please rename it to dhcp6_information_request. Enable/disable DHCPv6 information request.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-delegation

string

Deprecated, please rename it to dhcp6_prefix_delegation. Enable/disable DHCPv6 prefix delegation.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-hint

string

Deprecated, please rename it to dhcp6_prefix_hint. DHCPv6 prefix that will be used as a hint to the upstre…

dhcp6-prefix-hint-plt

integer

Deprecated, please rename it to dhcp6_prefix_hint_plt. DHCPv6 prefix hint preferred life time

dhcp6-prefix-hint-vlt

integer

Deprecated, please rename it to dhcp6_prefix_hint_vlt. DHCPv6 prefix hint valid life time

dhcp6-relay-interface-id

string

Deprecated, please rename it to dhcp6_relay_interface_id. DHCP6 relay interface ID.

dhcp6-relay-ip

string

Deprecated, please rename it to dhcp6_relay_ip. DHCPv6 relay IP address.

dhcp6-relay-service

string

Deprecated, please rename it to dhcp6_relay_service. Enable/disable DHCPv6 relay.

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-interface

string

Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable use of address on this interf…

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-ip

string

Deprecated, please rename it to dhcp6_relay_source_ip. IPv6 address used by the DHCP6 relay as its source IP.

dhcp6-relay-type

string

Deprecated, please rename it to dhcp6_relay_type. DHCPv6 relay type.

Choices:

  • "regular"

icmp6-send-redirect

string

Deprecated, please rename it to icmp6_send_redirect. Enable/disable sending of ICMPv6 redirects.

Choices:

  • "disable"

  • "enable"

interface-identifier

string

Deprecated, please rename it to interface_identifier. IPv6 interface identifier.

ip6-address

string

Deprecated, please rename it to ip6_address. Primary IPv6 address prefix, syntax

ip6-allowaccess

list / elements=string

Deprecated, please rename it to ip6_allowaccess. Allow management access to the interface.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6-default-life

integer

Deprecated, please rename it to ip6_default_life. Default life

ip6-delegated-prefix-iaid

integer

Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of obtained delegated-prefix from the upst…

ip6-delegated-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_delegated_prefix_list. Ip6-Delegated-Prefix-List.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag. Enable/disable the autonomous flag.

Choices:

  • "disable"

  • "enable"

delegated-prefix-iaid

integer

Deprecated, please rename it to delegated_prefix_iaid. IAID of obtained delegated-prefix from the …

string

Deprecated, please rename it to onlink_flag. Enable/disable the onlink flag.

Choices:

  • "disable"

  • "enable"

prefix-id

integer

Deprecated, please rename it to prefix_id. Prefix ID.

rdnss

any

(list) Recursive DNS server option.

rdnss-service

string

Deprecated, please rename it to rdnss_service. Recursive DNS service option.

Choices:

  • "delegated"

  • "default"

  • "specify"

subnet

string

Add subnet ID to routing prefix.

upstream-interface

string

Deprecated, please rename it to upstream_interface. Name of the interface that provides delegated …

ip6-dns-server-override

string

Deprecated, please rename it to ip6_dns_server_override. Enable/disable using the DNS server acquired by DHCP.

Choices:

  • "disable"

  • "enable"

ip6-extra-addr

list / elements=dictionary

Deprecated, please rename it to ip6_extra_addr. Ip6-Extra-Addr.

prefix

string

IPv6 address prefix.

ip6-hop-limit

integer

Deprecated, please rename it to ip6_hop_limit. Hop limit

integer

Deprecated, please rename it to ip6_link_mtu. IPv6 link MTU.

ip6-manage-flag

string

Deprecated, please rename it to ip6_manage_flag. Enable/disable the managed flag.

Choices:

  • "disable"

  • "enable"

ip6-max-interval

integer

Deprecated, please rename it to ip6_max_interval. IPv6 maximum interval

ip6-min-interval

integer

Deprecated, please rename it to ip6_min_interval. IPv6 minimum interval

ip6-mode

string

Deprecated, please rename it to ip6_mode. Addressing mode

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6-other-flag

string

Deprecated, please rename it to ip6_other_flag. Enable/disable the other IPv6 flag.

Choices:

  • "disable"

  • "enable"

ip6-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_prefix_list. Ip6-Prefix-List.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag. Enable/disable the autonomous flag.

Choices:

  • "disable"

  • "enable"

dnssl

any

(list) DNS search list option.

string

Deprecated, please rename it to onlink_flag. Enable/disable the onlink flag.

Choices:

  • "disable"

  • "enable"

preferred-life-time

integer

Deprecated, please rename it to preferred_life_time. Preferred life time

prefix

string

IPv6 prefix.

rdnss

any

(list) Recursive DNS server option.

valid-life-time

integer

Deprecated, please rename it to valid_life_time. Valid life time

ip6-prefix-mode

string

Deprecated, please rename it to ip6_prefix_mode. Assigning a prefix from DHCP or RA.

Choices:

  • "dhcp6"

  • "ra"

ip6-reachable-time

integer

Deprecated, please rename it to ip6_reachable_time. IPv6 reachable time

ip6-retrans-time

integer

Deprecated, please rename it to ip6_retrans_time. IPv6 retransmit time

ip6-send-adv

string

Deprecated, please rename it to ip6_send_adv. Enable/disable sending advertisements about the interface.

Choices:

  • "disable"

  • "enable"

ip6-subnet

string

Deprecated, please rename it to ip6_subnet. Subnet to routing prefix, syntax

ip6-upstream-interface

string

Deprecated, please rename it to ip6_upstream_interface. Interface name providing delegated information.

nd-cert

string

Deprecated, please rename it to nd_cert. Neighbor discovery certificate.

nd-cga-modifier

string

Deprecated, please rename it to nd_cga_modifier. Neighbor discovery CGA modifier.

nd-mode

string

Deprecated, please rename it to nd_mode. Neighbor discovery mode.

Choices:

  • "basic"

  • "SEND-compatible"

nd-security-level

integer

Deprecated, please rename it to nd_security_level. Neighbor discovery security level

nd-timestamp-delta

integer

Deprecated, please rename it to nd_timestamp_delta. Neighbor discovery timestamp delta value

nd-timestamp-fuzz

integer

Deprecated, please rename it to nd_timestamp_fuzz. Neighbor discovery timestamp fuzz factor

ra-send-mtu

string

Deprecated, please rename it to ra_send_mtu. Enable/disable sending link MTU in RA packet.

Choices:

  • "disable"

  • "enable"

unique-autoconf-addr

string

Deprecated, please rename it to unique_autoconf_addr. Enable/disable unique auto config address.

Choices:

  • "disable"

  • "enable"

string

Link-local IPv6 address of virtual router.

vrrp-virtual-mac6

string

Deprecated, please rename it to vrrp_virtual_mac6. Enable/disable virtual MAC for VRRP.

Choices:

  • "disable"

  • "enable"

vrrp6

list / elements=dictionary

Vrrp6.

accept-mode

string

Deprecated, please rename it to accept_mode. Enable/disable accept mode.

Choices:

  • "disable"

  • "enable"

adv-interval

integer

Deprecated, please rename it to adv_interval. Advertisement interval

ignore-default-route

string

Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default route whe…

Choices:

  • "disable"

  • "enable"

preempt

string

Enable/disable preempt mode.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority of the virtual router

start-time

integer

Deprecated, please rename it to start_time. Startup time

status

string

Enable/disable VRRP.

Choices:

  • "disable"

  • "enable"

vrdst6

string

Monitor the route to this destination.

vrgrp

integer

VRRP group ID

vrid

integer

Virtual router identifier

vrip6

string

IPv6 address of the virtual router.

l2forward

string

Enable/disable l2 forwarding.

Choices:

  • "disable"

  • "enable"

l2tp-client

string

Deprecated, please rename it to l2tp_client. Enable/disable this interface as a Layer 2 Tunnelling Protocol

Choices:

  • "disable"

  • "enable"

lacp-ha-secondary

string

Deprecated, please rename it to lacp_ha_secondary.

Choices:

  • "disable"

  • "enable"

lacp-ha-slave

string

Deprecated, please rename it to lacp_ha_slave. LACP HA slave.

Choices:

  • "disable"

  • "enable"

lacp-mode

string

Deprecated, please rename it to lacp_mode. LACP mode.

Choices:

  • "static"

  • "passive"

  • "active"

lacp-speed

string

Deprecated, please rename it to lacp_speed. How often the interface sends LACP messages.

Choices:

  • "slow"

  • "fast"

large-receive-offload

string

Deprecated, please rename it to large_receive_offload.

Choices:

  • "disable"

  • "enable"

lcp-echo-interval

integer

Deprecated, please rename it to lcp_echo_interval. Time in seconds between PPPoE Link Control Protocol

lcp-max-echo-fails

integer

Deprecated, please rename it to lcp_max_echo_fails. Maximum missed LCP echo messages before disconnect.

integer

Deprecated, please rename it to link_up_delay. Number of milliseconds to wait before considering a link is up.

listen-forticlient-connection

string

Deprecated, please rename it to listen_forticlient_connection. Listen-Forticlient-Connection.

Choices:

  • "disable"

  • "enable"

lldp-network-policy

string

Deprecated, please rename it to lldp_network_policy. LLDP-MED network policy profile.

lldp-reception

string

Deprecated, please rename it to lldp_reception. Enable/disable Link Layer Discovery Protocol

Choices:

  • "disable"

  • "enable"

  • "vdom"

lldp-transmission

string

Deprecated, please rename it to lldp_transmission. Enable/disable Link Layer Discovery Protocol

Choices:

  • "enable"

  • "disable"

  • "vdom"

log

string

Log.

Choices:

  • "disable"

  • "enable"

macaddr

string

Change the interfaces MAC address.

managed-subnetwork-size

string

Deprecated, please rename it to managed_subnetwork_size. Number of IP addresses to be allocated by FortiIPAM and u…

Choices:

  • "256"

  • "512"

  • "1024"

  • "2048"

  • "4096"

  • "8192"

  • "16384"

  • "32768"

  • "65536"

  • "32"

  • "64"

  • "128"

management-ip

string

Deprecated, please rename it to management_ip. High Availability in-band management IP address of this interface.

max-egress-burst-rate

integer

Deprecated, please rename it to max_egress_burst_rate. Max egress burst rate

max-egress-rate

integer

Deprecated, please rename it to max_egress_rate. Max egress rate

measured-downstream-bandwidth

integer

Deprecated, please rename it to measured_downstream_bandwidth. Measured downstream bandwidth

measured-upstream-bandwidth

integer

Deprecated, please rename it to measured_upstream_bandwidth. Measured upstream bandwidth

mediatype

string

Select SFP media interface type

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"

  • "sr2"

  • "lr2"

  • "cr2"

  • "sr8"

  • "lr8"

  • "cr8"

member

any

(list or str) Physical interfaces that belong to the aggregate or redundant interface.

integer

Deprecated, please rename it to min_links. Minimum number of aggregated ports that must be up.

string

Deprecated, please rename it to min_links_down. Action to take when less than the configured minimum number of lin…

Choices:

  • "operational"

  • "administrative"

mirroring-direction

string

Deprecated, please rename it to mirroring_direction. Port mirroring direction.

Choices:

  • "rx"

  • "tx"

  • "both"

mirroring-port

string

Deprecated, please rename it to mirroring_port. Mirroring port.

mode

string

Addressing mode

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "pppoa"

  • "ipoa"

  • "eoa"

monitor-bandwidth

string

Deprecated, please rename it to monitor_bandwidth. Enable monitoring bandwidth on this interface.

Choices:

  • "disable"

  • "enable"

mtu

integer

MTU value for this interface.

mtu-override

string

Deprecated, please rename it to mtu_override. Enable to set a custom MTU for this interface.

Choices:

  • "disable"

  • "enable"

mux-type

string

Deprecated, please rename it to mux_type. Multiplexer type

Choices:

  • "llc-encaps"

  • "vc-encaps"

name

string

Name.

ndiscforward

string

Enable/disable NDISC forwarding.

Choices:

  • "disable"

  • "enable"

netbios-forward

string

Deprecated, please rename it to netbios_forward. Enable/disable NETBIOS forwarding.

Choices:

  • "disable"

  • "enable"

netflow-sampler

string

Deprecated, please rename it to netflow_sampler. Enable/disable NetFlow on this interface and set the data that Ne…

Choices:

  • "disable"

  • "tx"

  • "rx"

  • "both"

np-qos-profile

integer

Deprecated, please rename it to np_qos_profile. NP QoS profile ID.

npu-fastpath

string

Deprecated, please rename it to npu_fastpath. Npu-Fastpath.

Choices:

  • "disable"

  • "enable"

nst

string

Nst.

Choices:

  • "disable"

  • "enable"

out-force-vlan-cos

integer

Deprecated, please rename it to out_force_vlan_cos. Out-Force-Vlan-Cos.

outbandwidth

integer

Bandwidth limit for outgoing traffic

padt-retry-timeout

integer

Deprecated, please rename it to padt_retry_timeout. PPPoE Active Discovery Terminate

password

any

(list) PPPoE accounts password.

peer-interface

any

(list or str) Deprecated, please rename it to peer_interface. Peer-Interface.

phy-mode

string

Deprecated, please rename it to phy_mode. DSL physical mode.

Choices:

  • "auto"

  • "adsl"

  • "vdsl"

  • "adsl-auto"

  • "vdsl2"

  • "adsl2+"

  • "adsl2"

  • "g.dmt"

  • "t1.413"

  • "g.lite"

ping-serv-status

integer

Deprecated, please rename it to ping_serv_status. Ping-Serv-Status.

poe

string

Enable/disable PoE status.

Choices:

  • "disable"

  • "enable"

polling-interval

integer

Deprecated, please rename it to polling_interval. SFlow polling interval

port-mirroring

string

Deprecated, please rename it to port_mirroring. Enable/disable NP port mirroring.

Choices:

  • "disable"

  • "enable"

pppoe-unnumbered-negotiate

string

Deprecated, please rename it to pppoe_unnumbered_negotiate. Enable/disable PPPoE unnumbered negotiation.

Choices:

  • "disable"

  • "enable"

pptp-auth-type

string

Deprecated, please rename it to pptp_auth_type. PPTP authentication type.

Choices:

  • "auto"

  • "pap"

  • "chap"

  • "mschapv1"

  • "mschapv2"

pptp-client

string

Deprecated, please rename it to pptp_client. Enable/disable PPTP client.

Choices:

  • "disable"

  • "enable"

pptp-password

any

(list) Deprecated, please rename it to pptp_password. PPTP password.

pptp-server-ip

string

Deprecated, please rename it to pptp_server_ip. PPTP server IP address.

pptp-timeout

integer

Deprecated, please rename it to pptp_timeout. Idle timer in minutes

pptp-user

string

Deprecated, please rename it to pptp_user. PPTP user name.

preserve-session-route

string

Deprecated, please rename it to preserve_session_route. Enable/disable preservation of session route when dirty.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority of learned routes.

priority-override

string

Deprecated, please rename it to priority_override. Enable/disable fail back to higher priority port once recovered.

Choices:

  • "disable"

  • "enable"

proxy-captive-portal

string

Deprecated, please rename it to proxy_captive_portal. Enable/disable proxy captive portal on this interface.

Choices:

  • "disable"

  • "enable"

pvc-atm-qos

string

Deprecated, please rename it to pvc_atm_qos. SFP-DSL ADSL Fallback PVC ATM QoS.

Choices:

  • "cbr"

  • "rt-vbr"

  • "nrt-vbr"

  • "ubr"

pvc-chan

integer

Deprecated, please rename it to pvc_chan. SFP-DSL ADSL Fallback PVC Channel.

pvc-crc

integer

Deprecated, please rename it to pvc_crc. SFP-DSL ADSL Fallback PVC CRC Option

pvc-pcr

integer

Deprecated, please rename it to pvc_pcr. SFP-DSL ADSL Fallback PVC Packet Cell Rate in cells

pvc-scr

integer

Deprecated, please rename it to pvc_scr. SFP-DSL ADSL Fallback PVC Sustainable Cell Rate in cells

pvc-vlan-id

integer

Deprecated, please rename it to pvc_vlan_id. SFP-DSL ADSL Fallback PVC VLAN ID.

pvc-vlan-rx-id

integer

Deprecated, please rename it to pvc_vlan_rx_id. SFP-DSL ADSL Fallback PVC VLANID RX.

pvc-vlan-rx-op

string

Deprecated, please rename it to pvc_vlan_rx_op. SFP-DSL ADSL Fallback PVC VLAN RX op.

Choices:

  • "pass-through"

  • "replace"

  • "remove"

pvc-vlan-tx-id

integer

Deprecated, please rename it to pvc_vlan_tx_id. SFP-DSL ADSL Fallback PVC VLAN ID TX.

pvc-vlan-tx-op

string

Deprecated, please rename it to pvc_vlan_tx_op. SFP-DSL ADSL Fallback PVC VLAN TX op.

Choices:

  • "pass-through"

  • "replace"

  • "remove"

reachable-time

integer

Deprecated, please rename it to reachable_time. IPv4 reachable time in milliseconds

redundant-interface

string

Deprecated, please rename it to redundant_interface. Redundant-Interface.

remote-ip

string

Deprecated, please rename it to remote_ip. Remote IP address of tunnel.

replacemsg-override-group

string

Deprecated, please rename it to replacemsg_override_group. Replacement message override group.

retransmission

string

Enable/disable DSL retransmission.

Choices:

  • "disable"

  • "enable"

ring-rx

integer

Deprecated, please rename it to ring_rx. RX ring size.

ring-tx

integer

Deprecated, please rename it to ring_tx. TX ring size.

role

string

Interface role.

Choices:

  • "lan"

  • "wan"

  • "dmz"

  • "undefined"

sample-direction

string

Deprecated, please rename it to sample_direction. Data that NetFlow collects

Choices:

  • "rx"

  • "tx"

  • "both"

sample-rate

integer

Deprecated, please rename it to sample_rate. SFlow sample rate

scan-botnet-connections

string

Deprecated, please rename it to scan_botnet_connections. Enable monitoring or blocking connections to Botnet serve…

Choices:

  • "disable"

  • "block"

  • "monitor"

secondary-IP

string

Deprecated, please rename it to secondary_IP. Enable/disable adding a secondary IP to this interface.

Choices:

  • "disable"

  • "enable"

secondaryip

list / elements=dictionary

Secondaryip.

allowaccess

list / elements=string

Management access settings for the secondary IP address.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "auto-ipsec"

  • "radius-acct"

  • "probe-response"

  • "capwap"

  • "dnp"

  • "ftm"

  • "fabric"

  • "speed-test"

detectprotocol

list / elements=string

Protocols used to detect the server.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

detectserver

string

Gateways ping server for this IP.

gwdetect

string

Enable/disable detect gateway alive for first.

Choices:

  • "disable"

  • "enable"

ha-priority

integer

Deprecated, please rename it to ha_priority. HA election priority for the PING server.

id

integer

ID.

ip

string

Secondary IP address of the interface.

ping-serv-status

integer

Deprecated, please rename it to ping_serv_status. Ping-Serv-Status.

secip-relay-ip

string

Deprecated, please rename it to secip_relay_ip. DHCP relay IP address.

seq

integer

Seq.

security-8021x-dynamic-vlan-id

integer

Deprecated, please rename it to security_8021x_dynamic_vlan_id. VLAN ID for virtual switch.

security-8021x-master

string

Deprecated, please rename it to security_8021x_master. ‘802.’

security-8021x-member-mode

string

Deprecated, please rename it to security_8021x_member_mode. ‘802.’

Choices:

  • "disable"

  • "switch"

security-8021x-mode

string

Deprecated, please rename it to security_8021x_mode. ‘802.’

Choices:

  • "default"

  • "dynamic-vlan"

  • "fallback"

  • "slave"

security-exempt-list

string

Deprecated, please rename it to security_exempt_list. Name of security-exempt-list.

security-external-logout

string

Deprecated, please rename it to security_external_logout. URL of external authentication logout server.

security-external-web

string

Deprecated, please rename it to security_external_web. URL of external authentication web server.

security-groups

any

(list or str) Deprecated, please rename it to security_groups. User groups that can authenticate with the captive …

security-mac-auth-bypass

string

Deprecated, please rename it to security_mac_auth_bypass. Enable/disable MAC authentication bypass.

Choices:

  • "disable"

  • "enable"

  • "mac-auth-only"

security-mode

string

Deprecated, please rename it to security_mode. Turn on captive portal authentication for this interface.

Choices:

  • "none"

  • "captive-portal"

  • "802.1X"

security-redirect-url

string

Deprecated, please rename it to security_redirect_url. URL redirection after disclaimer/authentication.

select-profile-30a-35b

string

Deprecated, please rename it to select_profile_30a_35b. Select VDSL Profile 30a or 35b.

Choices:

  • "30A"

  • "35B"

service-name

string

Deprecated, please rename it to service_name. PPPoE service name.

sflow-sampler

string

Deprecated, please rename it to sflow_sampler. Enable/disable sFlow on this interface.

Choices:

  • "disable"

  • "enable"

sfp-dsl

string

Deprecated, please rename it to sfp_dsl. Enable/disable SFP DSL.

Choices:

  • "disable"

  • "enable"

sfp-dsl-adsl-fallback

string

Deprecated, please rename it to sfp_dsl_adsl_fallback. Enable/disable SFP DSL ADSL fallback.

Choices:

  • "disable"

  • "enable"

sfp-dsl-autodetect

string

Deprecated, please rename it to sfp_dsl_autodetect. Enable/disable SFP DSL MAC address autodetect.

Choices:

  • "disable"

  • "enable"

sfp-dsl-mac

string

Deprecated, please rename it to sfp_dsl_mac. SFP DSL MAC address.

speed

string

Interface speed.

Choices:

  • "auto"

  • "10full"

  • "10half"

  • "100full"

  • "100half"

  • "1000full"

  • "1000half"

  • "10000full"

  • "1000auto"

  • "10000auto"

  • "40000full"

  • "100Gfull"

  • "25000full"

  • "40000auto"

  • "25000auto"

  • "100Gauto"

  • "400Gfull"

  • "400Gauto"

  • "50000full"

  • "2500auto"

  • "5000auto"

  • "50000auto"

  • "200Gfull"

  • "200Gauto"

  • "100auto"

spillover-threshold

integer

Deprecated, please rename it to spillover_threshold. Egress Spillover threshold

src-check

string

Deprecated, please rename it to src_check. Enable/disable source IP check.

Choices:

  • "disable"

  • "enable"

status

string

Bring the interface up or shut the interface down.

Choices:

  • "down"

  • "up"

stp

string

Enable/disable STP.

Choices:

  • "disable"

  • "enable"

stp-edge

string

Deprecated, please rename it to stp_edge. Enable/disable as STP edge port.

Choices:

  • "disable"

  • "enable"

stp-ha-secondary

string

Deprecated, please rename it to stp_ha_secondary. Control STP behaviour on HA secondary.

Choices:

  • "disable"

  • "enable"

  • "priority-adjust"

stp-ha-slave

string

Deprecated, please rename it to stp_ha_slave. Control STP behaviour on HA slave.

Choices:

  • "disable"

  • "enable"

  • "priority-adjust"

stpforward

string

Enable/disable STP forwarding.

Choices:

  • "disable"

  • "enable"

stpforward-mode

string

Deprecated, please rename it to stpforward_mode. Configure STP forwarding mode.

Choices:

  • "rpl-all-ext-id"

  • "rpl-bridge-ext-id"

  • "rpl-nothing"

strip-priority-vlan-tag

string

Deprecated, please rename it to strip_priority_vlan_tag. Strip-Priority-Vlan-Tag.

Choices:

  • "disable"

  • "enable"

subst

string

Enable to always send packets from this interface to a destination MAC address.

Choices:

  • "disable"

  • "enable"

substitute-dst-mac

string

Deprecated, please rename it to substitute_dst_mac. Destination MAC address that all packets are sent to from this…

sw-algorithm

string

Deprecated, please rename it to sw_algorithm. Frame distribution algorithm for switch.

Choices:

  • "l2"

  • "l3"

  • "eh"

swc-first-create

integer

Deprecated, please rename it to swc_first_create. Initial create for switch-controller VLANs.

swc-vlan

integer

Deprecated, please rename it to swc_vlan. Swc-Vlan.

switch

string

Switch.

switch-controller-access-vlan

string

Deprecated, please rename it to switch_controller_access_vlan. Block FortiSwitch port-to-port traffic.

Choices:

  • "disable"

  • "enable"

switch-controller-arp-inspection

string

Deprecated, please rename it to switch_controller_arp_inspection. Enable/disable FortiSwitch ARP inspection.

Choices:

  • "disable"

  • "enable"

switch-controller-auth

string

Deprecated, please rename it to switch_controller_auth. Switch controller authentication.

Choices:

  • "radius"

  • "usergroup"

switch-controller-dhcp-snooping

string

Deprecated, please rename it to switch_controller_dhcp_snooping. Switch controller DHCP snooping.

Choices:

  • "disable"

  • "enable"

switch-controller-dhcp-snooping-option82

string

Deprecated, please rename it to switch_controller_dhcp_snooping_option82. Switch controller DHCP snooping option82.

Choices:

  • "disable"

  • "enable"

switch-controller-dhcp-snooping-verify-mac

string

Deprecated, please rename it to switch_controller_dhcp_snooping_verify_mac. Switch controller DHCP snooping verify…

Choices:

  • "disable"

  • "enable"

switch-controller-dynamic

string

Deprecated, please rename it to switch_controller_dynamic. Integrated FortiLink settings for managed FortiSwitch.

switch-controller-feature

string

Deprecated, please rename it to switch_controller_feature. Interfaces purpose when assigning traffic

Choices:

  • "none"

  • "default-vlan"

  • "quarantine"

  • "sniffer"

  • "voice"

  • "camera"

  • "rspan"

  • "video"

  • "nac"

  • "nac-segment"

switch-controller-igmp-snooping

string

Deprecated, please rename it to switch_controller_igmp_snooping. Switch controller IGMP snooping.

Choices:

  • "disable"

  • "enable"

switch-controller-igmp-snooping-fast-leave

string

Deprecated, please rename it to switch_controller_igmp_snooping_fast_leave. Switch controller IGMP snooping fast-l…

Choices:

  • "disable"

  • "enable"

switch-controller-igmp-snooping-proxy

string

Deprecated, please rename it to switch_controller_igmp_snooping_proxy. Switch controller IGMP snooping proxy.

Choices:

  • "disable"

  • "enable"

switch-controller-iot-scanning

string

Deprecated, please rename it to switch_controller_iot_scanning. Enable/disable managed FortiSwitch IoT scanning.

Choices:

  • "disable"

  • "enable"

switch-controller-learning-limit

integer

Deprecated, please rename it to switch_controller_learning_limit. Limit the number of dynamic MAC addresses on thi…

switch-controller-mgmt-vlan

integer

Deprecated, please rename it to switch_controller_mgmt_vlan. VLAN to use for FortiLink management purposes.

switch-controller-nac

string

Deprecated, please rename it to switch_controller_nac. Integrated NAC settings for managed FortiSwitch.

switch-controller-netflow-collect

string

Deprecated, please rename it to switch_controller_netflow_collect. NetFlow collection and processing.

Choices:

  • "disable"

  • "enable"

switch-controller-offload

string

Deprecated, please rename it to switch_controller_offload. Enable/disable managed FortiSwitch routing offload.

Choices:

  • "disable"

  • "enable"

switch-controller-offload-gw

string

Deprecated, please rename it to switch_controller_offload_gw. Enable/disable managed FortiSwitch routing offload g…

Choices:

  • "disable"

  • "enable"

switch-controller-offload-ip

string

Deprecated, please rename it to switch_controller_offload_ip. IP for routing offload on FortiSwitch.

switch-controller-offloading

string

Deprecated, please rename it to switch_controller_offloading.

Choices:

  • "disable"

  • "enable"

switch-controller-offloading-gw

string

Deprecated, please rename it to switch_controller_offloading_gw.

Choices:

  • "disable"

  • "enable"

switch-controller-offloading-ip

string

Deprecated, please rename it to switch_controller_offloading_ip.

switch-controller-radius-server

string

Deprecated, please rename it to switch_controller_radius_server. RADIUS server name for this FortiSwitch VLAN.

switch-controller-rspan-mode

string

Deprecated, please rename it to switch_controller_rspan_mode. Stop Layer2 MAC learning and interception of BPDUs a…

Choices:

  • "disable"

  • "enable"

switch-controller-source-ip

string

Deprecated, please rename it to switch_controller_source_ip. Source IP address used in FortiLink over L3 connections.

Choices:

  • "outbound"

  • "fixed"

switch-controller-traffic-policy

string

Deprecated, please rename it to switch_controller_traffic_policy. Switch controller traffic policy for the VLAN.

system-id

string

Deprecated, please rename it to system_id. Define a system ID for the aggregate interface.

system-id-type

string

Deprecated, please rename it to system_id_type. Method in which system ID is generated.

Choices:

  • "auto"

  • "user"

tc-mode

string

Deprecated, please rename it to tc_mode. DSL transfer mode.

Choices:

  • "ptm"

  • "atm"

tcp-mss

integer

Deprecated, please rename it to tcp_mss. TCP maximum segment size.

trunk

string

Enable/disable VLAN trunk.

Choices:

  • "disable"

  • "enable"

trust-ip-1

string

Deprecated, please rename it to trust_ip_1. Trusted host for dedicated management traffic

trust-ip-2

string

Deprecated, please rename it to trust_ip_2. Trusted host for dedicated management traffic

trust-ip-3

string

Deprecated, please rename it to trust_ip_3. Trusted host for dedicated management traffic

trust-ip6-1

string

Deprecated, please rename it to trust_ip6_1. Trusted IPv6 host for dedicated management traffic

trust-ip6-2

string

Deprecated, please rename it to trust_ip6_2. Trusted IPv6 host for dedicated management traffic

trust-ip6-3

string

Deprecated, please rename it to trust_ip6_3. Trusted IPv6 host for dedicated management traffic

type

string

Interface type.

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"

username

string

Username of the PPPoE account, provided by your ISP.

vci

integer

Virtual Channel ID

vectoring

string

Enable/disable DSL vectoring.

Choices:

  • "disable"

  • "enable"

vindex

integer

Vindex.

vlan-id

integer

Deprecated, please rename it to vlan_id. Vlan ID

vlan-op-mode

string

Deprecated, please rename it to vlan_op_mode. Configure DSL 802.

Choices:

  • "tag"

  • "untag"

  • "passthrough"

vlan-protocol

string

Deprecated, please rename it to vlan_protocol. Ethernet protocol of VLAN.

Choices:

  • "8021q"

  • "8021ad"

vlanforward

string

Enable/disable traffic forwarding between VLANs on this interface.

Choices:

  • "disable"

  • "enable"

vlanid

integer

VLAN ID

vpi

integer

Virtual Path ID

vrf

integer

Virtual Routing Forwarding ID.

vrrp

list / elements=dictionary

Vrrp.

accept-mode

string

Deprecated, please rename it to accept_mode. Enable/disable accept mode.

Choices:

  • "disable"

  • "enable"

adv-interval

integer

Deprecated, please rename it to adv_interval. Advertisement interval

ignore-default-route

string

Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default route when checki…

Choices:

  • "disable"

  • "enable"

preempt

string

Enable/disable preempt mode.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority of the virtual router

proxy-arp

list / elements=dictionary

Deprecated, please rename it to proxy_arp.

id

integer

ID.

ip

string

Set IP addresses of proxy ARP.

start-time

integer

Deprecated, please rename it to start_time. Startup time

status

string

Enable/disable this VRRP configuration.

Choices:

  • "disable"

  • "enable"

version

string

VRRP version.

Choices:

  • "2"

  • "3"

vrdst

any

(list) Monitor the route to this destination.

vrdst-priority

integer

Deprecated, please rename it to vrdst_priority. Priority of the virtual router when the virtual router des…

vrgrp

integer

VRRP group ID

vrid

integer

Virtual router identifier

vrip

string

IP address of the virtual router.

vrrp-virtual-mac

string

Deprecated, please rename it to vrrp_virtual_mac. Enable/disable use of virtual MAC for VRRP.

Choices:

  • "disable"

  • "enable"

wccp

string

Enable/disable WCCP on this interface.

Choices:

  • "disable"

  • "enable"

weight

integer

Default weight for static routes

wifi-5g-threshold

string

Deprecated, please rename it to wifi_5g_threshold. Minimal signal strength to be considered as a good 5G AP.

wifi-acl

string

Deprecated, please rename it to wifi_acl. Access control for MAC addresses in the MAC list.

Choices:

  • "deny"

  • "allow"

wifi-ap-band

string

Deprecated, please rename it to wifi_ap_band. How to select the AP to connect.

Choices:

  • "any"

  • "5g-preferred"

  • "5g-only"

wifi-auth

string

Deprecated, please rename it to wifi_auth. WiFi authentication.

Choices:

  • "PSK"

  • "RADIUS"

  • "radius"

  • "usergroup"

wifi-auto-connect

string

Deprecated, please rename it to wifi_auto_connect. Enable/disable WiFi network auto connect.

Choices:

  • "disable"

  • "enable"

wifi-auto-save

string

Deprecated, please rename it to wifi_auto_save. Enable/disable WiFi network automatic save.

Choices:

  • "disable"

  • "enable"

wifi-broadcast-ssid

string

Deprecated, please rename it to wifi_broadcast_ssid. Enable/disable SSID broadcast in the beacon.

Choices:

  • "disable"

  • "enable"

wifi-dns-server1

string

Deprecated, please rename it to wifi_dns_server1. DNS server 1.

wifi-dns-server2

string

Deprecated, please rename it to wifi_dns_server2. DNS server 2.

wifi-encrypt

string

Deprecated, please rename it to wifi_encrypt. Data encryption.

Choices:

  • "TKIP"

  • "AES"

wifi-fragment-threshold

integer

Deprecated, please rename it to wifi_fragment_threshold. WiFi fragment threshold

wifi-gateway

string

Deprecated, please rename it to wifi_gateway. IPv4 default gateway IP address.

wifi-key

any

(list) Deprecated, please rename it to wifi_key. WiFi WEP Key.

wifi-keyindex

integer

Deprecated, please rename it to wifi_keyindex. WEP key index

wifi-mac-filter

string

Deprecated, please rename it to wifi_mac_filter. Enable/disable MAC filter status.

Choices:

  • "disable"

  • "enable"

wifi-passphrase

any

(list) Deprecated, please rename it to wifi_passphrase. WiFi pre-shared key for WPA.

wifi-radius-server

string

Deprecated, please rename it to wifi_radius_server. WiFi RADIUS server for WPA.

wifi-rts-threshold

integer

Deprecated, please rename it to wifi_rts_threshold. WiFi RTS threshold

wifi-security

string

Deprecated, please rename it to wifi_security. Wireless access security of SSID.

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"

wifi-ssid

string

Deprecated, please rename it to wifi_ssid. IEEE 802.

wifi-usergroup

string

Deprecated, please rename it to wifi_usergroup. WiFi user group for WPA.

wins-ip

string

Deprecated, please rename it to wins_ip. WINS server IP.

name

string / required

Name.

portal-message-override-group

string

Deprecated, please rename it to portal_message_override_group.

radius-server

string

Deprecated, please rename it to radius_server.

security

string

No description.

Choices:

  • "open"

  • "captive-portal"

  • "8021x"

selected-usergroups

string

Deprecated, please rename it to selected_usergroups.

usergroup

string

No description.

vdom

string

Vdom.

vlanid

integer

Vlanid.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Fsp vlan
      fortinet.fortimanager.fmgr_fsp_vlan:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        fsp_vlan:
          _dhcp_status: <value in [disable, enable]>
          auth: <value in [radius, usergroup]>
          color: <integer>
          comments: <string>
          dynamic_mapping:
            -
              _dhcp_status: <value in [disable, enable]>
              _scope:
                -
                  name: <string>
                  vdom: <string>
              dhcp_server:
                auto_configuration: <value in [disable, enable]>
                auto_managed_status: <value in [disable, enable]>
                conflicted_ip_timeout: <integer>
                ddns_auth: <value in [disable, tsig]>
                ddns_key: <list or string>
                ddns_keyname: <string>
                ddns_server_ip: <string>
                ddns_ttl: <integer>
                ddns_update: <value in [disable, enable]>
                ddns_update_override: <value in [disable, enable]>
                ddns_zone: <string>
                default_gateway: <string>
                dhcp_settings_from_fortiipam: <value in [disable, enable]>
                dns_server1: <string>
                dns_server2: <string>
                dns_server3: <string>
                dns_server4: <string>
                dns_service: <value in [default, specify, local]>
                domain: <string>
                enable: <value in [disable, enable]>
                exclude_range:
                  -
                    end_ip: <string>
                    id: <integer>
                    start_ip: <string>
                    vci_match: <value in [disable, enable]>
                    vci_string: <list or string>
                    lease_time: <integer>
                    uci_match: <value in [disable, enable]>
                    uci_string: <list or string>
                filename: <string>
                forticlient_on_net_status: <value in [disable, enable]>
                id: <integer>
                ip_mode: <value in [range, usrgrp]>
                ip_range:
                  -
                    end_ip: <string>
                    id: <integer>
                    start_ip: <string>
                    vci_match: <value in [disable, enable]>
                    vci_string: <list or string>
                    lease_time: <integer>
                    uci_match: <value in [disable, enable]>
                    uci_string: <list or string>
                ipsec_lease_hold: <integer>
                lease_time: <integer>
                mac_acl_default_action: <value in [assign, block]>
                netmask: <string>
                next_server: <string>
                ntp_server1: <string>
                ntp_server2: <string>
                ntp_server3: <string>
                ntp_service: <value in [default, specify, local]>
                option1: <list or string>
                option2: <list or string>
                option3: <list or string>
                option4: <string>
                option5: <string>
                option6: <string>
                options:
                  -
                    code: <integer>
                    id: <integer>
                    ip: <list or string>
                    type: <value in [hex, string, ip, ...]>
                    value: <string>
                    vci_match: <value in [disable, enable]>
                    vci_string: <list or string>
                    uci_match: <value in [disable, enable]>
                    uci_string: <list or string>
                reserved_address:
                  -
                    action: <value in [assign, block, reserved]>
                    circuit_id: <string>
                    circuit_id_type: <value in [hex, string]>
                    description: <string>
                    id: <integer>
                    ip: <string>
                    mac: <string>
                    remote_id: <string>
                    remote_id_type: <value in [hex, string]>
                    type: <value in [mac, option82]>
                server_type: <value in [regular, ipsec]>
                status: <value in [disable, enable]>
                tftp_server: <list or string>
                timezone: <value in [00, 01, 02, ...]>
                timezone_option: <value in [disable, default, specify]>
                vci_match: <value in [disable, enable]>
                vci_string: <list or string>
                wifi_ac_service: <value in [specify, local]>
                wifi_ac1: <string>
                wifi_ac2: <string>
                wifi_ac3: <string>
                wins_server1: <string>
                wins_server2: <string>
                relay_agent: <string>
                shared_subnet: <value in [disable, enable]>
              interface:
                dhcp_relay_agent_option: <value in [disable, enable]>
                dhcp_relay_ip: <list or string>
                dhcp_relay_service: <value in [disable, enable]>
                dhcp_relay_type: <value in [regular, ipsec]>
                ip: <string>
                ipv6:
                  autoconf: <value in [disable, enable]>
                  dhcp6_client_options:
                    - rapid
                    - iapd
                    - iana
                    - dns
                    - dnsname
                  dhcp6_information_request: <value in [disable, enable]>
                  dhcp6_prefix_delegation: <value in [disable, enable]>
                  dhcp6_prefix_hint: <string>
                  dhcp6_prefix_hint_plt: <integer>
                  dhcp6_prefix_hint_vlt: <integer>
                  dhcp6_relay_ip: <string>
                  dhcp6_relay_service: <value in [disable, enable]>
                  dhcp6_relay_type: <value in [regular]>
                  icmp6_send_redirect: <value in [disable, enable]>
                  interface_identifier: <string>
                  ip6_address: <string>
                  ip6_allowaccess:
                    - https
                    - ping
                    - ssh
                    - snmp
                    - http
                    - telnet
                    - fgfm
                    - capwap
                    - fabric
                  ip6_default_life: <integer>
                  ip6_delegated_prefix_list:
                    -
                      autonomous_flag: <value in [disable, enable]>
                      onlink_flag: <value in [disable, enable]>
                      prefix_id: <integer>
                      rdnss: <list or string>
                      rdnss_service: <value in [delegated, default, specify]>
                      subnet: <string>
                      upstream_interface: <string>
                      delegated_prefix_iaid: <integer>
                  ip6_dns_server_override: <value in [disable, enable]>
                  ip6_extra_addr:
                    -
                      prefix: <string>
                  ip6_hop_limit: <integer>
                  ip6_link_mtu: <integer>
                  ip6_manage_flag: <value in [disable, enable]>
                  ip6_max_interval: <integer>
                  ip6_min_interval: <integer>
                  ip6_mode: <value in [static, dhcp, pppoe, ...]>
                  ip6_other_flag: <value in [disable, enable]>
                  ip6_prefix_list:
                    -
                      autonomous_flag: <value in [disable, enable]>
                      dnssl: <list or string>
                      onlink_flag: <value in [disable, enable]>
                      preferred_life_time: <integer>
                      prefix: <string>
                      rdnss: <list or string>
                      valid_life_time: <integer>
                  ip6_reachable_time: <integer>
                  ip6_retrans_time: <integer>
                  ip6_send_adv: <value in [disable, enable]>
                  ip6_subnet: <string>
                  ip6_upstream_interface: <string>
                  nd_cert: <string>
                  nd_cga_modifier: <string>
                  nd_mode: <value in [basic, SEND-compatible]>
                  nd_security_level: <integer>
                  nd_timestamp_delta: <integer>
                  nd_timestamp_fuzz: <integer>
                  unique_autoconf_addr: <value in [disable, enable]>
                  vrip6_link_local: <string>
                  vrrp_virtual_mac6: <value in [disable, enable]>
                  vrrp6:
                    -
                      accept_mode: <value in [disable, enable]>
                      adv_interval: <integer>
                      preempt: <value in [disable, enable]>
                      priority: <integer>
                      start_time: <integer>
                      status: <value in [disable, enable]>
                      vrdst6: <string>
                      vrgrp: <integer>
                      vrid: <integer>
                      vrip6: <string>
                      ignore_default_route: <value in [disable, enable]>
                  cli_conn6_status: <integer>
                  ip6_prefix_mode: <value in [dhcp6, ra]>
                  ra_send_mtu: <value in [disable, enable]>
                  ip6_delegated_prefix_iaid: <integer>
                  dhcp6_relay_source_interface: <value in [disable, enable]>
                  dhcp6_relay_interface_id: <string>
                  dhcp6_relay_source_ip: <string>
                secondary_IP: <value in [disable, enable]>
                secondaryip:
                  -
                    allowaccess:
                      - https
                      - ping
                      - ssh
                      - snmp
                      - http
                      - telnet
                      - fgfm
                      - auto-ipsec
                      - radius-acct
                      - probe-response
                      - capwap
                      - dnp
                      - ftm
                      - fabric
                      - speed-test
                    detectprotocol:
                      - ping
                      - tcp-echo
                      - udp-echo
                    detectserver: <string>
                    gwdetect: <value in [disable, enable]>
                    ha_priority: <integer>
                    id: <integer>
                    ip: <string>
                    ping_serv_status: <integer>
                    seq: <integer>
                    secip_relay_ip: <string>
                vlanid: <integer>
                dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
                vrrp:
                  -
                    accept_mode: <value in [disable, enable]>
                    adv_interval: <integer>
                    ignore_default_route: <value in [disable, enable]>
                    preempt: <value in [disable, enable]>
                    priority: <integer>
                    proxy_arp:
                      -
                        id: <integer>
                        ip: <string>
                    start_time: <integer>
                    status: <value in [disable, enable]>
                    version: <value in [2, 3]>
                    vrdst: <list or string>
                    vrdst_priority: <integer>
                    vrgrp: <integer>
                    vrid: <integer>
                    vrip: <string>
          name: <string>
          portal_message_override_group: <string>
          radius_server: <string>
          security: <value in [open, captive-portal, 8021x]>
          selected_usergroups: <string>
          usergroup: <string>
          vdom: <string>
          vlanid: <integer>
          dhcp_server:
            auto_configuration: <value in [disable, enable]>
            auto_managed_status: <value in [disable, enable]>
            conflicted_ip_timeout: <integer>
            ddns_auth: <value in [disable, tsig]>
            ddns_key: <list or string>
            ddns_keyname: <string>
            ddns_server_ip: <string>
            ddns_ttl: <integer>
            ddns_update: <value in [disable, enable]>
            ddns_update_override: <value in [disable, enable]>
            ddns_zone: <string>
            default_gateway: <string>
            dhcp_settings_from_fortiipam: <value in [disable, enable]>
            dns_server1: <string>
            dns_server2: <string>
            dns_server3: <string>
            dns_server4: <string>
            dns_service: <value in [default, specify, local]>
            domain: <string>
            enable: <value in [disable, enable]>
            exclude_range:
              -
                end_ip: <string>
                id: <integer>
                start_ip: <string>
                vci_match: <value in [disable, enable]>
                vci_string: <list or string>
                lease_time: <integer>
                uci_match: <value in [disable, enable]>
                uci_string: <list or string>
            filename: <string>
            forticlient_on_net_status: <value in [disable, enable]>
            id: <integer>
            ip_mode: <value in [range, usrgrp]>
            ip_range:
              -
                end_ip: <string>
                id: <integer>
                start_ip: <string>
                vci_match: <value in [disable, enable]>
                vci_string: <list or string>
                lease_time: <integer>
                uci_match: <value in [disable, enable]>
                uci_string: <list or string>
            ipsec_lease_hold: <integer>
            lease_time: <integer>
            mac_acl_default_action: <value in [assign, block]>
            netmask: <string>
            next_server: <string>
            ntp_server1: <string>
            ntp_server2: <string>
            ntp_server3: <string>
            ntp_service: <value in [default, specify, local]>
            option1: <list or string>
            option2: <list or string>
            option3: <list or string>
            option4: <string>
            option5: <string>
            option6: <string>
            options:
              -
                code: <integer>
                id: <integer>
                ip: <list or string>
                type: <value in [hex, string, ip, ...]>
                value: <string>
                vci_match: <value in [disable, enable]>
                vci_string: <list or string>
                uci_match: <value in [disable, enable]>
                uci_string: <list or string>
            reserved_address:
              -
                action: <value in [assign, block, reserved]>
                circuit_id: <string>
                circuit_id_type: <value in [hex, string]>
                description: <string>
                id: <integer>
                ip: <string>
                mac: <string>
                remote_id: <string>
                remote_id_type: <value in [hex, string]>
                type: <value in [mac, option82]>
            server_type: <value in [regular, ipsec]>
            status: <value in [disable, enable]>
            tftp_server: <list or string>
            timezone: <value in [00, 01, 02, ...]>
            timezone_option: <value in [disable, default, specify]>
            vci_match: <value in [disable, enable]>
            vci_string: <list or string>
            wifi_ac_service: <value in [specify, local]>
            wifi_ac1: <string>
            wifi_ac2: <string>
            wifi_ac3: <string>
            wins_server1: <string>
            wins_server2: <string>
            relay_agent: <string>
            shared_subnet: <value in [disable, enable]>
          interface:
            ac_name: <string>
            aggregate: <string>
            algorithm: <value in [L2, L3, L4, ...]>
            alias: <string>
            allowaccess:
              - https
              - ping
              - ssh
              - snmp
              - http
              - telnet
              - fgfm
              - auto-ipsec
              - radius-acct
              - probe-response
              - capwap
              - dnp
              - ftm
              - fabric
              - speed-test
            ap_discover: <value in [disable, enable]>
            arpforward: <value in [disable, enable]>
            atm_protocol: <value in [none, ipoa]>
            auth_type: <value in [auto, pap, chap, ...]>
            auto_auth_extension_device: <value in [disable, enable]>
            bandwidth_measure_time: <integer>
            bfd: <value in [global, enable, disable]>
            bfd_desired_min_tx: <integer>
            bfd_detect_mult: <integer>
            bfd_required_min_rx: <integer>
            broadcast_forticlient_discovery: <value in [disable, enable]>
            broadcast_forward: <value in [disable, enable]>
            captive_portal: <integer>
            cli_conn_status: <integer>
            color: <integer>
            ddns: <value in [disable, enable]>
            ddns_auth: <value in [disable, tsig]>
            ddns_domain: <string>
            ddns_key: <list or string>
            ddns_keyname: <string>
            ddns_password: <list or string>
            ddns_server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
            ddns_server_ip: <string>
            ddns_sn: <string>
            ddns_ttl: <integer>
            ddns_username: <string>
            ddns_zone: <string>
            dedicated_to: <value in [none, management]>
            defaultgw: <value in [disable, enable]>
            description: <string>
            detected_peer_mtu: <integer>
            detectprotocol:
              - ping
              - tcp-echo
              - udp-echo
            detectserver: <string>
            device_access_list: <list or string>
            device_identification: <value in [disable, enable]>
            device_identification_active_scan: <value in [disable, enable]>
            device_netscan: <value in [disable, enable]>
            device_user_identification: <value in [disable, enable]>
            devindex: <integer>
            dhcp_client_identifier: <string>
            dhcp_relay_agent_option: <value in [disable, enable]>
            dhcp_relay_interface: <string>
            dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
            dhcp_relay_ip: <list or string>
            dhcp_relay_service: <value in [disable, enable]>
            dhcp_relay_type: <value in [regular, ipsec]>
            dhcp_renew_time: <integer>
            disc_retry_timeout: <integer>
            disconnect_threshold: <integer>
            distance: <integer>
            dns_query: <value in [disable, recursive, non-recursive]>
            dns_server_override: <value in [disable, enable]>
            drop_fragment: <value in [disable, enable]>
            drop_overlapped_fragment: <value in [disable, enable]>
            egress_cos: <value in [disable, cos0, cos1, ...]>
            egress_shaping_profile: <string>
            eip: <string>
            endpoint_compliance: <value in [disable, enable]>
            estimated_downstream_bandwidth: <integer>
            estimated_upstream_bandwidth: <integer>
            explicit_ftp_proxy: <value in [disable, enable]>
            explicit_web_proxy: <value in [disable, enable]>
            external: <value in [disable, enable]>
            fail_action_on_extender: <value in [soft-restart, hard-restart, reboot]>
            fail_alert_interfaces: <list or string>
            fail_alert_method: <value in [link-failed-signal, link-down]>
            fail_detect: <value in [disable, enable]>
            fail_detect_option:
              - detectserver
              - link-down
            fdp: <value in [disable, enable]>
            fortiheartbeat: <value in [disable, enable]>
            fortilink: <value in [disable, enable]>
            fortilink_backup_link: <integer>
            fortilink_neighbor_detect: <value in [lldp, fortilink]>
            fortilink_split_interface: <value in [disable, enable]>
            fortilink_stacking: <value in [disable, enable]>
            forward_domain: <integer>
            forward_error_correction: <value in [disable, enable, rs-fec, ...]>
            fp_anomaly:
              - drop_tcp_fin_noack
              - pass_winnuke
              - pass_tcpland
              - pass_udpland
              - pass_icmpland
              - pass_ipland
              - pass_iprr
              - pass_ipssrr
              - pass_iplsrr
              - pass_ipstream
              - pass_ipsecurity
              - pass_iptimestamp
              - pass_ipunknown_option
              - pass_ipunknown_prot
              - pass_icmp_frag
              - pass_tcp_no_flag
              - pass_tcp_fin_noack
              - drop_winnuke
              - drop_tcpland
              - drop_udpland
              - drop_icmpland
              - drop_ipland
              - drop_iprr
              - drop_ipssrr
              - drop_iplsrr
              - drop_ipstream
              - drop_ipsecurity
              - drop_iptimestamp
              - drop_ipunknown_option
              - drop_ipunknown_prot
              - drop_icmp_frag
              - drop_tcp_no_flag
            fp_disable:
              - all
              - ipsec
              - none
            gateway_address: <string>
            gi_gk: <value in [disable, enable]>
            gwaddr: <string>
            gwdetect: <value in [disable, enable]>
            ha_priority: <integer>
            icmp_accept_redirect: <value in [disable, enable]>
            icmp_redirect: <value in [disable, enable]>
            icmp_send_redirect: <value in [disable, enable]>
            ident_accept: <value in [disable, enable]>
            idle_timeout: <integer>
            if_mdix: <value in [auto, normal, crossover]>
            if_media: <value in [auto, copper, fiber]>
            in_force_vlan_cos: <integer>
            inbandwidth: <integer>
            ingress_cos: <value in [disable, cos0, cos1, ...]>
            ingress_shaping_profile: <string>
            ingress_spillover_threshold: <integer>
            internal: <integer>
            ip: <string>
            ip_managed_by_fortiipam: <value in [disable, enable, inherit-global]>
            ipmac: <value in [disable, enable]>
            ips_sniffer_mode: <value in [disable, enable]>
            ipunnumbered: <string>
            ipv6:
              autoconf: <value in [disable, enable]>
              dhcp6_client_options:
                - rapid
                - iapd
                - iana
                - dns
                - dnsname
              dhcp6_information_request: <value in [disable, enable]>
              dhcp6_prefix_delegation: <value in [disable, enable]>
              dhcp6_prefix_hint: <string>
              dhcp6_prefix_hint_plt: <integer>
              dhcp6_prefix_hint_vlt: <integer>
              dhcp6_relay_ip: <string>
              dhcp6_relay_service: <value in [disable, enable]>
              dhcp6_relay_type: <value in [regular]>
              icmp6_send_redirect: <value in [disable, enable]>
              interface_identifier: <string>
              ip6_address: <string>
              ip6_allowaccess:
                - https
                - ping
                - ssh
                - snmp
                - http
                - telnet
                - fgfm
                - capwap
                - fabric
              ip6_default_life: <integer>
              ip6_delegated_prefix_list:
                -
                  autonomous_flag: <value in [disable, enable]>
                  onlink_flag: <value in [disable, enable]>
                  prefix_id: <integer>
                  rdnss: <list or string>
                  rdnss_service: <value in [delegated, default, specify]>
                  subnet: <string>
                  upstream_interface: <string>
                  delegated_prefix_iaid: <integer>
              ip6_dns_server_override: <value in [disable, enable]>
              ip6_extra_addr:
                -
                  prefix: <string>
              ip6_hop_limit: <integer>
              ip6_link_mtu: <integer>
              ip6_manage_flag: <value in [disable, enable]>
              ip6_max_interval: <integer>
              ip6_min_interval: <integer>
              ip6_mode: <value in [static, dhcp, pppoe, ...]>
              ip6_other_flag: <value in [disable, enable]>
              ip6_prefix_list:
                -
                  autonomous_flag: <value in [disable, enable]>
                  dnssl: <list or string>
                  onlink_flag: <value in [disable, enable]>
                  preferred_life_time: <integer>
                  prefix: <string>
                  rdnss: <list or string>
                  valid_life_time: <integer>
              ip6_reachable_time: <integer>
              ip6_retrans_time: <integer>
              ip6_send_adv: <value in [disable, enable]>
              ip6_subnet: <string>
              ip6_upstream_interface: <string>
              nd_cert: <string>
              nd_cga_modifier: <string>
              nd_mode: <value in [basic, SEND-compatible]>
              nd_security_level: <integer>
              nd_timestamp_delta: <integer>
              nd_timestamp_fuzz: <integer>
              unique_autoconf_addr: <value in [disable, enable]>
              vrip6_link_local: <string>
              vrrp_virtual_mac6: <value in [disable, enable]>
              vrrp6:
                -
                  accept_mode: <value in [disable, enable]>
                  adv_interval: <integer>
                  preempt: <value in [disable, enable]>
                  priority: <integer>
                  start_time: <integer>
                  status: <value in [disable, enable]>
                  vrdst6: <string>
                  vrgrp: <integer>
                  vrid: <integer>
                  vrip6: <string>
                  ignore_default_route: <value in [disable, enable]>
              cli_conn6_status: <integer>
              ip6_prefix_mode: <value in [dhcp6, ra]>
              ra_send_mtu: <value in [disable, enable]>
              ip6_delegated_prefix_iaid: <integer>
              dhcp6_relay_source_interface: <value in [disable, enable]>
              dhcp6_relay_interface_id: <string>
              dhcp6_relay_source_ip: <string>
            l2forward: <value in [disable, enable]>
            l2tp_client: <value in [disable, enable]>
            lacp_ha_slave: <value in [disable, enable]>
            lacp_mode: <value in [static, passive, active]>
            lacp_speed: <value in [slow, fast]>
            lcp_echo_interval: <integer>
            lcp_max_echo_fails: <integer>
            link_up_delay: <integer>
            listen_forticlient_connection: <value in [disable, enable]>
            lldp_network_policy: <string>
            lldp_reception: <value in [disable, enable, vdom]>
            lldp_transmission: <value in [enable, disable, vdom]>
            log: <value in [disable, enable]>
            macaddr: <string>
            managed_subnetwork_size: <value in [256, 512, 1024, ...]>
            management_ip: <string>
            max_egress_burst_rate: <integer>
            max_egress_rate: <integer>
            measured_downstream_bandwidth: <integer>
            measured_upstream_bandwidth: <integer>
            mediatype: <value in [serdes-sfp, sgmii-sfp, cfp2-sr10, ...]>
            member: <list or string>
            min_links: <integer>
            min_links_down: <value in [operational, administrative]>
            mode: <value in [static, dhcp, pppoe, ...]>
            monitor_bandwidth: <value in [disable, enable]>
            mtu: <integer>
            mtu_override: <value in [disable, enable]>
            mux_type: <value in [llc-encaps, vc-encaps]>
            name: <string>
            ndiscforward: <value in [disable, enable]>
            netbios_forward: <value in [disable, enable]>
            netflow_sampler: <value in [disable, tx, rx, ...]>
            np_qos_profile: <integer>
            npu_fastpath: <value in [disable, enable]>
            nst: <value in [disable, enable]>
            out_force_vlan_cos: <integer>
            outbandwidth: <integer>
            padt_retry_timeout: <integer>
            password: <list or string>
            peer_interface: <list or string>
            phy_mode: <value in [auto, adsl, vdsl, ...]>
            ping_serv_status: <integer>
            poe: <value in [disable, enable]>
            polling_interval: <integer>
            pppoe_unnumbered_negotiate: <value in [disable, enable]>
            pptp_auth_type: <value in [auto, pap, chap, ...]>
            pptp_client: <value in [disable, enable]>
            pptp_password: <list or string>
            pptp_server_ip: <string>
            pptp_timeout: <integer>
            pptp_user: <string>
            preserve_session_route: <value in [disable, enable]>
            priority: <integer>
            priority_override: <value in [disable, enable]>
            proxy_captive_portal: <value in [disable, enable]>
            redundant_interfa