fortinet.fortimanager.fmgr_fsp_vlan_interface module – Configure interfaces.

Note

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

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

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

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

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter

Comments

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_interface

dictionary

The top level parameters set.

ac-name

string

Deprecated, please rename it to ac_name. Ac name.

aggregate

string

Aggregate.

aggregate-type

string

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

Choices:

  • "physical"

  • "vxlan"

algorithm

string

Algorithm.

Choices:

  • "L2"

  • "L3"

  • "L4"

  • "LB"

  • "Source-MAC"

alias

string

Alias.

allowaccess

list / elements=string

Allowaccess.

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. Ap discover.

Choices:

  • "disable"

  • "enable"

arpforward

string

Arpforward.

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. Auth type.

Choices:

  • "auto"

  • "pap"

  • "chap"

  • "mschapv1"

  • "mschapv2"

auto-auth-extension-device

string

Deprecated, please rename it to auto_auth_extension_device. Auto auth extension device.

Choices:

  • "disable"

  • "enable"

bandwidth-measure-time

integer

Deprecated, please rename it to bandwidth_measure_time. Bandwidth measure time.

bfd

string

Bfd.

Choices:

  • "global"

  • "enable"

  • "disable"

bfd-desired-min-tx

integer

Deprecated, please rename it to bfd_desired_min_tx. Bfd desired min tx.

bfd-detect-mult

integer

Deprecated, please rename it to bfd_detect_mult. Bfd detect mult.

bfd-required-min-rx

integer

Deprecated, please rename it to bfd_required_min_rx. Bfd required min rx.

broadcast-forticlient-discovery

string

Deprecated, please rename it to broadcast_forticlient_discovery. Broadcast forticlient discovery.

Choices:

  • "disable"

  • "enable"

broadcast-forward

string

Deprecated, please rename it to broadcast_forward. Broadcast forward.

Choices:

  • "disable"

  • "enable"

captive-portal

integer

Deprecated, please rename it to captive_portal. Captive portal.

cli-conn-status

integer

Deprecated, please rename it to cli_conn_status. Cli conn status.

color

integer

Color.

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. Dedicated to.

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

Defaultgw.

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

Detectprotocol.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

detectserver

string

Detectserver.

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. Device identification.

Choices:

  • "disable"

  • "enable"

device-identification-active-scan

string

Deprecated, please rename it to device_identification_active_scan. Device identification active scan.

Choices:

  • "disable"

  • "enable"

device-netscan

string

Deprecated, please rename it to device_netscan. Device netscan.

Choices:

  • "disable"

  • "enable"

device-user-identification

string

Deprecated, please rename it to device_user_identification. Device user identification.

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 by the …

Choices:

  • "disable"

  • "enable"

dhcp-classless-route-addition

string

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

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. Dhcp relay agent option.

Choices:

  • "disable"

  • "enable"

dhcp-relay-allow-no-end-option

string

Deprecated, please rename it to dhcp_relay_allow_no_end_option. Enable/disable relaying DHCP messages with no end 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. Dhcp relay interface.

dhcp-relay-interface-select-method

string

Deprecated, please rename it to dhcp_relay_interface_select_method. 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.

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. Dhcp relay service.

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.

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. Disc retry timeout.

disconnect-threshold

integer

Deprecated, please rename it to disconnect_threshold. Disconnect threshold.

distance

integer

Distance.

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. Dns server override.

Choices:

  • "disable"

  • "enable"

dns-server-protocol

list / elements=string

Deprecated, please rename it to dns_server_protocol. DNS transport protocols.

Choices:

  • "cleartext"

  • "dot"

  • "doh"

drop-fragment

string

Deprecated, please rename it to drop_fragment. Drop fragment.

Choices:

  • "disable"

  • "enable"

drop-overlapped-fragment

string

Deprecated, please rename it to drop_overlapped_fragment. Drop overlapped fragment.

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 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. Egress cos.

Choices:

  • "disable"

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

egress-shaping-profile

string

Deprecated, please rename it to egress_shaping_profile. Egress shaping profile.

eip

string

Eip.

endpoint-compliance

string

Deprecated, please rename it to endpoint_compliance. Endpoint compliance.

Choices:

  • "disable"

  • "enable"

estimated-downstream-bandwidth

integer

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

estimated-upstream-bandwidth

integer

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

explicit-ftp-proxy

string

Deprecated, please rename it to explicit_ftp_proxy. Explicit ftp proxy.

Choices:

  • "disable"

  • "enable"

explicit-web-proxy

string

Deprecated, please rename it to explicit_web_proxy. Explicit web proxy.

Choices:

  • "disable"

  • "enable"

external

string

External.

Choices:

  • "disable"

  • "enable"

fail-action-on-extender

string

Deprecated, please rename it to fail_action_on_extender. Fail action on extender.

Choices:

  • "soft-restart"

  • "hard-restart"

  • "reboot"

fail-alert-interfaces

any

(list or str) Deprecated, please rename it to fail_alert_interfaces. Fail alert interfaces.

fail-alert-method

string

Deprecated, please rename it to fail_alert_method. Fail alert method.

Choices:

  • "link-failed-signal"

  • "link-down"

fail-detect

string

Deprecated, please rename it to fail_detect. Fail detect.

Choices:

  • "disable"

  • "enable"

fail-detect-option

list / elements=string

Deprecated, please rename it to fail_detect_option. Fail detect option.

Choices:

  • "detectserver"

  • "link-down"

fdp

string

Fdp.

Choices:

  • "disable"

  • "enable"

fortiheartbeat

string

Fortiheartbeat.

Choices:

  • "disable"

  • "enable"

string

Fortilink.

Choices:

  • "disable"

  • "enable"

integer

Deprecated, please rename it to fortilink_backup_link. Fortilink backup link.

string

Deprecated, please rename it to fortilink_neighbor_detect. Fortilink neighbor detect.

Choices:

  • "lldp"

  • "fortilink"

string

Deprecated, please rename it to fortilink_split_interface. Fortilink split interface.

Choices:

  • "disable"

  • "enable"

string

Deprecated, please rename it to fortilink_stacking. Fortilink stacking.

Choices:

  • "disable"

  • "enable"

forward-domain

integer

