fmgr_fsp_vlan_interface – Configure interfaces.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • Tested with FortiManager v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • vlan - The parameter in requested url type: str required: true
  • fsp_vlan_interface - Configure interfaces. type: dict
    • ac_name (Alias name: ac-name) type: str more...
    • aggregate type: str more...
    • algorithm type: str choices: [L2, L3, L4, LB, Source-MAC] more...
    • alias type: str more...
    • allowaccess type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
    • ap_discover (Alias name: ap-discover) type: str choices: [disable, enable] more...
    • arpforward type: str choices: [disable, enable] more...
    • atm_protocol (Alias name: atm-protocol) type: str choices: [none, ipoa] more...
    • auth_type (Alias name: auth-type) type: str choices: [auto, pap, chap, mschapv1, mschapv2] more...
    • auto_auth_extension_device (Alias name: auto-auth-extension-device) type: str choices: [disable, enable] more...
    • bfd type: str choices: [global, enable, disable] more...
    • bfd_desired_min_tx (Alias name: bfd-desired-min-tx) type: int more...
    • bfd_detect_mult (Alias name: bfd-detect-mult) type: int more...
    • bfd_required_min_rx (Alias name: bfd-required-min-rx) type: int more...
    • broadcast_forticlient_discovery (Alias name: broadcast-forticlient-discovery) type: str choices: [disable, enable] more...
    • broadcast_forward (Alias name: broadcast-forward) type: str choices: [disable, enable] more...
    • captive_portal (Alias name: captive-portal) type: int more...
    • cli_conn_status (Alias name: cli-conn-status) type: int more...
    • color type: int more...
    • ddns type: str choices: [disable, enable] more...
    • ddns_auth (Alias name: ddns-auth) type: str choices: [disable, tsig] more...
    • ddns_domain (Alias name: ddns-domain) type: str more...
    • ddns_key (Alias name: ddns-key) type: list or str more...
    • ddns_keyname (Alias name: ddns-keyname) type: str more...
    • ddns_password (Alias name: ddns-password) type: list more...
    • ddns_server (Alias name: ddns-server) type: str choices: [dhs.org, dyndns.org, dyns.net, tzo.com, ods.org, vavic.com, now.net.cn, dipdns.net, easydns.com, genericDDNS] more...
    • ddns_server_ip (Alias name: ddns-server-ip) type: str more...
    • ddns_sn (Alias name: ddns-sn) type: str more...
    • ddns_ttl (Alias name: ddns-ttl) type: int more...
    • ddns_username (Alias name: ddns-username) type: str more...
    • ddns_zone (Alias name: ddns-zone) type: str more...
    • dedicated_to (Alias name: dedicated-to) type: str choices: [none, management] more...
    • defaultgw type: str choices: [disable, enable] more...
    • description type: str more...
    • detected_peer_mtu (Alias name: detected-peer-mtu) type: int more...
    • detectprotocol type: list choices: [ping, tcp-echo, udp-echo] more...
    • detectserver type: str more...
    • device_access_list (Alias name: device-access-list) type: list or str more...
    • device_identification (Alias name: device-identification) type: str choices: [disable, enable] more...
    • device_identification_active_scan (Alias name: device-identification-active-scan) type: str choices: [disable, enable] more...
    • device_netscan (Alias name: device-netscan) type: str choices: [disable, enable] more...
    • device_user_identification (Alias name: device-user-identification) type: str choices: [disable, enable] more...
    • devindex type: int more...
    • dhcp_client_identifier (Alias name: dhcp-client-identifier) type: str more...
    • dhcp_relay_agent_option (Alias name: dhcp-relay-agent-option) type: str choices: [disable, enable] more...
    • dhcp_relay_ip (Alias name: dhcp-relay-ip) type: list more...
    • dhcp_relay_service (Alias name: dhcp-relay-service) type: str choices: [disable, enable] more...
    • dhcp_relay_type (Alias name: dhcp-relay-type) type: str choices: [regular, ipsec] more...
    • dhcp_renew_time (Alias name: dhcp-renew-time) type: int more...
    • disc_retry_timeout (Alias name: disc-retry-timeout) type: int more...
    • disconnect_threshold (Alias name: disconnect-threshold) type: int more...
    • distance type: int more...
    • dns_query (Alias name: dns-query) type: str choices: [disable, recursive, non-recursive] more...
    • dns_server_override (Alias name: dns-server-override) type: str choices: [disable, enable] more...
    • drop_fragment (Alias name: drop-fragment) type: str choices: [disable, enable] more...
    • drop_overlapped_fragment (Alias name: drop-overlapped-fragment) type: str choices: [disable, enable] more...
    • egress_cos (Alias name: egress-cos) type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7] more...
    • egress_shaping_profile (Alias name: egress-shaping-profile) type: str more...
    • endpoint_compliance (Alias name: endpoint-compliance) type: str choices: [disable, enable] more...
    • estimated_downstream_bandwidth (Alias name: estimated-downstream-bandwidth) type: int more...
    • estimated_upstream_bandwidth (Alias name: estimated-upstream-bandwidth) type: int more...
    • explicit_ftp_proxy (Alias name: explicit-ftp-proxy) type: str choices: [disable, enable] more...
    • explicit_web_proxy (Alias name: explicit-web-proxy) type: str choices: [disable, enable] more...
    • external type: str choices: [disable, enable] more...
    • fail_action_on_extender (Alias name: fail-action-on-extender) type: str choices: [soft-restart, hard-restart, reboot] more...
    • fail_alert_interfaces (Alias name: fail-alert-interfaces) type: list or str more...
    • fail_alert_method (Alias name: fail-alert-method) type: str choices: [link-failed-signal, link-down] more...
    • fail_detect (Alias name: fail-detect) type: str choices: [disable, enable] more...
    • fail_detect_option (Alias name: fail-detect-option) type: list choices: [detectserver, link-down] more...
    • fdp type: str choices: [disable, enable] more...
    • fortiheartbeat type: str choices: [disable, enable] more...
    • fortilink type: str choices: [disable, enable] more...
    • fortilink_backup_link (Alias name: fortilink-backup-link) type: int more...
    • fortilink_split_interface (Alias name: fortilink-split-interface) type: str choices: [disable, enable] more...
    • fortilink_stacking (Alias name: fortilink-stacking) type: str choices: [disable, enable] more...
    • forward_domain (Alias name: forward-domain) type: int more...
    • forward_error_correction (Alias name: forward-error-correction) type: str choices: [disable, enable, rs-fec, base-r-fec, fec-cl91, fec-cl74, rs-544, none, cl91-rs-fec, cl74-fc-fec, auto] more...
    • fp_anomaly (Alias name: fp-anomaly) type: list 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 (Alias name: fp-disable) type: list choices: [all, ipsec, none] more...
    • gateway_address (Alias name: gateway-address) type: str more...
    • gi_gk (Alias name: gi-gk) type: str choices: [disable, enable] more...
    • gwaddr type: str more...
    • gwdetect type: str choices: [disable, enable] more...
    • ha_priority (Alias name: ha-priority) type: int more...
    • icmp_accept_redirect (Alias name: icmp-accept-redirect) type: str choices: [disable, enable] more...
    • icmp_redirect (Alias name: icmp-redirect) type: str choices: [disable, enable] more...
    • icmp_send_redirect (Alias name: icmp-send-redirect) type: str choices: [disable, enable] more...
    • ident_accept (Alias name: ident-accept) type: str choices: [disable, enable] more...
    • idle_timeout (Alias name: idle-timeout) type: int more...
    • if_mdix (Alias name: if-mdix) type: str choices: [auto, normal, crossover] more...
    • if_media (Alias name: if-media) type: str choices: [auto, copper, fiber] more...
    • in_force_vlan_cos (Alias name: in-force-vlan-cos) type: int more...
    • inbandwidth type: int more...
    • ingress_cos (Alias name: ingress-cos) type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7] more...
    • ingress_spillover_threshold (Alias name: ingress-spillover-threshold) type: int more...
    • internal type: int more...
    • ip type: str more...
    • ipmac type: str choices: [disable, enable] more...
    • ips_sniffer_mode (Alias name: ips-sniffer-mode) type: str choices: [disable, enable] more...
    • ipunnumbered type: str more...
    • ipv6 type: dict
      • autoconf type: str choices: [disable, enable] more...
      • dhcp6_client_options (Alias name: dhcp6-client-options) type: list choices: [rapid, iapd, iana, dns, dnsname] more...
      • dhcp6_information_request (Alias name: dhcp6-information-request) type: str choices: [disable, enable] more...
      • dhcp6_prefix_delegation (Alias name: dhcp6-prefix-delegation) type: str choices: [disable, enable] more...
      • dhcp6_prefix_hint (Alias name: dhcp6-prefix-hint) type: str more...
      • dhcp6_prefix_hint_plt (Alias name: dhcp6-prefix-hint-plt) type: int more...
      • dhcp6_prefix_hint_vlt (Alias name: dhcp6-prefix-hint-vlt) type: int more...
      • dhcp6_relay_ip (Alias name: dhcp6-relay-ip) type: str more...
      • dhcp6_relay_service (Alias name: dhcp6-relay-service) type: str choices: [disable, enable] more...
      • dhcp6_relay_type (Alias name: dhcp6-relay-type) type: str choices: [regular] more...
      • ip6_address (Alias name: ip6-address) type: str more...
      • ip6_allowaccess (Alias name: ip6-allowaccess) type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...
      • ip6_default_life (Alias name: ip6-default-life) type: int more...
      • ip6_dns_server_override (Alias name: ip6-dns-server-override) type: str choices: [disable, enable] more...
      • ip6_hop_limit (Alias name: ip6-hop-limit) type: int more...
      • ip6_link_mtu (Alias name: ip6-link-mtu) type: int more...
      • ip6_manage_flag (Alias name: ip6-manage-flag) type: str choices: [disable, enable] more...
      • ip6_max_interval (Alias name: ip6-max-interval) type: int more...
      • ip6_min_interval (Alias name: ip6-min-interval) type: int more...
      • ip6_mode (Alias name: ip6-mode) type: str choices: [static, dhcp, pppoe, delegated] more...
      • ip6_other_flag (Alias name: ip6-other-flag) type: str choices: [disable, enable] more...
      • ip6_reachable_time (Alias name: ip6-reachable-time) type: int more...
      • ip6_retrans_time (Alias name: ip6-retrans-time) type: int more...
      • ip6_send_adv (Alias name: ip6-send-adv) type: str choices: [disable, enable] more...
      • ip6_subnet (Alias name: ip6-subnet) type: str more...
      • ip6_upstream_interface (Alias name: ip6-upstream-interface) type: str more...
      • nd_cert (Alias name: nd-cert) type: str more...
      • nd_cga_modifier (Alias name: nd-cga-modifier) type: str more...
      • nd_mode (Alias name: nd-mode) type: str choices: [basic, SEND-compatible] more...
      • nd_security_level (Alias name: nd-security-level) type: int more...
      • nd_timestamp_delta (Alias name: nd-timestamp-delta) type: int more...
      • nd_timestamp_fuzz (Alias name: nd-timestamp-fuzz) type: int more...
      • vrip6_link_local type: str more...
      • vrrp_virtual_mac6 (Alias name: vrrp-virtual-mac6) type: str choices: [disable, enable] more...
      • ip6_delegated_prefix_list (Alias name: ip6-delegated-prefix-list) type: list more...
        • autonomous_flag (Alias name: autonomous-flag) type: str choices: [disable, enable] more...
        • onlink_flag (Alias name: onlink-flag) type: str choices: [disable, enable] more...
        • prefix_id (Alias name: prefix-id) type: int more...
        • rdnss type: list more...
        • rdnss_service (Alias name: rdnss-service) type: str choices: [delegated, default, specify] more...
        • subnet type: str more...
        • upstream_interface (Alias name: upstream-interface) type: str more...
        • delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
      • ip6_extra_addr (Alias name: ip6-extra-addr) type: list more...
        • prefix type: str more...
      • ip6_prefix_list (Alias name: ip6-prefix-list) type: list more...
        • autonomous_flag (Alias name: autonomous-flag) type: str choices: [disable, enable] more...
        • dnssl type: list more...
        • onlink_flag (Alias name: onlink-flag) type: str choices: [disable, enable] more...
        • preferred_life_time (Alias name: preferred-life-time) type: int more...
        • prefix type: str more...
        • rdnss type: list more...
        • valid_life_time (Alias name: valid-life-time) type: int more...
      • vrrp6 type: list more...
        • accept_mode (Alias name: accept-mode) type: str choices: [disable, enable] more...
        • adv_interval (Alias name: adv-interval) type: int more...
        • preempt type: str choices: [disable, enable] more...
        • priority type: int more...
        • start_time (Alias name: start-time) type: int more...
        • status type: str choices: [disable, enable] more...
        • vrdst6 type: str more...
        • vrgrp type: int more...
        • vrid type: int more...
        • vrip6 type: str more...
        • ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable] more...
      • interface_identifier (Alias name: interface-identifier) type: str more...
      • unique_autoconf_addr (Alias name: unique-autoconf-addr) type: str choices: [disable, enable] more...
      • icmp6_send_redirect (Alias name: icmp6-send-redirect) Enable/disable sending of icmpv6 redirects. type: str choices: [disable, enable] more...
      • cli_conn6_status (Alias name: cli-conn6-status) type: int more...
      • ip6_prefix_mode (Alias name: ip6-prefix-mode) Assigning a prefix from dhcp or ra. type: str choices: [dhcp6, ra] more...
      • ra_send_mtu (Alias name: ra-send-mtu) Enable/disable sending link mtu in ra packet. type: str choices: [disable, enable] more...
      • ip6_delegated_prefix_iaid (Alias name: ip6-delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
      • dhcp6_relay_source_interface (Alias name: dhcp6-relay-source-interface) Enable/disable use of address on this interface as the source address of the relay message. type: str choices: [disable, enable] more...
      • dhcp6_relay_interface_id (Alias name: dhcp6-relay-interface-id) Dhcp6 relay interface id. type: str more...
      • dhcp6_relay_source_ip (Alias name: dhcp6-relay-source-ip) Ipv6 address used by the dhcp6 relay as its source ip. type: str more...
    • l2forward type: str choices: [disable, enable] more...
    • l2tp_client (Alias name: l2tp-client) type: str choices: [disable, enable] more...
    • lacp_ha_slave (Alias name: lacp-ha-slave) type: str choices: [disable, enable] more...
    • lacp_mode (Alias name: lacp-mode) type: str choices: [static, passive, active] more...
    • lacp_speed (Alias name: lacp-speed) type: str choices: [slow, fast] more...
    • lcp_echo_interval (Alias name: lcp-echo-interval) type: int more...
    • lcp_max_echo_fails (Alias name: lcp-max-echo-fails) type: int more...
    • link_up_delay (Alias name: link-up-delay) type: int more...
    • listen_forticlient_connection (Alias name: listen-forticlient-connection) type: str choices: [disable, enable] more...
    • lldp_network_policy (Alias name: lldp-network-policy) type: str more...
    • lldp_reception (Alias name: lldp-reception) type: str choices: [disable, enable, vdom] more...
    • lldp_transmission (Alias name: lldp-transmission) type: str choices: [enable, disable, vdom] more...
    • log type: str choices: [disable, enable] more...
    • macaddr type: str more...
    • management_ip (Alias name: management-ip) type: str more...
    • max_egress_burst_rate (Alias name: max-egress-burst-rate) type: int more...
    • max_egress_rate (Alias name: max-egress-rate) type: int more...
    • mediatype 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, sr2, lr2, cr2, sr8, lr8, cr8] more...
    • member type: list or str more...
    • min_links (Alias name: min-links) type: int more...
    • min_links_down (Alias name: min-links-down) type: str choices: [operational, administrative] more...
    • mode type: str choices: [static, dhcp, pppoe, pppoa, ipoa, eoa] more...
    • mtu type: int more...
    • mtu_override (Alias name: mtu-override) type: str choices: [disable, enable] more...
    • mux_type (Alias name: mux-type) type: str choices: [llc-encaps, vc-encaps] more...
    • name type: str more...
    • ndiscforward type: str choices: [disable, enable] more...
    • netbios_forward (Alias name: netbios-forward) type: str choices: [disable, enable] more...
    • netflow_sampler (Alias name: netflow-sampler) type: str choices: [disable, tx, rx, both] more...
    • npu_fastpath (Alias name: npu-fastpath) type: str choices: [disable, enable] more...
    • nst type: str choices: [disable, enable] more...
    • out_force_vlan_cos (Alias name: out-force-vlan-cos) type: int more...
    • outbandwidth type: int more...
    • padt_retry_timeout (Alias name: padt-retry-timeout) type: int more...
    • password type: list more...
    • peer_interface (Alias name: peer-interface) type: list or str more...
    • phy_mode (Alias name: phy-mode) type: str choices: [auto, adsl, vdsl, adsl-auto, vdsl2, adsl2+, adsl2, g.dmt, t1.413, g.lite] more...
    • ping_serv_status (Alias name: ping-serv-status) type: int more...
    • poe type: str choices: [disable, enable] more...
    • polling_interval (Alias name: polling-interval) type: int more...
    • pppoe_unnumbered_negotiate (Alias name: pppoe-unnumbered-negotiate) type: str choices: [disable, enable] more...
    • pptp_auth_type (Alias name: pptp-auth-type) type: str choices: [auto, pap, chap, mschapv1, mschapv2] more...
    • pptp_client (Alias name: pptp-client) type: str choices: [disable, enable] more...
    • pptp_password (Alias name: pptp-password) type: list more...
    • pptp_server_ip (Alias name: pptp-server-ip) type: str more...
    • pptp_timeout (Alias name: pptp-timeout) type: int more...
    • pptp_user (Alias name: pptp-user) type: str more...
    • preserve_session_route (Alias name: preserve-session-route) type: str choices: [disable, enable] more...
    • priority type: int more...
    • priority_override (Alias name: priority-override) type: str choices: [disable, enable] more...
    • proxy_captive_portal (Alias name: proxy-captive-portal) type: str choices: [disable, enable] more...
    • redundant_interface (Alias name: redundant-interface) type: str more...
    • remote_ip (Alias name: remote-ip) type: str more...
    • replacemsg_override_group (Alias name: replacemsg-override-group) type: str more...
    • retransmission type: str choices: [disable, enable] more...
    • role type: str choices: [lan, wan, dmz, undefined] more...
    • sample_direction (Alias name: sample-direction) type: str choices: [rx, tx, both] more...
    • sample_rate (Alias name: sample-rate) type: int more...
    • scan_botnet_connections (Alias name: scan-botnet-connections) type: str choices: [disable, block, monitor] more...
    • secondary_IP (Alias name: secondary-IP) type: str choices: [disable, enable] more...
    • secondaryip type: list more...
      • allowaccess type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
      • detectprotocol type: list choices: [ping, tcp-echo, udp-echo] more...
      • detectserver type: str more...
      • gwdetect type: str choices: [disable, enable] more...
      • ha_priority (Alias name: ha-priority) type: int more...
      • id type: int more...
      • ip type: str more...
      • ping_serv_status (Alias name: ping-serv-status) type: int more...
      • seq type: int more...
      • secip_relay_ip (Alias name: secip-relay-ip) Dhcp relay ip address. type: str more...
    • security_8021x_dynamic_vlan_id (Alias name: security-8021x-dynamic-vlan-id) type: int more...
    • security_8021x_master (Alias name: security-8021x-master) type: str more...
    • security_8021x_mode (Alias name: security-8021x-mode) type: str choices: [default, dynamic-vlan, fallback, slave] more...
    • security_exempt_list (Alias name: security-exempt-list) type: str more...
    • security_external_logout (Alias name: security-external-logout) type: str more...
    • security_external_web (Alias name: security-external-web) type: str more...
    • security_groups (Alias name: security-groups) type: list or str more...
    • security_mac_auth_bypass (Alias name: security-mac-auth-bypass) type: str choices: [disable, enable, mac-auth-only] more...
    • security_mode (Alias name: security-mode) type: str choices: [none, captive-portal, 802.1X] more...
    • security_redirect_url (Alias name: security-redirect-url) type: str more...
    • service_name (Alias name: service-name) type: str more...
    • sflow_sampler (Alias name: sflow-sampler) type: str choices: [disable, enable] more...
    • speed type: str 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] more...
    • spillover_threshold (Alias name: spillover-threshold) type: int more...
    • src_check (Alias name: src-check) type: str choices: [disable, enable] more...
    • status type: str choices: [down, up] more...
    • stp type: str choices: [disable, enable] more...
    • stp_ha_slave (Alias name: stp-ha-slave) type: str choices: [disable, enable, priority-adjust] more...
    • stpforward type: str choices: [disable, enable] more...
    • stpforward_mode (Alias name: stpforward-mode) type: str choices: [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing] more...
    • strip_priority_vlan_tag (Alias name: strip-priority-vlan-tag) type: str choices: [disable, enable] more...
    • subst type: str choices: [disable, enable] more...
    • substitute_dst_mac (Alias name: substitute-dst-mac) type: str more...
    • switch type: str more...
    • switch_controller_access_vlan (Alias name: switch-controller-access-vlan) type: str choices: [disable, enable] more...
    • switch_controller_arp_inspection (Alias name: switch-controller-arp-inspection) type: str choices: [disable, enable] more...
    • switch_controller_auth (Alias name: switch-controller-auth) type: str choices: [radius, usergroup] more...
    • switch_controller_dhcp_snooping (Alias name: switch-controller-dhcp-snooping) type: str choices: [disable, enable] more...
    • switch_controller_dhcp_snooping_option82 (Alias name: switch-controller-dhcp-snooping-option82) type: str choices: [disable, enable] more...
    • switch_controller_dhcp_snooping_verify_mac (Alias name: switch-controller-dhcp-snooping-verify-mac) type: str choices: [disable, enable] more...
    • switch_controller_igmp_snooping (Alias name: switch-controller-igmp-snooping) type: str choices: [disable, enable] more...
    • switch_controller_learning_limit (Alias name: switch-controller-learning-limit) type: int more...
    • switch_controller_radius_server (Alias name: switch-controller-radius-server) type: str more...
    • switch_controller_traffic_policy (Alias name: switch-controller-traffic-policy) type: str more...
    • tc_mode (Alias name: tc-mode) type: str choices: [ptm, atm] more...
    • tcp_mss (Alias name: tcp-mss) type: int more...
    • trunk type: str choices: [disable, enable] more...
    • trust_ip_1 (Alias name: trust-ip-1) type: str more...
    • trust_ip_2 (Alias name: trust-ip-2) type: str more...
    • trust_ip_3 (Alias name: trust-ip-3) type: str more...
    • trust_ip6_1 (Alias name: trust-ip6-1) type: str more...
    • trust_ip6_2 (Alias name: trust-ip6-2) type: str more...
    • trust_ip6_3 (Alias name: trust-ip6-3) type: str more...
    • type type: str choices: [physical, vlan, aggregate, redundant, tunnel, wireless, vdom-link, loopback, switch, hard-switch, hdlc, vap-switch, wl-mesh, fortilink, switch-vlan, fctrl-trunk, tdm, fext-wan, vxlan, emac-vlan, geneve, ssl, lan-extension] more...
    • username type: str more...
    • vci type: int more...
    • vectoring type: str choices: [disable, enable] more...
    • vindex type: int more...
    • vlanforward type: str choices: [disable, enable] more...
    • vlanid type: int more...
    • vpi type: int more...
    • vrf type: int more...
    • vrrp type: list more...
      • accept_mode (Alias name: accept-mode) type: str choices: [disable, enable] more...
      • adv_interval (Alias name: adv-interval) type: int more...
      • ignore_default_route (Alias name: ignore-default-route) type: str choices: [disable, enable] more...
      • preempt type: str choices: [disable, enable] more...
      • priority type: int more...
      • start_time (Alias name: start-time) type: int more...
      • status type: str choices: [disable, enable] more...
      • version type: str choices: [2, 3] more...
      • vrdst type: list more...
      • vrdst_priority (Alias name: vrdst-priority) type: int more...
      • vrgrp type: int more...
      • vrid type: int more...
      • vrip type: str more...
      • proxy_arp (Alias name: proxy-arp) type: list more...
        • id Id. type: int more...
        • ip Set ip addresses of proxy arp. type: str more...
    • vrrp_virtual_mac (Alias name: vrrp-virtual-mac) type: str choices: [disable, enable] more...
    • wccp type: str choices: [disable, enable] more...
    • weight type: int more...
    • wifi_5g_threshold (Alias name: wifi-5g-threshold) type: str more...
    • wifi_acl (Alias name: wifi-acl) type: str choices: [deny, allow] more...
    • wifi_ap_band (Alias name: wifi-ap-band) type: str choices: [any, 5g-preferred, 5g-only] more...
    • wifi_auth (Alias name: wifi-auth) type: str choices: [PSK, RADIUS, radius, usergroup] more...
    • wifi_auto_connect (Alias name: wifi-auto-connect) type: str choices: [disable, enable] more...
    • wifi_auto_save (Alias name: wifi-auto-save) type: str choices: [disable, enable] more...
    • wifi_broadcast_ssid (Alias name: wifi-broadcast-ssid) type: str choices: [disable, enable] more...
    • wifi_encrypt (Alias name: wifi-encrypt) type: str choices: [TKIP, AES] more...
    • wifi_fragment_threshold (Alias name: wifi-fragment-threshold) type: int more...
    • wifi_key (Alias name: wifi-key) type: list more...
    • wifi_keyindex (Alias name: wifi-keyindex) type: int more...
    • wifi_mac_filter (Alias name: wifi-mac-filter) type: str choices: [disable, enable] more...
    • wifi_passphrase (Alias name: wifi-passphrase) type: list more...
    • wifi_radius_server (Alias name: wifi-radius-server) type: str more...
    • wifi_rts_threshold (Alias name: wifi-rts-threshold) type: int more...
    • wifi_security (Alias name: wifi-security) 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 (Alias name: wifi-ssid) type: str more...
    • wifi_usergroup (Alias name: wifi-usergroup) type: str more...
    • wins_ip (Alias name: wins-ip) type: str more...
    • eip type: str more...
    • fortilink_neighbor_detect (Alias name: fortilink-neighbor-detect) type: str choices: [lldp, fortilink] more...
    • ingress_shaping_profile (Alias name: ingress-shaping-profile) type: str more...
    • ring_rx (Alias name: ring-rx) type: int more...
    • ring_tx (Alias name: ring-tx) type: int more...
    • switch_controller_igmp_snooping_fast_leave (Alias name: switch-controller-igmp-snooping-fast-leave) type: str choices: [disable, enable] more...
    • switch_controller_igmp_snooping_proxy (Alias name: switch-controller-igmp-snooping-proxy) type: str choices: [disable, enable] more...
    • switch_controller_rspan_mode (Alias name: switch-controller-rspan-mode) type: str choices: [disable, enable] more...
    • bandwidth_measure_time (Alias name: bandwidth-measure-time) type: int more...
    • ip_managed_by_fortiipam (Alias name: ip-managed-by-fortiipam) type: str choices: [disable, enable, inherit-global] more...
    • managed_subnetwork_size (Alias name: managed-subnetwork-size) type: str choices: [256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 32, 64, 128] more...
    • measured_downstream_bandwidth (Alias name: measured-downstream-bandwidth) type: int more...
    • measured_upstream_bandwidth (Alias name: measured-upstream-bandwidth) type: int more...
    • monitor_bandwidth (Alias name: monitor-bandwidth) type: str choices: [disable, enable] more...
    • swc_vlan (Alias name: swc-vlan) type: int more...
    • switch_controller_feature (Alias name: switch-controller-feature) type: str choices: [none, default-vlan, quarantine, sniffer, voice, camera, rspan, video, nac, nac-segment] more...
    • switch_controller_mgmt_vlan (Alias name: switch-controller-mgmt-vlan) type: int more...
    • switch_controller_nac (Alias name: switch-controller-nac) type: str more...
    • vlan_protocol (Alias name: vlan-protocol) type: str choices: [8021q, 8021ad] more...
    • dhcp_relay_interface (Alias name: dhcp-relay-interface) type: str more...
    • dhcp_relay_interface_select_method (Alias name: dhcp-relay-interface-select-method) type: str choices: [auto, sdwan, specify] more...
    • np_qos_profile (Alias name: np-qos-profile) Np qos profile id. type: int more...
    • swc_first_create (Alias name: swc-first-create) Initial create for switch-controller vlans. type: int more...
    • switch_controller_iot_scanning (Alias name: switch-controller-iot-scanning) Enable/disable managed fortiswitch iot scanning. type: str choices: [disable, enable] more...
    • switch_controller_source_ip (Alias name: switch-controller-source-ip) Source ip address used in fortilink over l3 connections. type: str choices: [outbound, fixed] more...
    • dhcp_relay_request_all_server (Alias name: dhcp-relay-request-all-server) Enable/disable sending of dhcp requests to all servers. type: str choices: [disable, enable] more...
    • stp_ha_secondary (Alias name: stp-ha-secondary) Control stp behaviour on ha secondary. type: str choices: [disable, enable, priority-adjust] more...
    • switch_controller_dynamic (Alias name: switch-controller-dynamic) Integrated fortilink settings for managed fortiswitch. type: str more...
    • auth_cert (Alias name: auth-cert) Https server certificate. type: str more...
    • auth_portal_addr (Alias name: auth-portal-addr) Address of captive portal. type: str more...
    • dhcp_classless_route_addition (Alias name: 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 (Alias name: dhcp-relay-link-selection) Dhcp relay link selection. type: str more...
    • dns_server_protocol (Alias name: dns-server-protocol) type: list choices: [cleartext, dot, doh] more...
    • eap_ca_cert (Alias name: eap-ca-cert) Eap ca certificate name. type: str more...
    • eap_identity (Alias name: eap-identity) Eap identity. type: str more...
    • eap_method (Alias name: eap-method) Eap method. type: str choices: [tls, peap] more...
    • eap_password (Alias name: eap-password) type: list more...
    • eap_supplicant (Alias name: eap-supplicant) Enable/disable eap-supplicant. type: str choices: [disable, enable] more...
    • eap_user_cert (Alias name: eap-user-cert) Eap user certificate name. type: str more...
    • ike_saml_server (Alias name: ike-saml-server) Configure ike authentication saml server. type: str more...
    • lacp_ha_secondary (Alias name: lacp-ha-secondary) type: str choices: [disable, enable] more...
    • pvc_atm_qos (Alias name: pvc-atm-qos) Sfp-dsl adsl fallback pvc atm qos. type: str choices: [cbr, rt-vbr, nrt-vbr, ubr] more...
    • pvc_chan (Alias name: pvc-chan) Sfp-dsl adsl fallback pvc channel. type: int more...
    • pvc_crc (Alias name: 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 (Alias name: pvc-pcr) Sfp-dsl adsl fallback pvc packet cell rate in cells (0 - 5500). type: int more...
    • pvc_scr (Alias name: pvc-scr) Sfp-dsl adsl fallback pvc sustainable cell rate in cells (0 - 5500). type: int more...
    • pvc_vlan_id (Alias name: pvc-vlan-id) Sfp-dsl adsl fallback pvc vlan id. type: int more...
    • pvc_vlan_rx_id (Alias name: pvc-vlan-rx-id) Sfp-dsl adsl fallback pvc vlanid rx. type: int more...
    • pvc_vlan_rx_op (Alias name: pvc-vlan-rx-op) Sfp-dsl adsl fallback pvc vlan rx op. type: str choices: [pass-through, replace, remove] more...
    • pvc_vlan_tx_id (Alias name: pvc-vlan-tx-id) Sfp-dsl adsl fallback pvc vlan id tx. type: int more...
    • pvc_vlan_tx_op (Alias name: pvc-vlan-tx-op) Sfp-dsl adsl fallback pvc vlan tx op. type: str choices: [pass-through, replace, remove] more...
    • reachable_time (Alias name: reachable-time) Ipv4 reachable time in milliseconds (30000 - 3600000, default = 30000). type: int more...
    • select_profile_30a_35b (Alias name: select-profile-30a-35b) Select vdsl profile 30a or 35b. type: str choices: [30A, 35B] more...
    • sfp_dsl (Alias name: sfp-dsl) Enable/disable sfp dsl. type: str choices: [disable, enable] more...
    • sfp_dsl_adsl_fallback (Alias name: sfp-dsl-adsl-fallback) Enable/disable sfp dsl adsl fallback. type: str choices: [disable, enable] more...
    • sfp_dsl_autodetect (Alias name: sfp-dsl-autodetect) Enable/disable sfp dsl mac address autodetect. type: str choices: [disable, enable] more...
    • sfp_dsl_mac (Alias name: sfp-dsl-mac) Sfp dsl mac address. type: str more...
    • sw_algorithm (Alias name: sw-algorithm) Frame distribution algorithm for switch. type: str choices: [l2, l3, eh] more...
    • system_id (Alias name: system-id) Define a system id for the aggregate interface. type: str more...
    • system_id_type (Alias name: system-id-type) Method in which system id is generated. type: str choices: [auto, user] more...
    • vlan_id (Alias name: vlan-id) Vlan id type: int more...
    • vlan_op_mode (Alias name: vlan-op-mode) Configure dsl 802. type: str choices: [tag, untag, passthrough] more...
    • generic_receive_offload (Alias name: generic-receive-offload) type: str choices: [disable, enable] more...
    • interconnect_profile (Alias name: interconnect-profile) Set interconnect profile. type: str choices: [default, profile1, profile2] more...
    • large_receive_offload (Alias name: large-receive-offload) type: str choices: [disable, enable] more...
    • annex Set xdsl annex type. type: str choices: [a, b, j, bjm, i, al, m, aijlm, bj] more...
    • aggregate_type (Alias name: aggregate-type) Type of aggregation. type: str choices: [physical, vxlan] more...
    • switch_controller_netflow_collect (Alias name: switch-controller-netflow-collect) Netflow collection and processing. type: str choices: [disable, enable] more...
    • wifi_dns_server1 (Alias name: wifi-dns-server1) Dns server 1. type: str more...
    • wifi_dns_server2 (Alias name: wifi-dns-server2) Dns server 2. type: str more...
    • wifi_gateway (Alias name: wifi-gateway) Ipv4 default gateway ip address. type: str more...
    • default_purdue_level (Alias name: default-purdue-level) Default purdue level of device detected on this interface. type: str choices: [1, 2, 3, 4, 5, 1.5, 2.5, 3.5, 5.5] more...
    • dhcp_broadcast_flag (Alias name: dhcp-broadcast-flag) Enable/disable setting of the broadcast flag in messages sent by the dhcp client (default = enable). type: str choices: [disable, enable] more...
    • dhcp_smart_relay (Alias name: dhcp-smart-relay) Enable/disable dhcp smart relay. type: str choices: [disable, enable] more...
    • switch_controller_offloading (Alias name: switch-controller-offloading) type: str choices: [disable, enable] more...
    • switch_controller_offloading_gw (Alias name: switch-controller-offloading-gw) type: str choices: [disable, enable] more...
    • switch_controller_offloading_ip (Alias name: switch-controller-offloading-ip) type: str more...
    • dhcp_relay_circuit_id (Alias name: dhcp-relay-circuit-id) Dhcp relay circuit id. type: str more...
    • dhcp_relay_source_ip (Alias name: dhcp-relay-source-ip) Ip address used by the dhcp relay as its source ip. type: str more...
    • switch_controller_offload (Alias name: switch-controller-offload) Enable/disable managed fortiswitch routing offload. type: str choices: [disable, enable] more...
    • switch_controller_offload_gw (Alias name: switch-controller-offload-gw) Enable/disable managed fortiswitch routing offload gateway. type: str choices: [disable, enable] more...
    • switch_controller_offload_ip (Alias name: switch-controller-offload-ip) Ip for routing offload on fortiswitch. type: str more...
    • mirroring_direction (Alias name: mirroring-direction) Port mirroring direction. type: str choices: [rx, tx, both] more...
    • mirroring_port (Alias name: mirroring-port) Mirroring port. type: str more...
    • port_mirroring (Alias name: port-mirroring) Enable/disable np port mirroring. type: str choices: [disable, enable] more...
    • security_8021x_member_mode (Alias name: security-8021x-member-mode) 802. type: str choices: [disable, switch] more...
    • stp_edge (Alias name: stp-edge) Enable/disable as stp edge port. type: str choices: [disable, enable] 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

- 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]>
            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
              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]>
          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]>

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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)