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.1.5).
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 version 2.10: of fortinet.fortimanager
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 |
|---|---|
the parameter (adom) in requested url |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
Enable/Disable logging for task Choices:
|
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the top level parameters set |
|
_Platform. |
|
Custom-Command. |
|
List of FortiSwitch commands. |
|
Names of commands to be pushed to this FortiSwitch device, as configured under config switch-controller custom-command. |
|
Description. |
|
Enable/disable provisioning of firmware to FortiSwitches on join connection. Choices:
|
|
Firmware version to provision to this FortiSwitch on bootup (major.minor.build, i.e. 6.2.1234). |
|
no description |
|
no description |
|
Configure binding pair. |
|
Source IP for this rule. |
|
MAC address for this rule. |
|
Description. |
|
Ingress interface to which source guard is bound. |
|
L3-Discovered. |
|
Enable/disable MCLAG IGMP-snooping awareness. Choices:
|
|
Managed-switch name. |
|
Enable/disable overriding the global SNMP communities. Choices:
|
|
Enable/disable overriding the global SNMP system information. Choices:
|
|
Enable/disable overriding the global SNMP trap threshold values. Choices:
|
|
Enable/disable overriding the global SNMP users. Choices:
|
|
Poe-Detection-Type. |
|
Ports. |
|
Access mode of the port. Choices:
|
|
LACP member select mode. Choices:
|
|
Configure switch port tagged vlans |
|
Enable/disable all defined vlans on this port. Choices:
|
|
Trusted or untrusted dynamic ARP inspection. Choices:
|
|
Enable/disable Link Aggregation Group (LAG) bundling for non-FortiLink interfaces. Choices:
|
|
Description for port. |
|
Enable/disable allowance of DHCP with option-82 on untrusted interface. Choices:
|
|
Trusted or untrusted DHCP-snooping interface. Choices:
|
|
Configure discard mode for port. Choices:
|
|
Enable/disable this interface as an edge port, bridging connections between workstations and/or computers. Choices:
|
|
Switch controller export port to pool-list. |
|
FEC capable. |
|
State of forward error correction. Choices:
|
|
Flow control direction. Choices:
|
|
Set IGMP snooping mode for the physical port interface. Choices:
|
|
Enable/disable flooding of IGMP reports to this interface when igmp-snooping enabled. Choices:
|
|
Enable/disable flooding of IGMP snooping traffic to this interface. Choices:
|
|
Enable/disable IP source guard. Choices:
|
|
end Link Aggregation Control Protocol (LACP) messages every 30 seconds (slow) or every second (fast). Choices:
|
|
Limit the number of dynamic MAC addresses on this Port (1 - 128, 0 = no limit, default). |
|
LLDP port TLV profile. |
|
LLDP transmit and receive status. Choices:
|
|
Enable/disable loop-guard on this interface, an STP optimization used to prevent network loops. Choices:
|
|
Loop-guard timeout (0 - 120 min, default = 45). |
|
Port/Trunk MAC. |
|
Matched interface tags in the dynamic port policy. |
|
Matched child policy in the dynamic port policy. |
|
Maximum size of LAG bundle (1 - 24, default = 24) |
|
Enable/disable multi-chassis link aggregation (MCLAG). Choices:
|
|
Mclag-Icl-Port. |
|
Media-Type. |
|
Port behavior after it withdraws because of loss of control packets. Choices:
|
|
Aggregated LAG bundle interfaces. |
|
Minimum size of LAG bundle (1 - 24, default = 1) |
|
LACP mode: ignore and do not send control messages, or negotiate 802.3ad aggregation passively or actively. Choices:
|
|
P2P-Port. |
|
Packet sampling rate (0 - 99999 p/sec). |
|
Enable/disable packet sampling on this interface. Choices:
|
|
Configure ingress pause metering rate, in kbps (default = 0, disabled). |
|
Resume threshold for resuming traffic on ingress port. Choices:
|
|
Enable/disable PoE pre-standard detection. Choices:
|
|
Enable/disable PoE status. Choices:
|
|
Switch port name. |
|
Switch port name. |
|
Switch controller dynamic port policy from available options. |
|
Switch controller authentication policy to apply to this managed switch from available options. |
|
Algorithm for aggregate port selection. Choices:
|
|
Switch controller QoS policy from available options. |
|
Enable/disable inter-operability with rapid PVST on this interface. Choices:
|
|
sFlow sample direction. Choices:
|
|
sFlow sampler counter polling interval (1 - 255 sec). |
|
sFlow sampler sample rate (0 - 99999 p/sec). |
|
Enable/disable sFlow protocol on this interface. Choices:
|
|
Switch port admin status: up or down. Choices:
|
|
Enable or disable sticky-mac on the interface. Choices:
|
|
Switch controller storm control policy from available options. |
|
Enable/disable STP BPDU guard on this interface. Choices:
|
|
BPDU Guard disabling protection (0 - 120 min). |
|
Enable/disable STP root guard on this interface. Choices:
|
|
Enable/disable Spanning Tree Protocol (STP) on this interface. Choices:
|
|
Trunk member. |
|
Interface type: physical or trunk port. Choices:
|
|
Configure switch port untagged vlans |
|
Assign switch ports to a VLAN. |
|
Set QoS drop-policy. Choices:
|
|
Set QoS RED/WRED drop probability. |
|
no description |
|
Enable/disable comma-separated value (CSV) strings. Choices:
|
|
Facility to log to remote syslog server. Choices:
|
|
Remote log name. |
|
Remote syslog server listening port. |
|
IPv4 address of the remote syslog server. |
|
Severity of logs to be transferred to remote log server. Choices:
|
|
Enable/disable logging by FortiSwitch device to a remote syslog server. Choices:
|
|
no description |
|
no description Choices:
|
|
no description |
|
Host entry ID. |
|
IPv4 address of the SNMP manager (host). |
|
SNMP community ID. |
|
SNMP community name. |
|
SNMP v1 query port (default = 161). |
|
Enable/disable SNMP v1 queries. Choices:
|
|
SNMP v2c query port (default = 161). |
|
Enable/disable SNMP v2c queries. Choices:
|
|
Enable/disable this SNMP community. Choices:
|
|
SNMP v2c trap local port (default = 162). |
|
SNMP v2c trap remote port (default = 162). |
|
Enable/disable SNMP v1 traps. Choices:
|
|
SNMP v2c trap local port (default = 162). |
|
SNMP v2c trap remote port (default = 162). |
|
Enable/disable SNMP v2c traps. Choices:
|
|
no description |
|
Authentication protocol. Choices:
|
|
no description |
|
SNMP user name. |
|
Privacy (encryption) protocol. Choices:
|
|
no description |
|
Enable/disable SNMP queries for this user. Choices:
|
|
SNMPv3 query port (default = 161). |
|
Security level for message authentication and encryption. Choices:
|
|
DHCP option43 key. |
|
Managed-switch id. |
|
Tdr-Supported. |
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
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>
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]>
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>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)