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

New in version 2.10.

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.

Requirements

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

• ansible>=2.9.0

FortiManager Version Compatibility

	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
switchcontroller_managedswitch	yes	yes	yes	yes	yes	yes	yes	yes	yes

Parameters

• 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
• 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
• 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
• 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
• adom - The parameter in requested url type: str required: true
• switchcontroller_managedswitch - no description type: dict
• _platform - _Platform. type: str more...

  	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  _platform	True	True	True	True	True	True	True	True	True

• description - Description. type: str more...

  	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  description	True	True	True	True	True	True	True	True	True

• name - Managed-switch name. type: str more...

  	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  name	True	True	True	True	True	True	True	True	True

• ports - Ports. type: array more...

  	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  ports	True	True	True	True	True	True	True	True	True

  • allowed-vlans - Configure switch port tagged vlans type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    allowed-vlans	True	True	True	True	True	True	True	True	True

  • allowed-vlans-all - Enable/disable all defined vlans on this port. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    allowed-vlans-all	True	True	True	True	True	True	True	True	True

  • arp-inspection-trust - Trusted or untrusted dynamic ARP inspection. type: str choices: [untrusted, trusted] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    arp-inspection-trust	True	True	True	True	True	True	True	True	True

  • bundle - Enable/disable Link Aggregation Group (LAG) bundling for non-FortiLink interfaces. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    bundle	True	True	True	True	True	True	True	True	True

  • description - Description for port. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    description	True	True	True	True	True	True	True	True	True

  • dhcp-snoop-option82-trust - Enable/disable allowance of DHCP with option-82 on untrusted interface. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    dhcp-snoop-option82-trust	True	True	True	True	True	True	True	True	True

  • dhcp-snooping - Trusted or untrusted DHCP-snooping interface. type: str choices: [trusted, untrusted] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    dhcp-snooping	True	True	True	True	True	True	True	True	True

  • discard-mode - Configure discard mode for port. type: str choices: [none, all-untagged, all-tagged] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    discard-mode	True	True	True	True	True	True	True	True	True

  • edge-port - Enable/disable this interface as an edge port, bridging connections between workstations and/or computers. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    edge-port	True	True	True	True	True	True	True	True	True

  • igmp-snooping - Set IGMP snooping mode for the physical port interface. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    igmp-snooping	True	True	True	True	False	False	False	False	False

  • igmps-flood-reports - Enable/disable flooding of IGMP reports to this interface when igmp-snooping enabled. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    igmps-flood-reports	True	True	True	True	True	True	True	True	True

  • igmps-flood-traffic - Enable/disable flooding of IGMP snooping traffic to this interface. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    igmps-flood-traffic	True	True	True	True	True	True	True	True	True

  • lacp-speed - end Link Aggregation Control Protocol (LACP) messages every 30 seconds (slow) or every second (fast). type: str choices: [slow, fast] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    lacp-speed	True	True	True	True	True	True	True	True	True

  • learning-limit - Limit the number of dynamic MAC addresses on this Port (1 - 128, 0 = no limit, default). type: int more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    learning-limit	True	True	True	True	True	True	True	True	True

  • lldp-profile - LLDP port TLV profile. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    lldp-profile	True	True	True	True	True	True	True	True	True

  • lldp-status - LLDP transmit and receive status. type: str choices: [disable, rx-only, tx-only, tx-rx] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    lldp-status	True	True	True	True	True	True	True	True	True

  • loop-guard - Enable/disable loop-guard on this interface, an STP optimization used to prevent network loops. type: str choices: [disabled, enabled] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    loop-guard	True	True	True	True	True	True	True	True	True

  • loop-guard-timeout - Loop-guard timeout (0 - 120 min, default = 45). type: int more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    loop-guard-timeout	True	True	True	True	True	True	True	True	True

  • max-bundle - Maximum size of LAG bundle (1 - 24, default = 24) type: int more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    max-bundle	True	True	True	True	True	True	True	True	True

  • mclag - Enable/disable multi-chassis link aggregation (MCLAG). type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    mclag	True	True	True	True	True	True	True	True	True

  • member-withdrawal-behavior - Port behavior after it withdraws because of loss of control packets. type: str choices: [forward, block] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    member-withdrawal-behavior	True	True	True	True	True	True	True	True	True

  • members - Aggregated LAG bundle interfaces. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    members	True	True	True	True	True	True	True	True	True

  • min-bundle - Minimum size of LAG bundle (1 - 24, default = 1) type: int more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    min-bundle	True	True	True	True	True	True	True	True	True

  • mode - LACP mode: ignore and do not send control messages, or negotiate 802. type: str choices: [static, lacp-passive, lacp-active] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    mode	True	True	True	True	True	True	True	True	True

  • poe-pre-standard-detection - Enable/disable PoE pre-standard detection. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    poe-pre-standard-detection	True	True	True	True	True	True	True	True	True

  • poe-status - Enable/disable PoE status. type: str choices: [disable, enable] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    poe-status	True	True	True	True	True	True	True	True	True

  • port-name - Switch port name. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    port-name	True	True	True	True	True	True	True	True	True

  • port-owner - Switch port name. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    port-owner	True	True	True	True	True	True	True	True	True

  • port-security-policy - Switch controller authentication policy to apply to this managed switch from available options. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    port-security-policy	True	True	True	True	True	True	True	True	True

  • 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...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    port-selection-criteria	True	True	True	True	True	True	True	True	True

  • qos-policy - Switch controller QoS policy from available options. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    qos-policy	True	True	True	True	True	True	True	True	True

  • sample-direction - sFlow sample direction. type: str choices: [rx, tx, both] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    sample-direction	True	True	True	True	True	True	True	True	True

  • sflow-counter-interval - sFlow sampler counter polling interval (1 - 255 sec). type: int more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    sflow-counter-interval	True	True	True	True	True	True	True	True	True

  • sflow-sample-rate - sFlow sampler sample rate (0 - 99999 p/sec). type: int more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    sflow-sample-rate	True	False	False	False	False	False	False	False	False

  • sflow-sampler - Enable/disable sFlow protocol on this interface. type: str choices: [disabled, enabled] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    sflow-sampler	True	False	False	False	False	False	False	False	False

  • stp-bpdu-guard - Enable/disable STP BPDU guard on this interface. type: str choices: [disabled, enabled] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    stp-bpdu-guard	True	True	True	True	True	True	True	True	True

  • stp-bpdu-guard-timeout - BPDU Guard disabling protection (0 - 120 min). type: int more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    stp-bpdu-guard-timeout	True	True	True	True	True	True	True	True	True

  • stp-root-guard - Enable/disable STP root guard on this interface. type: str choices: [disabled, enabled] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    stp-root-guard	True	True	True	True	True	True	True	True	True

  • stp-state - Enable/disable Spanning Tree Protocol (STP) on this interface. type: str choices: [disabled, enabled] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    stp-state	True	True	True	True	True	True	True	True	True

  • type - Interface type: physical or trunk port. type: str choices: [physical, trunk] more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    type	True	True	True	True	True	True	True	True	True

  • untagged-vlans - Configure switch port untagged vlans type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    untagged-vlans	True	True	True	True	True	True	True	True	True

  • vlan - Assign switch ports to a VLAN. type: str more...

    	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    vlan	True	True	True	True	True	True	True	True	True

  • export-to-pool-flag - Switch controller export port to pool-list. type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    export-to-pool-flag	True	True	False	False	False	False	False	False

  • mac-addr - Port/Trunk MAC. type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    mac-addr	True	False	False	False	False	False	False	False

  • packet-sample-rate - Packet sampling rate (0 - 99999 p/sec). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    packet-sample-rate	True	True	True	True	True	True	True	True

  • packet-sampler - Enable/disable packet sampling on this interface. type: str choices: [disabled, enabled] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    packet-sampler	True	True	True	True	True	True	True	True

  • sticky-mac - Enable or disable sticky-mac on the interface. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    sticky-mac	True	True	True	True	True	True	True	True

  • storm-control-policy - Switch controller storm control policy from available options. type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    storm-control-policy	True	True	False	False	False	False	False	False

  • access-mode - Access mode of the port. type: str choices: [normal, nac, dynamic, static] more...

    	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    access-mode	True	True	True	True	True

  • ip-source-guard - Enable/disable IP source guard. type: str choices: [disable, enable] more...

    	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    ip-source-guard	True	True	True	True	True

  • mclag-icl-port - Mclag-Icl-Port. type: int more...

    	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    mclag-icl-port	True	True	True	True	True

  • p2p-port - P2P-Port. type: int more...

    	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    p2p-port	True	True	True	True	True

  • aggregator-mode - LACP member select mode. type: str choices: [bandwidth, count] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    aggregator-mode	True	True	True	True

  • rpvst-port - Enable/disable inter-operability with rapid PVST on this interface. type: str choices: [disabled, enabled] more...

    	6.4.2	6.4.5	7.0.0	7.2.0
    rpvst-port	True	True	True	True

  • flow-control - Flow control direction. type: str choices: [disable, tx, rx, both] more...

    	6.4.5	7.0.0	7.2.0
    flow-control	True	True	True

  • media-type - Media-Type. type: str more...

    	6.4.5	7.0.0	7.2.0
    media-type	True	True	True

  • pause-meter - Configure ingress pause metering rate, in kbps (default = 0, disabled). type: int more...

    	6.4.5	7.0.0	7.2.0
    pause-meter	True	True	True

  • pause-meter-resume - Resume threshold for resuming traffic on ingress port. type: str choices: [25%, 50%, 75%] more...

    	6.4.5	7.0.0	7.2.0
    pause-meter-resume	True	True	True

  • trunk-member - Trunk member. type: int more...

    	6.4.5	7.0.0	7.2.0
    trunk-member	True	True	True

  • fec-capable - FEC capable. type: int more...

    	7.0.0	7.2.0
    fec-capable	True	True

  • fec-state - State of forward error correction. type: str choices: [disabled, cl74, cl91] more...

    	7.0.0	7.2.0
    fec-state	True	True

  • matched-dpp-intf-tags - Matched interface tags in the dynamic port policy. type: str more...

    	7.0.0	7.2.0
    matched-dpp-intf-tags	True	True

  • matched-dpp-policy - Matched child policy in the dynamic port policy. type: str more...

    	7.0.0	7.2.0
    matched-dpp-policy	True	True

  • port-policy - Switch controller dynamic port policy from available options. type: str more...

    	7.0.0	7.2.0
    port-policy	True	True

  • status - Switch port admin status: up or down. type: str choices: [down, up] more...

    	7.0.0	7.2.0
    status	True	True

  • dsl-profile - DSL policy configuration. type: str more...

    	7.2.0
    dsl-profile	True

  • flap-duration - Period over which flap events are calculated (seconds). type: int more...

    	7.2.0
    flap-duration	True

  • flap-rate - Number of stage change events needed within flap-duration. type: int more...

    	7.2.0
    flap-rate	True

  • flap-timeout - Flap guard disabling protection (min). type: int more...

    	7.2.0
    flap-timeout	True

  • flapguard - Enable/disable flap guard. type: str choices: [disable, enable] more...

    	7.2.0
    flapguard	True

  • interface-tags - No description for the parameter type: str more...

    	7.2.0
    interface-tags	True

  • poe-max-power - No description for the parameter type: str more...

    	7.2.0
    poe-max-power	True

  • poe-standard - No description for the parameter type: str more...

    	7.2.0
    poe-standard	True

