fortinet.fortimanager.fmgr_fsp_vlan_interface module – Configure interfaces.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.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

Ac name.

aggregate

string

Aggregate.

aggregate_type

string

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

Ap discover.

Choices:

  • "disable"

  • "enable"

arpforward

string

Arpforward.

Choices:

  • "disable"

  • "enable"

atm_protocol

string

Atm protocol.

Choices:

  • "none"

  • "ipoa"

auth_cert

string

HTTPS server certificate.

auth_portal_addr

string

Address of captive portal.

auth_type

string

Auth type.

Choices:

  • "auto"

  • "pap"

  • "chap"

  • "mschapv1"

  • "mschapv2"

auto_auth_extension_device

string

Auto auth extension device.

Choices:

  • "disable"

  • "enable"

bandwidth_measure_time

integer

Bandwidth measure time.

bfd

string

Bfd.

Choices:

  • "global"

  • "enable"

  • "disable"

bfd_desired_min_tx

integer

Bfd desired min tx.

bfd_detect_mult

integer

Bfd detect mult.

bfd_required_min_rx

integer

Bfd required min rx.

broadcast_forticlient_discovery

string

Broadcast forticlient discovery.

Choices:

  • "disable"

  • "enable"

broadcast_forward

string

Broadcast forward.

Choices:

  • "disable"

  • "enable"

captive_portal

integer

Captive portal.

cli_conn_status

integer

Cli conn status.

color

integer

Color.

ddns

string

Ddns.

Choices:

  • "disable"

  • "enable"

ddns_auth

string

Ddns auth.

Choices:

  • "disable"

  • "tsig"

ddns_domain

string

Ddns domain.

ddns_key

any

(list or str) Ddns key.

ddns_keyname

string

Ddns keyname.

ddns_password

any

(list) Ddns password.

ddns_server

string

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

Ddns server ip.

ddns_sn

string

Ddns sn.

ddns_ttl

integer

Ddns ttl.

ddns_username

string

Ddns username.

ddns_zone

string

Ddns zone.

dedicated_to

string

Dedicated to.

Choices:

  • "none"

  • "management"

default_purdue_level

string

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

Detected peer mtu.

detectprotocol

list / elements=string

Detectprotocol.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

detectserver

string

Detectserver.

device_access_list

any

(list or str) Device access list.

device_identification

string

Device identification.

Choices:

  • "disable"

  • "enable"

device_identification_active_scan

string

Device identification active scan.

Choices:

  • "disable"

  • "enable"

device_netscan

string

Device netscan.

Choices:

  • "disable"

  • "enable"

device_user_identification

string

Device user identification.

Choices:

  • "disable"

  • "enable"

devindex

integer

Devindex.

dhcp_broadcast_flag

string

Enable/disable setting of the broadcast flag in messages sent by the DHCP client

Choices:

  • "disable"

  • "enable"

dhcp_classless_route_addition

string

Enable/disable addition of classless static routes retrieved from DHCP server.

Choices:

  • "disable"

  • "enable"

dhcp_client_identifier

string

Dhcp client identifier.

dhcp_relay_agent_option

string

Dhcp relay agent option.

Choices:

  • "disable"

  • "enable"

dhcp_relay_allow_no_end_option

string

Enable/disable relaying DHCP messages with no end option.

Choices:

  • "disable"

  • "enable"

dhcp_relay_circuit_id

string

DHCP relay circuit ID.

dhcp_relay_interface

string

Dhcp relay interface.

dhcp_relay_interface_select_method

string

Dhcp relay interface select method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

dhcp_relay_ip

any

(list) Dhcp relay ip.

string

DHCP relay link selection.

dhcp_relay_request_all_server

string

Enable/disable sending of DHCP requests to all servers.

Choices:

  • "disable"

  • "enable"

dhcp_relay_service

string

Dhcp relay service.

Choices:

  • "disable"

  • "enable"

dhcp_relay_source_ip

string

IP address used by the DHCP relay as its source IP.

dhcp_relay_type

string

Dhcp relay type.

Choices:

  • "regular"

  • "ipsec"

dhcp_renew_time

integer

Dhcp renew time.

dhcp_smart_relay

string

Enable/disable DHCP smart relay.

Choices:

  • "disable"

  • "enable"

disc_retry_timeout

integer

Disc retry timeout.

disconnect_threshold

integer

Disconnect threshold.

distance

integer

Distance.

dns_query

string

Dns query.

Choices:

  • "disable"

  • "recursive"

  • "non-recursive"

dns_server_override

string

Dns server override.

Choices:

  • "disable"

  • "enable"

dns_server_protocol

list / elements=string

DNS transport protocols.

Choices:

  • "cleartext"

  • "dot"

  • "doh"

drop_fragment

string

Drop fragment.

Choices:

  • "disable"

  • "enable"

drop_overlapped_fragment

string

Drop overlapped fragment.

Choices:

  • "disable"

  • "enable"

eap_ca_cert

string

EAP CA certificate name.

eap_identity

string

EAP identity.

eap_method

string

EAP method.

Choices:

  • "tls"

  • "peap"

eap_password

any

(list) EAP password.

eap_supplicant

string

Enable/disable EAP-Supplicant.

Choices:

  • "disable"

  • "enable"

eap_user_cert

string

EAP user certificate name.

egress_cos

string

Egress cos.

Choices:

  • "disable"

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

egress_shaping_profile

string

Egress shaping profile.

eip

string

Eip.

endpoint_compliance

string

Endpoint compliance.

Choices:

  • "disable"

  • "enable"

estimated_downstream_bandwidth

integer

Estimated downstream bandwidth.

estimated_upstream_bandwidth

integer

Estimated upstream bandwidth.

explicit_ftp_proxy

string

Explicit ftp proxy.

Choices:

  • "disable"

  • "enable"

explicit_web_proxy

string

Explicit web proxy.

Choices:

  • "disable"

  • "enable"

external

string

External.

Choices:

  • "disable"

  • "enable"

fail_action_on_extender

string

Fail action on extender.

Choices:

  • "soft-restart"

  • "hard-restart"

  • "reboot"

fail_alert_interfaces

any

(list or str) Fail alert interfaces.

fail_alert_method

string

Fail alert method.

Choices:

  • "link-failed-signal"

  • "link-down"

fail_detect

string

Fail detect.

Choices:

  • "disable"

  • "enable"

fail_detect_option

list / elements=string

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

Fortilink backup link.

string

Fortilink neighbor detect.

Choices:

  • "lldp"

  • "fortilink"

string

Fortilink split interface.

Choices:

  • "disable"

  • "enable"

string

Fortilink stacking.

Choices:

  • "disable"

  • "enable"

forward_domain

integer

Forward domain.

forward_error_correction

string

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

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

Fp disable.

Choices:

  • "all"

  • "ipsec"

  • "none"

gateway_address

string

Gateway address.

generic_receive_offload

string

Generic receive offload.

Choices:

  • "disable"

  • "enable"

gi_gk

string

Gi gk.

Choices:

  • "disable"

  • "enable"

gwaddr

string

Gwaddr.

gwdetect

string

Gwdetect.

Choices:

  • "disable"

  • "enable"

ha_priority

integer

Ha priority.

icmp_accept_redirect

string

Icmp accept redirect.

Choices:

  • "disable"

  • "enable"

icmp_redirect

string

Icmp redirect.

Choices:

  • "disable"

  • "enable"

icmp_send_redirect

string

Icmp send redirect.

Choices:

  • "disable"

  • "enable"

ident_accept

string

Ident accept.

Choices:

  • "disable"

  • "enable"

idle_timeout

integer

Idle timeout.

if_mdix

string

If mdix.

Choices:

  • "auto"

  • "normal"

  • "crossover"

if_media

string

If media.

Choices:

  • "auto"

  • "copper"

  • "fiber"

ike_saml_server

string

Configure IKE authentication SAML server.

in_force_vlan_cos

integer

In force vlan cos.

inbandwidth

integer

Inbandwidth.

ingress_cos

string

Ingress cos.

Choices:

  • "disable"

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

ingress_shaping_profile

string

Ingress shaping profile.

ingress_spillover_threshold

integer

Ingress spillover threshold.

interconnect_profile

string

Set interconnect profile.

Choices:

  • "default"

  • "profile1"

  • "profile2"

internal

integer

Internal.

ip

string

Ip.

ip_managed_by_fortiipam

string

Ip managed by fortiipam.

Choices:

  • "disable"

  • "enable"

  • "inherit-global"

ipmac

string

Ipmac.

Choices:

  • "disable"

  • "enable"

ips_sniffer_mode

string

Ips sniffer mode.