Deprecated, please rename it to forward_domain. Forward domain.

forward-error-correction

string

Deprecated, please rename it to forward_error_correction. 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. Generic receive offload.

Choices:

  • "disable"

  • "enable"

gi-gk

string

Deprecated, please rename it to gi_gk. Gi gk.

Choices:

  • "disable"

  • "enable"

gwaddr

string

Gwaddr.

gwdetect

string

Gwdetect.

Choices:

  • "disable"

  • "enable"

ha-priority

integer

Deprecated, please rename it to ha_priority. Ha priority.

icmp-accept-redirect

string

Deprecated, please rename it to icmp_accept_redirect. Icmp accept redirect.

Choices:

  • "disable"

  • "enable"

icmp-redirect

string

Deprecated, please rename it to icmp_redirect. Icmp redirect.

Choices:

  • "disable"

  • "enable"

icmp-send-redirect

string

Deprecated, please rename it to icmp_send_redirect. Icmp send redirect.

Choices:

  • "disable"

  • "enable"

ident-accept

string

Deprecated, please rename it to ident_accept. Ident accept.

Choices:

  • "disable"

  • "enable"

idle-timeout

integer

Deprecated, please rename it to idle_timeout. Idle timeout.

if-mdix

string

Deprecated, please rename it to if_mdix. If mdix.

Choices:

  • "auto"

  • "normal"

  • "crossover"

if-media

string

Deprecated, please rename it to if_media. If media.

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

Inbandwidth.

ingress-cos

string

Deprecated, please rename it to ingress_cos. Ingress cos.

Choices:

  • "disable"

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

ingress-shaping-profile

string

Deprecated, please rename it to ingress_shaping_profile. Ingress 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

Internal.

ip

string

Ip.

ip-managed-by-fortiipam

string

Deprecated, please rename it to ip_managed_by_fortiipam. Ip managed by fortiipam.

Choices:

  • "disable"

  • "enable"

  • "inherit-global"

ipmac

string

Ipmac.

Choices:

  • "disable"

  • "enable"

ips-sniffer-mode

string

Deprecated, please rename it to ips_sniffer_mode. Ips sniffer mode.

Choices:

  • "disable"

  • "enable"

ipunnumbered

string

Ipunnumbered.

ipv6

dictionary

Ipv6.

autoconf

string

Autoconf.

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. Dhcp6 information request.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-delegation

string

Deprecated, please rename it to dhcp6_prefix_delegation. Dhcp6 prefix delegation.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-hint

string

Deprecated, please rename it to dhcp6_prefix_hint. Dhcp6 prefix hint.

dhcp6-prefix-hint-plt

integer

Deprecated, please rename it to dhcp6_prefix_hint_plt. Dhcp6 prefix hint plt.

dhcp6-prefix-hint-vlt

integer

Deprecated, please rename it to dhcp6_prefix_hint_vlt. Dhcp6 prefix hint vlt.

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. Dhcp6 relay ip.

dhcp6-relay-service

string

Deprecated, please rename it to dhcp6_relay_service. Dhcp6 relay service.

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-interface

string

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

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. Dhcp6 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. Interface identifier.

ip6-address

string

Deprecated, please rename it to ip6_address. Ip6 address.

ip6-allowaccess

list / elements=string

Deprecated, please rename it to ip6_allowaccess. Ip6 allowaccess.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6-default-life

integer

Deprecated, please rename it to ip6_default_life. Ip6 default life.

ip6-delegated-prefix-iaid

integer

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

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. Autonomous flag.

Choices:

  • "disable"

  • "enable"

delegated-prefix-iaid

integer

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

string

Deprecated, please rename it to onlink_flag. Onlink flag.

Choices:

  • "disable"

  • "enable"

prefix-id

integer

Deprecated, please rename it to prefix_id. Prefix id.

rdnss

any

(list) Rdnss.

rdnss-service

string

Deprecated, please rename it to rdnss_service. Rdnss service.

Choices:

  • "delegated"

  • "default"

  • "specify"

subnet

string

Subnet.

upstream-interface

string

Deprecated, please rename it to upstream_interface. Upstream interface.

ip6-dns-server-override

string

Deprecated, please rename it to ip6_dns_server_override. Ip6 dns server override.

Choices:

  • "disable"

  • "enable"

ip6-extra-addr

list / elements=dictionary

Deprecated, please rename it to ip6_extra_addr. Ip6 extra addr.

prefix

string

Prefix.

ip6-hop-limit

integer

Deprecated, please rename it to ip6_hop_limit. Ip6 hop limit.

integer

Deprecated, please rename it to ip6_link_mtu. Ip6 link mtu.

ip6-manage-flag

string

Deprecated, please rename it to ip6_manage_flag. Ip6 manage flag.

Choices:

  • "disable"

  • "enable"

ip6-max-interval

integer

Deprecated, please rename it to ip6_max_interval. Ip6 max interval.

ip6-min-interval

integer

Deprecated, please rename it to ip6_min_interval. Ip6 min interval.

ip6-mode

string

Deprecated, please rename it to ip6_mode. Ip6 mode.

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6-other-flag

string

Deprecated, please rename it to ip6_other_flag. Ip6 other 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. Autonomous flag.

Choices:

  • "disable"

  • "enable"

dnssl

any

(list) Dnssl.

string

Deprecated, please rename it to onlink_flag. Onlink flag.

Choices:

  • "disable"

  • "enable"

preferred-life-time

integer

Deprecated, please rename it to preferred_life_time. Preferred life time.

prefix

string

Prefix.

rdnss

any

(list) Rdnss.

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. Ip6 reachable time.

ip6-retrans-time

integer

Deprecated, please rename it to ip6_retrans_time. Ip6 retrans time.

ip6-send-adv

string

Deprecated, please rename it to ip6_send_adv. Ip6 send adv.

Choices:

  • "disable"

  • "enable"

ip6-subnet

string

Deprecated, please rename it to ip6_subnet. Ip6 subnet.

ip6-upstream-interface

string

Deprecated, please rename it to ip6_upstream_interface. Ip6 upstream interface.

nd-cert

string

Deprecated, please rename it to nd_cert. Nd cert.

nd-cga-modifier

string

Deprecated, please rename it to nd_cga_modifier. Nd cga modifier.

nd-mode

string

Deprecated, please rename it to nd_mode. Nd mode.

Choices:

  • "basic"

  • "SEND-compatible"

nd-security-level

integer

Deprecated, please rename it to nd_security_level. Nd security level.

nd-timestamp-delta

integer

Deprecated, please rename it to nd_timestamp_delta. Nd timestamp delta.

nd-timestamp-fuzz

integer

Deprecated, please rename it to nd_timestamp_fuzz. Nd timestamp fuzz.

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. Unique autoconf addr.

Choices:

  • "disable"

  • "enable"

string

Vrip6 link local.

vrrp-virtual-mac6

string

Deprecated, please rename it to vrrp_virtual_mac6. Vrrp virtual mac6.

Choices:

  • "disable"

  • "enable"

vrrp6

list / elements=dictionary

Vrrp6.

accept-mode

string

Deprecated, please rename it to accept_mode. Accept mode.

Choices:

  • "disable"

  • "enable"

adv-interval

integer

Deprecated, please rename it to adv_interval. Adv 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

Preempt.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority.

start-time

integer

Deprecated, please rename it to start_time. Start time.

status

string

Status.

Choices:

  • "disable"

  • "enable"

vrdst-priority

integer

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

vrdst6

string

Vrdst6.

vrgrp

integer

Vrgrp.

vrid

integer

Vrid.

vrip6

string

Vrip6.

l2forward

string

L2forward.

Choices:

  • "disable"

  • "enable"

l2tp-client

string

Deprecated, please rename it to l2tp_client. L2tp client.

Choices:

  • "disable"

  • "enable"

lacp-ha-secondary

string

Deprecated, please rename it to lacp_ha_secondary. 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. Lacp speed.

Choices:

  • "slow"

  • "fast"

large-receive-offload

string

Deprecated, please rename it to large_receive_offload. Large receive offload.

Choices:

  • "disable"

  • "enable"

lcp-echo-interval

integer

Deprecated, please rename it to lcp_echo_interval. Lcp echo interval.

lcp-max-echo-fails

integer

Deprecated, please rename it to lcp_max_echo_fails. Lcp max echo fails.

integer

Deprecated, please rename it to link_up_delay. Link up delay.

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 network policy.

lldp-reception

string

Deprecated, please rename it to lldp_reception. Lldp reception.

Choices:

  • "disable"

  • "enable"

  • "vdom"

lldp-transmission

string

Deprecated, please rename it to lldp_transmission. Lldp transmission.

Choices:

  • "enable"

  • "disable"

  • "vdom"

log

string

Log.

Choices:

  • "disable"

  • "enable"

macaddr

string

Macaddr.

managed-subnetwork-size

string

Deprecated, please rename it to managed_subnetwork_size. Managed subnetwork size.

Choices:

  • "256"

  • "512"

  • "1024"

  • "2048"

  • "4096"

  • "8192"

  • "16384"

  • "32768"

  • "65536"

  • "32"

  • "64"

  • "128"

management-ip

string

Deprecated, please rename it to management_ip. Management ip.

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

Mediatype.

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) Member.

integer

Deprecated, please rename it to min_links. Min links.

string

Deprecated, please rename it to min_links_down. Min links down.

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

Mode.

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "pppoa"

  • "ipoa"

  • "eoa"

monitor-bandwidth

string

Deprecated, please rename it to monitor_bandwidth. Monitor bandwidth.

Choices:

  • "disable"

  • "enable"

mtu

integer

Mtu.

mtu-override

string

Deprecated, please rename it to mtu_override. Mtu override.

Choices:

  • "disable"

  • "enable"

mux-type

string

Deprecated, please rename it to mux_type. Mux type.

Choices:

  • "llc-encaps"

  • "vc-encaps"

name

string

Name.

ndiscforward

string

Ndiscforward.

Choices:

  • "disable"

  • "enable"

netbios-forward

string

Deprecated, please rename it to netbios_forward. Netbios forward.

Choices:

  • "disable"

  • "enable"

netflow-sample-rate

integer

Deprecated, please rename it to netflow_sample_rate. NetFlow sample rate.

netflow-sampler

string

Deprecated, please rename it to netflow_sampler. Netflow sampler.

Choices:

  • "disable"

  • "tx"

  • "rx"

  • "both"

netflow-sampler-id

integer

Deprecated, please rename it to netflow_sampler_id. Netflow sampler ID.

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

Outbandwidth.

padt-retry-timeout

integer

Deprecated, please rename it to padt_retry_timeout. Padt retry timeout.

password

any

(list) 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. Phy mode.

Choices:

  • "auto"

  • "adsl"

  • "vdsl"

  • "adsl-auto"

  • "vdsl2"

  • "adsl2+"

  • "adsl2"

  • "g.dmt"

  • "t1.413"

  • "g.lite"

  • "g-dmt"

  • "t1-413"

  • "g-lite"

ping-serv-status

integer

Deprecated, please rename it to ping_serv_status. Ping serv status.

poe

string

Poe.

Choices:

  • "disable"

  • "enable"

polling-interval

integer

Deprecated, please rename it to polling_interval. Polling interval.

port-mirroring

string

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

Choices:

  • "disable"

  • "enable"

pppoe-egress-cos

string

Deprecated, please rename it to pppoe_egress_cos. CoS in VLAN tag for outgoing PPPoE/PPP packets.

Choices:

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

pppoe-unnumbered-negotiate

string

Deprecated, please rename it to pppoe_unnumbered_negotiate. Pppoe unnumbered negotiate.

Choices:

  • "disable"

  • "enable"

pptp-auth-type

string

Deprecated, please rename it to pptp_auth_type. Pptp auth type.

Choices:

  • "auto"

  • "pap"

  • "chap"

  • "mschapv1"

  • "mschapv2"

pptp-client

string

Deprecated, please rename it to pptp_client. 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.

pptp-timeout

integer

Deprecated, please rename it to pptp_timeout. Pptp timeout.

pptp-user

string

Deprecated, please rename it to pptp_user. Pptp user.

preserve-session-route

string

Deprecated, please rename it to preserve_session_route. Preserve session route.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority.

