PARALLAX

fortios_system_interface

Manage FortiOS configuration through native controller HTTPAPI; requires httpapi inventory and fortinet.fortios.fortios network OS

Collection: fortinet.fortios

Full Name: fortinet.fortios.fortios_system_interface

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manage FortiOS configuration through native controller HTTPAPI; requires httpapi inventory and fortinet.fortios.fortios network OS

Parameters

NameTypeRequiredDefaultDescription
access_tokenstr
enable_logboolfalse
member_pathstr
member_statestr
statestryes
system_interfacedict
vdomstrroot

Example

yaml
# Define these inventory variables: fortios_access_token.
- fortinet.fortios.fortios_system_interface:
    access_token: '{{ fortios_access_token }}'
    state: present
    system_interface:
        aggregate_type: physical
        algorithm: L2
        allowaccess: ping
        ap_discover: enable
        arpforward: enable
        auth_type: auto
        auto_auth_extension_device: enable
        bandwidth_measure_time: "0"
        bfd: global
        bfd_desired_min_tx: "250"
        bfd_detect_mult: "3"
        bfd_required_min_rx: "250"
        broadcast_forticlient_discovery: enable
        broadcast_forward: enable
        captive_portal: "2147483647"
        cli_conn_status: "0"
        client_options:
            - code: "0"
              id: "26"
              type: hex
        color: "0"
        dedicated_to: none
        default_purdue_level: "1"
        defaultgw: enable
        detected_peer_mtu: "0"
        detectprotocol: ping
        device_identification: enable
        device_identification_active_scan: enable
        device_netscan: disable
        device_user_identification: enable
        devindex: "0"
        dhcp_broadcast_flag: disable
        dhcp_classless_route_addition: enable
        dhcp_client_identifier: myId_46
        dhcp_relay_agent_option: enable
        dhcp_relay_allow_no_end_option: disable
        dhcp_relay_interface_select_method: auto
        dhcp_relay_request_all_server: disable
        dhcp_relay_service: disable
        dhcp_relay_type: regular
        dhcp_relay_vrf_select: "-1"
        dhcp_renew_time: "0"
        dhcp_smart_relay: disable
        dhcp_snooping_server_list:
            - name: default_name_62
        disc_retry_timeout: "1"
        disconnect_threshold: "0"
        distance: "5"
        dns_server_override: enable
        dns_server_protocol: cleartext
        drop_fragment: enable
        drop_overlapped_fragment: enable
        eap_method: tls
        eap_supplicant: enable
        egress_cos: disable
        endpoint_compliance: enable
        estimated_downstream_bandwidth: "0"
        estimated_upstream_bandwidth: "0"
        exclude_signatures: iot
        explicit_ftp_proxy: enable
        explicit_web_proxy: enable
        external: enable
        fail_action_on_extender: soft-restart
        fail_alert_interfaces:
            - name: default_name_97 (source system.interface.name)
        fail_alert_method: link-failed-signal
        fail_detect: enable
        fail_detect_option: detectserver
        fortiheartbeat: enable
        fortilink: enable
        fortilink_backup_link: "0"
        fortilink_neighbor_detect: lldp
        fortilink_split_interface: enable
        fortilink_stacking: enable
        forward_domain: "0"
        forward_error_correction: none
        gi_gk: enable
        gwdetect: enable
        ha_priority: "1"
        icmp_accept_redirect: enable
        icmp_send_redirect: enable
        ident_accept: enable
        idle_timeout: "0"
        inbandwidth: "0"
        ingress_cos: disable
        ingress_spillover_threshold: "0"
        interconnect_profile: default
        internal: "0"
        ip_managed_by_fortiipam: inherit-global
        ipmac: enable
        ips_sniffer_mode: enable
        ipv6:
            autoconf: enable
            cli_conn6_status: "0"
            client_options:
                - code: "0"
                  id: "134"
                  type: hex
            dhcp6_client_options: rapid
            dhcp6_iapd_list:
                - iaid: 1
                  prefix_hint_plt: "604800"
                  prefix_hint_vlt: "2592000"
            dhcp6_information_request: enable
            dhcp6_prefix_delegation: enable
            dhcp6_prefix_hint_plt: "604800"
            dhcp6_prefix_hint_vlt: "2592000"
            dhcp6_relay_service: disable
            dhcp6_relay_source_interface: disable
            dhcp6_relay_type: regular
            icmp6_send_redirect: enable
            interface_identifier: myId_156
            ip6_adv_rio: enable
            ip6_allowaccess: ping
            ip6_default_life: "1800"
            ip6_delegated_prefix_iaid: "0"
            ip6_delegated_prefix_list:
                - autonomous_flag: enable
                  delegated_prefix_iaid: "0"
                  dnssl_service: enable
                  onlink_flag: enable
                  prefix_id: 1
                  rdnss_service: delegated
            ip6_dns_server_override: enable
            ip6_hop_limit: "0"
            ip6_link_mtu: "0"
            ip6_manage_flag: enable
            ip6_max_interval: "600"
            ip6_min_interval: "198"
            ip6_mode: static
            ip6_other_flag: enable
            ip6_prefix_mode: dhcp6
            ip6_reachable_time: "0"
            ip6_retrans_time: "0"
            ip6_route_pref: medium
            ip6_send_adv: enable
            nd_mode: basic
            nd_security_level: "0"
            nd_timestamp_delta: "300"
            nd_timestamp_fuzz: "1"
            ra_send_mtu: enable
            unique_autoconf_addr: enable
            vrrp_virtual_mac6: enable
            vrrp6:
                - accept_mode: enable
                  adv_interval: "1000"
                  ignore_default_route: enable
                  preempt: enable
                  priority: "100"
                  start_time: "3"
                  status: enable
                  vrdst_priority: "0"
                  vrgrp: "0"
                  vrid: 1
        l2forward: enable
        lacp_ha_secondary: enable
        lacp_ha_slave: enable
        lacp_mode: static
        lacp_speed: slow
        lcp_echo_interval: "5"
        lcp_max_echo_fails: "3"
        link_up_delay: "50"
        lldp_reception: enable
        lldp_transmission: enable
        managed_device:
            - name: default_name_244
        managed_subnetwork_size: "4"
        measured_downstream_bandwidth: "0"
        measured_upstream_bandwidth: "0"
        mediatype: none
        min_links: "1"
        min_links_down: operational
        mirroring_direction: rx
        mirroring_filter:
            filter_dport: "0"
            filter_protocol: "0"
            filter_sport: "0"
        mode: static
        monitor_bandwidth: enable
        mrru: "1500"
        mtu: "1500"
        mtu_override: enable
        multilink: enable
        name: default_name_268
        ndiscforward: enable
        netbios_forward: disable
        netflow_sample_rate: "1"
        netflow_sampler: disable
        netflow_sampler_id: "0"
        np_qos_profile: "0"
        outbandwidth: "0"
        padt_retry_timeout: "1"
        phy_setting:
            signal_ok_threshold: "0"
        ping_serv_status: "0"
        polling_interval: "20"
        port_mirroring: disable
        pppoe_egress_cos: cos0
        pppoe_unnumbered_negotiate: enable
        pptp_auth_type: auto
        pptp_client: enable
        pptp_timeout: "0"
        preserve_session_route: enable
        priority: "1"
        priority_override: enable
        proxy_captive_portal: enable
        reachable_time: "30000"
        ring_rx: "0"
        ring_tx: "0"
        role: lan
        sample_direction: tx
        sample_rate: "2000"
        scan_botnet_connections: disable
        secondary_IP: enable
        secondaryip:
            - allowaccess: ping
              detectprotocol: ping
              gwdetect: enable
              ha_priority: "1"
              id: "312"
              ping_serv_status: "0"
        security_8021x_dynamic_vlan_id: "0"
        security_8021x_member_mode: switch
        security_8021x_mode: default
        security_groups:
            - name: default_name_324 (source user.group.name)
        security_ip_auth_bypass: enable
        security_mac_auth_bypass: mac-auth-only
        security_mode: none
        sflow_sampler: enable
        snmp_index: "0"
        speed: auto
        spillover_threshold: "0"
        src_check: enable
        status: up
        stp: disable
        stp_edge: disable
        stp_ha_secondary: disable
        stp_ha_slave: disable
        stpforward: enable
        stpforward_mode: rpl-all-ext-id
        subst: enable
        sw_algorithm: l2
        swc_first_create: "0"
        swc_vlan: "0"
        switch_controller_access_vlan: enable
        switch_controller_arp_inspection: enable
        switch_controller_dhcp_snooping: enable
        switch_controller_dhcp_snooping_option82: enable
        switch_controller_dhcp_snooping_verify_mac: enable
        switch_controller_feature: none
        switch_controller_igmp_snooping: enable
        switch_controller_igmp_snooping_fast_leave: enable
        switch_controller_igmp_snooping_proxy: enable
        switch_controller_iot_scanning: enable
        switch_controller_learning_limit: "0"
        switch_controller_mgmt_vlan: "4094"
        switch_controller_netflow_collect: disable
        switch_controller_offload: enable
        switch_controller_offload_gw: enable
        switch_controller_rspan_mode: disable
        switch_controller_source_ip: outbound
        system_id_type: auto
        tagging:
            - name: default_name_373
              tags:
                - name: default_name_375 (source system.object-tagging.tags.name)
        tcp_mss: "0"
        telemetry_discover: enable
        trunk: enable
        type: physical
        vindex: "0"
        vlan_protocol: 8021q
        vlanforward: enable
        vlanid: "0"
        vrf: "0"
        vrrp:
            - accept_mode: enable
              adv_interval: "1000"
              ignore_default_route: enable
              preempt: enable
              priority: "100"
              proxy_arp:
                - id: "401"
              start_time: "3"
              status: enable
              version: "2"
              vrdst_priority: "0"
              vrgrp: "0"
              vrid: 1
        vrrp_virtual_mac: enable
        wccp: enable
        weight: "0"
    vdom: root
  name: Configure interfaces.
Search
    ↑ ↓ move↵ openesc close