Choices:

  • "disable"

  • "enable"

ipunnumbered

string

Ipunnumbered.

ipv6

dictionary

Ipv6.

autoconf

string

Autoconf.

Choices:

  • "disable"

  • "enable"

cli_conn6_status

integer

Cli conn6 status.

dhcp6_client_options

list / elements=string

Dhcp6 client options.

Choices:

  • "rapid"

  • "iapd"

  • "iana"

  • "dns"

  • "dnsname"

dhcp6_information_request

string

Dhcp6 information request.

Choices:

  • "disable"

  • "enable"

dhcp6_prefix_delegation

string

Dhcp6 prefix delegation.

Choices:

  • "disable"

  • "enable"

dhcp6_prefix_hint

string

Dhcp6 prefix hint.

dhcp6_prefix_hint_plt

integer

Dhcp6 prefix hint plt.

dhcp6_prefix_hint_vlt

integer

Dhcp6 prefix hint vlt.

dhcp6_relay_interface_id

string

DHCP6 relay interface ID.

dhcp6_relay_ip

string

Dhcp6 relay ip.

dhcp6_relay_service

string

Dhcp6 relay service.

Choices:

  • "disable"

  • "enable"

dhcp6_relay_source_interface

string

Enable/disable use of address on this interface as the source address of the relay message.

Choices:

  • "disable"

  • "enable"

dhcp6_relay_source_ip

string

IPv6 address used by the DHCP6 relay as its source IP.

dhcp6_relay_type

string

Dhcp6 relay type.

Choices:

  • "regular"

icmp6_send_redirect

string

Enable/disable sending of ICMPv6 redirects.

Choices:

  • "disable"

  • "enable"

interface_identifier

string

Interface identifier.

ip6_address

string

Ip6 address.

ip6_allowaccess

list / elements=string

Ip6 allowaccess.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6_default_life

integer

Ip6 default life.

ip6_delegated_prefix_iaid

integer

IAID of obtained delegated-prefix from the upstream interface.

ip6_delegated_prefix_list

list / elements=dictionary

Ip6 delegated prefix list.

autonomous_flag

string

Autonomous flag.

Choices:

  • "disable"

  • "enable"

delegated_prefix_iaid

integer

IAID of obtained delegated-prefix from the upstream interface.

string

Onlink flag.

Choices:

  • "disable"

  • "enable"

prefix_id

integer

Prefix id.

rdnss

any

(list) Rdnss.

rdnss_service

string

Rdnss service.

Choices:

  • "delegated"

  • "default"

  • "specify"

subnet

string

Subnet.

upstream_interface

string

Upstream interface.

ip6_dns_server_override

string

Ip6 dns server override.

Choices:

  • "disable"

  • "enable"

ip6_extra_addr

list / elements=dictionary

Ip6 extra addr.

prefix

string

Prefix.

ip6_hop_limit

integer

Ip6 hop limit.

integer

Ip6 link mtu.

ip6_manage_flag

string

Ip6 manage flag.

Choices:

  • "disable"

  • "enable"

ip6_max_interval

integer

Ip6 max interval.

ip6_min_interval

integer

Ip6 min interval.

ip6_mode

string

Ip6 mode.

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6_other_flag

string

Ip6 other flag.

Choices:

  • "disable"

  • "enable"

ip6_prefix_list

list / elements=dictionary

Ip6 prefix list.

autonomous_flag

string

Autonomous flag.

Choices:

  • "disable"

  • "enable"

dnssl

any

(list) Dnssl.

string

Onlink flag.

Choices:

  • "disable"

  • "enable"

preferred_life_time

integer

Preferred life time.

prefix

string

Prefix.

rdnss

any

(list) Rdnss.

valid_life_time

integer

Valid life time.

ip6_prefix_mode

string

Assigning a prefix from DHCP or RA.

Choices:

  • "dhcp6"

  • "ra"

ip6_reachable_time

integer

Ip6 reachable time.

ip6_retrans_time

integer

Ip6 retrans time.

ip6_send_adv

string

Ip6 send adv.

Choices:

  • "disable"

  • "enable"

ip6_subnet

string

Ip6 subnet.

ip6_upstream_interface

string

Ip6 upstream interface.

nd_cert

string

Nd cert.

nd_cga_modifier

string

Nd cga modifier.

nd_mode

string

Nd mode.

Choices:

  • "basic"

  • "SEND-compatible"