priority-override

string

Deprecated, please rename it to priority_override. Priority override.

Choices:

  • "disable"

  • "enable"

proxy-captive-portal

string

Deprecated, please rename it to proxy_captive_portal. Proxy captive portal.

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.

replacemsg-override-group

string

Deprecated, please rename it to replacemsg_override_group. Replacemsg override group.

retransmission

string

Retransmission.

Choices:

  • "disable"

  • "enable"

ring-rx

integer

Deprecated, please rename it to ring_rx. Ring rx.

ring-tx

integer

Deprecated, please rename it to ring_tx. Ring tx.

role

string

Role.

Choices:

  • "lan"

  • "wan"

  • "dmz"

  • "undefined"

sample-direction

string

Deprecated, please rename it to sample_direction. Sample direction.

Choices:

  • "rx"

  • "tx"

  • "both"

sample-rate

integer

Deprecated, please rename it to sample_rate. Sample rate.

scan-botnet-connections

string

Deprecated, please rename it to scan_botnet_connections. Scan botnet connections.

Choices:

  • "disable"

  • "block"

  • "monitor"

secondary-IP

string

Deprecated, please rename it to secondary_IP. Secondary IP.

Choices:

  • "disable"

  • "enable"

secondaryip

list / elements=dictionary

Secondaryip.

allowaccess

list / elements=string

Allowaccess.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "auto-ipsec"

  • "radius-acct"

  • "probe-response"

  • "capwap"

  • "dnp"

  • "ftm"

  • "fabric"

  • "speed-test"

  • "icond"

  • "scim"

detectprotocol

list / elements=string

Detectprotocol.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

detectserver

string

Detectserver.

gwdetect

string

Gwdetect.

Choices:

  • "disable"

  • "enable"

ha-priority

integer

Deprecated, please rename it to ha_priority. Ha priority.

id

integer

Id.

ip

string

Ip.

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. Security 8021x dynamic vlan id.

security-8021x-master

string

Deprecated, please rename it to security_8021x_master. Security 8021x master.

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. Security 8021x mode.

Choices:

  • "default"

  • "dynamic-vlan"

  • "fallback"

  • "slave"

security-exempt-list

string

Deprecated, please rename it to security_exempt_list. Security exempt list.

security-external-logout

string

Deprecated, please rename it to security_external_logout. Security external logout.

security-external-web

string

Deprecated, please rename it to security_external_web. Security external web.

security-groups

any

(list or str) Deprecated, please rename it to security_groups. Security groups.

security-ip-auth-bypass

string

Deprecated, please rename it to security_ip_auth_bypass. Enable/disable IP authentication bypass.

Choices:

  • "disable"

  • "enable"

security-mac-auth-bypass

string

Deprecated, please rename it to security_mac_auth_bypass. Security mac auth bypass.

Choices:

  • "disable"

  • "enable"

  • "mac-auth-only"

security-mode

string

Deprecated, please rename it to security_mode. Security mode.

Choices:

  • "none"

  • "captive-portal"

  • "802.1X"

security-redirect-url

string

Deprecated, please rename it to security_redirect_url. Security redirect url.

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. Service name.

sflow-sampler

string

Deprecated, please rename it to sflow_sampler. Sflow sampler.

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

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. Spillover threshold.

src-check

string

Deprecated, please rename it to src_check. Src check.

Choices:

  • "disable"

  • "enable"

status

string

Status.

Choices:

  • "down"

  • "up"

stp

string

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. Stp ha slave.

Choices:

  • "disable"

  • "enable"

  • "priority-adjust"

stpforward

string

Stpforward.

Choices:

  • "disable"

  • "enable"

stpforward-mode

string

Deprecated, please rename it to stpforward_mode. Stpforward 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

Subst.

Choices:

  • "disable"

  • "enable"

substitute-dst-mac

string

Deprecated, please rename it to substitute_dst_mac. Substitute dst mac.

sw-algorithm

string

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

Choices:

  • "l2"

  • "l3"

  • "eh"

  • "default"

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. Switch controller access vlan.

Choices:

  • "disable"

  • "enable"

switch-controller-arp-inspection

string

Deprecated, please rename it to switch_controller_arp_inspection. Switch controller arp inspection.

Choices:

  • "disable"

  • "enable"

  • "monitor"

switch-controller-auth

string

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

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 mac.

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. Switch controller feature.

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 leave.

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. Switch controller learning limit.

switch-controller-mgmt-vlan

integer

Deprecated, please rename it to switch_controller_mgmt_vlan. Switch controller mgmt vlan.

switch-controller-nac

string

Deprecated, please rename it to switch_controller_nac. Switch controller nac.

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 gateway.

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. Switch controller offloading.

Choices:

  • "disable"

  • "enable"

switch-controller-offloading-gw

string

Deprecated, please rename it to switch_controller_offloading_gw. Switch controller offloading gw.

Choices:

  • "disable"

  • "enable"

switch-controller-offloading-ip

string

Deprecated, please rename it to switch_controller_offloading_ip. Switch controller offloading ip.

switch-controller-radius-server

string

Deprecated, please rename it to switch_controller_radius_server. Switch controller radius server.

switch-controller-rspan-mode

string

Deprecated, please rename it to switch_controller_rspan_mode. Switch controller rspan mode.

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.

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. Tc mode.

Choices:

  • "ptm"

  • "atm"

tcp-mss

integer

Deprecated, please rename it to tcp_mss. Tcp mss.

trunk

string

Trunk.

Choices:

  • "disable"

  • "enable"

trust-ip-1

string

Deprecated, please rename it to trust_ip_1. Trust ip 1.

trust-ip-2

string

Deprecated, please rename it to trust_ip_2. Trust ip 2.

trust-ip-3

string

Deprecated, please rename it to trust_ip_3. Trust ip 3.

trust-ip6-1

string

Deprecated, please rename it to trust_ip6_1. Trust ip6 1.

trust-ip6-2

string

Deprecated, please rename it to trust_ip6_2. Trust ip6 2.

trust-ip6-3

string

Deprecated, please rename it to trust_ip6_3. Trust ip6 3.

type

string

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.

vci

integer

Vci.

vectoring

string

Vectoring.

Choices:

  • "disable"

  • "enable"

