fmgd_switchcontroller_managedswitch – Configure FortiSwitch devices that are managed by this FortiGate.

Added in version 1.0.0.

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 v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> 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
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • switchcontroller_managedswitch - Configure FortiSwitch devices that are managed by this FortiGate. type: dict
    • 802_1X_settings (Alias name: 802-1X-settings) 802 1x settings. type: dict more...
      • link_down_auth (Alias name: link-down-auth) Authentication state to set if a link is down. type: str choices: [set-unauth, no-action] more...
      • local_override (Alias name: local-override) Enable to override global 802. type: str choices: [disable, enable] more...
      • mab_reauth (Alias name: mab-reauth) Enable or disable mab reauthentication settings. type: str choices: [disable, enable] more...
      • mac_called_station_delimiter (Alias name: mac-called-station-delimiter) Mac called station delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none] more...
      • mac_calling_station_delimiter (Alias name: mac-calling-station-delimiter) Mac calling station delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none] more...
      • mac_case (Alias name: mac-case) Mac case (default = lowercase). type: str choices: [uppercase, lowercase] more...
      • mac_password_delimiter (Alias name: mac-password-delimiter) Mac authentication password delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none] more...
      • mac_username_delimiter (Alias name: mac-username-delimiter) Mac authentication username delimiter (default = hyphen). type: str choices: [hyphen, single-hyphen, colon, none] more...
      • max_reauth_attempt (Alias name: max-reauth-attempt) Maximum number of authentication attempts (0 - 15, default = 3). type: int more...
      • reauth_period (Alias name: reauth-period) Reauthentication time interval (1 - 1440 min, default = 60, 0 = disable). type: int more...
      • tx_period (Alias name: tx-period) 802. type: int more...
    • _platform Platform. type: str more...
    • access_profile (Alias name: access-profile) Fortiswitch access profile. type: list more...
    • custom_command (Alias name: custom-command) Custom command. type: list more...
      • command_entry (Alias name: command-entry) List of fortiswitch commands. type: str more...
      • command_name (Alias name: command-name) Names of commands to be pushed to this fortiswitch device, as configured under config switch-controller custom-command. type: list more...
    • delayed_restart_trigger (Alias name: delayed-restart-trigger) Delayed restart triggered for this fortiswitch. type: int more...
    • description Description. type: str more...
    • dhcp_server_access_list (Alias name: dhcp-server-access-list) Dhcp snooping server access list. type: str choices: [disable, enable, global] more...
    • dhcp_snooping_static_client (Alias name: dhcp-snooping-static-client) Dhcp snooping static client. type: list more...
      • ip Client static ip address. type: str more...
      • mac Client mac address. type: str more...
      • name Client name. type: str more...
      • port Interface name. type: str more...
      • vlan Vlan name. type: list more...
    • directly_connected (Alias name: directly-connected) Directly connected. type: int more...
    • dynamic_capability (Alias name: 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: str more...
    • dynamically_discovered (Alias name: dynamically-discovered) Dynamically discovered. type: int more...
    • firmware_provision (Alias name: firmware-provision) Enable/disable provisioning of firmware to fortiswitches on join connection. type: str choices: [disable, enable] more...
    • firmware_provision_latest (Alias name: firmware-provision-latest) Enable/disable one-time automatic provisioning of the latest firmware version. type: str choices: [disable, once] more...
    • firmware_provision_version (Alias name: firmware-provision-version) Firmware version to provision to this fortiswitch on bootup (major. type: str more...
    • flow_identity (Alias name: flow-identity) Flow-tracking netflow ipfix switch identity in hex format(00000000-ffffffff default=0). type: str more...
    • fsw_wan1_admin (Alias name: fsw-wan1-admin) Fortiswitch wan1 admin status; enable to authorize the fortiswitch as a managed switch. type: str choices: [disable, enable, discovered] more...
    • fsw_wan1_peer (Alias name: fsw-wan1-peer) Fortiswitch wan1 peer port. type: list more...
    • fsw_wan2_admin (Alias name: fsw-wan2-admin) Fortiswitch wan2 admin status; enable to authorize the fortiswitch as a managed switch. type: str choices: [disable, enable, discovered] more...
    • fsw_wan2_peer (Alias name: fsw-wan2-peer) Fortiswitch wan2 peer port. type: str more...
    • igmp_snooping (Alias name: igmp-snooping) Igmp snooping. type: dict more...
      • aging_time (Alias name: aging-time) Maximum time to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300). type: int more...
      • flood_unknown_multicast (Alias name: flood-unknown-multicast) Enable/disable unknown multicast flooding. type: str choices: [disable, enable] more...
      • local_override (Alias name: local-override) Enable/disable overriding the global igmp snooping configuration. type: str choices: [disable, enable] more...
      • vlans Vlans. type: list more...
        • proxy Igmp snooping proxy for the vlan interface. type: str choices: [disable, enable, global] more...
        • querier Enable/disable igmp snooping querier for the vlan interface. type: str choices: [disable, enable] more...
        • querier_addr (Alias name: querier-addr) Igmp snooping querier address. type: str more...
        • version Igmp snooping querying version. type: int more...
        • vlan_name (Alias name: vlan-name) List of fortiswitch vlans. type: list more...
    • ip_source_guard (Alias name: ip-source-guard) Ip source guard. type: list more...
      • binding_entry (Alias name: binding-entry) Binding entry. type: list more...
        • entry_name (Alias name: entry-name) Configure binding pair. type: str more...
        • ip Source ip for this rule. type: str more...
        • mac Mac address for this rule. type: str more...
      • description Description. type: str more...
      • port Ingress interface to which source guard is bound. type: str more...
    • l3_discovered (Alias name: l3-discovered) L3 discovered. type: int more...
    • max_allowed_trunk_members (Alias name: max-allowed-trunk-members) Fortiswitch maximum allowed trunk members. type: int more...
    • mclag_igmp_snooping_aware (Alias name: mclag-igmp-snooping-aware) Enable/disable mclag igmp-snooping awareness. type: str choices: [disable, enable] more...
    • mgmt_mode (Alias name: mgmt-mode) Fortilink management mode. type: int more...
    • mirror Mirror. type: list more...
      • dst Destination port. type: str more...
      • name Mirror name. type: str more...
      • src_egress (Alias name: src-egress) Source egress interfaces. type: list more...
      • src_ingress (Alias name: src-ingress) Source ingress interfaces. type: list more...
      • status Active/inactive mirror configuration. type: str choices: [inactive, active] more...
      • switching_packet (Alias name: switching-packet) Enable/disable switching functionality when mirroring. type: str choices: [disable, enable] more...
    • override_snmp_community (Alias name: override-snmp-community) Enable/disable overriding the global snmp communities. type: str choices: [disable, enable] more...
    • override_snmp_sysinfo (Alias name: override-snmp-sysinfo) Enable/disable overriding the global snmp system information. type: str choices: [disable, enable] more...
    • override_snmp_trap_threshold (Alias name: override-snmp-trap-threshold) Enable/disable overriding the global snmp trap threshold values. type: str choices: [disable, enable] more...
    • override_snmp_user (Alias name: override-snmp-user) Enable/disable overriding the global snmp users. type: str choices: [disable, enable] more...
    • owner_vdom (Alias name: owner-vdom) Vdom which owner of port belongs to. type: str more...
    • poe_detection_type (Alias name: poe-detection-type) Poe detection type for fortiswitch. type: int more...
    • poe_pre_standard_detection (Alias name: poe-pre-standard-detection) Enable/disable poe pre-standard detection. type: str choices: [disable, enable] more...
    • ports Ports. type: list more...
      • access_mode (Alias name: access-mode) Access mode of the port. type: str choices: [normal, nac, dynamic, static] more...
      • acl_group (Alias name: acl-group) Acl groups on this port. type: list more...
      • aggregator_mode (Alias name: aggregator-mode) Lacp member select mode. type: str choices: [bandwidth, count] more...
      • allow_arp_monitor (Alias name: allow-arp-monitor) Enable/disable allow arp monitor. type: str choices: [disable, enable] more...
      • allowed_vlans (Alias name: allowed-vlans) Configure switch port tagged vlans. type: list more...
      • allowed_vlans_all (Alias name: allowed-vlans-all) Enable/disable all defined vlans on this port. type: str choices: [disable, enable] more...
      • arp_inspection_trust (Alias name: arp-inspection-trust) Trusted or untrusted dynamic arp inspection. type: str choices: [untrusted, trusted] more...
      • authenticated_port (Alias name: authenticated-port) Authenticated port. type: int more...
      • bundle Enable/disable link aggregation group (lag) bundling for non-fortilink interfaces. type: str choices: [disable, enable] more...
      • description Description for port. type: str more...
      • dhcp_snoop_option82_override (Alias name: dhcp-snoop-option82-override) Dhcp snoop option82 override. type: list more...
        • circuit_id (Alias name: circuit-id) Circuit id string. type: str more...
        • remote_id (Alias name: remote-id) Remote id string. type: str more...
        • vlan_name (Alias name: vlan-name) Dhcp snooping option 82 vlan. type: list more...
      • dhcp_snoop_option82_trust (Alias name: dhcp-snoop-option82-trust) Enable/disable allowance of dhcp with option-82 on untrusted interface. type: str choices: [disable, enable] more...
      • dhcp_snooping (Alias name: dhcp-snooping) Trusted or untrusted dhcp-snooping interface. type: str choices: [trusted, untrusted] more...
      • discard_mode (Alias name: discard-mode) Configure discard mode for port. type: str choices: [none, all-untagged, all-tagged] more...
      • dsl_profile (Alias name: dsl-profile) Dsl policy configuration. type: list more...
      • edge_port (Alias name: edge-port) Enable/disable this interface as an edge port, bridging connections between workstations and/or computers. type: str choices: [disable, enable] more...
      • encrypted_port (Alias name: encrypted-port) Encrypted port. type: int more...
      • export_to (Alias name: export-to) Export managed-switch port to a tenant vdom. type: list more...
      • export_to_pool (Alias name: export-to-pool) Switch controller export port to pool-list. type: list more...
      • export_to_pool_flag (Alias name: export-to-pool-flag) Switch controller export port to pool-list. type: int more...
      • fallback_port (Alias name: fallback-port) Lacp fallback port. type: str more...
      • fec_capable (Alias name: fec-capable) Fec capable. type: int more...
      • fec_state (Alias name: fec-state) State of forward error correction. type: str choices: [disabled, cl74, cl91, detect-by-module] more...
      • fgt_peer_device_name (Alias name: fgt-peer-device-name) Fgt peer device name. type: str more...
      • fgt_peer_port_name (Alias name: fgt-peer-port-name) Fgt peer port name. type: str more...
      • fiber_port (Alias name: fiber-port) Fiber port. type: int more...
      • flags Flags. type: int more...
      • flap_duration (Alias name: flap-duration) Period over which flap events are calculated (seconds). type: int more...
      • flap_rate (Alias name: flap-rate) Number of stage change events needed within flap-duration. type: int more...
      • flap_timeout (Alias name: flap-timeout) Flap guard disabling protection (min). type: int more...
      • flapguard Enable/disable flap guard. type: str choices: [disable, enable] more...
      • flow_control (Alias name: flow-control) Flow control direction. type: str choices: [disable, tx, rx, both] more...
      • fortilink_port (Alias name: fortilink-port) Fortilink port. type: int more...
      • fortiswitch_acls (Alias name: fortiswitch-acls) Acls on this port. type: list more...
      • igmp_snooping_flood_reports (Alias name: igmp-snooping-flood-reports) Enable/disable flooding of igmp reports to this interface when igmp-snooping enabled. type: str choices: [disable, enable] more...
      • interface_tags (Alias name: interface-tags) Tag(s) associated with the interface for various features including virtual port pool, dynamic port policy. type: list more...
      • ip_source_guard (Alias name: ip-source-guard) Enable/disable ip source guard. type: str choices: [disable, enable] more...
      • isl_local_trunk_name (Alias name: isl-local-trunk-name) Isl local trunk name. type: str more...
      • isl_peer_device_name (Alias name: isl-peer-device-name) Isl peer device name. type: str more...
      • isl_peer_device_sn (Alias name: isl-peer-device-sn) Isl peer device sn. type: str more...
      • isl_peer_port_name (Alias name: isl-peer-port-name) Isl peer port name. type: str more...
      • lacp_speed (Alias name: lacp-speed) End link aggregation control protocol (lacp) messages every 30 seconds (slow) or every second (fast). type: str choices: [slow, fast] more...
      • learning_limit (Alias name: learning-limit) Limit the number of dynamic mac addresses on this port (1 - 128, 0 = no limit, default). type: int more...
      • link_status (Alias name: link-status) Link status. type: str choices: [down, up] more...
      • lldp_profile (Alias name: lldp-profile) Lldp port tlv profile. type: list more...
      • lldp_status (Alias name: lldp-status) Lldp transmit and receive status. type: str choices: [disable, rx-only, tx-only, tx-rx] more...
      • loop_guard (Alias name: loop-guard) Enable/disable loop-guard on this interface, an stp optimization used to prevent network loops. type: str choices: [disabled, enabled] more...
      • loop_guard_timeout (Alias name: loop-guard-timeout) Loop-guard timeout (0 - 120 min, default = 45). type: int more...
      • mac_addr (Alias name: mac-addr) Port/trunk mac. type: str more...
      • matched_dpp_intf_tags (Alias name: matched-dpp-intf-tags) Matched interface tags in the dynamic port policy. type: str more...
      • matched_dpp_policy (Alias name: matched-dpp-policy) Matched child policy in the dynamic port policy. type: str more...
      • max_bundle (Alias name: max-bundle) Maximum size of lag bundle (1 - 24, default = 24). type: int more...
      • mcast_snooping_flood_traffic (Alias name: mcast-snooping-flood-traffic) Enable/disable flooding of igmp snooping traffic to this interface. type: str choices: [disable, enable] more...
      • mclag Enable/disable multi-chassis link aggregation (mclag). type: str choices: [disable, enable] more...
      • mclag_icl_port (Alias name: mclag-icl-port) Mclag icl port. type: int more...
      • media_type (Alias name: media-type) Media type. type: str more...
      • member_withdrawal_behavior (Alias name: member-withdrawal-behavior) Port behavior after it withdraws because of loss of control packets. type: str choices: [forward, block] more...
      • members Aggregated lag bundle interfaces. type: list more...
      • min_bundle (Alias name: min-bundle) Minimum size of lag bundle (1 - 24, default = 1). type: int more...
      • mode Lacp mode: ignore and do not send control messages, or negotiate 802. type: str choices: [static, lacp-passive, lacp-active] more...
      • p2p_port (Alias name: p2p-port) P2p port. type: int more...
      • packet_sample_rate (Alias name: packet-sample-rate) Packet sampling rate (0 - 99999 p/sec). type: int more...
      • packet_sampler (Alias name: packet-sampler) Enable/disable packet sampling on this interface. type: str choices: [disabled, enabled] more...
      • pause_meter (Alias name: pause-meter) Configure ingress pause metering rate, in kbps (default = 0, disabled). type: int more...
      • pause_meter_resume (Alias name: pause-meter-resume) Resume threshold for resuming traffic on ingress port. type: str choices: [25%, 50%, 75%] more...
      • poe_capable (Alias name: poe-capable) Poe capable. type: int more...
      • poe_max_power (Alias name: poe-max-power) Poe max power. type: str more...
      • poe_mode_bt_cabable (Alias name: poe-mode-bt-cabable) Poe mode ieee 802. type: int more...
      • poe_port_mode (Alias name: poe-port-mode) Configure poe port mode. type: str choices: [ieee802-3af, ieee802-3at, ieee802-3bt] more...
      • poe_port_power (Alias name: poe-port-power) Configure poe port power. type: str choices: [normal, perpetual, perpetual-fast] more...
      • poe_port_priority (Alias name: poe-port-priority) Configure poe port priority. type: str choices: [critical-priority, high-priority, low-priority, medium-priority] more...
      • poe_pre_standard_detection (Alias name: poe-pre-standard-detection) Enable/disable poe pre-standard detection. type: str choices: [disable, enable] more...
      • poe_standard (Alias name: poe-standard) Poe standard. type: str more...
      • poe_status (Alias name: poe-status) Enable/disable poe status. type: str choices: [disable, enable] more...
      • port_name (Alias name: port-name) Switch port name. type: str more...
      • port_number (Alias name: port-number) Port number. type: int more...
      • port_owner (Alias name: port-owner) Switch port name. type: str more...
      • port_policy (Alias name: port-policy) Switch controller dynamic port policy from available options. type: list more...
      • port_prefix_type (Alias name: port-prefix-type) Port prefix type. type: int more...
      • port_security_policy (Alias name: port-security-policy) Switch controller authentication policy to apply to this managed switch from available options. type: list more...
      • port_selection_criteria (Alias name: 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] more...
      • ptp_policy (Alias name: ptp-policy) Ptp policy configuration. type: list more...
      • ptp_status (Alias name: ptp-status) Enable/disable ptp policy on this fortiswitch port. type: str choices: [disable, enable] more...
      • qos_policy (Alias name: qos-policy) Switch controller qos policy from available options. type: list more...
      • restricted_auth_port (Alias name: restricted-auth-port) Restricted auth port. type: int more...
      • rpvst_port (Alias name: rpvst-port) Enable/disable inter-operability with rapid pvst on this interface. type: str choices: [disabled, enabled] more...
      • sample_direction (Alias name: sample-direction) Packet sampling direction. type: str choices: [rx, tx, both] more...
      • sflow_counter_interval (Alias name: sflow-counter-interval) Sflow sampling counter polling interval in seconds (0 - 255). type: int more...
      • speed Switch port speed; default and available settings depend on hardware. type: str choices: [auto, 10full, 10half, 100full, 100half, 1000full, 10000full, 1000auto, 40000full, 1000fiber, 10000, 40000, auto-module, 100FX-half, 100FX-full, 100000full, 2500full, 25000full, 50000full, 40000auto, 10000cr, 10000sr, 100000sr4, 100000cr4, 25000cr4, 25000sr4, 5000full, 2500auto, 5000auto, 1000full-fiber, 40000sr4, 40000cr4, 25000cr, 25000sr, 50000cr, 50000sr, sgmii-auto] more...
      • speed_mask (Alias name: speed-mask) Switch port speed mask. type: int more...
      • stacking_port (Alias name: stacking-port) Stacking port. type: int more...
      • status Switch port admin status: up or down. type: str choices: [down, up] more...
      • sticky_mac (Alias name: sticky-mac) Enable or disable sticky-mac on the interface. type: str choices: [disable, enable] more...
      • storm_control_policy (Alias name: storm-control-policy) Switch controller storm control policy from available options. type: list more...
      • stp_bpdu_guard (Alias name: stp-bpdu-guard) Enable/disable stp bpdu guard on this interface. type: str choices: [disabled, enabled] more...
      • stp_bpdu_guard_timeout (Alias name: stp-bpdu-guard-timeout) Bpdu guard disabling protection (0 - 120 min). type: int more...
      • stp_root_guard (Alias name: stp-root-guard) Enable/disable stp root guard on this interface. type: str choices: [disabled, enabled] more...
      • stp_state (Alias name: stp-state) Enable/disable spanning tree protocol (stp) on this interface. type: str choices: [disabled, enabled] more...
      • switch_id (Alias name: switch-id) Switch id. type: str more...
      • trunk_member (Alias name: trunk-member) Trunk member. type: int more...
      • type Interface type: physical or trunk port. type: str choices: [physical, trunk] more...
      • untagged_vlans (Alias name: untagged-vlans) Configure switch port untagged vlans. type: list more...
      • virtual_port (Alias name: virtual-port) Virtualized switch port. type: int more...
      • vlan Assign switch ports to a vlan. type: list more...
      • igmps_flood_reports (Alias name: igmps-flood-reports) Enable/disable flooding of igmp reports to this interface when igmp-snooping enabled. type: str choices: [disable, enable] more...
      • igmps_flood_traffic (Alias name: igmps-flood-traffic) Enable/disable flooding of igmp snooping traffic to this interface. type: str choices: [disable, enable] more...
      • export_tags (Alias name: export-tags) Configure export tag(s) for fortiswitch port when exported to a virtual port pool. type: list more...
      • igmp_snooping (Alias name: igmp-snooping) Set igmp snooping mode for the physical port interface. type: str choices: [disable, enable] more...
      • log_mac_event (Alias name: log-mac-event) Enable/disable logging for dynamic mac address events. type: str choices: [disable, enable] more...
      • pd_capable (Alias name: pd-capable) Powered device capable. type: int more...
      • qnq 802. type: list more...
    • pre_provisioned (Alias name: pre-provisioned) Pre-provisioned managed switch. type: int more...
    • ptp_profile (Alias name: ptp-profile) Ptp profile configuration. type: list more...
    • ptp_status (Alias name: ptp-status) Enable/disable ptp profile on this fortiswitch. type: str choices: [disable, enable] more...
    • purdue_level (Alias name: purdue-level) Purdue level of this fortiswitch. type: str choices: [1, 2, 3, 4, 5, 1.5, 2.5, 3.5, 5.5] more...
    • qos_drop_policy (Alias name: qos-drop-policy) Set qos drop-policy. type: str choices: [taildrop, random-early-detection] more...
    • qos_red_probability (Alias name: qos-red-probability) Set qos red/wred drop probability. type: int more...
    • radius_nas_ip (Alias name: radius-nas-ip) Nas-ip address. type: str more...
    • radius_nas_ip_override (Alias name: radius-nas-ip-override) Use locally defined nas-ip. type: str choices: [disable, enable] more...
    • remote_log (Alias name: remote-log) Remote log. type: list more...
      • csv Enable/disable comma-separated value (csv) strings. type: str choices: [disable, enable] more...
      • 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] more...
      • name Remote log name. type: str more...
      • port Remote syslog server listening port. type: int more...
      • server Ipv4 address of the remote syslog server. type: str more...
      • severity Severity of logs to be transferred to remote log server. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] more...
      • status Enable/disable logging by fortiswitch device to a remote syslog server. type: str choices: [disable, enable] more...
    • route_offload (Alias name: route-offload) Enable/disable route offload on this fortiswitch. type: str choices: [disable, enable] more...
    • route_offload_mclag (Alias name: route-offload-mclag) Enable/disable route offload mclag on this fortiswitch. type: str choices: [disable, enable] more...
    • route_offload_router (Alias name: route-offload-router) Route offload router. type: list more...
      • router_ip (Alias name: router-ip) Router ip address. type: str more...
      • vlan_name (Alias name: vlan-name) Vlan name. type: list more...
    • sn Managed-switch serial number. type: str more...
    • snmp_community (Alias name: snmp-community) Snmp community. type: list more...
      • events Snmp notifications (traps) to send. type: list choices: [cpu-high, mem-low, log-full, intf-ip, ent-conf-change, l2mac] more...
      • hosts Hosts. type: list more...
        • id Host entry id. type: int more...
        • ip Ipv4 address of the snmp manager (host). type: list more...
      • id Snmp community id. type: int more...
      • name Snmp community name. type: str more...
      • query_v1_port (Alias name: query-v1-port) Snmp v1 query port (default = 161). type: int more...
      • query_v1_status (Alias name: query-v1-status) Enable/disable snmp v1 queries. type: str choices: [disable, enable] more...
      • query_v2c_port (Alias name: query-v2c-port) Snmp v2c query port (default = 161). type: int more...
      • query_v2c_status (Alias name: query-v2c-status) Enable/disable snmp v2c queries. type: str choices: [disable, enable] more...
      • status Enable/disable this snmp community. type: str choices: [disable, enable] more...
      • trap_v1_lport (Alias name: trap-v1-lport) Snmp v2c trap local port (default = 162). type: int more...
      • trap_v1_rport (Alias name: trap-v1-rport) Snmp v2c trap remote port (default = 162). type: int more...
      • trap_v1_status (Alias name: trap-v1-status) Enable/disable snmp v1 traps. type: str choices: [disable, enable] more...
      • trap_v2c_lport (Alias name: trap-v2c-lport) Snmp v2c trap local port (default = 162). type: int more...
      • trap_v2c_rport (Alias name: trap-v2c-rport) Snmp v2c trap remote port (default = 162). type: int more...
      • trap_v2c_status (Alias name: trap-v2c-status) Enable/disable snmp v2c traps. type: str choices: [disable, enable] more...
    • snmp_sysinfo (Alias name: snmp-sysinfo) Snmp sysinfo. type: dict more...
      • contact_info (Alias name: contact-info) Contact information. type: str more...
      • description System description. type: str more...
      • engine_id (Alias name: engine-id) Local snmp engine id string (max 24 char). type: str more...
      • location System location. type: str more...
      • status Enable/disable snmp. type: str choices: [disable, enable] more...
    • snmp_trap_threshold (Alias name: snmp-trap-threshold) Snmp trap threshold. type: dict more...
      • trap_high_cpu_threshold (Alias name: trap-high-cpu-threshold) Cpu usage when trap is sent. type: int more...
      • trap_log_full_threshold (Alias name: trap-log-full-threshold) Log disk usage when trap is sent. type: int more...
      • trap_low_memory_threshold (Alias name: trap-low-memory-threshold) Memory usage when trap is sent. type: int more...
    • snmp_user (Alias name: snmp-user) Snmp user. type: list more...
      • auth_proto (Alias name: auth-proto) Authentication protocol. type: str choices: [md5, sha, sha1, sha256, sha384, sha512, sha224] more...
      • auth_pwd (Alias name: auth-pwd) Password for authentication protocol. type: list more...
      • name Snmp user name. type: str more...
      • priv_proto (Alias name: priv-proto) Privacy (encryption) protocol. type: str choices: [des, aes, aes128, aes192, aes256, aes192c, aes256c] more...
      • priv_pwd (Alias name: priv-pwd) Password for privacy (encryption) protocol. type: list more...
      • queries Enable/disable snmp queries for this user. type: str choices: [disable, enable] more...
      • query_port (Alias name: query-port) Snmpv3 query port (default = 161). type: int more...
      • security_level (Alias name: security-level) Security level for message authentication and encryption. type: str choices: [no-auth-no-priv, auth-no-priv, auth-priv] more...
    • staged_image_version (Alias name: staged-image-version) Staged image version for fortiswitch. type: str more...
    • static_mac (Alias name: static-mac) Static mac. type: list more...
      • description Description. type: str more...
      • id Id. type: int more...
      • interface Interface name. type: str more...
      • mac Mac address. type: str more...
      • type Type. type: str choices: [static, sticky] more...
      • vlan Vlan. type: list more...
    • storm_control (Alias name: storm-control) Storm control. type: dict more...
      • broadcast Enable/disable storm control to drop broadcast traffic. type: str choices: [disable, enable] more...
      • local_override (Alias name: local-override) Enable to override global fortiswitch storm control settings for this fortiswitch. type: str choices: [disable, enable] more...
      • rate Rate in packets per second at which storm control drops excess traffic(0-10000000, default=500, drop-all=0). type: int more...
      • unknown_multicast (Alias name: unknown-multicast) Enable/disable storm control to drop unknown multicast traffic. type: str choices: [disable, enable] more...
      • unknown_unicast (Alias name: unknown-unicast) Enable/disable storm control to drop unknown unicast traffic. type: str choices: [disable, enable] more...
      • burst_size_level (Alias name: burst-size-level) Increase level to handle bursty traffic (0 - 4, default = 0). type: int more...
    • stp_instance (Alias name: stp-instance) Stp instance. type: list more...
      • id Instance id. type: str more...
      • priority Priority. type: str choices: [0, 4096, 8192, 12288, 12328, 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, 61440] more...
    • stp_settings (Alias name: stp-settings) Stp settings. type: dict more...
      • forward_time (Alias name: forward-time) Period of time a port is in listening and learning state (4 - 30 sec, default = 15). type: int more...
      • hello_time (Alias name: hello-time) Period of time between successive stp frame bridge protocol data units (bpdus) sent on a port (1 - 10 sec, default = 2). type: int more...
      • local_override (Alias name: local-override) Enable to configure local stp settings that override global stp settings. type: str choices: [disable, enable] more...
      • max_age (Alias name: max-age) Maximum time before a bridge port saves its configuration bpdu information (6 - 40 sec, default = 20). type: int more...
      • max_hops (Alias name: max-hops) Maximum number of hops between the root bridge and the furthest bridge (1- 40, default = 20). type: int more...
      • name Name of local stp settings configuration. type: str more...
      • pending_timer (Alias name: pending-timer) Pending time (1 - 15 sec, default = 4). type: int more...
      • revision Stp revision number (0 - 65535). type: int more...
      • status Enable/disable stp. type: str choices: [disable, enable] more...
    • switch_device_tag (Alias name: switch-device-tag) User definable label/tag. type: str more...
    • switch_dhcp_opt43_key (Alias name: switch-dhcp_opt43_key) Dhcp option43 key. type: str more...
    • switch_id (Alias name: switch-id) Managed-switch name. type: str more...
    • switch_log (Alias name: switch-log) Switch log. type: dict more...
      • local_override (Alias name: local-override) Enable to configure local logging settings that override global logging settings. type: str choices: [disable, enable] more...
      • severity Severity of fortiswitch logs that are added to the fortigate event log. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] more...
      • status Enable/disable adding fortiswitch logs to the fortigate event log. type: str choices: [disable, enable] more...
    • switch_profile (Alias name: switch-profile) Fortiswitch profile. type: list more...
    • tdr_supported (Alias name: tdr-supported) Tdr supported. type: str more...
    • tunnel_discovered (Alias name: tunnel-discovered) Tunnel discovered. type: int more...
    • type Indication of switch type, physical or virtual. type: str choices: [physical, virtual] more...
    • version Fortiswitch version. type: int more...
    • vlan Vlan. type: list more...
      • assignment_priority (Alias name: assignment-priority) 802. type: int more...
      • vlan_name (Alias name: vlan-name) Vlan name. type: list more...
    • name Managed-switch name. type: str more...
    • poe_lldp_detection (Alias name: poe-lldp-detection) Enable/disable poe lldp detection. type: str choices: [disable, enable] more...
    • router_static (Alias name: router-static) Router static. type: list more...
      • blackhole Enable/disable blackhole on this route. type: str choices: [disable, enable] more...
      • comment Comment. type: str more...
      • device Gateway out interface. type: list more...
      • distance Administrative distance for the route (1 - 255, default = 10). type: int more...
      • dst Destination ip and mask for this route. type: list more...
      • dynamic_gateway (Alias name: dynamic-gateway) Enable/disable dynamic gateway. type: str choices: [disable, enable] more...
      • gateway Gateway ip for this route. type: str more...
      • id Entry sequence number. type: int more...
      • status Enable/disable route status. type: str choices: [disable, enable] more...
      • switch_id (Alias name: switch-id) Switch id. type: list more...
      • vrf Vrf for this route. type: list more...
    • router_vrf (Alias name: router-vrf) Router vrf. type: list more...
      • name Vrf entry name. type: str more...
      • switch_id (Alias name: switch-id) Switch id. type: list more...
      • vrfid Vrf id. type: int more...
    • system_dhcp_server (Alias name: system-dhcp-server) System dhcp server. type: list more...
      • default_gateway (Alias name: default-gateway) Default gateway ip address assigned by the dhcp server. type: str more...
      • dns_server1 (Alias name: dns-server1) Dns server 1. type: str more...
      • dns_server2 (Alias name: dns-server2) Dns server 2. type: str more...
      • dns_server3 (Alias name: dns-server3) Dns server 3. type: str more...
      • dns_service (Alias name: dns-service) Options for assigning dns servers to dhcp clients. type: str choices: [default, specify, local] more...
      • id Id. type: int more...
      • interface Dhcp server can assign ip configurations to clients connected to this interface. type: list more...
      • ip_range (Alias name: ip-range) Ip range. type: list more...
        • end_ip (Alias name: end-ip) End of ip range. type: str more...
        • id Id. type: int more...
        • start_ip (Alias name: start-ip) Start of ip range. type: str more...
      • lease_time (Alias name: lease-time) Lease time in seconds, 0 means unlimited. type: int more...
      • netmask Netmask assigned by the dhcp server. type: str more...
      • ntp_server1 (Alias name: ntp-server1) Ntp server 1. type: str more...
      • ntp_server2 (Alias name: ntp-server2) Ntp server 2. type: str more...
      • ntp_server3 (Alias name: ntp-server3) Ntp server 3. type: str more...
      • ntp_service (Alias name: ntp-service) Options for assigning network time protocol (ntp) servers to dhcp clients. type: str choices: [default, specify, local] more...
      • options Options. type: list more...
        • code Dhcp option code. type: int more...
        • id Id. type: int more...
        • ip Dhcp option ips. type: str more...
        • type Dhcp option type. type: str choices: [hex, string, ip, fqdn] more...
        • value Dhcp option value. type: str more...
      • status Enable/disable this dhcp configuration. type: str choices: [disable, enable] more...
      • switch_id (Alias name: switch-id) Switch id. type: list more...
    • system_interface (Alias name: system-interface) System interface. type: list more...
      • allowaccess Permitted types of management access to this interface. type: list choices: [https, ping, ssh, snmp, http, telnet, radius-acct] more...
      • interface Interface name. type: list more...
      • ip Ip and mask for this interface. type: list more...
      • mode Interface addressing mode. type: str choices: [static, dhcp] more...
      • name Interface name. type: str more...
      • status Enable/disable interface status. type: str choices: [disable, enable] more...
      • switch_id (Alias name: switch-id) Switch id. type: list more...
      • type Interface type. type: str choices: [physical, vlan] more...
      • vlan Vlan name. type: list more...
      • vrf Vrf for this route. type: list more...
    • max_poe_budget (Alias name: max-poe-budget) Max poe budget. type: int 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
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiSwitch devices that are managed by this FortiGate.
      fortinet.fmgdevice.fmgd_switchcontroller_managedswitch:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_managedswitch:
          switch_id: "your value" # Required variable, string
          # 802_1X_settings:
          #   link_down_auth: <value in [set-unauth, no-action]>
          #   local_override: <value in [disable, enable]>
          #   mab_reauth: <value in [disable, enable]>
          #   mac_called_station_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          #   mac_calling_station_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          #   mac_case: <value in [uppercase, lowercase]>
          #   mac_password_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          #   mac_username_delimiter: <value in [hyphen, single-hyphen, colon, ...]>
          #   max_reauth_attempt: <integer>
          #   reauth_period: <integer>
          #   tx_period: <integer>
          # _platform: <string>
          # access_profile: <list or string>
          # custom_command:
          #   - command_entry: <string>
          #     command_name: <list or string>
          # delayed_restart_trigger: <integer>
          # description: <string>
          # dhcp_server_access_list: <value in [disable, enable, global]>
          # dhcp_snooping_static_client:
          #   - ip: <string>
          #     mac: <string>
          #     name: <string>
          #     port: <string>
          #     vlan: <list or string>
          # directly_connected: <integer>
          # dynamic_capability: <string>
          # dynamically_discovered: <integer>
          # firmware_provision: <value in [disable, enable]>
          # firmware_provision_latest: <value in [disable, once]>
          # firmware_provision_version: <string>
          # flow_identity: <string>
          # fsw_wan1_admin: <value in [disable, enable, discovered]>
          # fsw_wan1_peer: <list or string>
          # fsw_wan2_admin: <value in [disable, enable, discovered]>
          # fsw_wan2_peer: <string>
          # igmp_snooping:
          #   aging_time: <integer>
          #   flood_unknown_multicast: <value in [disable, enable]>
          #   local_override: <value in [disable, enable]>
          #   vlans:
          #     - proxy: <value in [disable, enable, global]>
          #       querier: <value in [disable, enable]>
          #       querier_addr: <string>
          #       version: <integer>
          #       vlan_name: <list or string>
          # ip_source_guard:
          #   - binding_entry:
          #       - entry_name: <string>
          #         ip: <string>
          #         mac: <string>
          #     description: <string>
          #     port: <string>
          # l3_discovered: <integer>
          # max_allowed_trunk_members: <integer>
          # mclag_igmp_snooping_aware: <value in [disable, enable]>
          # mgmt_mode: <integer>
          # mirror:
          #   - dst: <string>
          #     name: <string>
          #     src_egress: <list or string>
          #     src_ingress: <list or string>
          #     status: <value in [inactive, active]>
          #     switching_packet: <value in [disable, enable]>
          # override_snmp_community: <value in [disable, enable]>
          # override_snmp_sysinfo: <value in [disable, enable]>
          # override_snmp_trap_threshold: <value in [disable, enable]>
          # override_snmp_user: <value in [disable, enable]>
          # owner_vdom: <string>
          # poe_detection_type: <integer>
          # poe_pre_standard_detection: <value in [disable, enable]>
          # ports:
          #   - access_mode: <value in [normal, nac, dynamic, ...]>
          #     acl_group: <list or string>
          #     aggregator_mode: <value in [bandwidth, count]>
          #     allow_arp_monitor: <value in [disable, enable]>
          #     allowed_vlans: <list or string>
          #     allowed_vlans_all: <value in [disable, enable]>
          #     arp_inspection_trust: <value in [untrusted, trusted]>
          #     authenticated_port: <integer>
          #     bundle: <value in [disable, enable]>
          #     description: <string>
          #     dhcp_snoop_option82_override:
          #       - circuit_id: <string>
          #         remote_id: <string>
          #         vlan_name: <list or string>
          #     dhcp_snoop_option82_trust: <value in [disable, enable]>
          #     dhcp_snooping: <value in [trusted, untrusted]>
          #     discard_mode: <value in [none, all-untagged, all-tagged]>
          #     dsl_profile: <list or string>
          #     edge_port: <value in [disable, enable]>
          #     encrypted_port: <integer>
          #     export_to: <list or string>
          #     export_to_pool: <list or string>
          #     export_to_pool_flag: <integer>
          #     fallback_port: <string>
          #     fec_capable: <integer>
          #     fec_state: <value in [disabled, cl74, cl91, ...]>
          #     fgt_peer_device_name: <string>
          #     fgt_peer_port_name: <string>
          #     fiber_port: <integer>
          #     flags: <integer>
          #     flap_duration: <integer>
          #     flap_rate: <integer>
          #     flap_timeout: <integer>
          #     flapguard: <value in [disable, enable]>
          #     flow_control: <value in [disable, tx, rx, ...]>
          #     fortilink_port: <integer>
          #     fortiswitch_acls: <list or integer>
          #     igmp_snooping_flood_reports: <value in [disable, enable]>
          #     interface_tags: <list or string>
          #     ip_source_guard: <value in [disable, enable]>
          #     isl_local_trunk_name: <string>
          #     isl_peer_device_name: <string>
          #     isl_peer_device_sn: <string>
          #     isl_peer_port_name: <string>
          #     lacp_speed: <value in [slow, fast]>
          #     learning_limit: <integer>
          #     link_status: <value in [down, up]>
          #     lldp_profile: <list or string>
          #     lldp_status: <value in [disable, rx-only, tx-only, ...]>
          #     loop_guard: <value in [disabled, enabled]>
          #     loop_guard_timeout: <integer>
          #     mac_addr: <string>
          #     matched_dpp_intf_tags: <string>
          #     matched_dpp_policy: <string>
          #     max_bundle: <integer>
          #     mcast_snooping_flood_traffic: <value in [disable, enable]>
          #     mclag: <value in [disable, enable]>
          #     mclag_icl_port: <integer>
          #     media_type: <string>
          #     member_withdrawal_behavior: <value in [forward, block]>
          #     members: <list or string>
          #     min_bundle: <integer>
          #     mode: <value in [static, lacp-passive, lacp-active]>
          #     p2p_port: <integer>
          #     packet_sample_rate: <integer>
          #     packet_sampler: <value in [disabled, enabled]>
          #     pause_meter: <integer>
          #     pause_meter_resume: <value in [25%, 50%, 75%]>
          #     poe_capable: <integer>
          #     poe_max_power: <string>
          #     poe_mode_bt_cabable: <integer>
          #     poe_port_mode: <value in [ieee802-3af, ieee802-3at, ieee802-3bt]>
          #     poe_port_power: <value in [normal, perpetual, perpetual-fast]>
          #     poe_port_priority: <value in [critical-priority, high-priority, low-priority, ...]>
          #     poe_pre_standard_detection: <value in [disable, enable]>
          #     poe_standard: <string>
          #     poe_status: <value in [disable, enable]>
          #     port_name: <string>
          #     port_number: <integer>
          #     port_owner: <string>
          #     port_policy: <list or string>
          #     port_prefix_type: <integer>
          #     port_security_policy: <list or string>
          #     port_selection_criteria: <value in [src-mac, dst-mac, src-dst-mac, ...]>
          #     ptp_policy: <list or string>
          #     ptp_status: <value in [disable, enable]>
          #     qos_policy: <list or string>
          #     restricted_auth_port: <integer>
          #     rpvst_port: <value in [disabled, enabled]>
          #     sample_direction: <value in [rx, tx, both]>
          #     sflow_counter_interval: <integer>
          #     speed: <value in [auto, 10full, 10half, ...]>
          #     speed_mask: <integer>
          #     stacking_port: <integer>
          #     status: <value in [down, up]>
          #     sticky_mac: <value in [disable, enable]>
          #     storm_control_policy: <list or string>
          #     stp_bpdu_guard: <value in [disabled, enabled]>
          #     stp_bpdu_guard_timeout: <integer>
          #     stp_root_guard: <value in [disabled, enabled]>
          #     stp_state: <value in [disabled, enabled]>
          #     switch_id: <string>
          #     trunk_member: <integer>
          #     type: <value in [physical, trunk]>
          #     untagged_vlans: <list or string>
          #     virtual_port: <integer>
          #     vlan: <list or string>
          #     igmps_flood_reports: <value in [disable, enable]>
          #     igmps_flood_traffic: <value in [disable, enable]>
          #     export_tags: <list or string>
          #     igmp_snooping: <value in [disable, enable]>
          #     log_mac_event: <value in [disable, enable]>
          #     pd_capable: <integer>
          #     qnq: <list or string>
          # pre_provisioned: <integer>
          # ptp_profile: <list or string>
          # ptp_status: <value in [disable, enable]>
          # purdue_level: <value in [1, 2, 3, ...]>
          # qos_drop_policy: <value in [taildrop, random-early-detection]>
          # qos_red_probability: <integer>
          # radius_nas_ip: <string>
          # radius_nas_ip_override: <value in [disable, enable]>
          # remote_log:
          #   - csv: <value in [disable, enable]>
          #     facility: <value in [kernel, user, mail, ...]>
          #     name: <string>
          #     port: <integer>
          #     server: <string>
          #     severity: <value in [emergency, alert, critical, ...]>
          #     status: <value in [disable, enable]>
          # route_offload: <value in [disable, enable]>
          # route_offload_mclag: <value in [disable, enable]>
          # route_offload_router:
          #   - router_ip: <string>
          #     vlan_name: <list or string>
          # sn: <string>
          # snmp_community:
          #   - events:
          #       - "cpu-high"
          #       - "mem-low"
          #       - "log-full"
          #       - "intf-ip"
          #       - "ent-conf-change"
          #       - "l2mac"
          #     hosts:
          #       - id: <integer>
          #         ip: <list or string>
          #     id: <integer>
          #     name: <string>
          #     query_v1_port: <integer>
          #     query_v1_status: <value in [disable, enable]>
          #     query_v2c_port: <integer>
          #     query_v2c_status: <value in [disable, enable]>
          #     status: <value in [disable, enable]>
          #     trap_v1_lport: <integer>
          #     trap_v1_rport: <integer>
          #     trap_v1_status: <value in [disable, enable]>
          #     trap_v2c_lport: <integer>
          #     trap_v2c_rport: <integer>
          #     trap_v2c_status: <value in [disable, enable]>
          # snmp_sysinfo:
          #   contact_info: <string>
          #   description: <string>
          #   engine_id: <string>
          #   location: <string>
          #   status: <value in [disable, enable]>
          # snmp_trap_threshold:
          #   trap_high_cpu_threshold: <integer>
          #   trap_log_full_threshold: <integer>
          #   trap_low_memory_threshold: <integer>
          # snmp_user:
          #   - auth_proto: <value in [md5, sha, sha1, ...]>
          #     auth_pwd: <list or string>
          #     name: <string>
          #     priv_proto: <value in [des, aes, aes128, ...]>
          #     priv_pwd: <list or string>
          #     queries: <value in [disable, enable]>
          #     query_port: <integer>
          #     security_level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>
          # staged_image_version: <string>
          # static_mac:
          #   - description: <string>
          #     id: <integer>
          #     interface: <string>
          #     mac: <string>
          #     type: <value in [static, sticky]>
          #     vlan: <list or string>
          # storm_control:
          #   broadcast: <value in [disable, enable]>
          #   local_override: <value in [disable, enable]>
          #   rate: <integer>
          #   unknown_multicast: <value in [disable, enable]>
          #   unknown_unicast: <value in [disable, enable]>
          #   burst_size_level: <integer>
          # stp_instance:
          #   - id: <string>
          #     priority: <value in [0, 4096, 8192, ...]>
          # stp_settings:
          #   forward_time: <integer>
          #   hello_time: <integer>
          #   local_override: <value in [disable, enable]>
          #   max_age: <integer>
          #   max_hops: <integer>
          #   name: <string>
          #   pending_timer: <integer>
          #   revision: <integer>
          #   status: <value in [disable, enable]>
          # switch_device_tag: <string>
          # switch_dhcp_opt43_key: <string>
          # switch_log:
          #   local_override: <value in [disable, enable]>
          #   severity: <value in [emergency, alert, critical, ...]>
          #   status: <value in [disable, enable]>
          # switch_profile: <list or string>
          # tdr_supported: <string>
          # tunnel_discovered: <integer>
          # type: <value in [physical, virtual]>
          # version: <integer>
          # vlan:
          #   - assignment_priority: <integer>
          #     vlan_name: <list or string>
          # name: <string>
          # poe_lldp_detection: <value in [disable, enable]>
          # router_static:
          #   - blackhole: <value in [disable, enable]>
          #     comment: <string>
          #     device: <list or string>
          #     distance: <integer>
          #     dst: <list or string>
          #     dynamic_gateway: <value in [disable, enable]>
          #     gateway: <string>
          #     id: <integer>
          #     status: <value in [disable, enable]>
          #     switch_id: <list or string>
          #     vrf: <list or string>
          # router_vrf:
          #   - name: <string>
          #     switch_id: <list or string>
          #     vrfid: <integer>
          # system_dhcp_server:
          #   - default_gateway: <string>
          #     dns_server1: <string>
          #     dns_server2: <string>
          #     dns_server3: <string>
          #     dns_service: <value in [default, specify, local]>
          #     id: <integer>
          #     interface: <list or string>
          #     ip_range:
          #       - end_ip: <string>
          #         id: <integer>
          #         start_ip: <string>
          #     lease_time: <integer>
          #     netmask: <string>
          #     ntp_server1: <string>
          #     ntp_server2: <string>
          #     ntp_server3: <string>
          #     ntp_service: <value in [default, specify, local]>
          #     options:
          #       - code: <integer>
          #         id: <integer>
          #         ip: <string>
          #         type: <value in [hex, string, ip, ...]>
          #         value: <string>
          #     status: <value in [disable, enable]>
          #     switch_id: <list or string>
          # system_interface:
          #   - allowaccess:
          #       - "https"
          #       - "ping"
          #       - "ssh"
          #       - "snmp"
          #       - "http"
          #       - "telnet"
          #       - "radius-acct"
          #     interface: <list or string>
          #     ip: <list or string>
          #     mode: <value in [static, dhcp]>
          #     name: <string>
          #     status: <value in [disable, enable]>
          #     switch_id: <list or string>
          #     type: <value in [physical, vlan]>
          #     vlan: <list or string>
          #     vrf: <list or string>
          # max_poe_budget: <integer>

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)