nd_security_level

integer

Nd security level.

nd_timestamp_delta

integer

Nd timestamp delta.

nd_timestamp_fuzz

integer

Nd timestamp fuzz.

ra_send_mtu

string

Enable/disable sending link MTU in RA packet.

Choices:

  • "disable"

  • "enable"

unique_autoconf_addr

string

Unique autoconf addr.

Choices:

  • "disable"

  • "enable"

string

Vrip6 link local.

vrrp6

list / elements=dictionary

Vrrp6.

accept_mode

string

Accept mode.

Choices:

  • "disable"

  • "enable"

adv_interval

integer

Adv interval.

ignore_default_route

string

Enable/disable ignoring of default route when checking destination.

Choices:

  • "disable"

  • "enable"

preempt

string

Preempt.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority.

start_time

integer

Start time.

status

string

Status.

Choices:

  • "disable"

  • "enable"

vrdst6

string

Vrdst6.

vrdst_priority

integer

Priority of the virtual router when the virtual router destination becomes unreachable

vrgrp

integer

Vrgrp.

vrid

integer

Vrid.

vrip6

string

Vrip6.

vrrp_virtual_mac6

string

Vrrp virtual mac6.

Choices:

  • "disable"

  • "enable"

l2forward

string

L2forward.

Choices:

  • "disable"

  • "enable"

l2tp_client

string

L2tp client.

Choices:

  • "disable"

  • "enable"

lacp_ha_secondary

string

Lacp ha secondary.

Choices:

  • "disable"

  • "enable"

lacp_ha_slave

string

Lacp ha slave.

Choices:

  • "disable"

  • "enable"

lacp_mode

string

Lacp mode.

Choices:

  • "static"

  • "passive"

  • "active"

lacp_speed

string

Lacp speed.

Choices:

  • "slow"

  • "fast"

large_receive_offload

string

Large receive offload.

Choices:

  • "disable"

  • "enable"

lcp_echo_interval

integer

Lcp echo interval.

lcp_max_echo_fails

integer

Lcp max echo fails.

integer

Link up delay.

listen_forticlient_connection

string

Listen forticlient connection.

Choices:

  • "disable"

  • "enable"

lldp_network_policy

string

Lldp network policy.

lldp_reception

string

Lldp reception.

Choices:

  • "disable"

  • "enable"

  • "vdom"

lldp_transmission

string

Lldp transmission.

Choices:

  • "enable"

  • "disable"

  • "vdom"

log

string

Log.

Choices:

  • "disable"

  • "enable"

macaddr

string

Macaddr.

managed_subnetwork_size

string

Managed subnetwork size.

Choices:

  • "256"

  • "512"

  • "1024"

  • "2048"

  • "4096"

  • "8192"

  • "16384"

  • "32768"

  • "65536"

  • "32"

  • "64"

  • "128"

management_ip

string

Management ip.

max_egress_burst_rate

integer

Max egress burst rate.

max_egress_rate

integer

Max egress rate.

measured_downstream_bandwidth

integer

Measured downstream bandwidth.

measured_upstream_bandwidth

integer

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

Min links.

string

Min links down.

Choices:

  • "operational"

  • "administrative"

mirroring_direction

string

Port mirroring direction.

Choices:

  • "rx"

  • "tx"

  • "both"

mirroring_port

string

Mirroring port.

mode

string

Mode.

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "pppoa"

  • "ipoa"

  • "eoa"

monitor_bandwidth

string

Monitor bandwidth.

Choices:

  • "disable"

  • "enable"

mtu

integer

Mtu.

mtu_override

string

Mtu override.

Choices:

  • "disable"

  • "enable"

mux_type

string

Mux type.

Choices:

  • "llc-encaps"

  • "vc-encaps"

name

string

Name.

ndiscforward

string

Ndiscforward.

Choices:

  • "disable"

  • "enable"

netbios_forward

string

Netbios forward.

Choices:

  • "disable"

  • "enable"

netflow_sample_rate

integer

NetFlow sample rate.

netflow_sampler

string

Netflow sampler.

Choices:

  • "disable"

  • "tx"

  • "rx"

  • "both"

netflow_sampler_id

integer

Netflow sampler ID.

np_qos_profile

integer

NP QoS profile ID.

npu_fastpath

string

Npu fastpath.

Choices:

  • "disable"

  • "enable"

nst

string

Nst.

Choices:

  • "disable"

  • "enable"

out_force_vlan_cos

integer

Out force vlan cos.

outbandwidth

integer

Outbandwidth.

padt_retry_timeout

integer

Padt retry timeout.

password

any

(list) Password.

peer_interface

any

(list or str) Peer interface.

phy_mode

string

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

Ping serv status.

poe

string

Poe.

Choices:

  • "disable"

  • "enable"

polling_interval

integer

Polling interval.

port_mirroring

string

Enable/disable NP port mirroring.

Choices:

  • "disable"

  • "enable"

pppoe_egress_cos

string

CoS in VLAN tag for outgoing PPPoE/PPP packets.

Choices:

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

pppoe_unnumbered_negotiate

string

Pppoe unnumbered negotiate.

Choices:

  • "disable"

  • "enable"

pptp_auth_type

string

Pptp auth type.

Choices:

  • "auto"

  • "pap"

  • "chap"

  • "mschapv1"

  • "mschapv2"

pptp_client

string

Pptp client.

Choices:

  • "disable"

  • "enable"

pptp_password

any

(list) Pptp password.

pptp_server_ip

string

Pptp server ip.

pptp_timeout

integer

Pptp timeout.

pptp_user

string

Pptp user.

preserve_session_route

string

Preserve session route.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority.

priority_override

string

Priority override.

Choices:

  • "disable"

  • "enable"

proxy_captive_portal

string

Proxy captive portal.

Choices:

  • "disable"

  • "enable"

pvc_atm_qos

string

SFP-DSL ADSL Fallback PVC ATM QoS.

Choices:

  • "cbr"

  • "rt-vbr"

  • "nrt-vbr"

  • "ubr"

pvc_chan

integer

SFP-DSL ADSL Fallback PVC Channel.

pvc_crc

integer

SFP-DSL ADSL Fallback PVC CRC Option

pvc_pcr

integer

SFP-DSL ADSL Fallback PVC Packet Cell Rate in cells

pvc_scr

integer

SFP-DSL ADSL Fallback PVC Sustainable Cell Rate in cells

pvc_vlan_id

integer

SFP-DSL ADSL Fallback PVC VLAN ID.

pvc_vlan_rx_id

integer

SFP-DSL ADSL Fallback PVC VLANID RX.

pvc_vlan_rx_op

string

SFP-DSL ADSL Fallback PVC VLAN RX op.

Choices:

  • "pass-through"

  • "replace"

  • "remove"

pvc_vlan_tx_id

integer

SFP-DSL ADSL Fallback PVC VLAN ID TX.

pvc_vlan_tx_op

string

SFP-DSL ADSL Fallback PVC VLAN TX op.

Choices:

  • "pass-through"

  • "replace"

  • "remove"

reachable_time

integer

IPv4 reachable time in milliseconds

redundant_interface

string

Redundant interface.

remote_ip

string

Remote ip.

replacemsg_override_group

string

Replacemsg override group.

retransmission

string

Retransmission.

Choices:

  • "disable"

  • "enable"

ring_rx

integer

Ring rx.

ring_tx

integer

Ring tx.

role

string

Role.

Choices:

  • "lan"

  • "wan"

  • "dmz"

  • "undefined"

sample_direction

string

Sample direction.

Choices:

  • "rx"

  • "tx"

  • "both"

sample_rate

integer

Sample rate.

scan_botnet_connections

string

Scan botnet connections.

Choices:

  • "disable"

  • "block"

  • "monitor"

secondary_IP

string

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

Ha priority.

id

integer

Id.

ip

string

Ip.

ping_serv_status

integer

Ping serv status.

secip_relay_ip

string

DHCP relay IP address.

seq

integer

Seq.

security_8021x_dynamic_vlan_id

integer

Security 8021x dynamic vlan id.

security_8021x_master

string

Security 8021x master.

security_8021x_member_mode

string

Choices:

  • "disable"

  • "switch"

security_8021x_mode

string

Security 8021x mode.

Choices:

  • "default"

  • "dynamic-vlan"

  • "fallback"

  • "slave"

security_exempt_list

string

Security exempt list.

security_external_logout

string

Security external logout.

security_external_web

string

Security external web.

security_groups

any

(list or str) Security groups.

security_ip_auth_bypass

string

Enable/disable IP authentication bypass.

Choices:

  • "disable"

  • "enable"

security_mac_auth_bypass

string

