:source: fmgr_switchcontroller_managedswitch_ports.py
:orphan:
.. _fmgr_switchcontroller_managedswitch_ports:
fmgr_switchcontroller_managedswitch_ports -- Managed-switch port list.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. 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: v6.0.0 -> 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- managed_switch - The parameter in requested url type: str required: true
- switchcontroller_managedswitch_ports - Managed-switch port list. type: dict
- allowed_vlans (Alias name: allowed-vlans) Configure switch port tagged vlans type: list or str
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> latest
- arp_inspection_trust (Alias name: arp-inspection-trust) Trusted or untrusted dynamic arp inspection. type: str choices: [untrusted, trusted]
more...
Supported Version Ranges: v6.0.0 -> latest
- bundle Enable/disable link aggregation group (lag) bundling for non-fortilink interfaces. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- description Description for port. type: str
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> latest
- dhcp_snooping (Alias name: dhcp-snooping) Trusted or untrusted dhcp-snooping interface. type: str choices: [trusted, untrusted]
more...
Supported Version Ranges: v6.0.0 -> latest
- discard_mode (Alias name: discard-mode) Configure discard mode for port. type: str choices: [none, all-untagged, all-tagged]
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> 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: v6.0.0 -> v7.6.2
- 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: v6.0.0 -> 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: v6.0.0 -> 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: v6.0.0 -> 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: v6.0.0 -> latest
- lldp_profile (Alias name: lldp-profile) Lldp port tlv profile. type: str
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> 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: v6.0.0 -> latest
- loop_guard_timeout (Alias name: loop-guard-timeout) Loop-guard timeout (0 - 120 min, default = 45). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- max_bundle (Alias name: max-bundle) Maximum size of lag bundle (1 - 24, default = 24) type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- mclag Enable/disable multi-chassis link aggregation (mclag). type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> latest
- members Aggregated lag bundle interfaces. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- min_bundle (Alias name: min-bundle) Minimum size of lag bundle (1 - 24, default = 1) type: int
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> 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: v6.0.0 -> latest
- poe_status (Alias name: poe-status) Enable/disable poe status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- port_name (Alias name: port-name) Switch port name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- port_owner (Alias name: port-owner) Switch port name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- port_security_policy (Alias name: port-security-policy) Switch controller authentication policy to apply to this managed switch from available options. type: str
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> latest
- qos_policy (Alias name: qos-policy) Switch controller qos policy from available options. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- sample_direction (Alias name: sample-direction) Sflow sample direction. type: str choices: [rx, tx, both]
more...
Supported Version Ranges: v6.0.0 -> latest
- sflow_counter_interval (Alias name: sflow-counter-interval) Sflow sampler counter polling interval (1 - 255 sec). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- sflow_sample_rate (Alias name: sflow-sample-rate) Sflow sampler sample rate (0 - 99999 p/sec). type: int
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- sflow_sampler (Alias name: sflow-sampler) Enable/disable sflow protocol on this interface. type: str choices: [disabled, enabled]
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- 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: v6.0.0 -> latest
- stp_bpdu_guard_timeout (Alias name: stp-bpdu-guard-timeout) Bpdu guard disabling protection (0 - 120 min). type: int
more...
Supported Version Ranges: v6.0.0 -> 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: v6.0.0 -> 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: v6.0.0 -> latest
- type Interface type: physical or trunk port. type: str choices: [physical, trunk]
more...
Supported Version Ranges: v6.0.0 -> latest
- untagged_vlans (Alias name: untagged-vlans) Configure switch port untagged vlans type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- vlan Assign switch ports to a vlan. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- export_to_pool_flag (Alias name: export-to-pool-flag) Switch controller export port to pool-list. type: int
more...
Supported Version Ranges: v6.2.1 -> v6.2.3, 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: v6.2.1 -> v6.2.1, 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: v6.2.0 -> latest
- packet_sampler (Alias name: packet-sampler) Enable/disable packet sampling on this interface. type: str choices: [disabled, enabled]
more...
Supported Version Ranges: v6.2.0 -> latest
- sticky_mac (Alias name: sticky-mac) Enable or disable sticky-mac on the interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> latest
- storm_control_policy (Alias name: storm-control-policy) Switch controller storm control policy from available options. type: str
more...
Supported Version Ranges: v6.2.0 -> v6.2.3, v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dot1x_enable (Alias name: dot1x-enable) Dot1x enable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.0 -> v6.2.13
- max_miss_heartbeats (Alias name: max-miss-heartbeats) Maximum tolerant missed heartbeats. type: int
more...
Supported Version Ranges: v6.2.0 -> v6.2.13
- access_mode (Alias name: access-mode) Access mode of the port. type: str choices: [normal, nac, dynamic, static]
more...
Supported Version Ranges: v6.4.0 -> latest
- ip_source_guard (Alias name: ip-source-guard) Enable/disable ip source guard. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.0 -> latest
- mclag_icl_port (Alias name: mclag-icl-port) Mclag icl port. type: int
more...
Supported Version Ranges: v6.4.0 -> latest
- p2p_port (Alias name: p2p-port) P2p port. type: int
more...
Supported Version Ranges: v6.4.0 -> latest
- aggregator_mode (Alias name: aggregator-mode) Lacp member select mode. type: str choices: [bandwidth, count]
more...
Supported Version Ranges: v6.4.2 -> 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: v6.4.2 -> latest
- flow_control (Alias name: flow-control) Flow control direction. type: str choices: [disable, tx, rx, both]
more...
Supported Version Ranges: v6.4.3 -> latest
- media_type (Alias name: media-type) Media type. type: str
more...
Supported Version Ranges: v6.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: v6.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: v6.4.3 -> latest
- trunk_member (Alias name: trunk-member) Trunk member. type: int
more...
Supported Version Ranges: v6.2.7 -> v6.2.13, v6.4.3 -> latest
- fec_capable (Alias name: fec-capable) Fec capable. type: int
more...
Supported Version Ranges: v7.0.0 -> 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.0.0 -> 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.0.0 -> latest
- matched_dpp_policy (Alias name: matched-dpp-policy) Matched child policy in the dynamic port policy. type: str
more...
Supported Version Ranges: v7.0.0 -> latest
- port_policy (Alias name: port-policy) Switch controller dynamic port policy from available options. type: str
more...
Supported Version Ranges: v7.0.0 -> v7.0.4, v7.2.0 -> latest
- status Switch port admin status: up or down. type: str choices: [down, up]
more...
Supported Version Ranges: v6.4.6 -> latest
- dsl_profile (Alias name: dsl-profile) Dsl policy configuration. type: str
more...
Supported Version Ranges: v7.0.2 -> latest
- flap_duration (Alias name: flap-duration) Period over which flap events are calculated (seconds). type: int
more...
Supported Version Ranges: v7.2.0 -> latest
- flap_rate (Alias name: flap-rate) Number of stage change events needed within flap-duration. type: int
more...
Supported Version Ranges: v7.2.0 -> latest
- flap_timeout (Alias name: flap-timeout) Flap guard disabling protection (min). type: int
more...
Supported Version Ranges: v7.2.0 -> latest
- flapguard Enable/disable flap guard. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.0 -> 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 or str
more...
Supported Version Ranges: v7.0.2 -> latest
- poe_max_power (Alias name: poe-max-power) Poe max power. type: str
more...
Supported Version Ranges: v7.0.1 -> latest
- poe_standard (Alias name: poe-standard) Poe standard. type: str
more...
Supported Version Ranges: v7.0.1 -> 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.1 -> 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.1 -> latest
- link_status (Alias name: link-status) Link status. type: str choices: [down, up]
more...
Supported Version Ranges: v7.2.2 -> latest
- poe_mode_bt_cabable (Alias name: poe-mode-bt-cabable) Poe mode ieee 802. type: int
more...
Supported Version Ranges: v7.2.2 -> 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.2 -> 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.2 -> 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.2 -> latest
- acl_group (Alias name: acl-group) Acl groups on this port. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- dhcp_snoop_option82_override (Alias name: dhcp-snoop-option82-override) Dhcp snoop option82 override. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- circuit_id (Alias name: circuit-id) Circuit id string. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- remote_id (Alias name: remote-id) Remote id string. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- vlan_name (Alias name: vlan-name) Dhcp snooping option 82 vlan. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- fortiswitch_acls (Alias name: fortiswitch-acls) Acls on this port. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- isl_peer_device_sn (Alias name: isl-peer-device-sn) Isl peer device sn. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- authenticated_port (Alias name: authenticated-port) Authenticated port. type: int
more...
Supported Version Ranges: v7.4.1 -> latest
- encrypted_port (Alias name: encrypted-port) Encrypted port. type: int
more...
Supported Version Ranges: v7.4.1 -> 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.1 -> latest
- restricted_auth_port (Alias name: restricted-auth-port) Restricted auth port. type: int
more...
Supported Version Ranges: v7.4.1 -> 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
- 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
- fallback_port (Alias name: fallback-port) Lacp fallback port. type: str
more...
Supported Version Ranges: 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
- fortilink_port (Alias name: fortilink-port) Fortilink port. type: int
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_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
- poe_capable (Alias name: poe-capable) Poe capable. type: int
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_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
- 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
- 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
- switch_id (Alias name: switch-id) Switch id. type: str
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
- 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
- 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
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
tasks:
- name: Managed-switch port list.
fortinet.fortimanager.fmgr_switchcontroller_managedswitch_ports:
# workspace_locking_adom:
adom:
managed_switch:
state: present #
switchcontroller_managedswitch_ports:
port_name: "your value" # Required variable, string
# allowed_vlans:
# allowed_vlans_all:
# arp_inspection_trust:
# bundle:
# description:
# dhcp_snoop_option82_trust:
# dhcp_snooping:
# discard_mode:
# edge_port:
# igmp_snooping:
# igmps_flood_reports:
# igmps_flood_traffic:
# lacp_speed:
# learning_limit:
# lldp_profile:
# lldp_status:
# loop_guard:
# loop_guard_timeout:
# max_bundle:
# mclag:
# member_withdrawal_behavior:
# members:
# min_bundle:
# mode:
# poe_pre_standard_detection:
# poe_status:
# port_owner:
# port_security_policy:
# port_selection_criteria:
# qos_policy:
# sample_direction:
# sflow_counter_interval:
# sflow_sample_rate:
# sflow_sampler:
# stp_bpdu_guard:
# stp_bpdu_guard_timeout:
# stp_root_guard:
# stp_state:
# type:
# untagged_vlans:
# vlan:
# export_to_pool_flag:
# mac_addr:
# packet_sample_rate:
# packet_sampler:
# sticky_mac:
# storm_control_policy:
# dot1x_enable:
# max_miss_heartbeats:
# access_mode:
# ip_source_guard:
# mclag_icl_port:
# p2p_port:
# aggregator_mode:
# rpvst_port:
# flow_control:
# media_type:
# pause_meter:
# pause_meter_resume:
# trunk_member:
# fec_capable:
# fec_state:
# matched_dpp_intf_tags:
# matched_dpp_policy:
# port_policy:
# status:
# dsl_profile:
# flap_duration:
# flap_rate:
# flap_timeout:
# flapguard:
# interface_tags:
# poe_max_power:
# poe_standard:
# igmp_snooping_flood_reports:
# mcast_snooping_flood_traffic:
# link_status:
# poe_mode_bt_cabable:
# poe_port_mode:
# poe_port_power:
# poe_port_priority:
# acl_group:
# dhcp_snoop_option82_override:
# - circuit_id:
# remote_id:
# vlan_name:
# fortiswitch_acls:
# isl_peer_device_sn:
# authenticated_port:
# encrypted_port:
# ptp_status:
# restricted_auth_port:
# allow_arp_monitor:
# export_to:
# export_to_pool:
# fallback_port:
# fgt_peer_device_name:
# fgt_peer_port_name:
# fiber_port:
# flags:
# fortilink_port:
# isl_local_trunk_name:
# isl_peer_device_name:
# isl_peer_port_name:
# poe_capable:
# port_number:
# port_prefix_type:
# ptp_policy:
# speed:
# speed_mask:
# stacking_port:
# switch_id:
# virtual_port:
# export_tags:
# log_mac_event:
# pd_capable:
# qnq:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)