fortios_switch_controller_managed_switch – Configure FortiSwitch devices that are managed by this FortiGate in Fortinet’s FortiOS and FortiGate.

New in version 2.8.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and managed_switch category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0

Requirements

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

  • ansible>=2.9.0

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
  • switch_controller_managed_switch - Configure FortiSwitch devices that are managed by this FortiGate. type: dict
    • state - B(Deprecated) type: str required: False choices: present, absent
    • settings_802_1X - Configuration method to edit FortiSwitch 802.1X global settings. type: dict
      • link_down_auth - Authentication state to set if a link is down. type: str choices: set-unauth, no-action
      • local_override - Enable to override global 802.1X settings on individual FortiSwitches. type: str choices: enable, disable
      • max_reauth_attempt - Maximum number of authentication attempts (0 - 15). type: int
      • reauth_period - Reauthentication time interval (1 - 1440 min). type: int
      • tx_period - 802.1X Tx period (seconds). type: int
    • access_profile - FortiSwitch access profile. Source switch-controller.security-policy.local-access.name. type: str
    • custom_command - Configuration method to edit FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller or the FortiSwitch. type: list
      • command_entry - List of FortiSwitch commands. type: str
      • command_name - Names of commands to be pushed to this FortiSwitch device, as configured under config switch-controller custom-command. Source switch-controller.custom-command.command-name. type: str
    • delayed_restart_trigger - Delayed restart triggered for this FortiSwitch. type: int
    • description - Description. type: str
    • directly_connected - Directly connected FortiSwitch. type: int
    • dynamic_capability - List of features this FortiSwitch supports (not configurable) that is sent to the FortiGate device for subsequent configuration initiated by the FortiGate device. type: int
    • dynamically_discovered - Dynamically discovered FortiSwitch. type: int
    • flow_identity - Flow-tracking netflow ipfix switch identity in hex format(00000000-FFFFFFFF ). type: str
    • fsw_wan1_admin - FortiSwitch WAN1 admin status; enable to authorize the FortiSwitch as a managed switch. type: str choices: discovered, disable, enable
    • fsw_wan1_peer - Fortiswitch WAN1 peer port. type: str
    • igmp_snooping - Configure FortiSwitch IGMP snooping global settings. type: dict
      • aging_time - Maximum time to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec). type: int
      • flood_unknown_multicast - Enable/disable unknown multicast flooding. type: str choices: enable, disable
      • local_override - Enable/disable overriding the global IGMP snooping configuration. type: str choices: enable, disable
    • ip_source_guard - IP source guard. type: list
      • binding_entry - IP and MAC address configuration. type: list
        • entry_name - Configure binding pair. type: str
        • ip - Source IP for this rule. type: str
        • mac - MAC address for this rule. type: str
      • description - Description. type: str
      • port - Ingress interface to which source guard is bound. type: str required: True
    • l3_discovered - Layer 3 management discovered. type: int
    • mclag_igmp_snooping_aware - Enable/disable MCLAG IGMP-snooping awareness. type: str choices: enable, disable
    • mirror - Configuration method to edit FortiSwitch packet mirror. type: list
      • dst - Destination port. type: str
      • name - Mirror name. type: str required: True
      • src_egress - Source egress interfaces. type: list
        • name - Interface name. type: str required: True
      • src_ingress - Source ingress interfaces. type: list
        • name - Interface name. type: str required: True
      • status - Active/inactive mirror configuration. type: str choices: active, inactive
      • switching_packet - Enable/disable switching functionality when mirroring. type: str choices: enable, disable
    • name - Managed-switch name. type: str
    • override_snmp_community - Enable/disable overriding the global SNMP communities. type: str choices: enable, disable
    • override_snmp_sysinfo - Enable/disable overriding the global SNMP system information. type: str choices: disable, enable
    • override_snmp_trap_threshold - Enable/disable overriding the global SNMP trap threshold values. type: str choices: enable, disable
    • override_snmp_user - Enable/disable overriding the global SNMP users. type: str choices: enable, disable
    • owner_vdom - VDOM which owner of port belongs to. type: str
    • poe_detection_type - PoE detection type for FortiSwitch. type: int
    • poe_pre_standard_detection - Enable/disable PoE pre-standard detection. type: str choices: enable, disable
    • ports - Managed-switch port list. type: list
      • access_mode - Access mode of the port. type: str choices: normal, nac
      • allowed_vlans - Configure switch port tagged vlans type: list
        • vlan_name - VLAN name. Source system.interface.name. type: str
      • allowed_vlans_all - Enable/disable all defined vlans on this port. type: str choices: enable, disable
      • arp_inspection_trust - Trusted or untrusted dynamic ARP inspection. type: str choices: untrusted, trusted
      • bundle - Enable/disable Link Aggregation Group (LAG) bundling for non-FortiLink interfaces. type: str choices: enable, disable
      • description - Description for port. type: str
      • dhcp_snoop_option82_trust - Enable/disable allowance of DHCP with option-82 on untrusted interface. type: str choices: enable, disable
      • dhcp_snooping - Trusted or untrusted DHCP-snooping interface. type: str choices: untrusted, trusted
      • discard_mode - Configure discard mode for port. type: str choices: none, all-untagged, all-tagged
      • edge_port - Enable/disable this interface as an edge port, bridging connections between workstations and/or computers. type: str choices: enable, disable
      • export_tags - Configure export tag(s) for FortiSwitch port when exported to a virtual port pool. type: list
        • tag_name - FortiSwitch port tag name when exported to a virtual port pool. Source switch-controller.switch-interface-tag.name. type: str
      • export_to - Export managed-switch port to a tenant VDOM. Source system.vdom.name. type: str
      • export_to_pool - Switch controller export port to pool-list. Source switch-controller.virtual-port-pool.name. type: str
      • fgt_peer_device_name - FGT peer device name. type: str
      • fgt_peer_port_name - FGT peer port name. type: str
      • fiber_port - Fiber-port. type: int
      • flags - Port properties flags. type: int
      • fortilink_port - FortiLink uplink port. type: int
      • igmps_flood_reports - Enable/disable flooding of IGMP reports to this interface when igmp-snooping enabled. type: str choices: enable, disable
      • igmps_flood_traffic - Enable/disable flooding of IGMP snooping traffic to this interface. type: str choices: enable, disable
      • ip_source_guard - Enable/disable IP source guard. type: str choices: disable, enable
      • isl_local_trunk_name - ISL local trunk name. type: str
      • isl_peer_device_name - ISL peer device name. type: str
      • isl_peer_port_name - ISL peer port name. type: str
      • lacp_speed - end Link Aggregation Control Protocol (LACP) messages every 30 seconds (slow) or every second (fast). type: str choices: slow, fast
      • learning_limit - Limit the number of dynamic MAC addresses on this Port (1 - 128, 0 = no limit, default). type: int
      • lldp_profile - LLDP port TLV profile. Source switch-controller.lldp-profile.name. type: str
      • lldp_status - LLDP transmit and receive status. type: str choices: disable, rx-only, tx-only, tx-rx
      • loop_guard - Enable/disable loop-guard on this interface, an STP optimization used to prevent network loops. type: str choices: enabled, disabled
      • loop_guard_timeout - Loop-guard timeout (0 - 120 min). type: int
      • mac_addr - Port/Trunk MAC. type: str
      • max_bundle - Maximum size of LAG bundle (1 - 24) type: int
      • mclag - Enable/disable multi-chassis link aggregation (MCLAG). type: str choices: enable, disable
      • mclag_icl_port - MCLAG-ICL port. type: int
      • member_withdrawal_behavior - Port behavior after it withdraws because of loss of control packets. type: str choices: forward, block
      • members - Aggregated LAG bundle interfaces. type: list
        • member_name - Interface name from available options. type: str
      • min_bundle - Minimum size of LAG bundle (1 - 24) type: int
      • mode - LACP mode: ignore and do not send control messages, or negotiate 802.3ad aggregation passively or actively. type: str choices: static, lacp-passive, lacp-active
      • p2p_port - General peer to peer tunnel port. type: int
      • packet_sample_rate - Packet sampling rate (0 - 99999 p/sec). type: int
      • packet_sampler - Enable/disable packet sampling on this interface. type: str choices: enabled, disabled
      • poe_capable - PoE capable. type: int
      • poe_pre_standard_detection - Enable/disable PoE pre-standard detection. type: str choices: enable, disable
      • poe_status - Enable/disable PoE status. type: str choices: enable, disable
      • port_name - Switch port name. type: str
      • port_number - Port number. type: int
      • port_owner - Switch port name. type: str
      • port_prefix_type - Port prefix type. type: int
      • port_security_policy - Switch controller authentication policy to apply to this managed switch from available options. Source switch-controller .security-policy.802-1X.name switch-controller.security-policy.captive-portal.name. type: str
      • port_selection_criteria - Algorithm for aggregate port selection. type: str choices: src-mac, dst-mac, src-dst-mac, src-ip, dst-ip, src-dst-ip
      • qos_policy - Switch controller QoS policy from available options. Source switch-controller.qos.qos-policy.name. type: str
      • sample_direction - Packet sampling direction. type: str choices: tx, rx, both
      • sflow_counter_interval - sFlow sampling counter polling interval (0 - 255 sec). type: int
      • speed - Switch port speed; default and available settings depend on hardware. type: str choices: 10half, 10full, 100half, 100full, 1000auto, 1000fiber, 1000full, 10000, 40000, auto, auto-module, 100FX-half, 100FX-full, 100000full, 2500auto, 25000full, 50000full, 10000cr, 10000sr, 100000sr4, 100000cr4, 25000cr4, 25000sr4, 5000full
      • stacking_port - Stacking port. type: int
      • status - Switch port admin status: up or down. type: str choices: up, down
      • sticky_mac - Enable or disable sticky-mac on the interface. type: str choices: enable, disable
      • storm_control_policy - Switch controller storm control policy from available options. Source switch-controller.storm-control-policy.name. type: str
      • stp_bpdu_guard - Enable/disable STP BPDU guard on this interface. type: str choices: enabled, disabled
      • stp_bpdu_guard_timeout - BPDU Guard disabling protection (0 - 120 min). type: int
      • stp_root_guard - Enable/disable STP root guard on this interface. type: str choices: enabled, disabled
      • stp_state - Enable/disable Spanning Tree Protocol (STP) on this interface. type: str choices: enabled, disabled
      • switch_id - Switch id. type: str
      • type - Interface type: physical or trunk port. type: str choices: physical, trunk
      • untagged_vlans - Configure switch port untagged vlans type: list
        • vlan_name - VLAN name. Source system.interface.name. type: str
      • vlan - Assign switch ports to a VLAN. Source system.interface.name. type: str
    • pre_provisioned - Pre-provisioned managed switch. type: int
    • qos_drop_policy - Set QoS drop-policy. type: str choices: taildrop, random-early-detection
    • qos_red_probability - Set QoS RED/WRED drop probability. type: int
    • remote_log - Configure logging by FortiSwitch device to a remote syslog server. type: list
      • csv - Enable/disable comma-separated value (CSV) strings. type: str choices: enable, disable
      • facility - Facility to log to remote syslog server. type: str choices: kernel, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7
      • name - Remote log name. type: str required: True
      • port - Remote syslog server listening port. type: int
      • server - IPv4 address of the remote syslog server. type: str
      • severity - Severity of logs to be transferred to remote log server. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
      • status - Enable/disable logging by FortiSwitch device to a remote syslog server. type: str choices: enable, disable
    • snmp_community - Configuration method to edit Simple Network Management Protocol (SNMP) communities. type: list
      • events - SNMP notifications (traps) to send. type: str choices: cpu-high, mem-low, log-full, intf-ip, ent-conf-change
      • hosts - Configure IPv4 SNMP managers (hosts). type: list
        • id - Host entry ID. type: int required: True
        • ip - IPv4 address of the SNMP manager (host). type: str
      • id - SNMP community ID. type: int required: True
      • name - SNMP community name. type: str
      • query_v1_port - SNMP v1 query port . type: int
      • query_v1_status - Enable/disable SNMP v1 queries. type: str choices: disable, enable
      • query_v2c_port - SNMP v2c query port . type: int
      • query_v2c_status - Enable/disable SNMP v2c queries. type: str choices: disable, enable
      • status - Enable/disable this SNMP community. type: str choices: disable, enable
      • trap_v1_lport - SNMP v2c trap local port . type: int
      • trap_v1_rport - SNMP v2c trap remote port . type: int
      • trap_v1_status - Enable/disable SNMP v1 traps. type: str choices: disable, enable
      • trap_v2c_lport - SNMP v2c trap local port . type: int
      • trap_v2c_rport - SNMP v2c trap remote port . type: int
      • trap_v2c_status - Enable/disable SNMP v2c traps. type: str choices: disable, enable
    • snmp_sysinfo - Configuration method to edit Simple Network Management Protocol (SNMP) system info. type: dict
      • contact_info - Contact information. type: str
      • description - System description. type: str
      • engine_id - Local SNMP engine ID string (max 24 char). type: str
      • location - System location. type: str
      • status - Enable/disable SNMP. type: str choices: disable, enable
    • snmp_trap_threshold - Configuration method to edit Simple Network Management Protocol (SNMP) trap threshold values. type: dict
      • trap_high_cpu_threshold - CPU usage when trap is sent. type: int
      • trap_log_full_threshold - Log disk usage when trap is sent. type: int
      • trap_low_memory_threshold - Memory usage when trap is sent. type: int
    • snmp_user - Configuration method to edit Simple Network Management Protocol (SNMP) users. type: list
      • auth_proto - Authentication protocol. type: str choices: md5, sha
      • auth_pwd - Password for authentication protocol. type: str
      • name - SNMP user name. type: str required: True
      • priv_proto - Privacy (encryption) protocol. type: str choices: aes, des
      • priv_pwd - Password for privacy (encryption) protocol. type: str
      • queries - Enable/disable SNMP queries for this user. type: str choices: disable, enable
      • query_port - SNMPv3 query port . type: int
      • security_level - Security level for message authentication and encryption. type: str choices: no-auth-no-priv, auth-no-priv, auth-priv
    • staged_image_version - Staged image version for FortiSwitch. type: str
    • static_mac - Configuration method to edit FortiSwitch Static and Sticky MAC. type: list
      • description - Description. type: str
      • id - Id type: int required: True
      • interface - Interface name. type: str
      • mac - MAC address. type: str
      • type - Type. type: str choices: static, sticky
      • vlan - Vlan. Source system.interface.name. type: str
    • storm_control - Configuration method to edit FortiSwitch storm control for measuring traffic activity using data rates to prevent traffic disruption. type: dict
      • broadcast - Enable/disable storm control to drop broadcast traffic. type: str choices: enable, disable
      • local_override - Enable to override global FortiSwitch storm control settings for this FortiSwitch. type: str choices: enable, disable
      • rate - Rate in packets per second at which storm traffic is controlled (1 - 10000000). Storm control drops excess traffic data rates beyond this threshold. type: int
      • unknown_multicast - Enable/disable storm control to drop unknown multicast traffic. type: str choices: enable, disable
      • unknown_unicast - Enable/disable storm control to drop unknown unicast traffic. type: str choices: enable, disable
    • stp_instance - Configuration method to edit Spanning Tree Protocol (STP) instances. type: list
      • id - Instance ID. type: str required: True
      • priority - Priority. type: str choices: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, 61440
    • stp_settings - Configuration method to edit Spanning Tree Protocol (STP) settings used to prevent bridge loops. type: dict
      • forward_time - Period of time a port is in listening and learning state (4 - 30 sec). type: int
      • hello_time - Period of time between successive STP frame Bridge Protocol Data Units (BPDUs) sent on a port (1 - 10 sec). type: int
      • local_override - Enable to configure local STP settings that override global STP settings. type: str choices: enable, disable
      • max_age - Maximum time before a bridge port saves its configuration BPDU information (6 - 40 sec). type: int
      • max_hops - Maximum number of hops between the root bridge and the furthest bridge (1- 40). type: int
      • name - Name of local STP settings configuration. type: str
      • pending_timer - Pending time (1 - 15 sec). type: int
      • revision - STP revision number (0 - 65535). type: int
    • switch_device_tag - User definable label/tag. type: str
    • switch_dhcp_opt43_key - DHCP option43 key. type: str
    • switch_id - Managed-switch id. type: str
    • switch_log - Configuration method to edit FortiSwitch logging settings (logs are transferred to and inserted into the FortiGate event log). type: dict
      • local_override - Enable to configure local logging settings that override global logging settings. type: str choices: enable, disable
      • severity - Severity of FortiSwitch logs that are added to the FortiGate event log. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
      • status - Enable/disable adding FortiSwitch logs to the FortiGate event log. type: str choices: enable, disable
    • switch_profile - FortiSwitch profile. Source switch-controller.switch-profile.name. type: str
    • type - Indication of switch type, physical or virtual. type: str choices: virtual, physical
    • version - FortiSwitch version. type: int

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure FortiSwitch devices that are managed by this FortiGate.
    fortios_switch_controller_managed_switch:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_managed_switch:
        settings_802_1X:
            link_down_auth: "set-unauth"
            local_override: "enable"
            max_reauth_attempt: "6"
            reauth_period: "7"
            tx_period: "8"
        access_profile: "<your_own_value> (source switch-controller.security-policy.local-access.name)"
        custom_command:
         -
            command_entry: "<your_own_value>"
            command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
        delayed_restart_trigger: "13"
        description: "<your_own_value>"
        directly_connected: "15"
        dynamic_capability: "16"
        dynamically_discovered: "17"
        flow_identity: "<your_own_value>"
        fsw_wan1_admin: "discovered"
        fsw_wan1_peer: "<your_own_value>"
        igmp_snooping:
            aging_time: "22"
            flood_unknown_multicast: "enable"
            local_override: "enable"
        ip_source_guard:
         -
            binding_entry:
             -
                entry_name: "<your_own_value>"
                ip: "<your_own_value>"
                mac: "<your_own_value>"
            description: "<your_own_value>"
            port: "<your_own_value>"
        l3_discovered: "32"
        mclag_igmp_snooping_aware: "enable"
        mirror:
         -
            dst: "<your_own_value>"
            name: "default_name_36"
            src_egress:
             -
                name: "default_name_38"
            src_ingress:
             -
                name: "default_name_40"
            status: "active"
            switching_packet: "enable"
        name: "default_name_43"
        override_snmp_community: "enable"
        override_snmp_sysinfo: "disable"
        override_snmp_trap_threshold: "enable"
        override_snmp_user: "enable"
        owner_vdom: "<your_own_value>"
        poe_detection_type: "49"
        poe_pre_standard_detection: "enable"
        ports:
         -
            access_mode: "normal"
            allowed_vlans:
             -
                vlan_name: "<your_own_value> (source system.interface.name)"
            allowed_vlans_all: "enable"
            arp_inspection_trust: "untrusted"
            bundle: "enable"
            description: "<your_own_value>"
            dhcp_snoop_option82_trust: "enable"
            dhcp_snooping: "untrusted"
            discard_mode: "none"
            edge_port: "enable"
            export_tags:
             -
                tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
            export_to: "<your_own_value> (source system.vdom.name)"
            export_to_pool: "<your_own_value> (source switch-controller.virtual-port-pool.name)"
            fgt_peer_device_name: "<your_own_value>"
            fgt_peer_port_name: "<your_own_value>"
            fiber_port: "69"
            flags: "70"
            fortilink_port: "71"
            igmps_flood_reports: "enable"
            igmps_flood_traffic: "enable"
            ip_source_guard: "disable"
            isl_local_trunk_name: "<your_own_value>"
            isl_peer_device_name: "<your_own_value>"
            isl_peer_port_name: "<your_own_value>"
            lacp_speed: "slow"
            learning_limit: "79"
            lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
            lldp_status: "disable"
            loop_guard: "enabled"
            loop_guard_timeout: "83"
            mac_addr: "<your_own_value>"
            max_bundle: "85"
            mclag: "enable"
            mclag_icl_port: "87"
            member_withdrawal_behavior: "forward"
            members:
             -
                member_name: "<your_own_value>"
            min_bundle: "91"
            mode: "static"
            p2p_port: "93"
            packet_sample_rate: "94"
            packet_sampler: "enabled"
            poe_capable: "96"
            poe_pre_standard_detection: "enable"
            poe_status: "enable"
            port_name: "<your_own_value>"
            port_number: "100"
            port_owner: "<your_own_value>"
            port_prefix_type: "102"
            port_security_policy: "<your_own_value> (source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal
              .name)"
            port_selection_criteria: "src-mac"
            qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
            sample_direction: "tx"
            sflow_counter_interval: "107"
            speed: "10half"
            stacking_port: "109"
            status: "up"
            sticky_mac: "enable"
            storm_control_policy: "<your_own_value> (source switch-controller.storm-control-policy.name)"
            stp_bpdu_guard: "enabled"
            stp_bpdu_guard_timeout: "114"
            stp_root_guard: "enabled"
            stp_state: "enabled"
            switch_id: "<your_own_value>"
            type: "physical"
            untagged_vlans:
             -
                vlan_name: "<your_own_value> (source system.interface.name)"
            vlan: "<your_own_value> (source system.interface.name)"
        pre_provisioned: "122"
        qos_drop_policy: "taildrop"
        qos_red_probability: "124"
        remote_log:
         -
            csv: "enable"
            facility: "kernel"
            name: "default_name_128"
            port: "129"
            server: "192.168.100.40"
            severity: "emergency"
            status: "enable"
        snmp_community:
         -
            events: "cpu-high"
            hosts:
             -
                id:  "136"
                ip: "<your_own_value>"
            id:  "138"
            name: "default_name_139"
            query_v1_port: "140"
            query_v1_status: "disable"
            query_v2c_port: "142"
            query_v2c_status: "disable"
            status: "disable"
            trap_v1_lport: "145"
            trap_v1_rport: "146"
            trap_v1_status: "disable"
            trap_v2c_lport: "148"
            trap_v2c_rport: "149"
            trap_v2c_status: "disable"
        snmp_sysinfo:
            contact_info: "<your_own_value>"
            description: "<your_own_value>"
            engine_id: "<your_own_value>"
            location: "<your_own_value>"
            status: "disable"
        snmp_trap_threshold:
            trap_high_cpu_threshold: "158"
            trap_log_full_threshold: "159"
            trap_low_memory_threshold: "160"
        snmp_user:
         -
            auth_proto: "md5"
            auth_pwd: "<your_own_value>"
            name: "default_name_164"
            priv_proto: "aes"
            priv_pwd: "<your_own_value>"
            queries: "disable"
            query_port: "168"
            security_level: "no-auth-no-priv"
        staged_image_version: "<your_own_value>"
        static_mac:
         -
            description: "<your_own_value>"
            id:  "173"
            interface: "<your_own_value>"
            mac: "<your_own_value>"
            type: "static"
            vlan: "<your_own_value> (source system.interface.name)"
        storm_control:
            broadcast: "enable"
            local_override: "enable"
            rate: "181"
            unknown_multicast: "enable"
            unknown_unicast: "enable"
        stp_instance:
         -
            id:  "185"
            priority: "0"
        stp_settings:
            forward_time: "188"
            hello_time: "189"
            local_override: "enable"
            max_age: "191"
            max_hops: "192"
            name: "default_name_193"
            pending_timer: "194"
            revision: "195"
        switch_device_tag: "<your_own_value>"
        switch_dhcp_opt43_key: "<your_own_value>"
        switch_id: "<your_own_value>"
        switch_log:
            local_override: "enable"
            severity: "emergency"
            status: "enable"
        switch_profile: "<your_own_value> (source switch-controller.switch-profile.name)"
        type: "virtual"
        version: "205"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

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