Security mac auth bypass.

Choices:

  • "disable"

  • "enable"

  • "mac-auth-only"

security_mode

string

Security mode.

Choices:

  • "none"

  • "captive-portal"

  • "802.1X"

security_redirect_url

string

Security redirect url.

select_profile_30a_35b

string

Select VDSL Profile 30a or 35b.

Choices:

  • "30A"

  • "35B"

service_name

string

Service name.

sflow_sampler

string

Sflow sampler.

Choices:

  • "disable"

  • "enable"

sfp_dsl

string

Enable/disable SFP DSL.

Choices:

  • "disable"

  • "enable"

sfp_dsl_adsl_fallback

string

Enable/disable SFP DSL ADSL fallback.

Choices:

  • "disable"

  • "enable"

sfp_dsl_autodetect

string

Enable/disable SFP DSL MAC address autodetect.

Choices:

  • "disable"

  • "enable"

sfp_dsl_mac

string

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

Spillover threshold.

src_check

string

Src check.

Choices:

  • "disable"

  • "enable"

status

string

Status.

Choices:

  • "down"

  • "up"

stp

string

Stp.

Choices:

  • "disable"

  • "enable"

stp_edge

string

Enable/disable as STP edge port.

Choices:

  • "disable"

  • "enable"

stp_ha_secondary

string

Control STP behaviour on HA secondary.

Choices:

  • "disable"

  • "enable"

  • "priority-adjust"

stp_ha_slave

string

Stp ha slave.

Choices:

  • "disable"

  • "enable"

  • "priority-adjust"

stpforward

string

Stpforward.

Choices:

  • "disable"

  • "enable"

stpforward_mode

string

Stpforward mode.

Choices:

  • "rpl-all-ext-id"

  • "rpl-bridge-ext-id"

  • "rpl-nothing"

strip_priority_vlan_tag

string

Strip priority vlan tag.

Choices:

  • "disable"

  • "enable"

subst

string

Subst.

Choices:

  • "disable"

  • "enable"

substitute_dst_mac

string

Substitute dst mac.

sw_algorithm

string

Frame distribution algorithm for switch.

Choices:

  • "l2"

  • "l3"

  • "eh"

  • "default"

swc_first_create

integer

Initial create for switch-controller VLANs.

swc_vlan

integer

Swc vlan.

switch

string

Switch.

switch_controller_access_vlan

string

Switch controller access vlan.

Choices:

  • "disable"

  • "enable"

switch_controller_arp_inspection

string

Switch controller arp inspection.

Choices:

  • "disable"

  • "enable"

  • "monitor"

switch_controller_auth

string

Switch controller auth.

Choices:

  • "radius"

  • "usergroup"

switch_controller_dhcp_snooping

string

Switch controller dhcp snooping.

Choices:

  • "disable"

  • "enable"

switch_controller_dhcp_snooping_option82

string

Switch controller dhcp snooping option82.

Choices:

  • "disable"

  • "enable"

switch_controller_dhcp_snooping_verify_mac

string

Switch controller dhcp snooping verify mac.

Choices:

  • "disable"

  • "enable"

switch_controller_dynamic

string

Integrated FortiLink settings for managed FortiSwitch.

switch_controller_feature

string

Switch controller feature.

Choices:

  • "none"

  • "default-vlan"

  • "quarantine"

  • "sniffer"

  • "voice"

  • "camera"

  • "rspan"

  • "video"

  • "nac"

  • "nac-segment"

switch_controller_igmp_snooping

string

Switch controller igmp snooping.

Choices:

  • "disable"

  • "enable"

switch_controller_igmp_snooping_fast_leave

string

Switch controller igmp snooping fast leave.

Choices:

  • "disable"

  • "enable"

switch_controller_igmp_snooping_proxy

string

Switch controller igmp snooping proxy.

Choices:

  • "disable"

  • "enable"

switch_controller_iot_scanning

string

Enable/disable managed FortiSwitch IoT scanning.

Choices:

  • "disable"

  • "enable"

switch_controller_learning_limit

integer

Switch controller learning limit.

switch_controller_mgmt_vlan

integer

Switch controller mgmt vlan.

switch_controller_nac

string

Switch controller nac.

switch_controller_netflow_collect

string

NetFlow collection and processing.

Choices:

  • "disable"

  • "enable"

switch_controller_offload

string

Enable/disable managed FortiSwitch routing offload.