• switch-id - Managed-switch id. type: str more...

  	6.0.0	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  switch-id	True	True	True	True	True	True	True	True	True

• override-snmp-community - Enable/disable overriding the global SNMP communities. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  override-snmp-community	True	True	True	True	True	True	True	True

• override-snmp-sysinfo - Enable/disable overriding the global SNMP system information. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  override-snmp-sysinfo	True	True	True	True	True	True	True	True

• override-snmp-trap-threshold - Enable/disable overriding the global SNMP trap threshold values. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  override-snmp-trap-threshold	True	True	True	True	True	True	True	True

• override-snmp-user - Enable/disable overriding the global SNMP users. type: str choices: [disable, enable] more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  override-snmp-user	True	True	True	True	True	True	True	True

• poe-detection-type - Poe-Detection-Type. type: int more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  poe-detection-type	True	True	True	True	True	True	True	True

• remote-log - No description for the parameter type: array more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  remote-log	True	True	False	False	False	False	False	False

  • csv - Enable/disable comma-separated value (CSV) strings. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    csv	True	True	False	False	False	False	False	False

  • 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...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    facility	True	True	False	False	False	False	False	False

  • name - Remote log name. type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    name	True	True	False	False	False	False	False	False

  • port - Remote syslog server listening port. type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    port	True	True	False	False	False	False	False	False

  • server - IPv4 address of the remote syslog server. type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    server	True	True	False	False	False	False	False	False

  • severity - Severity of logs to be transferred to remote log server. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    severity	True	True	False	False	False	False	False	False

  • status - Enable/disable logging by FortiSwitch device to a remote syslog server. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    status	True	True	False	False	False	False	False	False

• snmp-community - No description for the parameter type: array more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  snmp-community	True	True	False	False	False	False	False	False

  • events - No description for the parameter type: array choices: [cpu-high, mem-low, log-full, intf-ip, ent-conf-change] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    events	True	True	False	False	False	False	False	False

  • hosts - No description for the parameter type: array more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    hosts	True	True	False	False	False	False	False	False

    • id - Host entry ID. type: int more...

      	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
      id	True	True	False	False	False	False	False	False

    • ip - IPv4 address of the SNMP manager (host). type: str more...

      	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
      ip	True	True	False	False	False	False	False	False

  • id - SNMP community ID. type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    id	True	True	False	False	False	False	False	False

  • name - SNMP community name. type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    name	True	True	False	False	False	False	False	False

  • query-v1-port - SNMP v1 query port (default = 161). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    query-v1-port	True	True	False	False	False	False	False	False

  • query-v1-status - Enable/disable SNMP v1 queries. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    query-v1-status	True	True	False	False	False	False	False	False

  • query-v2c-port - SNMP v2c query port (default = 161). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    query-v2c-port	True	True	False	False	False	False	False	False

  • query-v2c-status - Enable/disable SNMP v2c queries. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    query-v2c-status	True	True	False	False	False	False	False	False

  • status - Enable/disable this SNMP community. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    status	True	True	False	False	False	False	False	False

  • trap-v1-lport - SNMP v2c trap local port (default = 162). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    trap-v1-lport	True	True	False	False	False	False	False	False

  • trap-v1-rport - SNMP v2c trap remote port (default = 162). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    trap-v1-rport	True	True	False	False	False	False	False	False

  • trap-v1-status - Enable/disable SNMP v1 traps. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    trap-v1-status	True	True	False	False	False	False	False	False

  • trap-v2c-lport - SNMP v2c trap local port (default = 162). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    trap-v2c-lport	True	True	False	False	False	False	False	False

  • trap-v2c-rport - SNMP v2c trap remote port (default = 162). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    trap-v2c-rport	True	True	False	False	False	False	False	False

  • trap-v2c-status - Enable/disable SNMP v2c traps. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    trap-v2c-status	True	True	False	False	False	False	False	False

• snmp-user - No description for the parameter type: array more...

  	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  snmp-user	True	True	False	False	False	False	False	False

  • auth-proto - Authentication protocol. type: str choices: [md5, sha] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    auth-proto	True	True	False	False	False	False	False	False

  • auth-pwd - No description for the parameter type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    auth-pwd	True	True	False	False	False	False	False	False

  • name - SNMP user name. type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    name	True	True	False	False	False	False	False	False

  • priv-proto - Privacy (encryption) protocol. type: str choices: [des, aes] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    priv-proto	True	True	False	False	False	False	False	False

  • priv-pwd - No description for the parameter type: str more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    priv-pwd	True	True	False	False	False	False	False	False

  • queries - Enable/disable SNMP queries for this user. type: str choices: [disable, enable] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    queries	True	True	False	False	False	False	False	False

  • query-port - SNMPv3 query port (default = 161). type: int more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    query-port	True	True	False	False	False	False	False	False

  • security-level - Security level for message authentication and encryption. type: str choices: [no-auth-no-priv, auth-no-priv, auth-priv] more...

    	6.2.1	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    security-level	True	True	False	False	False	False	False	False

• mclag-igmp-snooping-aware - Enable/disable MCLAG IGMP-snooping awareness. type: str choices: [disable, enable] more...

  	6.2.3	6.2.5	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  mclag-igmp-snooping-aware	True	True	True	True	True	True	True