vindex

integer

Vindex.

virtual-mac

string

Deprecated, please rename it to virtual_mac. Change the interfaces virtual MAC address.

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. Vlan protocol.

Choices:

  • "8021q"

  • "8021ad"

vlanforward

string

Vlanforward.

Choices:

  • "disable"

  • "enable"

vlanid

integer

Vlanid.

vpi

integer

Vpi.

vrf

integer

Vrf.

vrrp

list / elements=dictionary

Vrrp.

accept-mode

string

Deprecated, please rename it to accept_mode. Accept mode.

Choices:

  • "disable"

  • "enable"

adv-interval

integer

Deprecated, please rename it to adv_interval. Adv interval.

ignore-default-route

string

Deprecated, please rename it to ignore_default_route. Ignore default route.

Choices:

  • "disable"

  • "enable"

preempt

string

Preempt.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority.

proxy-arp

list / elements=dictionary

Deprecated, please rename it to proxy_arp. Proxy arp.

id

integer

ID.

ip

string

Set IP addresses of proxy ARP.

start-time

integer

Deprecated, please rename it to start_time. Start time.

status

string

Status.

Choices:

  • "disable"

  • "enable"

version

string

Version.

Choices:

  • "2"

  • "3"

vrdst

any

(list) Vrdst.

vrdst-priority

integer

Deprecated, please rename it to vrdst_priority. Vrdst priority.

vrgrp

integer

Vrgrp.

vrid

integer

Vrid.

vrip

string

Vrip.

vrrp-virtual-mac

string

Deprecated, please rename it to vrrp_virtual_mac. Vrrp virtual mac.

Choices:

  • "disable"

  • "enable"

wccp

string

Wccp.

Choices:

  • "disable"

  • "enable"

weight

integer

Weight.

wifi-5g-threshold

string

Deprecated, please rename it to wifi_5g_threshold. Wifi 5g threshold.

wifi-acl

string

Deprecated, please rename it to wifi_acl. Wifi acl.

Choices:

  • "deny"

  • "allow"

wifi-ap-band

string

Deprecated, please rename it to wifi_ap_band. Wifi ap band.

Choices:

  • "any"

  • "5g-preferred"

  • "5g-only"

wifi-auth

string

Deprecated, please rename it to wifi_auth. Wifi auth.

Choices:

  • "PSK"

  • "RADIUS"

  • "radius"

  • "usergroup"

wifi-auto-connect

string

Deprecated, please rename it to wifi_auto_connect. Wifi auto connect.

Choices:

  • "disable"

  • "enable"

wifi-auto-save

string

Deprecated, please rename it to wifi_auto_save. Wifi auto save.

Choices:

  • "disable"

  • "enable"

wifi-broadcast-ssid

string

Deprecated, please rename it to wifi_broadcast_ssid. Wifi broadcast ssid.

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. Wifi encrypt.

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 key.

wifi-keyindex

integer

Deprecated, please rename it to wifi_keyindex. Wifi keyindex.

wifi-mac-filter

string

Deprecated, please rename it to wifi_mac_filter. Wifi mac filter.

Choices:

  • "disable"

  • "enable"

wifi-passphrase

any

(list) Deprecated, please rename it to wifi_passphrase. Wifi passphrase.

wifi-radius-server

string

Deprecated, please rename it to wifi_radius_server. Wifi radius server.

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. Wifi security.

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. Wifi ssid.

wifi-usergroup

string

Deprecated, please rename it to wifi_usergroup. Wifi usergroup.

wins-ip

string

Deprecated, please rename it to wins_ip. Wins ip.

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.

vlan

string / required

The parameter (vlan) in requested url.

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.

  • 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: Configure interfaces.
      fortinet.fortimanager.fmgr_fsp_vlan_interface:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        vlan: <your own value>
        fsp_vlan_interface:
          ac_name: <string>
          aggregate: <string>
          algorithm: <value in [L2, L3, L4, ...]>
          alias: <string>
          allowaccess:
            - https
            - ping
            - ssh
            - snmp
            - http
            - telnet
            - fgfm
            - auto-ipsec
            - radius-acct
            - probe-response
            - capwap
            - dnp
            - ftm
            - fabric
            - speed-test
          ap_discover: <value in [disable, enable]>
          arpforward: <value in [disable, enable]>
          atm_protocol: <value in [none, ipoa]>
          auth_type: <value in [auto, pap, chap, ...]>
          auto_auth_extension_device: <value in [disable, enable]>
          bfd: <value in [global, enable, disable]>
          bfd_desired_min_tx: <integer>
          bfd_detect_mult: <integer>
          bfd_required_min_rx: <integer>
          broadcast_forticlient_discovery: <value in [disable, enable]>
          broadcast_forward: <value in [disable, enable]>
          captive_portal: <integer>
          cli_conn_status: <integer>
          color: <integer>
          ddns: <value in [disable, enable]>
          ddns_auth: <value in [disable, tsig]>
          ddns_domain: <string>
          ddns_key: <list or string>
          ddns_keyname: <string>
          ddns_password: <list or string>
          ddns_server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
          ddns_server_ip: <string>
          ddns_sn: <string>
          ddns_ttl: <integer>
          ddns_username: <string>
          ddns_zone: <string>
          dedicated_to: <value in [none, management]>
          defaultgw: <value in [disable, enable]>
          description: <string>
          detected_peer_mtu: <integer>
          detectprotocol:
            - ping
            - tcp-echo
            - udp-echo
          detectserver: <string>
          device_access_list: <list or string>
          device_identification: <value in [disable, enable]>
          device_identification_active_scan: <value in [disable, enable]>
          device_netscan: <value in [disable, enable]>
          device_user_identification: <value in [disable, enable]>
          devindex: <integer>
          dhcp_client_identifier: <string>
          dhcp_relay_agent_option: <value in [disable, enable]>
          dhcp_relay_ip: <list or string>
          dhcp_relay_service: <value in [disable, enable]>
          dhcp_relay_type: <value in [regular, ipsec]>
          dhcp_renew_time: <integer>
          disc_retry_timeout: <integer>
          disconnect_threshold: <integer>
          distance: <integer>
          dns_query: <value in [disable, recursive, non-recursive]>
          dns_server_override: <value in [disable, enable]>
          drop_fragment: <value in [disable, enable]>
          drop_overlapped_fragment: <value in [disable, enable]>
          egress_cos: <value in [disable, cos0, cos1, ...]>
          egress_shaping_profile: <string>
          endpoint_compliance: <value in [disable, enable]>
          estimated_downstream_bandwidth: <integer>
          estimated_upstream_bandwidth: <integer>
          explicit_ftp_proxy: <value in [disable, enable]>
          explicit_web_proxy: <value in [disable, enable]>
          external: <value in [disable, enable]>
          fail_action_on_extender: <value in [soft-restart, hard-restart, reboot]>
          fail_alert_interfaces: <list or string>
          fail_alert_method: <value in [link-failed-signal, link-down]>
          fail_detect: <value in [disable, enable]>
          fail_detect_option:
            - detectserver
            - link-down
          fdp: <value in [disable, enable]>
          fortiheartbeat: <value in [disable, enable]>
          fortilink: <value in [disable, enable]>
          fortilink_backup_link: <integer>
          fortilink_split_interface: <value in [disable, enable]>
          fortilink_stacking: <value in [disable, enable]>
          forward_domain: <integer>
          forward_error_correction: <value in [disable, enable, rs-fec, ...]>
          fp_anomaly:
            - drop_tcp_fin_noack
            - pass_winnuke
            - pass_tcpland
            - pass_udpland
            - pass_icmpland
            - pass_ipland
            - pass_iprr
            - pass_ipssrr
            - pass_iplsrr
            - pass_ipstream
            - pass_ipsecurity
            - pass_iptimestamp
            - pass_ipunknown_option
            - pass_ipunknown_prot
            - pass_icmp_frag
            - pass_tcp_no_flag
            - pass_tcp_fin_noack
            - drop_winnuke
            - drop_tcpland
            - drop_udpland
            - drop_icmpland
            - drop_ipland
            - drop_iprr
            - drop_ipssrr
            - drop_iplsrr
            - drop_ipstream
            - drop_ipsecurity
            - drop_iptimestamp
            - drop_ipunknown_option
            - drop_ipunknown_prot
            - drop_icmp_frag
            - drop_tcp_no_flag
          fp_disable:
            - all
            - ipsec
            - none
          gateway_address: <string>
          gi_gk: <value in [disable, enable]>
          gwaddr: <string>
          gwdetect: <value in [disable, enable]>
          ha_priority: <integer>
          icmp_accept_redirect: <value in [disable, enable]>
          icmp_redirect: <value in [disable, enable]>
          icmp_send_redirect: <value in [disable, enable]>
          ident_accept: <value in [disable, enable]>
          idle_timeout: <integer>
          if_mdix: <value in [auto, normal, crossover]>
          if_media: <value in [auto, copper, fiber]>
          in_force_vlan_cos: <integer>
          inbandwidth: <integer>
          ingress_cos: <value in [disable, cos0, cos1, ...]>
          ingress_spillover_threshold: <integer>
          internal: <integer>
          ip: <string>
          ipmac: <value in [disable, enable]>
          ips_sniffer_mode: <value in [disable, enable]>
          ipunnumbered: <string>
          ipv6:
            autoconf: <value in [disable, enable]>
            dhcp6_client_options:
              - rapid
              - iapd
              - iana
              - dns
              - dnsname
            dhcp6_information_request: <value in [disable, enable]>
            dhcp6_prefix_delegation: <value in [disable, enable]>
            dhcp6_prefix_hint: <string>
            dhcp6_prefix_hint_plt: <integer>
            dhcp6_prefix_hint_vlt: <integer>
            dhcp6_relay_ip: <string>
            dhcp6_relay_service: <value in [disable, enable]>
            dhcp6_relay_type: <value in [regular]>
            ip6_address: <string>
            ip6_allowaccess:
              - https
              - ping
              - ssh
              - snmp
              - http
              - telnet
              - fgfm
              - capwap
              - fabric
            ip6_default_life: <integer>
            ip6_dns_server_override: <value in [disable, enable]>
            ip6_hop_limit: <integer>
            ip6_link_mtu: <integer>
            ip6_manage_flag: <value in [disable, enable]>
            ip6_max_interval: <integer>
            ip6_min_interval: <integer>
            ip6_mode: <value in [static, dhcp, pppoe, ...]>
            ip6_other_flag: <value in [disable, enable]>
            ip6_reachable_time: <integer>
            ip6_retrans_time: <integer>
            ip6_send_adv: <value in [disable, enable]>
            ip6_subnet: <string>
            ip6_upstream_interface: <string>
            nd_cert: <string>
            nd_cga_modifier: <string>
            nd_mode: <value in [basic, SEND-compatible]>
            nd_security_level: <integer>
            nd_timestamp_delta: <integer>
            nd_timestamp_fuzz: <integer>
            vrip6_link_local: <string>
            vrrp_virtual_mac6: <value in [disable, enable]>
            ip6_delegated_prefix_list:
              -
                autonomous_flag: <value in [disable, enable]>
                onlink_flag: <value in [disable, enable]>
                prefix_id: <integer>
                rdnss: <list or string>
                rdnss_service: <value in [delegated, default, specify]>
                subnet: <string>
                upstream_interface: <string>
                delegated_prefix_iaid: <integer>
            ip6_extra_addr:
              -
                prefix: <string>
            ip6_prefix_list:
              -
                autonomous_flag: <value in [disable, enable]>
                dnssl: <list or string>
                onlink_flag: <value in [disable, enable]>
                preferred_life_time: <integer>
                prefix: <string>
                rdnss: <list or string>
                valid_life_time: <integer>
            vrrp6:
              -
                accept_mode: <value in [disable, enable]>
                adv_interval: <integer>
                preempt: <value in [disable, enable]>
                priority: <integer>
                start_time: <integer>
                status: <value in [disable, enable]>
                vrdst6: <string>
                vrgrp: <integer>
                vrid: <integer>
                vrip6: <string>
                ignore_default_route: <value in [disable, enable]>
                vrdst_priority: <integer>
            interface_identifier: <string>
            unique_autoconf_addr: <value in [disable, enable]>
            icmp6_send_redirect: <value in [disable, enable]>
            cli_conn6_status: <integer>
            ip6_prefix_mode: <value in [dhcp6, ra]>
            ra_send_mtu: <value in [disable, enable]>
            ip6_delegated_prefix_iaid: <integer>
            dhcp6_relay_source_interface: <value in [disable, enable]>
            dhcp6_relay_interface_id: <string>
            dhcp6_relay_source_ip: <string>
          l2forward: <value in [disable, enable]>
          l2tp_client: <value in [disable, enable]>
          lacp_ha_slave: <value in [disable, enable]>
          lacp_mode: <value in [static, passive, active]>
          lacp_speed: <value in [slow, fast]>
          lcp_echo_interval: <integer>
          lcp_max_echo_fails: <integer>
          link_up_delay: <integer>
          listen_forticlient_connection: <value in [disable, enable]>
          lldp_network_policy: <string>
          lldp_reception: <value in [disable, enable, vdom]>
          lldp_transmission: <value in [enable, disable, vdom]>
          log: <value in [disable, enable]>
          macaddr: <string>
          management_ip: <string>
          max_egress_burst_rate: <integer>
          max_egress_rate: <integer>
          mediatype: <value in [serdes-sfp, sgmii-sfp, cfp2-sr10, ...]>
          member: <list or string>
          min_links: <integer>
          min_links_down: <value in [operational, administrative]>
          mode: <value in [static, dhcp, pppoe, ...]>
          mtu: <integer>
          mtu_override: <value in [disable, enable]>
          mux_type: <value in [llc-encaps, vc-encaps]>
          name: <string>
          ndiscforward: <value in [disable, enable]>
          netbios_forward: <value in [disable, enable]>
          netflow_sampler: <value in [disable, tx, rx, ...]>
          npu_fastpath: <value in [disable, enable]>
          nst: <value in [disable, enable]>
          out_force_vlan_cos: <integer>
          outbandwidth: <integer>
          padt_retry_timeout: <integer>
          password: <list or string>
          peer_interface: <list or string>
          phy_mode: <value in [auto, adsl, vdsl, ...]>
          ping_serv_status: <integer>
          poe: <value in [disable, enable]>
          polling_interval: <integer>
          pppoe_unnumbered_negotiate: <value in [disable, enable]>
          pptp_auth_type: <value in [auto, pap, chap, ...]>
          pptp_client: <value in [disable, enable]>
          pptp_password: <list or string>
          pptp_server_ip: <string>
          pptp_timeout: <integer>
          pptp_user: <string>
          preserve_session_route: <value in [disable, enable]>
          priority: <integer>
          priority_override: <value in [disable, enable]>
          proxy_captive_portal: <value in [disable, enable]>
          redundant_interface: <string>
          remote_ip: <string>
          replacemsg_override_group: <string>
          retransmission: <value in [disable, enable]>
          role: <value in [lan, wan, dmz, ...]>
          sample_direction: <value in [rx, tx, both]>
          sample_rate: <integer>
          scan_botnet_connections: <value in [disable, block, monitor]>
          secondary_IP: <value in [disable, enable]>
          secondaryip:
            -
              allowaccess:
                - https
                - ping
                - ssh
                - snmp
                - http
                - telnet
                - fgfm
                - auto-ipsec
                - radius-acct
                - probe-response
                - capwap
                - dnp
                - ftm
                - fabric
                - speed-test
                - icond
                - scim
              detectprotocol:
                - ping
                - tcp-echo
                - udp-echo
              detectserver: <string>
              gwdetect: <value in [disable, enable]>
              ha_priority: <integer>
              id: <integer>
              ip: <string>
              ping_serv_status: <integer>
              seq: <integer>
              secip_relay_ip: <string>
          security_8021x_dynamic_vlan_id: <integer>
          security_8021x_master: <string>
          security_8021x_mode: <value in [default, dynamic-vlan, fallback, ...]>
          security_exempt_list: <string>
          security_external_logout: <string>
          security_external_web: <string>
          security_groups: <list or string>
          security_mac_auth_bypass: <value in [disable, enable, mac-auth-only]>
          security_mode: <value in [none, captive-portal, 802.1X]>
          security_redirect_url: <string>
          service_name: <string>
          sflow_sampler: <value in [disable, enable]>
          speed: <value in [auto, 10full, 10half, ...]>
          spillover_threshold: <integer>
          src_check: <value in [disable, enable]>
          status: <value in [down, up]>
          stp: <value in [disable, enable]>
          stp_ha_slave: <value in [disable, enable, priority-adjust]>
          stpforward: <value in [disable, enable]>
          stpforward_mode: <value in [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing]>
          strip_priority_vlan_tag: <value in [disable, enable]>
          subst: <value in [disable, enable]>
          substitute_dst_mac: <string>
          switch: <string>
          switch_controller_access_vlan: <value in [disable, enable]>
          switch_controller_arp_inspection: <value in [disable, enable, monitor]>
          switch_controller_auth: <value in [radius, usergroup]>
          switch_controller_dhcp_snooping: <value in [disable, enable]>
          switch_controller_dhcp_snooping_option82: <value in [disable, enable]>
          switch_controller_dhcp_snooping_verify_mac: <value in [disable, enable]>
          switch_controller_igmp_snooping: <value in [disable, enable]>
          switch_controller_learning_limit: <integer>
          switch_controller_radius_server: <string>
          switch_controller_traffic_policy: <string>
          tc_mode: <value in [ptm, atm]>
          tcp_mss: <integer>
          trunk: <value in [disable, enable]>
          trust_ip_1: <string>
          trust_ip_2: <string>
          trust_ip_3: <string>
          trust_ip6_1: <string>
          trust_ip6_2: <string>
          trust_ip6_3: <string>
          type: <value in [physical, vlan, aggregate, ...]>
          username: <string>
          vci: <integer>
          vectoring: <value in [disable, enable]>
          vindex: <integer>
          vlanforward: <value in [disable, enable]>
          vlanid: <integer>
          vpi: <integer>
          vrf: <integer>
          vrrp:
            -
              accept_mode: <value in [disable, enable]>
              adv_interval: <integer>
              ignore_default_route: <value in [disable, enable]>
              preempt: <value in [disable, enable]>
              priority: <integer>
              start_time: <integer>
              status: <value in [disable, enable]>
              version: <value in [2, 3]>
              vrdst: <list or string>
              vrdst_priority: <integer>
              vrgrp: <integer>
              vrid: <integer>
              vrip: <string>
              proxy_arp:
                -
                  id: <integer>
                  ip: <string>
          vrrp_virtual_mac: <value in [disable, enable]>
          wccp: <value in [disable, enable]>
          weight: <integer>
          wifi_5g_threshold: <string>
          wifi_acl: <value in [deny, allow]>
          wifi_ap_band: <value in [any, 5g-preferred, 5g-only]>
          wifi_auth: <value in [PSK, RADIUS, radius, ...]>
          wifi_auto_connect: <value in [disable, enable]>
          wifi_auto_save: <value in [disable, enable]>
          wifi_broadcast_ssid: <value in [disable, enable]>
          wifi_encrypt: <value in [TKIP, AES]>
          wifi_fragment_threshold: <integer>
          wifi_key: <list or string>
          wifi_keyindex: <integer>
          wifi_mac_filter: <value in [disable, enable]>
          wifi_passphrase: <list or string>
          wifi_radius_server: <string>
          wifi_rts_threshold: <integer>
          wifi_security: <value in [None, WEP64, wep64, ...]>
          wifi_ssid: <string>
          wifi_usergroup: <string>
          wins_ip: <string>
          eip: <string>
          fortilink_neighbor_detect: <value in [lldp, fortilink]>
          ingress_shaping_profile: <string>
          ring_rx: <integer>
          ring_tx: <integer>
          switch_controller_igmp_snooping_fast_leave: <value in [disable, enable]>
          switch_controller_igmp_snooping_proxy: <value in [disable, enable]>
          switch_controller_rspan_mode: <value in [disable, enable]>
          bandwidth_measure_time: <integer>
          ip_managed_by_fortiipam: <value in [disable, enable, inherit-global]>
          managed_subnetwork_size: <value in [256, 512, 1024, ...]>
          measured_downstream_bandwidth: <integer>
          measured_upstream_bandwidth: <integer>
          monitor_bandwidth: <value in [disable, enable]>
          swc_vlan: <integer>
          switch_controller_feature: <value in [none, default-vlan, quarantine, ...]>
          switch_controller_mgmt_vlan: <integer>
          switch_controller_nac: <string>
          vlan_protocol: <value in [8021q, 8021ad]>
          dhcp_relay_interface: <string>
          dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
          np_qos_profile: <integer>
          swc_first_create: <integer>
          switch_controller_iot_scanning: <value in [disable, enable]>
          switch_controller_source_ip: <value in [outbound, fixed]>
          dhcp_relay_request_all_server: <value in [disable, enable]>
          stp_ha_secondary: <value in [disable, enable, priority-adjust]>
          switch_controller_dynamic: <string>
          auth_cert: <string>
          auth_portal_addr: <string>
          dhcp_classless_route_addition: <value in [disable, enable]>
          dhcp_relay_link_selection: <string>
          dns_server_protocol:
            - cleartext
            - dot
            - doh
          eap_ca_cert: <string>
          eap_identity: <string>
          eap_method: <value in [tls, peap]>
          eap_password: <list or string>
          eap_supplicant: <value in [disable, enable]>
          eap_user_cert: <string>
          ike_saml_server: <string>
          lacp_ha_secondary: <value in [disable, enable]>
          pvc_atm_qos: <value in [cbr, rt-vbr, nrt-vbr, ...]>
          pvc_chan: <integer>
          pvc_crc: <integer>
          pvc_pcr: <integer>
          pvc_scr: <integer>
          pvc_vlan_id: <integer>
          pvc_vlan_rx_id: <integer>
          pvc_vlan_rx_op: <value in [pass-through, replace, remove]>
          pvc_vlan_tx_id: <integer>
          pvc_vlan_tx_op: <value in [pass-through, replace, remove]>
          reachable_time: <integer>
          select_profile_30a_35b: <value in [30A, 35B]>
          sfp_dsl: <value in [disable, enable]>
          sfp_dsl_adsl_fallback: <value in [disable, enable]>
          sfp_dsl_autodetect: <value in [disable, enable]>
          sfp_dsl_mac: <string>
          sw_algorithm: <value in [l2, l3, eh, ...]>
          system_id: <string>
          system_id_type: <value in [auto, user]>
          vlan_id: <integer>
          vlan_op_mode: <value in [tag, untag, passthrough]>
          generic_receive_offload: <value in [disable, enable]>
          interconnect_profile: <value in [default, profile1, profile2]>
          large_receive_offload: <value in [disable, enable]>
          annex: <value in [a, b, j, ...]>
          aggregate_type: <value in [physical, vxlan]>
          switch_controller_netflow_collect: <value in [disable, enable]>
          wifi_dns_server1: <string>
          wifi_dns_server2: <string>
          wifi_gateway: <string>
          default_purdue_level: <value in [1, 2, 3, ...]>
          dhcp_broadcast_flag: <value in [disable, enable]>
          dhcp_smart_relay: <value in [disable, enable]>
          switch_controller_offloading: <value in [disable, enable]>
          switch_controller_offloading_gw: <value in [disable, enable]>
          switch_controller_offloading_ip: <string>
          dhcp_relay_circuit_id: <string>
          dhcp_relay_source_ip: <string>
          switch_controller_offload: <value in [disable, enable]>
          switch_controller_offload_gw: <value in [disable, enable]>
          switch_controller_offload_ip: <string>
          mirroring_direction: <value in [rx, tx, both]>
          mirroring_port: <string>
          port_mirroring: <value in [disable, enable]>
          security_8021x_member_mode: <value in [disable, switch]>
          stp_edge: <value in [disable, enable]>
          dhcp_relay_allow_no_end_option: <value in [disable, enable]>
          netflow_sample_rate: <integer>
          netflow_sampler_id: <integer>
          pppoe_egress_cos: <value in [cos0, cos1, cos2, ...]>
          security_ip_auth_bypass: <value in [disable, enable]>
          virtual_mac: <string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)