Choices:

  • "disable"

  • "enable"

switch_controller_offload_gw

string

Enable/disable managed FortiSwitch routing offload gateway.

Choices:

  • "disable"

  • "enable"

switch_controller_offload_ip

string

IP for routing offload on FortiSwitch.

switch_controller_offloading

string

Switch controller offloading.

Choices:

  • "disable"

  • "enable"

switch_controller_offloading_gw

string

Switch controller offloading gw.

Choices:

  • "disable"

  • "enable"

switch_controller_offloading_ip

string

Switch controller offloading ip.

switch_controller_radius_server

string

Switch controller radius server.

switch_controller_rspan_mode

string

Switch controller rspan mode.

Choices:

  • "disable"

  • "enable"

switch_controller_source_ip

string

Source IP address used in FortiLink over L3 connections.

Choices:

  • "outbound"

  • "fixed"

switch_controller_traffic_policy

string

Switch controller traffic policy.

system_id

string

Define a system ID for the aggregate interface.

system_id_type

string

Method in which system ID is generated.

Choices:

  • "auto"

  • "user"

tc_mode

string

Tc mode.

Choices:

  • "ptm"

  • "atm"

tcp_mss

integer

Tcp mss.

trunk

string

Trunk.

Choices:

  • "disable"

  • "enable"

trust_ip6_1

string

Trust ip6 1.

trust_ip6_2

string

Trust ip6 2.

trust_ip6_3

string

Trust ip6 3.

trust_ip_1

string

Trust ip 1.

trust_ip_2

string

Trust ip 2.

trust_ip_3

string

Trust ip 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

Change the interfaces virtual MAC address.

vlan_id

integer

Vlan ID

vlan_op_mode

string

Configure DSL 802.

Choices:

  • "tag"

  • "untag"

  • "passthrough"

vlan_protocol

string

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

Accept mode.

Choices:

  • "disable"

  • "enable"

adv_interval

integer

Adv interval.

ignore_default_route

string

Ignore default route.

Choices:

  • "disable"

  • "enable"

preempt

string

Preempt.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority.

proxy_arp

list / elements=dictionary

Proxy arp.

id

integer

ID.

ip

string

Set IP addresses of proxy ARP.

start_time

integer

Start time.

status

string

Status.

Choices:

  • "disable"

  • "enable"

version

string

Version.

Choices:

  • "2"

  • "3"

vrdst

any

(list) Vrdst.

vrdst_priority

integer

Vrdst priority.

vrgrp

integer

Vrgrp.

vrid

integer

Vrid.

vrip

string

Vrip.

vrrp_virtual_mac

string

Vrrp virtual mac.

Choices:

  • "disable"

  • "enable"

wccp

string

Wccp.

Choices:

  • "disable"

  • "enable"

weight

integer

Weight.

wifi_5g_threshold

string

Wifi 5g threshold.

wifi_acl

string

Wifi acl.

Choices:

  • "deny"

  • "allow"

wifi_ap_band

string

Wifi ap band.

Choices:

  • "any"

  • "5g-preferred"

  • "5g-only"

wifi_auth

string

Wifi auth.

Choices:

  • "PSK"

  • "RADIUS"

  • "radius"

  • "usergroup"

wifi_auto_connect

string

Wifi auto connect.

Choices:

  • "disable"

  • "enable"

wifi_auto_save

string

Wifi auto save.

Choices:

  • "disable"

  • "enable"

wifi_broadcast_ssid

string

Wifi broadcast ssid.

Choices:

  • "disable"

  • "enable"

wifi_dns_server1

string

DNS server 1.

wifi_dns_server2

string

DNS server 2.

wifi_encrypt

string

Wifi encrypt.

Choices:

  • "TKIP"

  • "AES"

wifi_fragment_threshold

integer

Wifi fragment threshold.

wifi_gateway

string

IPv4 default gateway IP address.

wifi_key

any

(list) Wifi key.

wifi_keyindex

integer

Wifi keyindex.

wifi_mac_filter

string

Wifi mac filter.

Choices:

  • "disable"

  • "enable"

wifi_passphrase

any

(list) Wifi passphrase.

wifi_radius_server

string

Wifi radius server.

wifi_rts_threshold

integer

Wifi rts threshold.

wifi_security

string

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

Wifi ssid.

wifi_usergroup

string

Wifi usergroup.

wins_ip

string

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)