• ip-source-guard - No description for the parameter type: array more...

  	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  ip-source-guard	True	False	False	False	False

  • binding-entry - No description for the parameter type: array more...

    	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    binding-entry	True	False	False	False	False

    • entry-name - Configure binding pair. type: str more...

      	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
      entry-name	True	False	False	False	False

    • ip - Source IP for this rule. type: str more...

      	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
      ip	True	False	False	False	False

    • mac - MAC address for this rule. type: str more...

      	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
      mac	True	False	False	False	False

  • description - Description. type: str more...

    	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    description	True	False	False	False	False

  • port - Ingress interface to which source guard is bound. type: str more...

    	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
    port	True	False	False	False	False

• l3-discovered - L3-Discovered. type: int more...

  	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  l3-discovered	True	True	True	True	True

• qos-drop-policy - Set QoS drop-policy. type: str choices: [taildrop, random-early-detection] more...

  	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  qos-drop-policy	True	True	True	True	True

• qos-red-probability - Set QoS RED/WRED drop probability. type: int more...

  	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  qos-red-probability	True	True	True	True	True

• switch-dhcp_opt43_key - DHCP option43 key. type: str more...

  	6.4.0	6.4.2	6.4.5	7.0.0	7.2.0
  switch-dhcp_opt43_key	True	True	True	True	True

• tdr-supported - Tdr-Supported. type: str more...

  	6.4.5	7.0.0	7.2.0
  tdr-supported	True	True	True

• custom-command - Custom-Command. type: array more...

  	7.0.0	7.2.0
  custom-command	True	True

  • command-entry - List of FortiSwitch commands. type: str more...

    	7.0.0	7.2.0
    command-entry	True	True

  • command-name - Names of commands to be pushed to this FortiSwitch device, as configured under config switch-controller custom-command. type: str more...

    	7.0.0	7.2.0
    command-name	True	True

• firmware-provision - Enable/disable provisioning of firmware to FortiSwitches on join connection. type: str choices: [disable, enable] more...

  	7.0.0	7.2.0
  firmware-provision	True	True

• firmware-provision-version - Firmware version to provision to this FortiSwitch on bootup (major. type: str more...

  	7.0.0	7.2.0
  firmware-provision-version	True	True

• dhcp-server-access-list - DHCP snooping server access list. type: str choices: [disable, enable, global] more...

  	7.2.0
  dhcp-server-access-list	True

• firmware-provision-latest - Enable/disable one-time automatic provisioning of the latest firmware version. type: str choices: [disable, once] more...

  	7.2.0
  firmware-provision-latest	True

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_switchcontroller_managedswitch:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        switchcontroller_managedswitch:
           _platform: <value of string>
           description: <value of string>
           name: <value of string>
           ports:
             -
                 allowed-vlans: <value of string>
                 allowed-vlans-all: <value in [disable, enable]>
                 arp-inspection-trust: <value in [untrusted, trusted]>
                 bundle: <value in [disable, enable]>
                 description: <value of string>
                 dhcp-snoop-option82-trust: <value in [disable, enable]>
                 dhcp-snooping: <value in [trusted, untrusted]>
                 discard-mode: <value in [none, all-untagged, all-tagged]>
                 edge-port: <value in [disable, enable]>
                 igmp-snooping: <value in [disable, enable]>
                 igmps-flood-reports: <value in [disable, enable]>
                 igmps-flood-traffic: <value in [disable, enable]>
                 lacp-speed: <value in [slow, fast]>
                 learning-limit: <value of integer>
                 lldp-profile: <value of string>
                 lldp-status: <value in [disable, rx-only, tx-only, ...]>
                 loop-guard: <value in [disabled, enabled]>
                 loop-guard-timeout: <value of integer>
                 max-bundle: <value of integer>
                 mclag: <value in [disable, enable]>
                 member-withdrawal-behavior: <value in [forward, block]>
                 members: <value of string>
                 min-bundle: <value of integer>
                 mode: <value in [static, lacp-passive, lacp-active]>
                 poe-pre-standard-detection: <value in [disable, enable]>
                 poe-status: <value in [disable, enable]>
                 port-name: <value of string>
                 port-owner: <value of string>
                 port-security-policy: <value of string>
                 port-selection-criteria: <value in [src-mac, dst-mac, src-dst-mac, ...]>
                 qos-policy: <value of string>
                 sample-direction: <value in [rx, tx, both]>
                 sflow-counter-interval: <value of integer>
                 sflow-sample-rate: <value of integer>
                 sflow-sampler: <value in [disabled, enabled]>
                 stp-bpdu-guard: <value in [disabled, enabled]>
                 stp-bpdu-guard-timeout: <value of integer>
                 stp-root-guard: <value in [disabled, enabled]>
                 stp-state: <value in [disabled, enabled]>
                 type: <value in [physical, trunk]>
                 untagged-vlans: <value of string>
                 vlan: <value of string>
                 export-to-pool-flag: <value of integer>
                 mac-addr: <value of string>
                 packet-sample-rate: <value of integer>
                 packet-sampler: <value in [disabled, enabled]>
                 sticky-mac: <value in [disable, enable]>
                 storm-control-policy: <value of string>
                 access-mode: <value in [normal, nac, dynamic, ...]>
                 ip-source-guard: <value in [disable, enable]>
                 mclag-icl-port: <value of integer>
                 p2p-port: <value of integer>
                 aggregator-mode: <value in [bandwidth, count]>
                 rpvst-port: <value in [disabled, enabled]>
                 flow-control: <value in [disable, tx, rx, ...]>
                 media-type: <value of string>
                 pause-meter: <value of integer>
                 pause-meter-resume: <value in [25%, 50%, 75%]>
                 trunk-member: <value of integer>
                 fec-capable: <value of integer>
                 fec-state: <value in [disabled, cl74, cl91]>
                 matched-dpp-intf-tags: <value of string>
                 matched-dpp-policy: <value of string>
                 port-policy: <value of string>
                 status: <value in [down, up]>
                 dsl-profile: <value of string>
                 flap-duration: <value of integer>
                 flap-rate: <value of integer>
                 flap-timeout: <value of integer>
                 flapguard: <value in [disable, enable]>
                 interface-tags: <value of string>
                 poe-max-power: <value of string>
                 poe-standard: <value of string>
           switch-id: <value of string>
           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]>
           poe-detection-type: <value of integer>
           remote-log:
             -
                 csv: <value in [disable, enable]>
                 facility: <value in [kernel, user, mail, ...]>
                 name: <value of string>
                 port: <value of integer>
                 server: <value of string>
                 severity: <value in [emergency, alert, critical, ...]>
                 status: <value in [disable, enable]>
           snmp-community:
             -
                 events:
                   - cpu-high
                   - mem-low
                   - log-full
                   - intf-ip
                   - ent-conf-change
                 hosts:
                   -
                       id: <value of integer>
                       ip: <value of string>
                 id: <value of integer>
                 name: <value of string>
                 query-v1-port: <value of integer>
                 query-v1-status: <value in [disable, enable]>
                 query-v2c-port: <value of integer>
                 query-v2c-status: <value in [disable, enable]>
                 status: <value in [disable, enable]>
                 trap-v1-lport: <value of integer>
                 trap-v1-rport: <value of integer>
                 trap-v1-status: <value in [disable, enable]>
                 trap-v2c-lport: <value of integer>
                 trap-v2c-rport: <value of integer>
                 trap-v2c-status: <value in [disable, enable]>
           snmp-user:
             -
                 auth-proto: <value in [md5, sha]>
                 auth-pwd: <value of string>
                 name: <value of string>
                 priv-proto: <value in [des, aes]>
                 priv-pwd: <value of string>
                 queries: <value in [disable, enable]>
                 query-port: <value of integer>
                 security-level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>
           mclag-igmp-snooping-aware: <value in [disable, enable]>
           ip-source-guard:
             -
                 binding-entry:
                   -
                       entry-name: <value of string>
                       ip: <value of string>
                       mac: <value of string>
                 description: <value of string>
                 port: <value of string>
           l3-discovered: <value of integer>
           qos-drop-policy: <value in [taildrop, random-early-detection]>
           qos-red-probability: <value of integer>
           switch-dhcp_opt43_key: <value of string>
           tdr-supported: <value of string>
           custom-command:
             -
                 command-entry: <value of string>
                 command-name: <value of string>
           firmware-provision: <value in [disable, enable]>
           firmware-provision-version: <value of string>
           dhcp-server-access-list: <value in [disable, enable, global]>
           firmware-provision-latest: <value in [disable, once]>

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:

• 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_message - The descriptive message of the api response returned: always type: str sample: OK
• response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)

Hint

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