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.8.2).
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
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:
|
|
Authenticate Ansible client with forticloud API access token. |
|
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. |
|
802 1X settings. |
|
Authentication state to set if a link is down. Choices:
|
|
Enable to override global 802. Choices:
|
|
Enable or disable MAB reauthentication settings. Choices:
|
|
MAC called station delimiter Choices:
|
|
MAC calling station delimiter Choices:
|
|
MAC case Choices:
|
|
MAC authentication password delimiter Choices:
|
|
MAC authentication username delimiter Choices:
|
|
Maximum number of authentication attempts |
|
Reauthentication time interval |
|
Platform. |
|
(list) FortiSwitch access profile. |
|
Custom command. |
|
List of FortiSwitch commands. |
|
Names of commands to be pushed to this FortiSwitch device, as configured under config switch-controller custom-com… |
|
Delayed restart triggered for this FortiSwitch. |
|
Description. |
|
DHCP snooping server access list. Choices:
|
|
Dhcp snooping static client. |
|
Client static IP address. |
|
Client MAC address. |
|
Client name. |
|
Interface name. |
|
VLAN name. |
|
Directly connected. |
|
List of features this FortiSwitch supports |
|
Dynamically discovered. |
|
Enable/disable provisioning of firmware to FortiSwitches on join connection. Choices:
|
|
Enable/disable one-time automatic provisioning of the latest firmware version. Choices:
|
|
Firmware version to provision to this FortiSwitch on bootup |
|
Flow-tracking netflow ipfix switch identity in hex format |
|
FortiSwitch WAN1 admin status; enable to authorize the FortiSwitch as a managed switch. Choices:
|
|
(list) FortiSwitch WAN1 peer port. |
|
FortiSwitch WAN2 admin status; enable to authorize the FortiSwitch as a managed switch. Choices:
|
|
FortiSwitch WAN2 peer port. |
|
Igmp snooping. |
|
Maximum time to retain a multicast snooping entry for which no packets have been seen |
|
Enable/disable unknown multicast flooding. Choices:
|
|
Enable/disable overriding the global IGMP snooping configuration. Choices:
|
|
Vlans. |
|
IGMP snooping proxy for the VLAN interface. Choices:
|
|
Enable/disable IGMP snooping querier for the VLAN interface. Choices:
|
|
IGMP snooping querier address. |
|
IGMP snooping querying version. |
|
(list) List of FortiSwitch VLANs. |
|
Ip source guard. |
|
Binding entry. |
|
Configure binding pair. |
|
Source IP for this rule. |
|
MAC address for this rule. |
|
Description. |
|
Ingress interface to which source guard is bound. |
|
L3 discovered. |
|
FortiSwitch maximum allowed trunk members. |
|
Enable/disable MCLAG IGMP-snooping awareness. Choices:
|
|
FortiLink management mode. |
|
Mirror. |
|
Destination port. |
|
Mirror name. |
|
(list) Source egress interfaces. |
|
(list) Source ingress interfaces. |
|
Active/inactive mirror configuration. Choices:
|
|
Enable/disable switching functionality when mirroring. 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:
|
|
VDOM which owner of port belongs to. |
|
Poe detection type. |
|
Enable/disable PoE LLDP detection. Choices:
|
|
Enable/disable PoE pre-standard detection. Choices:
|
|
Ports. |
|
Access mode of the port. Choices:
|
|
(list) ACL groups on this port. |
|
LACP member select mode. Choices:
|
|
Enable/Disable allow ARP monitor. Choices:
|
|
(list or str) Configure switch port tagged vlans |
|
Enable/disable all defined vlans on this port. Choices:
|
|
Trusted or untrusted dynamic ARP inspection. Choices:
|
|
Authenticated port. |
|
Enable/disable Link Aggregation Group Choices:
|
|
Description for port. |
|
Dhcp snoop option82 override. |
|
Circuit ID string. |
|
Remote ID string. |
|
DHCP snooping option 82 VLAN. |
|
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:
|
|
Dot1x enable. Choices:
|
|
DSL policy configuration. |
|
Enable/disable this interface as an edge port, bridging connections between workstations and/or computers. Choices:
|
|
Encrypted port. |
|
(list) Configure export tag |
|
(list) Export managed-switch port to a tenant VDOM. |
|
(list) Switch controller export port to pool-list. |
|
Switch controller export port to pool-list. |
|
LACP fallback port. |
|
FEC capable. |
|
State of forward error correction. Choices:
|
|
Fgt peer device name. |
|
Fgt peer port name. |
|
Fiber port. |
|
Flags. |
|
Period over which flap events are calculated |
|
Number of stage change events needed within flap-duration. |
|
Flap guard disabling protection |
|
Enable/disable flap guard. Choices:
|
|
Flow control direction. Choices:
|
|
Fortilink port. |
|
(list) ACLs on this port. |
|
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 reports to this interface when igmp-snooping enabled. Choices:
|
|
Enable/disable flooding of IGMP snooping traffic to this interface. Choices:
|
|
(list or str) Tag |
|
Enable/disable IP source guard. Choices:
|
|
Isl local trunk name. |
|
Isl peer device name. |
|
Isl peer device sn. |
|
Isl peer port name. |
|
End Link Aggregation Control Protocol Choices:
|
|
Limit the number of dynamic MAC addresses on this Port |
|
Link status. Choices:
|
|
LLDP port TLV profile. |
|
LLDP transmit and receive status. Choices:
|
|
Enable/disable logging for dynamic MAC address events. Choices:
|
|
Enable/disable loop-guard on this interface, an STP optimization used to prevent network loops. Choices:
|
|
Loop-guard timeout |
|
Port/Trunk MAC. |
|
Matched interface tags in the dynamic port policy. |
|
Matched child policy in the dynamic port policy. |
|
Maximum size of LAG bundle |
|
Maximum tolerant missed heartbeats. |
|
Enable/disable flooding of IGMP snooping traffic to this interface. Choices:
|
|
Enable/disable multi-chassis link aggregation Choices:
|
|
Mclag icl port. |
|
Media type. |
|
Port behavior after it withdraws because of loss of control packets. Choices:
|
|
(list) Aggregated LAG bundle interfaces. |
|
Minimum size of LAG bundle |
|
LACP mode Choices:
|
|
P2p port. |
|
Packet sampling rate |
|
Enable/disable packet sampling on this interface. Choices:
|
|
Configure ingress pause metering rate, in kbps |
|
Resume threshold for resuming traffic on ingress port. Choices:
|
|
Powered device capable. |
|
PoE capable. |
|
Poe max power. |
|
PoE mode IEEE 802. |
|
Configure PoE port mode. Choices:
|
|
Configure PoE port power. Choices:
|
|
Configure PoE port priority. Choices:
|
|
Enable/disable PoE pre-standard detection. Choices:
|
|
Poe standard. |
|
Enable/disable PoE status. Choices:
|
|
Switch port name. |
|
Port number. |
|
Switch port name. |
|
Switch controller dynamic port policy from available options. |
|
Port prefix type. |
|
Switch controller authentication policy to apply to this managed switch from available options. |
|
Algorithm for aggregate port selection. Choices:
|
|
(list) PTP policy configuration. |
|
Enable/disable PTP policy on this FortiSwitch port. Choices:
|
|
(list) ‘802.’ |
|
Switch controller QoS policy from available options. |
|
Restricted auth port. |
|
Enable/disable inter-operability with rapid PVST on this interface. Choices:
|
|
SFlow sample direction. Choices:
|
|
SFlow sampler counter polling interval |
|
SFlow sampler sample rate |
|
Enable/disable sFlow protocol on this interface. Choices:
|
|
Switch port speed; default and available settings depend on hardware. Choices:
|
|
Switch port speed mask. |
|
Stacking port. |
|
Switch port admin status 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 |
|
Enable/disable STP root guard on this interface. Choices:
|
|
Enable/disable Spanning Tree Protocol Choices:
|
|
Switch id. |
|
Trunk member. |
|
Interface type Choices:
|
|
(list or str) Configure switch port untagged vlans |
|
Virtualized switch port. |
|
Assign switch ports to a VLAN. |
|
Pre-provisioned managed switch. |
|
PTP profile configuration. |
|
Enable/disable PTP profile on this FortiSwitch. Choices:
|
|
Purdue Level of this FortiSwitch. Choices:
|
|
Set QoS drop-policy. Choices:
|
|
Set QoS RED/WRED drop probability. |
|
NAS-IP address. |
|
Use locally defined NAS-IP. Choices:
|
|
Remote log. |
|
Enable/disable comma-separated value 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:
|
|
Enable/disable route offload on this FortiSwitch. Choices:
|
|
Enable/disable route offload MCLAG on this FortiSwitch. Choices:
|
|
Route offload router. |
|
Router IP address. |
|
VLAN name. |
|
Managed-switch serial number. |
|
Snmp community. |
|
SNMP notifications Choices:
|
|
Hosts. |
|
Host entry ID. |
|
IPv4 address of the SNMP manager |
|
SNMP community ID. |
|
SNMP community name. |
|
SNMP v1 query port |
|
Enable/disable SNMP v1 queries. Choices:
|
|
SNMP v2c query port |
|
Enable/disable SNMP v2c queries. Choices:
|
|
Enable/disable this SNMP community. Choices:
|
|
SNMP v2c trap local port |
|
SNMP v2c trap remote port |
|
Enable/disable SNMP v1 traps. Choices:
|
|
SNMP v2c trap local port |
|
SNMP v2c trap remote port |
|
Enable/disable SNMP v2c traps. Choices:
|
|
Snmp sysinfo. |
|
Contact information. |
|
System description. |
|
Local SNMP engine ID string |
|
System location. |
|
Enable/disable SNMP. Choices:
|
|
Snmp trap threshold. |
|
CPU usage when trap is sent. |
|
Log disk usage when trap is sent. |
|
Memory usage when trap is sent. |
|
Snmp user. |
|
Authentication protocol. Choices:
|
|
(list) Password for authentication protocol. |
|
SNMP user name. |
|
Privacy Choices:
|
|
(list) Password for privacy |
|
Enable/disable SNMP queries for this user. Choices:
|
|
SNMPv3 query port |
|
Security level for message authentication and encryption. Choices:
|
|
Staged image version for FortiSwitch. |
|
Static mac. |
|
Description. |
|
ID. |
|
Interface name. |
|
MAC address. |
|
Type. Choices:
|
|
(list) Vlan. |
|
Storm control. |
|
Enable/disable storm control to drop broadcast traffic. Choices:
|
|
Enable to override global FortiSwitch storm control settings for this FortiSwitch. Choices:
|
|
Rate in packets per second at which storm control drops excess traffic |
|
Enable/disable storm control to drop unknown multicast traffic. Choices:
|
|
Enable/disable storm control to drop unknown unicast traffic. Choices:
|
|
Stp instance. |
|
Instance ID. |
|
Priority. Choices:
|
|
Stp settings. |
|
Period of time a port is in listening and learning state |
|
Period of time between successive STP frame Bridge Protocol Data Units |
|
Enable to configure local STP settings that override global STP settings. Choices:
|
|
Maximum time before a bridge port saves its configuration BPDU information |
|
Maximum number of hops between the root bridge and the furthest bridge |
|
Name of local STP settings configuration. |
|
Pending time |
|
STP revision number |
|
Enable/disable STP. Choices:
|
|
User definable label/tag. |
|
DHCP option43 key. |
|
Managed-switch id. |
|
Switch log. |
|
Enable to configure local logging settings that override global logging settings. Choices:
|
|
Severity of FortiSwitch logs that are added to the FortiGate event log. Choices:
|
|
Enable/disable adding FortiSwitch logs to the FortiGate event log. Choices:
|
|
(list) FortiSwitch profile. |
|
Tdr supported. |
|
Tunnel discovered. |
|
Indication of switch type, physical or virtual. Choices:
|
|
FortiSwitch version. |
|
Vlan. |
|
VLAN name. |
|
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: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
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.fortimanager.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: present # <value in [present, absent]>
switchcontroller_managedswitch:
_platform: <string>
description: <string>
name: <string>
ports:
-
allowed_vlans: <list or string>
allowed_vlans_all: <value in [disable, enable]>
arp_inspection_trust: <value in [untrusted, trusted]>
bundle: <value in [disable, enable]>
description: <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: <integer>
lldp_profile: <string>
lldp_status: <value in [disable, rx-only, tx-only, ...]>
loop_guard: <value in [disabled, enabled]>
loop_guard_timeout: <integer>
max_bundle: <integer>
mclag: <value in [disable, enable]>
member_withdrawal_behavior: <value in [forward, block]>
members: <list or string>
min_bundle: <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: <string>
port_owner: <string>
port_security_policy: <string>
port_selection_criteria: <value in [src-mac, dst-mac, src-dst-mac, ...]>
qos_policy: <string>
sample_direction: <value in [rx, tx, both]>
sflow_counter_interval: <integer>
sflow_sample_rate: <integer>
sflow_sampler: <value in [disabled, enabled]>
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]>
type: <value in [physical, trunk]>
untagged_vlans: <list or string>
vlan: <string>
export_to_pool_flag: <integer>
mac_addr: <string>
packet_sample_rate: <integer>
packet_sampler: <value in [disabled, enabled]>
sticky_mac: <value in [disable, enable]>
storm_control_policy: <string>
dot1x_enable: <value in [disable, enable]>
max_miss_heartbeats: <integer>
access_mode: <value in [normal, nac, dynamic, ...]>
ip_source_guard: <value in [disable, enable]>
mclag_icl_port: <integer>
p2p_port: <integer>
aggregator_mode: <value in [bandwidth, count]>
rpvst_port: <value in [disabled, enabled]>
flow_control: <value in [disable, tx, rx, ...]>
media_type: <string>
pause_meter: <integer>
pause_meter_resume: <value in [25%, 50%, 75%]>
trunk_member: <integer>
fec_capable: <integer>
fec_state: <value in [disabled, cl74, cl91, ...]>
matched_dpp_intf_tags: <string>
matched_dpp_policy: <string>
port_policy: <string>
status: <value in [down, up]>
dsl_profile: <string>
flap_duration: <integer>
flap_rate: <integer>
flap_timeout: <integer>
flapguard: <value in [disable, enable]>
interface_tags: <list or string>
poe_max_power: <string>
poe_standard: <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: <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: <list or string>
dhcp_snoop_option82_override:
-
circuit_id: <string>
remote_id: <string>
vlan_name: <string>
fortiswitch_acls: <list or integer>
isl_peer_device_sn: <string>
authenticated_port: <integer>
encrypted_port: <integer>
ptp_status: <value in [disable, enable]>
restricted_auth_port: <integer>
allow_arp_monitor: <value in [disable, enable]>
export_to: <list or string>
export_to_pool: <list or string>
fallback_port: <string>
fgt_peer_device_name: <string>
fgt_peer_port_name: <string>
fiber_port: <integer>
flags: <integer>
fortilink_port: <integer>
isl_local_trunk_name: <string>
isl_peer_device_name: <string>
isl_peer_port_name: <string>
poe_capable: <integer>
port_number: <integer>
port_prefix_type: <integer>
ptp_policy: <list or string>
speed: <value in [auto, 10full, 10half, ...]>
speed_mask: <integer>
stacking_port: <integer>
switch_id: <string>
virtual_port: <integer>
export_tags: <list or string>
log_mac_event: <value in [disable, enable]>
pd_capable: <integer>
qnq: <list or string>
switch_id: <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: <integer>
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]>
snmp_community:
-
events:
- "cpu-high"
- "mem-low"
- "log-full"
- "intf-ip"
- "ent-conf-change"
- "l2mac"
hosts:
-
id: <integer>
ip: <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_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]>
mclag_igmp_snooping_aware: <value in [disable, enable]>
ip_source_guard:
-
binding_entry:
-
entry_name: <string>
ip: <string>
mac: <string>
description: <string>
port: <string>
l3_discovered: <integer>
qos_drop_policy: <value in [taildrop, random-early-detection]>
qos_red_probability: <integer>
switch_dhcp_opt43_key: <string>
tdr_supported: <string>
custom_command:
-
command_entry: <string>
command_name: <string>
firmware_provision: <value in [disable, enable]>
firmware_provision_version: <string>
dhcp_server_access_list: <value in [disable, enable, global]>
firmware_provision_latest: <value in [disable, once]>
dhcp_snooping_static_client:
-
ip: <string>
mac: <string>
name: <string>
port: <string>
vlan: <string>
ptp_profile: <string>
ptp_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: <string>
mgmt_mode: <integer>
purdue_level: <value in [1, 2, 3, ...]>
radius_nas_ip: <string>
radius_nas_ip_override: <value in [disable, enable]>
tunnel_discovered: <integer>
vlan:
-
assignment_priority: <integer>
vlan_name: <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>
access_profile: <list or string>
delayed_restart_trigger: <integer>
directly_connected: <integer>
dynamic_capability: <string>
dynamically_discovered: <integer>
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>
max_allowed_trunk_members: <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]>
owner_vdom: <string>
poe_pre_standard_detection: <value in [disable, enable]>
pre_provisioned: <integer>
sn: <string>
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>
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]>
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_log:
local_override: <value in [disable, enable]>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
switch_profile: <list or string>
type: <value in [physical, virtual]>
version: <integer>
poe_lldp_detection: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |