fmgr_fsp_vlan_interface – Configure interfaces.

New in version 2.10.

Synopsis

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

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
fsp_vlan_interface yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • adom - The parameter in requested url type: str required: true
  • vlan - The parameter in requested url type: str required: true
  • fsp_vlan_interface - no description type: dict
    • ac-name - No description for the parameter type: str more...
    • aggregate - No description for the parameter type: str more...
    • algorithm - No description for the parameter type: str choices: [L2, L3, L4, LB] more...
    • alias - No description for the parameter type: str more...
    • allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
    • ap-discover - No description for the parameter type: str choices: [disable, enable] more...
    • arpforward - No description for the parameter type: str choices: [disable, enable] more...
    • atm-protocol - No description for the parameter type: str choices: [none, ipoa] more...
    • auth-type - No description for the parameter type: str choices: [auto, pap, chap, mschapv1, mschapv2] more...
    • auto-auth-extension-device - No description for the parameter type: str choices: [disable, enable] more...
    • bfd - No description for the parameter type: str choices: [global, enable, disable] more...
    • bfd-desired-min-tx - No description for the parameter type: int more...
    • bfd-detect-mult - No description for the parameter type: int more...
    • bfd-required-min-rx - No description for the parameter type: int more...
    • broadcast-forticlient-discovery - No description for the parameter type: str choices: [disable, enable] more...
    • broadcast-forward - No description for the parameter type: str choices: [disable, enable] more...
    • captive-portal - No description for the parameter type: int more...
    • cli-conn-status - No description for the parameter type: int more...
    • color - No description for the parameter type: int more...
    • ddns - No description for the parameter type: str choices: [disable, enable] more...
    • ddns-auth - No description for the parameter type: str choices: [disable, tsig] more...
    • ddns-domain - No description for the parameter type: str more...
    • ddns-key - No description for the parameter type: str more...
    • ddns-keyname - No description for the parameter type: str more...
    • ddns-password - No description for the parameter type: str more...
    • ddns-server - No description for the parameter type: str choices: [dhs.org, dyndns.org, dyns.net, tzo.com, ods.org, vavic.com, now.net.cn, dipdns.net, easydns.com, genericDDNS] more...
    • ddns-server-ip - No description for the parameter type: str more...
    • ddns-sn - No description for the parameter type: str more...
    • ddns-ttl - No description for the parameter type: int more...
    • ddns-username - No description for the parameter type: str more...
    • ddns-zone - No description for the parameter type: str more...
    • dedicated-to - No description for the parameter type: str choices: [none, management] more...
    • defaultgw - No description for the parameter type: str choices: [disable, enable] more...
    • description - No description for the parameter type: str more...
    • detected-peer-mtu - No description for the parameter type: int more...
    • detectprotocol - No description for the parameter type: array choices: [ping, tcp-echo, udp-echo] more...
    • detectserver - No description for the parameter type: str more...
    • device-access-list - No description for the parameter type: str more...
    • device-identification - No description for the parameter type: str choices: [disable, enable] more...
    • device-identification-active-scan - No description for the parameter type: str choices: [disable, enable] more...
    • device-netscan - No description for the parameter type: str choices: [disable, enable] more...
    • device-user-identification - No description for the parameter type: str choices: [disable, enable] more...
    • devindex - No description for the parameter type: int more...
    • dhcp-client-identifier - No description for the parameter type: str more...
    • dhcp-relay-agent-option - No description for the parameter type: str choices: [disable, enable] more...
    • dhcp-relay-ip - No description for the parameter type: str more...
    • dhcp-relay-service - No description for the parameter type: str choices: [disable, enable] more...
    • dhcp-relay-type - No description for the parameter type: str choices: [regular, ipsec] more...
    • dhcp-renew-time - No description for the parameter type: int more...
    • disc-retry-timeout - No description for the parameter type: int more...
    • disconnect-threshold - No description for the parameter type: int more...
    • distance - No description for the parameter type: int more...
    • dns-query - No description for the parameter type: str choices: [disable, recursive, non-recursive] more...
    • dns-server-override - No description for the parameter type: str choices: [disable, enable] more...
    • drop-fragment - No description for the parameter type: str choices: [disable, enable] more...
    • drop-overlapped-fragment - No description for the parameter type: str choices: [disable, enable] more...
    • egress-cos - No description for the parameter type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7] more...
    • egress-shaping-profile - No description for the parameter type: str more...
    • endpoint-compliance - No description for the parameter type: str choices: [disable, enable] more...
    • estimated-downstream-bandwidth - No description for the parameter type: int more...
    • estimated-upstream-bandwidth - No description for the parameter type: int more...
    • explicit-ftp-proxy - No description for the parameter type: str choices: [disable, enable] more...
    • explicit-web-proxy - No description for the parameter type: str choices: [disable, enable] more...
    • external - No description for the parameter type: str choices: [disable, enable] more...
    • fail-action-on-extender - No description for the parameter type: str choices: [soft-restart, hard-restart, reboot] more...
    • fail-alert-interfaces - No description for the parameter type: str more...
    • fail-alert-method - No description for the parameter type: str choices: [link-failed-signal, link-down] more...
    • fail-detect - No description for the parameter type: str choices: [disable, enable] more...
    • fail-detect-option - No description for the parameter type: array choices: [detectserver, link-down] more...
    • fdp - No description for the parameter type: str choices: [disable, enable] more...
    • fortiheartbeat - No description for the parameter type: str choices: [disable, enable] more...
    • fortilink - No description for the parameter type: str choices: [disable, enable] more...
    • fortilink-backup-link - No description for the parameter type: int more...
    • fortilink-split-interface - No description for the parameter type: str choices: [disable, enable] more...
    • fortilink-stacking - No description for the parameter type: str choices: [disable, enable] more...
    • forward-domain - No description for the parameter type: int more...
    • forward-error-correction - No description for the parameter type: str choices: [disable, enable, rs-fec, base-r-fec, fec-cl91, fec-cl74, rs-544, none, cl91-rs-fec, cl74-fc-fec] more...
    • fp-anomaly - No description for the parameter type: array choices: [drop_tcp_fin_noack, pass_winnuke, pass_tcpland, pass_udpland, pass_icmpland, pass_ipland, pass_iprr, pass_ipssrr, pass_iplsrr, pass_ipstream, pass_ipsecurity, pass_iptimestamp, pass_ipunknown_option, pass_ipunknown_prot, pass_icmp_frag, pass_tcp_no_flag, pass_tcp_fin_noack, drop_winnuke, drop_tcpland, drop_udpland, drop_icmpland, drop_ipland, drop_iprr, drop_ipssrr, drop_iplsrr, drop_ipstream, drop_ipsecurity, drop_iptimestamp, drop_ipunknown_option, drop_ipunknown_prot, drop_icmp_frag, drop_tcp_no_flag] more...
    • fp-disable - No description for the parameter type: array choices: [all, ipsec, none] more...
    • gateway-address - No description for the parameter type: str more...
    • gi-gk - No description for the parameter type: str choices: [disable, enable] more...
    • gwaddr - No description for the parameter type: str more...
    • gwdetect - No description for the parameter type: str choices: [disable, enable] more...
    • ha-priority - No description for the parameter type: int more...
    • icmp-accept-redirect - No description for the parameter type: str choices: [disable, enable] more...
    • icmp-redirect - No description for the parameter type: str choices: [disable, enable] more...
    • icmp-send-redirect - No description for the parameter type: str choices: [disable, enable] more...
    • ident-accept - No description for the parameter type: str choices: [disable, enable] more...
    • idle-timeout - No description for the parameter type: int more...
    • if-mdix - No description for the parameter type: str choices: [auto, normal, crossover] more...
    • if-media - No description for the parameter type: str choices: [auto, copper, fiber] more...
    • in-force-vlan-cos - No description for the parameter type: int more...
    • inbandwidth - No description for the parameter type: int more...
    • ingress-cos - No description for the parameter type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7] more...
    • ingress-spillover-threshold - No description for the parameter type: int more...
    • internal - No description for the parameter type: int more...
    • ip - No description for the parameter type: str more...
    • ipmac - No description for the parameter type: str choices: [disable, enable] more...
    • ips-sniffer-mode - No description for the parameter type: str choices: [disable, enable] more...
    • ipunnumbered - No description for the parameter type: str more...
    • ipv6 type: dict
      • autoconf - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-client-options - No description for the parameter type: array choices: [rapid, iapd, iana, dns, dnsname] more...
      • dhcp6-information-request - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-prefix-delegation - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-prefix-hint - No description for the parameter type: str more...
      • dhcp6-prefix-hint-plt - No description for the parameter type: int more...
      • dhcp6-prefix-hint-vlt - No description for the parameter type: int more...
      • dhcp6-relay-ip - No description for the parameter type: str more...
      • dhcp6-relay-service - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-relay-type - No description for the parameter type: str choices: [regular] more...
      • ip6-address - No description for the parameter type: str more...
      • ip6-allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...
      • ip6-default-life - No description for the parameter type: int more...
      • ip6-dns-server-override - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-hop-limit - No description for the parameter type: int more...
      • ip6-link-mtu - No description for the parameter type: int more...
      • ip6-manage-flag - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-max-interval - No description for the parameter type: int more...
      • ip6-min-interval - No description for the parameter type: int more...
      • ip6-mode - No description for the parameter type: str choices: [static, dhcp, pppoe, delegated] more...
      • ip6-other-flag - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-reachable-time - No description for the parameter type: int more...
      • ip6-retrans-time - No description for the parameter type: int more...
      • ip6-send-adv - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-subnet - No description for the parameter type: str more...
      • ip6-upstream-interface - No description for the parameter type: str more...
      • nd-cert - No description for the parameter type: str more...
      • nd-cga-modifier - No description for the parameter type: str more...
      • nd-mode - No description for the parameter type: str choices: [basic, SEND-compatible] more...
      • nd-security-level - No description for the parameter type: int more...
      • nd-timestamp-delta - No description for the parameter type: int more...
      • nd-timestamp-fuzz - No description for the parameter type: int more...
      • vrip6_link_local - No description for the parameter type: str more...
      • vrrp-virtual-mac6 - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-delegated-prefix-list - No description for the parameter type: array more...
        • autonomous-flag - No description for the parameter type: str choices: [disable, enable] more...
        • onlink-flag - No description for the parameter type: str choices: [disable, enable] more...
        • prefix-id - No description for the parameter type: int more...
        • rdnss - No description for the parameter type: str more...
        • rdnss-service - No description for the parameter type: str choices: [delegated, default, specify] more...
        • subnet - No description for the parameter type: str more...
        • upstream-interface - No description for the parameter type: str more...
        • delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
      • ip6-extra-addr - No description for the parameter type: array more...
        • prefix - No description for the parameter type: str more...
      • ip6-prefix-list - No description for the parameter type: array more...
        • autonomous-flag - No description for the parameter type: str choices: [disable, enable] more...
        • dnssl - No description for the parameter type: str more...
        • onlink-flag - No description for the parameter type: str choices: [disable, enable] more...
        • preferred-life-time - No description for the parameter type: int more...
        • prefix - No description for the parameter type: str more...
        • rdnss - No description for the parameter type: str more...
        • valid-life-time - No description for the parameter type: int more...
      • vrrp6 - No description for the parameter type: array more...
        • accept-mode - No description for the parameter type: str choices: [disable, enable] more...
        • adv-interval - No description for the parameter type: int more...
        • preempt - No description for the parameter type: str choices: [disable, enable] more...
        • priority - No description for the parameter type: int more...
        • start-time - No description for the parameter type: int more...
        • status - No description for the parameter type: str choices: [disable, enable] more...
        • vrdst6 - No description for the parameter type: str more...
        • vrgrp - No description for the parameter type: int more...
        • vrid - No description for the parameter type: int more...
        • vrip6 - No description for the parameter type: str more...
      • interface-identifier - No description for the parameter type: str more...
      • unique-autoconf-addr - No description for the parameter type: str choices: [disable, enable] more...
      • icmp6-send-redirect - Enable/disable sending of ICMPv6 redirects. type: str choices: [disable, enable] more...
      • cli-conn6-status - No description for the parameter type: int more...
      • ip6-prefix-mode - Assigning a prefix from DHCP or RA. type: str choices: [dhcp6, ra] more...
      • ra-send-mtu - Enable/disable sending link MTU in RA packet. type: str choices: [disable, enable] more...
      • ip6-delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
    • l2forward - No description for the parameter type: str choices: [disable, enable] more...
    • l2tp-client - No description for the parameter type: str choices: [disable, enable] more...
    • lacp-ha-slave - No description for the parameter type: str choices: [disable, enable] more...
    • lacp-mode - No description for the parameter type: str choices: [static, passive, active] more...
    • lacp-speed - No description for the parameter type: str choices: [slow, fast] more...
    • lcp-echo-interval - No description for the parameter type: int more...
    • lcp-max-echo-fails - No description for the parameter type: int more...
    • link-up-delay - No description for the parameter type: int more...
    • listen-forticlient-connection - No description for the parameter type: str choices: [disable, enable] more...
    • lldp-network-policy - No description for the parameter type: str more...
    • lldp-reception - No description for the parameter type: str choices: [disable, enable, vdom] more...
    • lldp-transmission - No description for the parameter type: str choices: [enable, disable, vdom] more...
    • log - No description for the parameter type: str choices: [disable, enable] more...
    • macaddr - No description for the parameter type: str more...
    • management-ip - No description for the parameter type: str more...
    • max-egress-burst-rate - No description for the parameter type: int more...
    • max-egress-rate - No description for the parameter type: int more...
    • mediatype - No description for the parameter type: str choices: [serdes-sfp, sgmii-sfp, cfp2-sr10, cfp2-lr4, serdes-copper-sfp, sr, cr, lr, qsfp28-sr4, qsfp28-lr4, qsfp28-cr4, sr4, cr4, lr4, none, gmii, sgmii] more...
    • member - No description for the parameter type: str more...
    • min-links - No description for the parameter type: int more...
    • min-links-down - No description for the parameter type: str choices: [operational, administrative] more...
    • mode - No description for the parameter type: str choices: [static, dhcp, pppoe, pppoa, ipoa, eoa] more...
    • mtu - No description for the parameter type: int more...
    • mtu-override - No description for the parameter type: str choices: [disable, enable] more...
    • mux-type - No description for the parameter type: str choices: [llc-encaps, vc-encaps] more...
    • name - No description for the parameter type: str more...
    • ndiscforward - No description for the parameter type: str choices: [disable, enable] more...
    • netbios-forward - No description for the parameter type: str choices: [disable, enable] more...
    • netflow-sampler - No description for the parameter type: str choices: [disable, tx, rx, both] more...
    • npu-fastpath - No description for the parameter type: str choices: [disable, enable] more...
    • nst - No description for the parameter type: str choices: [disable, enable] more...
    • out-force-vlan-cos - No description for the parameter type: int more...
    • outbandwidth - No description for the parameter type: int more...
    • padt-retry-timeout - No description for the parameter type: int more...
    • password - No description for the parameter type: str more...
    • peer-interface - No description for the parameter type: str more...
    • phy-mode - No description for the parameter type: str choices: [auto, adsl, vdsl, adsl-auto, vdsl2, adsl2+, adsl2, g.dmt, t1.413, g.lite] more...
    • ping-serv-status - No description for the parameter type: int more...
    • poe - No description for the parameter type: str choices: [disable, enable] more...
    • polling-interval - No description for the parameter type: int more...
    • pppoe-unnumbered-negotiate - No description for the parameter type: str choices: [disable, enable] more...
    • pptp-auth-type - No description for the parameter type: str choices: [auto, pap, chap, mschapv1, mschapv2] more...
    • pptp-client - No description for the parameter type: str choices: [disable, enable] more...
    • pptp-password - No description for the parameter type: str more...
    • pptp-server-ip - No description for the parameter type: str more...
    • pptp-timeout - No description for the parameter type: int more...
    • pptp-user - No description for the parameter type: str more...
    • preserve-session-route - No description for the parameter type: str choices: [disable, enable] more...
    • priority - No description for the parameter type: int more...
    • priority-override - No description for the parameter type: str choices: [disable, enable] more...
    • proxy-captive-portal - No description for the parameter type: str choices: [disable, enable] more...
    • redundant-interface - No description for the parameter type: str more...
    • remote-ip - No description for the parameter type: str more...
    • replacemsg-override-group - No description for the parameter type: str more...
    • retransmission - No description for the parameter type: str choices: [disable, enable] more...
    • role - No description for the parameter type: str choices: [lan, wan, dmz, undefined] more...
    • sample-direction - No description for the parameter type: str choices: [rx, tx, both] more...
    • sample-rate - No description for the parameter type: int more...
    • scan-botnet-connections - No description for the parameter type: str choices: [disable, block, monitor] more...
    • secondary-IP - No description for the parameter type: str choices: [disable, enable] more...
    • secondaryip - No description for the parameter type: array more...
      • allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
      • detectprotocol - No description for the parameter type: array choices: [ping, tcp-echo, udp-echo] more...
      • detectserver - No description for the parameter type: str more...
      • gwdetect - No description for the parameter type: str choices: [disable, enable] more...
      • ha-priority - No description for the parameter type: int more...
      • id - No description for the parameter type: int more...
      • ip - No description for the parameter type: str more...
      • ping-serv-status - No description for the parameter type: int more...
      • seq - No description for the parameter type: int more...
    • security-8021x-dynamic-vlan-id - No description for the parameter type: int more...
    • security-8021x-master - No description for the parameter type: str more...
    • security-8021x-mode - No description for the parameter type: str choices: [default, dynamic-vlan, fallback, slave] more...
    • security-exempt-list - No description for the parameter type: str more...
    • security-external-logout - No description for the parameter type: str more...
    • security-external-web - No description for the parameter type: str more...
    • security-groups - No description for the parameter type: str more...
    • security-mac-auth-bypass - No description for the parameter type: str choices: [disable, enable, mac-auth-only] more...
    • security-mode - No description for the parameter type: str choices: [none, captive-portal, 802.1X] more...
    • security-redirect-url - No description for the parameter type: str more...
    • service-name - No description for the parameter type: str more...
    • sflow-sampler - No description for the parameter type: str choices: [disable, enable] more...
    • speed - No description for the parameter type: str choices: [auto, 10full, 10half, 100full, 100half, 1000full, 1000half, 10000full, 1000auto, 10000auto, 40000full, 100Gfull, 25000full, 40000auto, 25000auto, 100Gauto, 400Gfull, 400Gauto] more...
    • spillover-threshold - No description for the parameter type: int more...
    • src-check - No description for the parameter type: str choices: [disable, enable] more...
    • status - No description for the parameter type: str choices: [down, up] more...
    • stp - No description for the parameter type: str choices: [disable, enable] more...
    • stp-ha-slave - No description for the parameter type: str choices: [disable, enable, priority-adjust] more...
    • stpforward - No description for the parameter type: str choices: [disable, enable] more...
    • stpforward-mode - No description for the parameter type: str choices: [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing] more...
    • strip-priority-vlan-tag - No description for the parameter type: str choices: [disable, enable] more...
    • subst - No description for the parameter type: str choices: [disable, enable] more...
    • substitute-dst-mac - No description for the parameter type: str more...
    • switch - No description for the parameter type: str more...
    • switch-controller-access-vlan - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-arp-inspection - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-auth - No description for the parameter type: str choices: [radius, usergroup] more...
    • switch-controller-dhcp-snooping - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-dhcp-snooping-option82 - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-dhcp-snooping-verify-mac - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-igmp-snooping - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-learning-limit - No description for the parameter type: int more...
    • switch-controller-radius-server - No description for the parameter type: str more...
    • switch-controller-traffic-policy - No description for the parameter type: str more...
    • tc-mode - No description for the parameter type: str choices: [ptm, atm] more...
    • tcp-mss - No description for the parameter type: int more...
    • trunk - No description for the parameter type: str choices: [disable, enable] more...
    • trust-ip-1 - No description for the parameter type: str more...
    • trust-ip-2 - No description for the parameter type: str more...
    • trust-ip-3 - No description for the parameter type: str more...
    • trust-ip6-1 - No description for the parameter type: str more...
    • trust-ip6-2 - No description for the parameter type: str more...
    • trust-ip6-3 - No description for the parameter type: str more...
    • type - No description for the parameter type: str choices: [physical, vlan, aggregate, redundant, tunnel, wireless, vdom-link, loopback, switch, hard-switch, hdlc, vap-switch, wl-mesh, fortilink, switch-vlan, fctrl-trunk, tdm, fext-wan, vxlan, emac-vlan, geneve, ssl, lan-extension] more...
    • username - No description for the parameter type: str more...
    • vci - No description for the parameter type: int more...
    • vectoring - No description for the parameter type: str choices: [disable, enable] more...
    • vindex - No description for the parameter type: int more...
    • vlanforward - No description for the parameter type: str choices: [disable, enable] more...
    • vlanid - No description for the parameter type: int more...
    • vpi - No description for the parameter type: int more...
    • vrf - No description for the parameter type: int more...
    • vrrp - No description for the parameter type: array more...
      • accept-mode - No description for the parameter type: str choices: [disable, enable] more...
      • adv-interval - No description for the parameter type: int more...
      • ignore-default-route - No description for the parameter type: str choices: [disable, enable] more...
      • preempt - No description for the parameter type: str choices: [disable, enable] more...
      • priority - No description for the parameter type: int more...
      • start-time - No description for the parameter type: int more...
      • status - No description for the parameter type: str choices: [disable, enable] more...
      • version - No description for the parameter type: str choices: [2, 3] more...
      • vrdst - No description for the parameter type: str more...
      • vrdst-priority - No description for the parameter type: int more...
      • vrgrp - No description for the parameter type: int more...
      • vrid - No description for the parameter type: int more...
      • vrip - No description for the parameter type: str more...
    • vrrp-virtual-mac - No description for the parameter type: str choices: [disable, enable] more...
    • wccp - No description for the parameter type: str choices: [disable, enable] more...
    • weight - No description for the parameter type: int more...
    • wifi-5g-threshold - No description for the parameter type: str more...
    • wifi-acl - No description for the parameter type: str choices: [deny, allow] more...
    • wifi-ap-band - No description for the parameter type: str choices: [any, 5g-preferred, 5g-only] more...
    • wifi-auth - No description for the parameter type: str choices: [PSK, RADIUS, radius, usergroup] more...
    • wifi-auto-connect - No description for the parameter type: str choices: [disable, enable] more...
    • wifi-auto-save - No description for the parameter type: str choices: [disable, enable] more...
    • wifi-broadcast-ssid - No description for the parameter type: str choices: [disable, enable] more...
    • wifi-encrypt - No description for the parameter type: str choices: [TKIP, AES] more...
    • wifi-fragment-threshold - No description for the parameter type: int more...
    • wifi-key - No description for the parameter type: str more...
    • wifi-keyindex - No description for the parameter type: int more...
    • wifi-mac-filter - No description for the parameter type: str choices: [disable, enable] more...
    • wifi-passphrase - No description for the parameter type: str more...
    • wifi-radius-server - No description for the parameter type: str more...
    • wifi-rts-threshold - No description for the parameter type: int more...
    • wifi-security - No description for the parameter type: str choices: [None, WEP64, wep64, WEP128, wep128, WPA_PSK, WPA_RADIUS, WPA, WPA2, WPA2_AUTO, open, wpa-personal, wpa-enterprise, wpa-only-personal, wpa-only-enterprise, wpa2-only-personal, wpa2-only-enterprise] more...
    • wifi-ssid - No description for the parameter type: str more...
    • wifi-usergroup - No description for the parameter type: str more...
    • wins-ip - No description for the parameter type: str more...
    • eip - No description for the parameter type: str more...
    • fortilink-neighbor-detect - No description for the parameter type: str choices: [lldp, fortilink] more...
    • ingress-shaping-profile - No description for the parameter type: str more...
    • ring-rx - No description for the parameter type: int more...
    • ring-tx - No description for the parameter type: int more...
    • switch-controller-igmp-snooping-fast-leave - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-igmp-snooping-proxy - No description for the parameter type: str choices: [disable, enable] more...
    • switch-controller-rspan-mode - No description for the parameter type: str choices: [disable, enable] more...
    • bandwidth-measure-time - No description for the parameter type: int more...
    • ip-managed-by-fortiipam - No description for the parameter type: str choices: [disable, enable] more...
    • managed-subnetwork-size - No description for the parameter type: str choices: [256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 32, 64, 128] more...
    • measured-downstream-bandwidth - No description for the parameter type: int more...
    • measured-upstream-bandwidth - No description for the parameter type: int more...
    • monitor-bandwidth - No description for the parameter type: str choices: [disable, enable] more...
    • swc-vlan - No description for the parameter type: int more...
    • switch-controller-feature - No description for the parameter type: str choices: [none, default-vlan, quarantine, sniffer, voice, camera, rspan, video, nac, nac-segment] more...
    • switch-controller-mgmt-vlan - No description for the parameter type: int more...
    • switch-controller-nac - No description for the parameter type: str more...
    • vlan-protocol - No description for the parameter type: str choices: [8021q, 8021ad] more...
    • dhcp-relay-interface - No description for the parameter type: str more...
    • dhcp-relay-interface-select-method - No description for the parameter type: str choices: [auto, sdwan, specify] more...
    • np-qos-profile - No description for the parameter type: int more...
    • swc-first-create - Initial create for switch-controller VLANs. type: int more...
    • switch-controller-iot-scanning - Enable/disable managed FortiSwitch IoT scanning. type: str choices: [disable, enable] more...
    • switch-controller-source-ip - Source IP address used in FortiLink over L3 connections. type: str choices: [outbound, fixed] more...
    • dhcp-relay-request-all-server - Enable/disable sending of DHCP requests to all servers. type: str choices: [disable, enable] more...
    • stp-ha-secondary - Control STP behaviour on HA secondary. type: str choices: [disable, enable, priority-adjust] more...
    • switch-controller-dynamic - Integrated FortiLink settings for managed FortiSwitch. type: str more...
    • auth-cert - HTTPS server certificate. type: str more...
    • auth-portal-addr - Address of captive portal. type: str more...
    • dhcp-classless-route-addition - Enable/disable addition of classless static routes retrieved from DHCP server. type: str choices: [disable, enable] more...
    • dhcp-relay-link-selection - DHCP relay link selection. type: str more...
    • dns-server-protocol - No description for the parameter type: array choices: [cleartext, dot, doh] more...
    • eap-ca-cert - EAP CA certificate name. type: str more...
    • eap-identity - EAP identity. type: str more...
    • eap-method - EAP method. type: str choices: [tls, peap] more...
    • eap-password - No description for the parameter type: str more...
    • eap-supplicant - Enable/disable EAP-Supplicant. type: str choices: [disable, enable] more...
    • eap-user-cert - EAP user certificate name. type: str more...
    • ike-saml-server - Configure IKE authentication SAML server. type: str more...
    • lacp-ha-secondary - No description for the parameter type: str choices: [disable, enable] more...
    • pvc-atm-qos - SFP-DSL ADSL Fallback PVC ATM QoS. type: str choices: [cbr, rt-vbr, nrt-vbr] more...
    • pvc-chan - SFP-DSL ADSL Fallback PVC Channel. type: int more...
    • pvc-crc - SFP-DSL ADSL Fallback PVC CRC Option: bit0: sar LLC preserve, bit1: ream LLC preserve, bit2: ream VC-MUX has crc. type: int more...
    • pvc-pcr - SFP-DSL ADSL Fallback PVC Packet Cell Rate in cells (0 - 5500). type: int more...
    • pvc-scr - SFP-DSL ADSL Fallback PVC Sustainable Cell Rate in cells (0 - 5500). type: int more...
    • pvc-vlan-id - SFP-DSL ADSL Fallback PVC VLAN ID. type: int more...
    • pvc-vlan-rx-id - SFP-DSL ADSL Fallback PVC VLANID RX. type: int more...
    • pvc-vlan-rx-op - SFP-DSL ADSL Fallback PVC VLAN RX op. type: str choices: [pass-through, replace, remove] more...
    • pvc-vlan-tx-id - SFP-DSL ADSL Fallback PVC VLAN ID TX. type: int more...
    • pvc-vlan-tx-op - SFP-DSL ADSL Fallback PVC VLAN TX op. type: str choices: [pass-through, replace, remove] more...
    • reachable-time - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000). type: int more...
    • select-profile-30a-35b - No description for the parameter type: str choices: [30A, 35B] more...
    • sfp-dsl - Enable/disable SFP DSL. type: str choices: [disable, enable] more...
    • sfp-dsl-adsl-fallback - Enable/disable SFP DSL ADSL fallback. type: str choices: [disable, enable] more...
    • sfp-dsl-autodetect - Enable/disable SFP DSL MAC address autodetect. type: str choices: [disable, enable] more...
    • sfp-dsl-mac - SFP DSL MAC address. type: str more...
    • sw-algorithm - Frame distribution algorithm for switch. type: str choices: [l2, l3, eh] more...
    • system-id - Define a system ID for the aggregate interface. type: str more...
    • system-id-type - Method in which system ID is generated. type: str choices: [auto, user] more...
    • vlan-id - No description for the parameter type: int more...
    • vlan-op-mode - No description for the parameter type: str choices: [tag, untag, passthrough] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_fsp_vlan_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: <value of string>
           aggregate: <value of string>
           algorithm: <value in [L2, L3, L4, ...]>
           alias: <value of string>
           allowaccess:
             - https
             - ping
             - ssh
             - snmp
             - http
             - telnet
             - fgfm
             - auto-ipsec
             - radius-acct
             - probe-response
             - capwap
             - dnp
             - ftm
             - fabric
             - speed-test
           ap-discover: <value in [disable, enable]>
           arpforward: <value in [disable, enable]>
           atm-protocol: <value in [none, ipoa]>
           auth-type: <value in [auto, pap, chap, ...]>
           auto-auth-extension-device: <value in [disable, enable]>
           bfd: <value in [global, enable, disable]>
           bfd-desired-min-tx: <value of integer>
           bfd-detect-mult: <value of integer>
           bfd-required-min-rx: <value of integer>
           broadcast-forticlient-discovery: <value in [disable, enable]>
           broadcast-forward: <value in [disable, enable]>
           captive-portal: <value of integer>
           cli-conn-status: <value of integer>
           color: <value of integer>
           ddns: <value in [disable, enable]>
           ddns-auth: <value in [disable, tsig]>
           ddns-domain: <value of string>
           ddns-key: <value of string>
           ddns-keyname: <value of string>
           ddns-password: <value of string>
           ddns-server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
           ddns-server-ip: <value of string>
           ddns-sn: <value of string>
           ddns-ttl: <value of integer>
           ddns-username: <value of string>
           ddns-zone: <value of string>
           dedicated-to: <value in [none, management]>
           defaultgw: <value in [disable, enable]>
           description: <value of string>
           detected-peer-mtu: <value of integer>
           detectprotocol:
             - ping
             - tcp-echo
             - udp-echo
           detectserver: <value of string>
           device-access-list: <value of string>
           device-identification: <value in [disable, enable]>
           device-identification-active-scan: <value in [disable, enable]>
           device-netscan: <value in [disable, enable]>
           device-user-identification: <value in [disable, enable]>
           devindex: <value of integer>
           dhcp-client-identifier: <value of string>
           dhcp-relay-agent-option: <value in [disable, enable]>
           dhcp-relay-ip: <value of string>
           dhcp-relay-service: <value in [disable, enable]>
           dhcp-relay-type: <value in [regular, ipsec]>
           dhcp-renew-time: <value of integer>
           disc-retry-timeout: <value of integer>
           disconnect-threshold: <value of integer>
           distance: <value of integer>
           dns-query: <value in [disable, recursive, non-recursive]>
           dns-server-override: <value in [disable, enable]>
           drop-fragment: <value in [disable, enable]>
           drop-overlapped-fragment: <value in [disable, enable]>
           egress-cos: <value in [disable, cos0, cos1, ...]>
           egress-shaping-profile: <value of string>
           endpoint-compliance: <value in [disable, enable]>
           estimated-downstream-bandwidth: <value of integer>
           estimated-upstream-bandwidth: <value of integer>
           explicit-ftp-proxy: <value in [disable, enable]>
           explicit-web-proxy: <value in [disable, enable]>
           external: <value in [disable, enable]>
           fail-action-on-extender: <value in [soft-restart, hard-restart, reboot]>
           fail-alert-interfaces: <value of string>
           fail-alert-method: <value in [link-failed-signal, link-down]>
           fail-detect: <value in [disable, enable]>
           fail-detect-option:
             - detectserver
             - link-down
           fdp: <value in [disable, enable]>
           fortiheartbeat: <value in [disable, enable]>
           fortilink: <value in [disable, enable]>
           fortilink-backup-link: <value of integer>
           fortilink-split-interface: <value in [disable, enable]>
           fortilink-stacking: <value in [disable, enable]>
           forward-domain: <value of integer>
           forward-error-correction: <value in [disable, enable, rs-fec, ...]>
           fp-anomaly:
             - drop_tcp_fin_noack
             - pass_winnuke
             - pass_tcpland
             - pass_udpland
             - pass_icmpland
             - pass_ipland
             - pass_iprr
             - pass_ipssrr
             - pass_iplsrr
             - pass_ipstream
             - pass_ipsecurity
             - pass_iptimestamp
             - pass_ipunknown_option
             - pass_ipunknown_prot
             - pass_icmp_frag
             - pass_tcp_no_flag
             - pass_tcp_fin_noack
             - drop_winnuke
             - drop_tcpland
             - drop_udpland
             - drop_icmpland
             - drop_ipland
             - drop_iprr
             - drop_ipssrr
             - drop_iplsrr
             - drop_ipstream
             - drop_ipsecurity
             - drop_iptimestamp
             - drop_ipunknown_option
             - drop_ipunknown_prot
             - drop_icmp_frag
             - drop_tcp_no_flag
           fp-disable:
             - all
             - ipsec
             - none
           gateway-address: <value of string>
           gi-gk: <value in [disable, enable]>
           gwaddr: <value of string>
           gwdetect: <value in [disable, enable]>
           ha-priority: <value of integer>
           icmp-accept-redirect: <value in [disable, enable]>
           icmp-redirect: <value in [disable, enable]>
           icmp-send-redirect: <value in [disable, enable]>
           ident-accept: <value in [disable, enable]>
           idle-timeout: <value of integer>
           if-mdix: <value in [auto, normal, crossover]>
           if-media: <value in [auto, copper, fiber]>
           in-force-vlan-cos: <value of integer>
           inbandwidth: <value of integer>
           ingress-cos: <value in [disable, cos0, cos1, ...]>
           ingress-spillover-threshold: <value of integer>
           internal: <value of integer>
           ip: <value of string>
           ipmac: <value in [disable, enable]>
           ips-sniffer-mode: <value in [disable, enable]>
           ipunnumbered: <value of string>
           ipv6:
              autoconf: <value in [disable, enable]>
              dhcp6-client-options:
                - rapid
                - iapd
                - iana
                - dns
                - dnsname
              dhcp6-information-request: <value in [disable, enable]>
              dhcp6-prefix-delegation: <value in [disable, enable]>
              dhcp6-prefix-hint: <value of string>
              dhcp6-prefix-hint-plt: <value of integer>
              dhcp6-prefix-hint-vlt: <value of integer>
              dhcp6-relay-ip: <value of string>
              dhcp6-relay-service: <value in [disable, enable]>
              dhcp6-relay-type: <value in [regular]>
              ip6-address: <value of string>
              ip6-allowaccess:
                - https
                - ping
                - ssh
                - snmp
                - http
                - telnet
                - fgfm
                - capwap
                - fabric
              ip6-default-life: <value of integer>
              ip6-dns-server-override: <value in [disable, enable]>
              ip6-hop-limit: <value of integer>
              ip6-link-mtu: <value of integer>
              ip6-manage-flag: <value in [disable, enable]>
              ip6-max-interval: <value of integer>
              ip6-min-interval: <value of integer>
              ip6-mode: <value in [static, dhcp, pppoe, ...]>
              ip6-other-flag: <value in [disable, enable]>
              ip6-reachable-time: <value of integer>
              ip6-retrans-time: <value of integer>
              ip6-send-adv: <value in [disable, enable]>
              ip6-subnet: <value of string>
              ip6-upstream-interface: <value of string>
              nd-cert: <value of string>
              nd-cga-modifier: <value of string>
              nd-mode: <value in [basic, SEND-compatible]>
              nd-security-level: <value of integer>
              nd-timestamp-delta: <value of integer>
              nd-timestamp-fuzz: <value of integer>
              vrip6_link_local: <value of 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: <value of integer>
                    rdnss: <value of string>
                    rdnss-service: <value in [delegated, default, specify]>
                    subnet: <value of string>
                    upstream-interface: <value of string>
                    delegated-prefix-iaid: <value of integer>
              ip6-extra-addr:
                -
                    prefix: <value of string>
              ip6-prefix-list:
                -
                    autonomous-flag: <value in [disable, enable]>
                    dnssl: <value of string>
                    onlink-flag: <value in [disable, enable]>
                    preferred-life-time: <value of integer>
                    prefix: <value of string>
                    rdnss: <value of string>
                    valid-life-time: <value of integer>
              vrrp6:
                -
                    accept-mode: <value in [disable, enable]>
                    adv-interval: <value of integer>
                    preempt: <value in [disable, enable]>
                    priority: <value of integer>
                    start-time: <value of integer>
                    status: <value in [disable, enable]>
                    vrdst6: <value of string>
                    vrgrp: <value of integer>
                    vrid: <value of integer>
                    vrip6: <value of string>
              interface-identifier: <value of string>
              unique-autoconf-addr: <value in [disable, enable]>
              icmp6-send-redirect: <value in [disable, enable]>
              cli-conn6-status: <value of integer>
              ip6-prefix-mode: <value in [dhcp6, ra]>
              ra-send-mtu: <value in [disable, enable]>
              ip6-delegated-prefix-iaid: <value of integer>
           l2forward: <value in [disable, enable]>
           l2tp-client: <value in [disable, enable]>
           lacp-ha-slave: <value in [disable, enable]>
           lacp-mode: <value in [static, passive, active]>
           lacp-speed: <value in [slow, fast]>
           lcp-echo-interval: <value of integer>
           lcp-max-echo-fails: <value of integer>
           link-up-delay: <value of integer>
           listen-forticlient-connection: <value in [disable, enable]>
           lldp-network-policy: <value of string>
           lldp-reception: <value in [disable, enable, vdom]>
           lldp-transmission: <value in [enable, disable, vdom]>
           log: <value in [disable, enable]>
           macaddr: <value of string>
           management-ip: <value of string>
           max-egress-burst-rate: <value of integer>
           max-egress-rate: <value of integer>
           mediatype: <value in [serdes-sfp, sgmii-sfp, cfp2-sr10, ...]>
           member: <value of string>
           min-links: <value of integer>
           min-links-down: <value in [operational, administrative]>
           mode: <value in [static, dhcp, pppoe, ...]>
           mtu: <value of integer>
           mtu-override: <value in [disable, enable]>
           mux-type: <value in [llc-encaps, vc-encaps]>
           name: <value of string>
           ndiscforward: <value in [disable, enable]>
           netbios-forward: <value in [disable, enable]>
           netflow-sampler: <value in [disable, tx, rx, ...]>
           npu-fastpath: <value in [disable, enable]>
           nst: <value in [disable, enable]>
           out-force-vlan-cos: <value of integer>
           outbandwidth: <value of integer>
           padt-retry-timeout: <value of integer>
           password: <value of string>
           peer-interface: <value of string>
           phy-mode: <value in [auto, adsl, vdsl, ...]>
           ping-serv-status: <value of integer>
           poe: <value in [disable, enable]>
           polling-interval: <value of integer>
           pppoe-unnumbered-negotiate: <value in [disable, enable]>
           pptp-auth-type: <value in [auto, pap, chap, ...]>
           pptp-client: <value in [disable, enable]>
           pptp-password: <value of string>
           pptp-server-ip: <value of string>
           pptp-timeout: <value of integer>
           pptp-user: <value of string>
           preserve-session-route: <value in [disable, enable]>
           priority: <value of integer>
           priority-override: <value in [disable, enable]>
           proxy-captive-portal: <value in [disable, enable]>
           redundant-interface: <value of string>
           remote-ip: <value of string>
           replacemsg-override-group: <value of string>
           retransmission: <value in [disable, enable]>
           role: <value in [lan, wan, dmz, ...]>
           sample-direction: <value in [rx, tx, both]>
           sample-rate: <value of integer>
           scan-botnet-connections: <value in [disable, block, monitor]>
           secondary-IP: <value in [disable, enable]>
           secondaryip:
             -
                 allowaccess:
                   - https
                   - ping
                   - ssh
                   - snmp
                   - http
                   - telnet
                   - fgfm
                   - auto-ipsec
                   - radius-acct
                   - probe-response
                   - capwap
                   - dnp
                   - ftm
                   - fabric
                   - speed-test
                 detectprotocol:
                   - ping
                   - tcp-echo
                   - udp-echo
                 detectserver: <value of string>
                 gwdetect: <value in [disable, enable]>
                 ha-priority: <value of integer>
                 id: <value of integer>
                 ip: <value of string>
                 ping-serv-status: <value of integer>
                 seq: <value of integer>
           security-8021x-dynamic-vlan-id: <value of integer>
           security-8021x-master: <value of string>
           security-8021x-mode: <value in [default, dynamic-vlan, fallback, ...]>
           security-exempt-list: <value of string>
           security-external-logout: <value of string>
           security-external-web: <value of string>
           security-groups: <value of string>
           security-mac-auth-bypass: <value in [disable, enable, mac-auth-only]>
           security-mode: <value in [none, captive-portal, 802.1X]>
           security-redirect-url: <value of string>
           service-name: <value of string>
           sflow-sampler: <value in [disable, enable]>
           speed: <value in [auto, 10full, 10half, ...]>
           spillover-threshold: <value of integer>
           src-check: <value in [disable, enable]>
           status: <value in [down, up]>
           stp: <value in [disable, enable]>
           stp-ha-slave: <value in [disable, enable, priority-adjust]>
           stpforward: <value in [disable, enable]>
           stpforward-mode: <value in [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing]>
           strip-priority-vlan-tag: <value in [disable, enable]>
           subst: <value in [disable, enable]>
           substitute-dst-mac: <value of string>
           switch: <value of string>
           switch-controller-access-vlan: <value in [disable, enable]>
           switch-controller-arp-inspection: <value in [disable, enable]>
           switch-controller-auth: <value in [radius, usergroup]>
           switch-controller-dhcp-snooping: <value in [disable, enable]>
           switch-controller-dhcp-snooping-option82: <value in [disable, enable]>
           switch-controller-dhcp-snooping-verify-mac: <value in [disable, enable]>
           switch-controller-igmp-snooping: <value in [disable, enable]>
           switch-controller-learning-limit: <value of integer>
           switch-controller-radius-server: <value of string>
           switch-controller-traffic-policy: <value of string>
           tc-mode: <value in [ptm, atm]>
           tcp-mss: <value of integer>
           trunk: <value in [disable, enable]>
           trust-ip-1: <value of string>
           trust-ip-2: <value of string>
           trust-ip-3: <value of string>
           trust-ip6-1: <value of string>
           trust-ip6-2: <value of string>
           trust-ip6-3: <value of string>
           type: <value in [physical, vlan, aggregate, ...]>
           username: <value of string>
           vci: <value of integer>
           vectoring: <value in [disable, enable]>
           vindex: <value of integer>
           vlanforward: <value in [disable, enable]>
           vlanid: <value of integer>
           vpi: <value of integer>
           vrf: <value of integer>
           vrrp:
             -
                 accept-mode: <value in [disable, enable]>
                 adv-interval: <value of integer>
                 ignore-default-route: <value in [disable, enable]>
                 preempt: <value in [disable, enable]>
                 priority: <value of integer>
                 start-time: <value of integer>
                 status: <value in [disable, enable]>
                 version: <value in [2, 3]>
                 vrdst: <value of string>
                 vrdst-priority: <value of integer>
                 vrgrp: <value of integer>
                 vrid: <value of integer>
                 vrip: <value of string>
           vrrp-virtual-mac: <value in [disable, enable]>
           wccp: <value in [disable, enable]>
           weight: <value of integer>
           wifi-5g-threshold: <value of string>
           wifi-acl: <value in [deny, allow]>
           wifi-ap-band: <value in [any, 5g-preferred, 5g-only]>
           wifi-auth: <value in [PSK, RADIUS, radius, ...]>
           wifi-auto-connect: <value in [disable, enable]>
           wifi-auto-save: <value in [disable, enable]>
           wifi-broadcast-ssid: <value in [disable, enable]>
           wifi-encrypt: <value in [TKIP, AES]>
           wifi-fragment-threshold: <value of integer>
           wifi-key: <value of string>
           wifi-keyindex: <value of integer>
           wifi-mac-filter: <value in [disable, enable]>
           wifi-passphrase: <value of string>
           wifi-radius-server: <value of string>
           wifi-rts-threshold: <value of integer>
           wifi-security: <value in [None, WEP64, wep64, ...]>
           wifi-ssid: <value of string>
           wifi-usergroup: <value of string>
           wins-ip: <value of string>
           eip: <value of string>
           fortilink-neighbor-detect: <value in [lldp, fortilink]>
           ingress-shaping-profile: <value of string>
           ring-rx: <value of integer>
           ring-tx: <value of 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: <value of integer>
           ip-managed-by-fortiipam: <value in [disable, enable]>
           managed-subnetwork-size: <value in [256, 512, 1024, ...]>
           measured-downstream-bandwidth: <value of integer>
           measured-upstream-bandwidth: <value of integer>
           monitor-bandwidth: <value in [disable, enable]>
           swc-vlan: <value of integer>
           switch-controller-feature: <value in [none, default-vlan, quarantine, ...]>
           switch-controller-mgmt-vlan: <value of integer>
           switch-controller-nac: <value of string>
           vlan-protocol: <value in [8021q, 8021ad]>
           dhcp-relay-interface: <value of string>
           dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>
           np-qos-profile: <value of integer>
           swc-first-create: <value of 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: <value of string>
           auth-cert: <value of string>
           auth-portal-addr: <value of string>
           dhcp-classless-route-addition: <value in [disable, enable]>
           dhcp-relay-link-selection: <value of string>
           dns-server-protocol:
             - cleartext
             - dot
             - doh
           eap-ca-cert: <value of string>
           eap-identity: <value of string>
           eap-method: <value in [tls, peap]>
           eap-password: <value of string>
           eap-supplicant: <value in [disable, enable]>
           eap-user-cert: <value of string>
           ike-saml-server: <value of string>
           lacp-ha-secondary: <value in [disable, enable]>
           pvc-atm-qos: <value in [cbr, rt-vbr, nrt-vbr]>
           pvc-chan: <value of integer>
           pvc-crc: <value of integer>
           pvc-pcr: <value of integer>
           pvc-scr: <value of integer>
           pvc-vlan-id: <value of integer>
           pvc-vlan-rx-id: <value of integer>
           pvc-vlan-rx-op: <value in [pass-through, replace, remove]>
           pvc-vlan-tx-id: <value of integer>
           pvc-vlan-tx-op: <value in [pass-through, replace, remove]>
           reachable-time: <value of integer>
           select-profile-30a-35b: <value in [30A, 35B]>
           sfp-dsl: <value in [disable, enable]>
           sfp-dsl-adsl-fallback: <value in [disable, enable]>
           sfp-dsl-autodetect: <value in [disable, enable]>
           sfp-dsl-mac: <value of string>
           sw-algorithm: <value in [l2, l3, eh]>
           system-id: <value of string>
           system-id-type: <value in [auto, user]>
           vlan-id: <value of integer>
           vlan-op-mode: <value in [tag, untag, passthrough]>

Return Values

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

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

Status

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

Authors

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

Hint

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