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