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

Note

This module is part of the fortinet.fortimanager collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_switchcontroller_managedswitch.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

switchcontroller_managedswitch

dictionary

the top level parameters set

_platform

string

_Platform.

custom-command

list / elements=dictionary

Custom-Command.

command-entry

string

List of FortiSwitch commands.

command-name

string

Names of commands to be pushed to this FortiSwitch device, as configured under config switch-controller custom-command.

description

string

Description.

dhcp-server-access-list

string

DHCP snooping server access list.

Choices:

  • "disable"

  • "enable"

  • "global"

dhcp-snooping-static-client

list / elements=dictionary

description

ip

string

Client static IP address.

mac

string

Client MAC address.

name

string

Client name.

port

string

Interface name.

vlan

string

VLAN name.

firmware-provision

string

Enable/disable provisioning of firmware to FortiSwitches on join connection.

Choices:

  • "disable"

  • "enable"

firmware-provision-latest

string

Enable/disable one-time automatic provisioning of the latest firmware version.

Choices:

  • "disable"

  • "once"

firmware-provision-version

string

Firmware version to provision to this FortiSwitch on bootup

ip-source-guard

list / elements=dictionary

description

binding-entry

list / elements=dictionary

description

entry-name

string

Configure binding pair.

ip

string

Source IP for this rule.

mac

string

MAC address for this rule.

description

string

Description.

port

string

Ingress interface to which source guard is bound.

l3-discovered

integer

L3-Discovered.

mclag-igmp-snooping-aware

string

Enable/disable MCLAG IGMP-snooping awareness.

Choices:

  • "disable"

  • "enable"

name

string

Managed-switch name.

override-snmp-community

string

Enable/disable overriding the global SNMP communities.

Choices:

  • "disable"

  • "enable"

override-snmp-sysinfo

string

Enable/disable overriding the global SNMP system information.

Choices:

  • "disable"

  • "enable"

override-snmp-trap-threshold

string

Enable/disable overriding the global SNMP trap threshold values.

Choices:

  • "disable"

  • "enable"

override-snmp-user

string

Enable/disable overriding the global SNMP users.

Choices:

  • "disable"

  • "enable"

poe-detection-type

integer

Poe-Detection-Type.

ports

list / elements=dictionary

Ports.

access-mode

string

Access mode of the port.

Choices:

  • "normal"

  • "nac"

  • "dynamic"

  • "static"

acl-group

string

description

aggregator-mode

string

LACP member select mode.

Choices:

  • "bandwidth"

  • "count"

allowed-vlans

string

Configure switch port tagged vlans

allowed-vlans-all

string

Enable/disable all defined vlans on this port.

Choices:

  • "disable"

  • "enable"

arp-inspection-trust

string

Trusted or untrusted dynamic ARP inspection.

Choices:

  • "untrusted"

  • "trusted"

bundle

string

Enable/disable Link Aggregation Group

Choices:

  • "disable"

  • "enable"

description

string

Description for port.

dhcp-snoop-option82-override

list / elements=dictionary

description

circuit-id

string

Circuit ID string.

remote-id

string

Remote ID string.

vlan-name

string

DHCP snooping option 82 VLAN.

dhcp-snoop-option82-trust

string

Enable/disable allowance of DHCP with option-82 on untrusted interface.

Choices:

  • "disable"

  • "enable"

dhcp-snooping

string

Trusted or untrusted DHCP-snooping interface.

Choices:

  • "trusted"

  • "untrusted"

discard-mode

string

Configure discard mode for port.

Choices:

  • "none"

  • "all-untagged"

  • "all-tagged"

dot1x-enable

string

no description

Choices:

  • "disable"

  • "enable"

dsl-profile

string

DSL policy configuration.

edge-port

string

Enable/disable this interface as an edge port, bridging connections between workstations and/or computers.

Choices:

  • "disable"

  • "enable"

export-to-pool-flag

integer

Switch controller export port to pool-list.

fec-capable

integer

FEC capable.

fec-state

string

State of forward error correction.

Choices:

  • "disabled"

  • "cl74"

  • "cl91"

flap-duration

integer

Period over which flap events are calculated

flap-rate

integer

Number of stage change events needed within flap-duration.

flap-timeout

integer

Flap guard disabling protection

flapguard

string

Enable/disable flap guard.

Choices:

  • "disable"

  • "enable"

flow-control

string

Flow control direction.

Choices:

  • "disable"

  • "tx"

  • "rx"

  • "both"

fortiswitch-acls

integer

description

igmp-snooping

string

Set IGMP snooping mode for the physical port interface.

Choices:

  • "disable"

  • "enable"

igmp-snooping-flood-reports

string

Enable/disable flooding of IGMP reports to this interface when igmp-snooping enabled.

Choices:

  • "disable"

  • "enable"

igmps-flood-reports

string

Enable/disable flooding of IGMP reports to this interface when igmp-snooping enabled.

Choices:

  • "disable"

  • "enable"

igmps-flood-traffic

string

Enable/disable flooding of IGMP snooping traffic to this interface.

Choices:

  • "disable"

  • "enable"

interface-tags

string

description

ip-source-guard

string

Enable/disable IP source guard.

Choices:

  • "disable"

  • "enable"

isl-peer-device-sn

string

no description

lacp-speed

string

end Link Aggregation Control Protocol

Choices:

  • "slow"

  • "fast"

learning-limit

integer

Limit the number of dynamic MAC addresses on this Port

string

no description

Choices:

  • "down"

  • "up"

lldp-profile

string

LLDP port TLV profile.

lldp-status

string

LLDP transmit and receive status.

Choices:

  • "disable"

  • "rx-only"

  • "tx-only"

  • "tx-rx"

loop-guard

string

Enable/disable loop-guard on this interface, an STP optimization used to prevent network loops.

Choices:

  • "disabled"

  • "enabled"

loop-guard-timeout

integer

Loop-guard timeout

mac-addr

string

Port/Trunk MAC.

matched-dpp-intf-tags

string

Matched interface tags in the dynamic port policy.

matched-dpp-policy

string

Matched child policy in the dynamic port policy.

max-bundle

integer

Maximum size of LAG bundle

max-miss-heartbeats

integer

Maximum tolerant missed heartbeats.

mcast-snooping-flood-traffic

string

Enable/disable flooding of IGMP snooping traffic to this interface.

Choices:

  • "disable"

  • "enable"

mclag

string

Enable/disable multi-chassis link aggregation

Choices:

  • "disable"

  • "enable"

mclag-icl-port

integer

Mclag-Icl-Port.

media-type

string

Media-Type.

member-withdrawal-behavior

string

Port behavior after it withdraws because of loss of control packets.

Choices:

  • "forward"

  • "block"

members

string

Aggregated LAG bundle interfaces.

min-bundle

integer

Minimum size of LAG bundle

mode

string

LACP mode

Choices:

  • "static"

  • "lacp-passive"

  • "lacp-active"

p2p-port

integer

P2P-Port.

packet-sample-rate

integer

Packet sampling rate

packet-sampler

string

Enable/disable packet sampling on this interface.

Choices:

  • "disabled"

  • "enabled"

pause-meter

integer

Configure ingress pause metering rate, in kbps

pause-meter-resume

string

Resume threshold for resuming traffic on ingress port.

Choices:

  • "25%"

  • "50%"

  • "75%"

poe-max-power

string

no description

poe-mode-bt-cabable

integer

PoE mode IEEE 802.

poe-port-mode

string

Configure PoE port mode.

Choices:

  • "ieee802-3af"

  • "ieee802-3at"

  • "ieee802-3bt"

poe-port-power

string

Configure PoE port power.

Choices:

  • "normal"

  • "perpetual"

  • "perpetual-fast"

poe-port-priority

string

Configure PoE port priority.

Choices:

  • "critical-priority"

  • "high-priority"

  • "low-priority"

  • "medium-priority"

poe-pre-standard-detection

string

Enable/disable PoE pre-standard detection.

Choices:

  • "disable"

  • "enable"

poe-standard

string

no description

poe-status

string

Enable/disable PoE status.

Choices:

  • "disable"

  • "enable"

port-name

string

Switch port name.

port-owner

string

Switch port name.

port-policy

string

Switch controller dynamic port policy from available options.

port-security-policy

string

Switch controller authentication policy to apply to this managed switch from available options.

port-selection-criteria

string

Algorithm for aggregate port selection.

Choices:

  • "src-mac"

  • "dst-mac"

  • "src-dst-mac"

  • "src-ip"

  • "dst-ip"

  • "src-dst-ip"

qos-policy

string

Switch controller QoS policy from available options.

rpvst-port

string

Enable/disable inter-operability with rapid PVST on this interface.

Choices:

  • "disabled"

  • "enabled"

sample-direction

string

sFlow sample direction.

Choices:

  • "rx"

  • "tx"

  • "both"

sflow-counter-interval

integer

sFlow sampler counter polling interval

sflow-sample-rate

integer

sFlow sampler sample rate

sflow-sampler

string

Enable/disable sFlow protocol on this interface.

Choices:

  • "disabled"

  • "enabled"

status

string

Switch port admin status

Choices:

  • "down"

  • "up"

sticky-mac

string

Enable or disable sticky-mac on the interface.

Choices:

  • "disable"

  • "enable"

storm-control-policy

string

Switch controller storm control policy from available options.

stp-bpdu-guard

string

Enable/disable STP BPDU guard on this interface.

Choices:

  • "disabled"

  • "enabled"

stp-bpdu-guard-timeout

integer

BPDU Guard disabling protection

stp-root-guard

string

Enable/disable STP root guard on this interface.

Choices:

  • "disabled"

  • "enabled"

stp-state

string

Enable/disable Spanning Tree Protocol

Choices:

  • "disabled"

  • "enabled"

trunk-member

integer

Trunk member.

type

string

Interface type

Choices:

  • "physical"

  • "trunk"

untagged-vlans

string

Configure switch port untagged vlans

vlan

string

Assign switch ports to a VLAN.

qos-drop-policy

string

Set QoS drop-policy.

Choices:

  • "taildrop"

  • "random-early-detection"

qos-red-probability

integer

Set QoS RED/WRED drop probability.

remote-log

list / elements=dictionary

description

csv

string

Enable/disable comma-separated value

Choices:

  • "disable"

  • "enable"

facility

string

Facility to log to remote syslog server.

Choices:

  • "kernel"

  • "user"

  • "mail"

  • "daemon"

  • "auth"

  • "syslog"

  • "lpr"

  • "news"

  • "uucp"

  • "cron"

  • "authpriv"

  • "ftp"

  • "ntp"

  • "audit"

  • "alert"

  • "clock"

  • "local0"

  • "local1"

  • "local2"

  • "local3"

  • "local4"

  • "local5"

  • "local6"

  • "local7"

name

string

Remote log name.

port

integer

Remote syslog server listening port.

server

string

IPv4 address of the remote syslog server.

severity

string

Severity of logs to be transferred to remote log server.

Choices:

  • "emergency"

  • "alert"

  • "critical"

  • "error"

  • "warning"

  • "notification"

  • "information"

  • "debug"

status

string

Enable/disable logging by FortiSwitch device to a remote syslog server.

Choices:

  • "disable"

  • "enable"

snmp-community

list / elements=dictionary

description

events

list / elements=string

description

Choices:

  • "cpu-high"

  • "mem-low"

  • "log-full"

  • "intf-ip"

  • "ent-conf-change"

hosts

list / elements=dictionary

description

id

integer

Host entry ID.

ip

string

IPv4 address of the SNMP manager

id

integer

SNMP community ID.

name

string

SNMP community name.

query-v1-port

integer

SNMP v1 query port

query-v1-status

string

Enable/disable SNMP v1 queries.

Choices:

  • "disable"

  • "enable"

query-v2c-port

integer

SNMP v2c query port

query-v2c-status

string

Enable/disable SNMP v2c queries.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable this SNMP community.

Choices:

  • "disable"

  • "enable"

trap-v1-lport

integer

SNMP v2c trap local port

trap-v1-rport

integer

SNMP v2c trap remote port

trap-v1-status

string

Enable/disable SNMP v1 traps.

Choices:

  • "disable"

  • "enable"

trap-v2c-lport

integer

SNMP v2c trap local port

trap-v2c-rport

integer

SNMP v2c trap remote port

trap-v2c-status

string

Enable/disable SNMP v2c traps.

Choices:

  • "disable"

  • "enable"

snmp-user

list / elements=dictionary

description

auth-proto

string

Authentication protocol.

Choices:

  • "md5"

  • "sha"

auth-pwd

string

description

name

string

SNMP user name.

priv-proto

string

Privacy

Choices:

  • "des"

  • "aes"

priv-pwd

string

description

queries

string

Enable/disable SNMP queries for this user.

Choices:

  • "disable"

  • "enable"

query-port

integer

SNMPv3 query port

security-level

string

Security level for message authentication and encryption.

Choices:

  • "no-auth-no-priv"

  • "auth-no-priv"

  • "auth-priv"

switch-dhcp_opt43_key

string

DHCP option43 key.

switch-id

string

Managed-switch id.

tdr-supported

string

Tdr-Supported.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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: Configure FortiSwitch devices that are managed by this FortiGate.
     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>
                 max-miss-heartbeats: <value of integer>
                 dot1x-enable: <value in [disable, enable]>
                 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>
                 igmp-snooping-flood-reports: <value in [disable, enable]>
                 mcast-snooping-flood-traffic: <value in [disable, enable]>
                 link-status: <value in [down, up]>
                 poe-mode-bt-cabable: <value of 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, ...]>
                 acl-group: <value of string>
                 dhcp-snoop-option82-override:
                   -
                       circuit-id: <value of string>
                       remote-id: <value of string>
                       vlan-name: <value of string>
                 fortiswitch-acls: <value of integer>
                 isl-peer-device-sn: <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]>
           dhcp-snooping-static-client:
             -
                 ip: <value of string>
                 mac: <value of string>
                 name: <value of string>
                 port: <value of string>
                 vlan: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)