fortinet.fortimanager.fmgr_fsp_vlan_interface module – Configure interfaces.
Note
This module is part of the fortinet.fortimanager collection (version 2.5.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_fsp_vlan_interface
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The top level parameters set. |
|
Deprecated, please rename it to ac_name. |
|
No description. |
|
Deprecated, please rename it to aggregate_type. Type of aggregation. Choices:
|
|
No description. Choices:
|
|
No description. |
|
No description. Choices:
|
|
Set xDSL annex type. Choices:
|
|
Deprecated, please rename it to ap_discover. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to atm_protocol. Choices:
|
|
Deprecated, please rename it to auth_cert. HTTPS server certificate. |
|
Deprecated, please rename it to auth_portal_addr. Address of captive portal. |
|
Deprecated, please rename it to auth_type. Choices:
|
|
Deprecated, please rename it to auto_auth_extension_device. Choices:
|
|
Deprecated, please rename it to bandwidth_measure_time. |
|
No description. Choices:
|
|
Deprecated, please rename it to bfd_desired_min_tx. |
|
Deprecated, please rename it to bfd_detect_mult. |
|
Deprecated, please rename it to bfd_required_min_rx. |
|
Deprecated, please rename it to broadcast_forticlient_discovery. Choices:
|
|
Deprecated, please rename it to broadcast_forward. Choices:
|
|
Deprecated, please rename it to captive_portal. |
|
Deprecated, please rename it to cli_conn_status. |
|
No description. |
|
No description. Choices:
|
|
Deprecated, please rename it to ddns_auth. Choices:
|
|
Deprecated, please rename it to ddns_domain. |
|
(list or str) Deprecated, please rename it to ddns_key. |
|
Deprecated, please rename it to ddns_keyname. |
|
(list) Deprecated, please rename it to ddns_password. |
|
Deprecated, please rename it to ddns_server. Choices:
|
|
Deprecated, please rename it to ddns_server_ip. |
|
Deprecated, please rename it to ddns_sn. |
|
Deprecated, please rename it to ddns_ttl. |
|
Deprecated, please rename it to ddns_username. |
|
Deprecated, please rename it to ddns_zone. |
|
Deprecated, please rename it to dedicated_to. Choices:
|
|
Deprecated, please rename it to default_purdue_level. Default purdue level of device detected on this interface. Choices:
|
|
No description. Choices:
|
|
No description. |
|
Deprecated, please rename it to detected_peer_mtu. |
|
No description. Choices:
|
|
No description. |
|
(list or str) Deprecated, please rename it to device_access_list. |
|
Deprecated, please rename it to device_identification. Choices:
|
|
Deprecated, please rename it to device_identification_active_scan. Choices:
|
|
Deprecated, please rename it to device_netscan. Choices:
|
|
Deprecated, please rename it to device_user_identification. Choices:
|
|
No description. |
|
Deprecated, please rename it to dhcp_broadcast_flag. Enable/disable setting of the broadcast flag in messages sent by the … Choices:
|
|
Deprecated, please rename it to dhcp_classless_route_addition. Enable/disable addition of classless static routes retrieve… Choices:
|
|
Deprecated, please rename it to dhcp_client_identifier. |
|
Deprecated, please rename it to dhcp_relay_agent_option. Choices:
|
|
Deprecated, please rename it to dhcp_relay_circuit_id. DHCP relay circuit ID. |
|
Deprecated, please rename it to dhcp_relay_interface. |
|
Deprecated, please rename it to dhcp_relay_interface_select_method. Choices:
|
|
(list) Deprecated, please rename it to dhcp_relay_ip. |
|
Deprecated, please rename it to dhcp_relay_link_selection. DHCP relay link selection. |
|
Deprecated, please rename it to dhcp_relay_request_all_server. Enable/disable sending of DHCP requests to all servers. Choices:
|
|
Deprecated, please rename it to dhcp_relay_service. Choices:
|
|
Deprecated, please rename it to dhcp_relay_source_ip. IP address used by the DHCP relay as its source IP. |
|
Deprecated, please rename it to dhcp_relay_type. Choices:
|
|
Deprecated, please rename it to dhcp_renew_time. |
|
Deprecated, please rename it to dhcp_smart_relay. Enable/disable DHCP smart relay. Choices:
|
|
Deprecated, please rename it to disc_retry_timeout. |
|
Deprecated, please rename it to disconnect_threshold. |
|
No description. |
|
Deprecated, please rename it to dns_query. Choices:
|
|
Deprecated, please rename it to dns_server_override. Choices:
|
|
Deprecated, please rename it to dns_server_protocol. Choices:
|
|
Deprecated, please rename it to drop_fragment. Choices:
|
|
Deprecated, please rename it to drop_overlapped_fragment. Choices:
|
|
Deprecated, please rename it to eap_ca_cert. EAP CA certificate name. |
|
Deprecated, please rename it to eap_identity. EAP identity. |
|
Deprecated, please rename it to eap_method. EAP method. Choices:
|
|
(list) Deprecated, please rename it to eap_password. |
|
Deprecated, please rename it to eap_supplicant. Enable/disable EAP-Supplicant. Choices:
|
|
Deprecated, please rename it to eap_user_cert. EAP user certificate name. |
|
Deprecated, please rename it to egress_cos. Choices:
|
|
Deprecated, please rename it to egress_shaping_profile. |
|
No description. |
|
Deprecated, please rename it to endpoint_compliance. Choices:
|
|
Deprecated, please rename it to estimated_downstream_bandwidth. |
|
Deprecated, please rename it to estimated_upstream_bandwidth. |
|
Deprecated, please rename it to explicit_ftp_proxy. Choices:
|
|
Deprecated, please rename it to explicit_web_proxy. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to fail_action_on_extender. Choices:
|
|
(list or str) Deprecated, please rename it to fail_alert_interfaces. |
|
Deprecated, please rename it to fail_alert_method. Choices:
|
|
Deprecated, please rename it to fail_detect. Choices:
|
|
Deprecated, please rename it to fail_detect_option. Choices:
|
|
No description. Choices:
|
|
No description. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to fortilink_backup_link. |
|
Deprecated, please rename it to fortilink_neighbor_detect. Choices:
|
|
Deprecated, please rename it to fortilink_split_interface. Choices:
|
|
Deprecated, please rename it to fortilink_stacking. Choices:
|
|
Deprecated, please rename it to forward_domain. |
|
Deprecated, please rename it to forward_error_correction. Choices:
|
|
Deprecated, please rename it to fp_anomaly. Choices:
|
|
Deprecated, please rename it to fp_disable. Choices:
|
|
Deprecated, please rename it to gateway_address. |
|
Deprecated, please rename it to generic_receive_offload. Choices:
|
|
Deprecated, please rename it to gi_gk. Choices:
|
|
No description. |
|
No description. Choices:
|
|
Deprecated, please rename it to ha_priority. |
|
Deprecated, please rename it to icmp_accept_redirect. Choices:
|
|
Deprecated, please rename it to icmp_redirect. Choices:
|
|
Deprecated, please rename it to icmp_send_redirect. Choices:
|
|
Deprecated, please rename it to ident_accept. Choices:
|
|
Deprecated, please rename it to idle_timeout. |
|
Deprecated, please rename it to if_mdix. Choices:
|
|
Deprecated, please rename it to if_media. Choices:
|
|
Deprecated, please rename it to ike_saml_server. Configure IKE authentication SAML server. |
|
Deprecated, please rename it to in_force_vlan_cos. |
|
No description. |
|
Deprecated, please rename it to ingress_cos. Choices:
|
|
Deprecated, please rename it to ingress_shaping_profile. |
|
Deprecated, please rename it to ingress_spillover_threshold. |
|
Deprecated, please rename it to interconnect_profile. Set interconnect profile. Choices:
|
|
No description. |
|
No description. |
|
Deprecated, please rename it to ip_managed_by_fortiipam. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to ips_sniffer_mode. Choices:
|
|
No description. |
|
No description. |
|
No description. Choices:
|
|
Deprecated, please rename it to cli_conn6_status. |
|
Deprecated, please rename it to dhcp6_client_options. Choices:
|
|
Deprecated, please rename it to dhcp6_information_request. Choices:
|
|
Deprecated, please rename it to dhcp6_prefix_delegation. Choices:
|
|
Deprecated, please rename it to dhcp6_prefix_hint. |
|
Deprecated, please rename it to dhcp6_prefix_hint_plt. |
|
Deprecated, please rename it to dhcp6_prefix_hint_vlt. |
|
Deprecated, please rename it to dhcp6_relay_interface_id. DHCP6 relay interface ID. |
|
Deprecated, please rename it to dhcp6_relay_ip. |
|
Deprecated, please rename it to dhcp6_relay_service. Choices:
|
|
Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable use of address on this interface as t… Choices:
|
|
Deprecated, please rename it to dhcp6_relay_source_ip. IPv6 address used by the DHCP6 relay as its source IP. |
|
Deprecated, please rename it to dhcp6_relay_type. Choices:
|
|
Deprecated, please rename it to icmp6_send_redirect. Enable/disable sending of ICMPv6 redirects. Choices:
|
|
Deprecated, please rename it to interface_identifier. |
|
Deprecated, please rename it to ip6_address. |
|
Deprecated, please rename it to ip6_allowaccess. Choices:
|
|
Deprecated, please rename it to ip6_default_life. |
|
Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream int… |
|
Deprecated, please rename it to ip6_delegated_prefix_list. |
|
Deprecated, please rename it to autonomous_flag. Choices:
|
|
Deprecated, please rename it to delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream… |
|
Deprecated, please rename it to onlink_flag. Choices:
|
|
Deprecated, please rename it to prefix_id. |
|
(list) No description. |
|
Deprecated, please rename it to rdnss_service. Choices:
|
|
No description. |
|
Deprecated, please rename it to upstream_interface. |
|
Deprecated, please rename it to ip6_dns_server_override. Choices:
|
|
Deprecated, please rename it to ip6_extra_addr. |
|
No description. |
|
Deprecated, please rename it to ip6_hop_limit. |
|
Deprecated, please rename it to ip6_link_mtu. |
|
Deprecated, please rename it to ip6_manage_flag. Choices:
|
|
Deprecated, please rename it to ip6_max_interval. |
|
Deprecated, please rename it to ip6_min_interval. |
|
Deprecated, please rename it to ip6_mode. Choices:
|
|
Deprecated, please rename it to ip6_other_flag. Choices:
|
|
Deprecated, please rename it to ip6_prefix_list. |
|
Deprecated, please rename it to autonomous_flag. Choices:
|
|
(list) No description. |
|
Deprecated, please rename it to onlink_flag. Choices:
|
|
Deprecated, please rename it to preferred_life_time. |
|
No description. |
|
(list) No description. |
|
Deprecated, please rename it to valid_life_time. |
|
Deprecated, please rename it to ip6_prefix_mode. Assigning a prefix from DHCP or RA. Choices:
|
|
Deprecated, please rename it to ip6_reachable_time. |
|
Deprecated, please rename it to ip6_retrans_time. |
|
Deprecated, please rename it to ip6_send_adv. Choices:
|
|
Deprecated, please rename it to ip6_subnet. |
|
Deprecated, please rename it to ip6_upstream_interface. |
|
Deprecated, please rename it to nd_cert. |
|
Deprecated, please rename it to nd_cga_modifier. |
|
Deprecated, please rename it to nd_mode. Choices:
|
|
Deprecated, please rename it to nd_security_level. |
|
Deprecated, please rename it to nd_timestamp_delta. |
|
Deprecated, please rename it to nd_timestamp_fuzz. |
|
Deprecated, please rename it to ra_send_mtu. Enable/disable sending link MTU in RA packet. Choices:
|
|
Deprecated, please rename it to unique_autoconf_addr. Choices:
|
|
No description. |
|
Deprecated, please rename it to vrrp_virtual_mac6. Choices:
|
|
No description. |
|
Deprecated, please rename it to accept_mode. Choices:
|
|
Deprecated, please rename it to adv_interval. |
|
Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default route when checki… Choices:
|
|
No description. Choices:
|
|
No description. |
|
Deprecated, please rename it to start_time. |
|
No description. Choices:
|
|
No description. |
|
No description. |
|
No description. |
|
No description. |
|
No description. Choices:
|
|
Deprecated, please rename it to l2tp_client. Choices:
|
|
Deprecated, please rename it to lacp_ha_secondary. Choices:
|
|
Deprecated, please rename it to lacp_ha_slave. Choices:
|
|
Deprecated, please rename it to lacp_mode. Choices:
|
|
Deprecated, please rename it to lacp_speed. Choices:
|
|
Deprecated, please rename it to large_receive_offload. Choices:
|
|
Deprecated, please rename it to lcp_echo_interval. |
|
Deprecated, please rename it to lcp_max_echo_fails. |
|
Deprecated, please rename it to link_up_delay. |
|
Deprecated, please rename it to listen_forticlient_connection. Choices:
|
|
Deprecated, please rename it to lldp_network_policy. |
|
Deprecated, please rename it to lldp_reception. Choices:
|
|
Deprecated, please rename it to lldp_transmission. Choices:
|
|
No description. Choices:
|
|
No description. |
|
Deprecated, please rename it to managed_subnetwork_size. Choices:
|
|
Deprecated, please rename it to management_ip. |
|
Deprecated, please rename it to max_egress_burst_rate. |
|
Deprecated, please rename it to max_egress_rate. |
|
Deprecated, please rename it to measured_downstream_bandwidth. |
|
Deprecated, please rename it to measured_upstream_bandwidth. |
|
No description. Choices:
|
|
(list or str) No description. |
|
Deprecated, please rename it to min_links. |
|
Deprecated, please rename it to min_links_down. Choices:
|
|
Deprecated, please rename it to mirroring_direction. Port mirroring direction. Choices:
|
|
Deprecated, please rename it to mirroring_port. Mirroring port. |
|
No description. Choices:
|
|
Deprecated, please rename it to monitor_bandwidth. Choices:
|
|
No description. |
|
Deprecated, please rename it to mtu_override. Choices:
|
|
Deprecated, please rename it to mux_type. Choices:
|
|
No description. |
|
No description. Choices:
|
|
Deprecated, please rename it to netbios_forward. Choices:
|
|
Deprecated, please rename it to netflow_sampler. Choices:
|
|
Deprecated, please rename it to np_qos_profile. NP QoS profile ID. |
|
Deprecated, please rename it to npu_fastpath. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to out_force_vlan_cos. |
|
No description. |
|
Deprecated, please rename it to padt_retry_timeout. |
|
(list) No description. |
|
(list or str) Deprecated, please rename it to peer_interface. |
|
Deprecated, please rename it to phy_mode. Choices:
|
|
Deprecated, please rename it to ping_serv_status. |
|
No description. Choices:
|
|
Deprecated, please rename it to polling_interval. |
|
Deprecated, please rename it to port_mirroring. Enable/disable NP port mirroring. Choices:
|
|
Deprecated, please rename it to pppoe_unnumbered_negotiate. Choices:
|
|
Deprecated, please rename it to pptp_auth_type. Choices:
|
|
Deprecated, please rename it to pptp_client. Choices:
|
|
(list) Deprecated, please rename it to pptp_password. |
|
Deprecated, please rename it to pptp_server_ip. |
|
Deprecated, please rename it to pptp_timeout. |
|
Deprecated, please rename it to pptp_user. |
|
Deprecated, please rename it to preserve_session_route. Choices:
|
|
No description. |
|
Deprecated, please rename it to priority_override. Choices:
|
|
Deprecated, please rename it to proxy_captive_portal. Choices:
|
|
Deprecated, please rename it to pvc_atm_qos. SFP-DSL ADSL Fallback PVC ATM QoS. Choices:
|
|
Deprecated, please rename it to pvc_chan. SFP-DSL ADSL Fallback PVC Channel. |
|
Deprecated, please rename it to pvc_crc. SFP-DSL ADSL Fallback PVC CRC Option |
|
Deprecated, please rename it to pvc_pcr. SFP-DSL ADSL Fallback PVC Packet Cell Rate in cells |
|
Deprecated, please rename it to pvc_scr. SFP-DSL ADSL Fallback PVC Sustainable Cell Rate in cells |
|
Deprecated, please rename it to pvc_vlan_id. SFP-DSL ADSL Fallback PVC VLAN ID. |
|
Deprecated, please rename it to pvc_vlan_rx_id. SFP-DSL ADSL Fallback PVC VLANID RX. |
|
Deprecated, please rename it to pvc_vlan_rx_op. SFP-DSL ADSL Fallback PVC VLAN RX op. Choices:
|
|
Deprecated, please rename it to pvc_vlan_tx_id. SFP-DSL ADSL Fallback PVC VLAN ID TX. |
|
Deprecated, please rename it to pvc_vlan_tx_op. SFP-DSL ADSL Fallback PVC VLAN TX op. Choices:
|
|
Deprecated, please rename it to reachable_time. IPv4 reachable time in milliseconds |
|
Deprecated, please rename it to redundant_interface. |
|
Deprecated, please rename it to remote_ip. |
|
Deprecated, please rename it to replacemsg_override_group. |
|
No description. Choices:
|
|
Deprecated, please rename it to ring_rx. |
|
Deprecated, please rename it to ring_tx. |
|
No description. Choices:
|
|
Deprecated, please rename it to sample_direction. Choices:
|
|
Deprecated, please rename it to sample_rate. |
|
Deprecated, please rename it to scan_botnet_connections. Choices:
|
|
Deprecated, please rename it to secondary_IP. Choices:
|
|
No description. |
|
No description. Choices:
|
|
No description. Choices:
|
|
No description. |
|
No description. Choices:
|
|
Deprecated, please rename it to ha_priority. |
|
No description. |
|
No description. |
|
Deprecated, please rename it to ping_serv_status. |
|
Deprecated, please rename it to secip_relay_ip. DHCP relay IP address. |
|
No description. |
|
Deprecated, please rename it to security_8021x_dynamic_vlan_id. |
|
Deprecated, please rename it to security_8021x_master. |
|
Deprecated, please rename it to security_8021x_member_mode. ‘802.’ Choices:
|
|
Deprecated, please rename it to security_8021x_mode. Choices:
|
|
Deprecated, please rename it to security_exempt_list. |
|
Deprecated, please rename it to security_external_logout. |
|
Deprecated, please rename it to security_external_web. |
|
(list or str) Deprecated, please rename it to security_groups. |
|
Deprecated, please rename it to security_mac_auth_bypass. Choices:
|
|
Deprecated, please rename it to security_mode. Choices:
|
|
Deprecated, please rename it to security_redirect_url. |
|
Deprecated, please rename it to select_profile_30a_35b. Select VDSL Profile 30a or 35b. Choices:
|
|
Deprecated, please rename it to service_name. |
|
Deprecated, please rename it to sflow_sampler. Choices:
|
|
Deprecated, please rename it to sfp_dsl. Enable/disable SFP DSL. Choices:
|
|
Deprecated, please rename it to sfp_dsl_adsl_fallback. Enable/disable SFP DSL ADSL fallback. Choices:
|
|
Deprecated, please rename it to sfp_dsl_autodetect. Enable/disable SFP DSL MAC address autodetect. Choices:
|
|
Deprecated, please rename it to sfp_dsl_mac. SFP DSL MAC address. |
|
No description. Choices:
|
|
Deprecated, please rename it to spillover_threshold. |
|
Deprecated, please rename it to src_check. Choices:
|
|
No description. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to stp_edge. Enable/disable as STP edge port. Choices:
|
|
Deprecated, please rename it to stp_ha_secondary. Control STP behaviour on HA secondary. Choices:
|
|
Deprecated, please rename it to stp_ha_slave. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to stpforward_mode. Choices:
|
|
Deprecated, please rename it to strip_priority_vlan_tag. Choices:
|
|
No description. Choices:
|
|
Deprecated, please rename it to substitute_dst_mac. |
|
Deprecated, please rename it to sw_algorithm. Frame distribution algorithm for switch. Choices:
|
|
Deprecated, please rename it to swc_first_create. Initial create for switch-controller VLANs. |
|
Deprecated, please rename it to swc_vlan. |
|
No description. |
|
Deprecated, please rename it to switch_controller_access_vlan. Choices:
|
|
Deprecated, please rename it to switch_controller_arp_inspection. Choices:
|
|
Deprecated, please rename it to switch_controller_auth. Choices:
|
|
Deprecated, please rename it to switch_controller_dhcp_snooping. Choices:
|
|
Deprecated, please rename it to switch_controller_dhcp_snooping_option82. Choices:
|
|
Deprecated, please rename it to switch_controller_dhcp_snooping_verify_mac. Choices:
|
|
Deprecated, please rename it to switch_controller_dynamic. Integrated FortiLink settings for managed FortiSwitch. |
|
Deprecated, please rename it to switch_controller_feature. Choices:
|
|
Deprecated, please rename it to switch_controller_igmp_snooping. Choices:
|
|
Deprecated, please rename it to switch_controller_igmp_snooping_fast_leave. Choices:
|
|
Deprecated, please rename it to switch_controller_igmp_snooping_proxy. Choices:
|
|
Deprecated, please rename it to switch_controller_iot_scanning. Enable/disable managed FortiSwitch IoT scanning. Choices:
|
|
Deprecated, please rename it to switch_controller_learning_limit. |
|
Deprecated, please rename it to switch_controller_mgmt_vlan. |
|
Deprecated, please rename it to switch_controller_nac. |
|
Deprecated, please rename it to switch_controller_netflow_collect. NetFlow collection and processing. Choices:
|
|
Deprecated, please rename it to switch_controller_offload. Enable/disable managed FortiSwitch routing offload. Choices:
|
|
Deprecated, please rename it to switch_controller_offload_gw. Enable/disable managed FortiSwitch routing offload gateway. Choices:
|
|
Deprecated, please rename it to switch_controller_offload_ip. IP for routing offload on FortiSwitch. |
|
Deprecated, please rename it to switch_controller_offloading. Choices:
|
|
Deprecated, please rename it to switch_controller_offloading_gw. Choices:
|
|
Deprecated, please rename it to switch_controller_offloading_ip. |
|
Deprecated, please rename it to switch_controller_radius_server. |
|
Deprecated, please rename it to switch_controller_rspan_mode. Choices:
|
|
Deprecated, please rename it to switch_controller_source_ip. Source IP address used in FortiLink over L3 connections. Choices:
|
|
Deprecated, please rename it to switch_controller_traffic_policy. |
|
Deprecated, please rename it to system_id. Define a system ID for the aggregate interface. |
|
Deprecated, please rename it to system_id_type. Method in which system ID is generated. Choices:
|
|
Deprecated, please rename it to tc_mode. Choices:
|
|
Deprecated, please rename it to tcp_mss. |
|
No description. Choices:
|
|
Deprecated, please rename it to trust_ip_1. |
|
Deprecated, please rename it to trust_ip_2. |
|
Deprecated, please rename it to trust_ip_3. |
|
Deprecated, please rename it to trust_ip6_1. |
|
Deprecated, please rename it to trust_ip6_2. |
|
Deprecated, please rename it to trust_ip6_3. |
|
No description. Choices:
|
|
No description. |
|
No description. |
|
No description. Choices:
|
|
No description. |
|
Deprecated, please rename it to vlan_id. Vlan ID |
|
Deprecated, please rename it to vlan_op_mode. Configure DSL 802. Choices:
|
|
Deprecated, please rename it to vlan_protocol. Choices:
|
|
No description. Choices:
|
|
No description. |
|
No description. |
|
No description. |
|
No description. |
|
Deprecated, please rename it to accept_mode. Choices:
|
|
Deprecated, please rename it to adv_interval. |
|
Deprecated, please rename it to ignore_default_route. Choices:
|
|
No description. Choices:
|
|
No description. |
|
Deprecated, please rename it to proxy_arp. |
|
ID. |
|
Set IP addresses of proxy ARP. |
|
Deprecated, please rename it to start_time. |
|
No description. Choices:
|
|
No description. Choices:
|
|
(list) No description. |
|
Deprecated, please rename it to vrdst_priority. |
|
No description. |
|
No description. |
|
No description. |
|
Deprecated, please rename it to vrrp_virtual_mac. Choices:
|
|
No description. Choices:
|
|
No description. |
|
Deprecated, please rename it to wifi_5g_threshold. |
|
Deprecated, please rename it to wifi_acl. Choices:
|
|
Deprecated, please rename it to wifi_ap_band. Choices:
|
|
Deprecated, please rename it to wifi_auth. Choices:
|
|
Deprecated, please rename it to wifi_auto_connect. Choices:
|
|
Deprecated, please rename it to wifi_auto_save. Choices:
|
|
Deprecated, please rename it to wifi_broadcast_ssid. Choices:
|
|
Deprecated, please rename it to wifi_dns_server1. DNS server 1. |
|
Deprecated, please rename it to wifi_dns_server2. DNS server 2. |
|
Deprecated, please rename it to wifi_encrypt. Choices:
|
|
Deprecated, please rename it to wifi_fragment_threshold. |
|
Deprecated, please rename it to wifi_gateway. IPv4 default gateway IP address. |
|
(list) Deprecated, please rename it to wifi_key. |
|
Deprecated, please rename it to wifi_keyindex. |
|
Deprecated, please rename it to wifi_mac_filter. Choices:
|
|
(list) Deprecated, please rename it to wifi_passphrase. |
|
Deprecated, please rename it to wifi_radius_server. |
|
Deprecated, please rename it to wifi_rts_threshold. |
|
Deprecated, please rename it to wifi_security. Choices:
|
|
Deprecated, please rename it to wifi_ssid. |
|
Deprecated, please rename it to wifi_usergroup. |
|
Deprecated, please rename it to wins_ip. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The parameter (vlan) in requested url. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure interfaces.
fortinet.fortimanager.fmgr_fsp_vlan_interface:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
vlan: <your own value>
fsp_vlan_interface:
ac_name: <string>
aggregate: <string>
algorithm: <value in [L2, L3, L4, ...]>
alias: <string>
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
- speed-test
ap_discover: <value in [disable, enable]>
arpforward: <value in [disable, enable]>
atm_protocol: <value in [none, ipoa]>
auth_type: <value in [auto, pap, chap, ...]>
auto_auth_extension_device: <value in [disable, enable]>
bfd: <value in [global, enable, disable]>
bfd_desired_min_tx: <integer>
bfd_detect_mult: <integer>
bfd_required_min_rx: <integer>
broadcast_forticlient_discovery: <value in [disable, enable]>
broadcast_forward: <value in [disable, enable]>
captive_portal: <integer>
cli_conn_status: <integer>
color: <integer>
ddns: <value in [disable, enable]>
ddns_auth: <value in [disable, tsig]>
ddns_domain: <string>
ddns_key: <list or string>
ddns_keyname: <string>
ddns_password: <list or string>
ddns_server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
ddns_server_ip: <string>
ddns_sn: <string>
ddns_ttl: <integer>
ddns_username: <string>
ddns_zone: <string>
dedicated_to: <value in [none, management]>
defaultgw: <value in [disable, enable]>
description: <string>
detected_peer_mtu: <integer>
detectprotocol:
- ping
- tcp-echo
- udp-echo
detectserver: <string>
device_access_list: <list or string>
device_identification: <value in [disable, enable]>
device_identification_active_scan: <value in [disable, enable]>
device_netscan: <value in [disable, enable]>
device_user_identification: <value in [disable, enable]>
devindex: <integer>
dhcp_client_identifier: <string>
dhcp_relay_agent_option: <value in [disable, enable]>
dhcp_relay_ip: <list or string>
dhcp_relay_service: <value in [disable, enable]>
dhcp_relay_type: <value in [regular, ipsec]>
dhcp_renew_time: <integer>
disc_retry_timeout: <integer>
disconnect_threshold: <integer>
distance: <integer>
dns_query: <value in [disable, recursive, non-recursive]>
dns_server_override: <value in [disable, enable]>
drop_fragment: <value in [disable, enable]>
drop_overlapped_fragment: <value in [disable, enable]>
egress_cos: <value in [disable, cos0, cos1, ...]>
egress_shaping_profile: <string>
endpoint_compliance: <value in [disable, enable]>
estimated_downstream_bandwidth: <integer>
estimated_upstream_bandwidth: <integer>
explicit_ftp_proxy: <value in [disable, enable]>
explicit_web_proxy: <value in [disable, enable]>
external: <value in [disable, enable]>
fail_action_on_extender: <value in [soft-restart, hard-restart, reboot]>
fail_alert_interfaces: <list or string>
fail_alert_method: <value in [link-failed-signal, link-down]>
fail_detect: <value in [disable, enable]>
fail_detect_option:
- detectserver
- link-down
fdp: <value in [disable, enable]>
fortiheartbeat: <value in [disable, enable]>
fortilink: <value in [disable, enable]>
fortilink_backup_link: <integer>
fortilink_split_interface: <value in [disable, enable]>
fortilink_stacking: <value in [disable, enable]>
forward_domain: <integer>
forward_error_correction: <value in [disable, enable, rs-fec, ...]>
fp_anomaly:
- drop_tcp_fin_noack
- pass_winnuke
- pass_tcpland
- pass_udpland
- pass_icmpland
- pass_ipland
- pass_iprr
- pass_ipssrr
- pass_iplsrr
- pass_ipstream
- pass_ipsecurity
- pass_iptimestamp
- pass_ipunknown_option
- pass_ipunknown_prot
- pass_icmp_frag
- pass_tcp_no_flag
- pass_tcp_fin_noack
- drop_winnuke
- drop_tcpland
- drop_udpland
- drop_icmpland
- drop_ipland
- drop_iprr
- drop_ipssrr
- drop_iplsrr
- drop_ipstream
- drop_ipsecurity
- drop_iptimestamp
- drop_ipunknown_option
- drop_ipunknown_prot
- drop_icmp_frag
- drop_tcp_no_flag
fp_disable:
- all
- ipsec
- none
gateway_address: <string>
gi_gk: <value in [disable, enable]>
gwaddr: <string>
gwdetect: <value in [disable, enable]>
ha_priority: <integer>
icmp_accept_redirect: <value in [disable, enable]>
icmp_redirect: <value in [disable, enable]>
icmp_send_redirect: <value in [disable, enable]>
ident_accept: <value in [disable, enable]>
idle_timeout: <integer>
if_mdix: <value in [auto, normal, crossover]>
if_media: <value in [auto, copper, fiber]>
in_force_vlan_cos: <integer>
inbandwidth: <integer>
ingress_cos: <value in [disable, cos0, cos1, ...]>
ingress_spillover_threshold: <integer>
internal: <integer>
ip: <string>
ipmac: <value in [disable, enable]>
ips_sniffer_mode: <value in [disable, enable]>
ipunnumbered: <string>
ipv6:
autoconf: <value in [disable, enable]>
dhcp6_client_options:
- rapid
- iapd
- iana
- dns
- dnsname
dhcp6_information_request: <value in [disable, enable]>
dhcp6_prefix_delegation: <value in [disable, enable]>
dhcp6_prefix_hint: <string>
dhcp6_prefix_hint_plt: <integer>
dhcp6_prefix_hint_vlt: <integer>
dhcp6_relay_ip: <string>
dhcp6_relay_service: <value in [disable, enable]>
dhcp6_relay_type: <value in [regular]>
ip6_address: <string>
ip6_allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6_default_life: <integer>
ip6_dns_server_override: <value in [disable, enable]>
ip6_hop_limit: <integer>
ip6_link_mtu: <integer>
ip6_manage_flag: <value in [disable, enable]>
ip6_max_interval: <integer>
ip6_min_interval: <integer>
ip6_mode: <value in [static, dhcp, pppoe, ...]>
ip6_other_flag: <value in [disable, enable]>
ip6_reachable_time: <integer>
ip6_retrans_time: <integer>
ip6_send_adv: <value in [disable, enable]>
ip6_subnet: <string>
ip6_upstream_interface: <string>
nd_cert: <string>
nd_cga_modifier: <string>
nd_mode: <value in [basic, SEND-compatible]>
nd_security_level: <integer>
nd_timestamp_delta: <integer>
nd_timestamp_fuzz: <integer>
vrip6_link_local: <string>
vrrp_virtual_mac6: <value in [disable, enable]>
ip6_delegated_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
onlink_flag: <value in [disable, enable]>
prefix_id: <integer>
rdnss: <list or string>
rdnss_service: <value in [delegated, default, specify]>
subnet: <string>
upstream_interface: <string>
delegated_prefix_iaid: <integer>
ip6_extra_addr:
-
prefix: <string>
ip6_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
dnssl: <list or string>
onlink_flag: <value in [disable, enable]>
preferred_life_time: <integer>
prefix: <string>
rdnss: <list or string>
valid_life_time: <integer>
vrrp6:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
preempt: <value in [disable, enable]>
priority: <integer>
start_time: <integer>
status: <value in [disable, enable]>
vrdst6: <string>
vrgrp: <integer>
vrid: <integer>
vrip6: <string>
ignore_default_route: <value in [disable, enable]>
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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |