Try SpotterManaged-switch port list.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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: Managed-switch port list.
fortinet.fortimanager.fmgr_switchcontroller_managedswitch_ports:
# 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>
managed_switch: <your own value>
state: present # <value in [present, absent]>
switchcontroller_managedswitch_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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
managed-switch:
description: Deprecated, please use "managed_switch"
type: str
managed_switch:
description: The parameter (managed-switch) in requested url.
type: str
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
switchcontroller_managedswitch_ports:
description: The top level parameters set.
required: false
suboptions:
access-mode:
choices:
- normal
- nac
- dynamic
- static
description: Deprecated, please rename it to access_mode. Access mode of the port.
type: str
acl-group:
description: (list) Deprecated, please rename it to acl_group.
type: raw
aggregator-mode:
choices:
- bandwidth
- count
description: Deprecated, please rename it to aggregator_mode. LACP member select
mode.
type: str
allowed-vlans:
description: (list or str) Deprecated, please rename it to allowed_vlans. Configure
switch port tagged vlans
type: raw
allowed-vlans-all:
choices:
- disable
- enable
description: Deprecated, please rename it to allowed_vlans_all. Enable/disable
all defined vlans on this port.
type: str
arp-inspection-trust:
choices:
- untrusted
- trusted
description: Deprecated, please rename it to arp_inspection_trust. Trusted or
untrusted dynamic ARP inspection.
type: str
authenticated-port:
description: Deprecated, please rename it to authenticated_port.
type: int
bundle:
choices:
- disable
- enable
description: Enable/disable Link Aggregation Group
type: str
description:
description: Description for port.
type: str
dhcp-snoop-option82-override:
description: Deprecated, please rename it to dhcp_snoop_option82_override.
elements: dict
suboptions:
circuit-id:
description: Deprecated, please rename it to circuit_id. Circuit ID string.
type: str
remote-id:
description: Deprecated, please rename it to remote_id. Remote ID string.
type: str
vlan-name:
description: Deprecated, please rename it to vlan_name. DHCP snooping option
82 VLAN.
type: str
type: list
dhcp-snoop-option82-trust:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_snoop_option82_trust. Enable/disable
allowance of DHCP with option-82 on untrusted in...
type: str
dhcp-snooping:
choices:
- trusted
- untrusted
description: Deprecated, please rename it to dhcp_snooping. Trusted or untrusted
DHCP-snooping interface.
type: str
discard-mode:
choices:
- none
- all-untagged
- all-tagged
description: Deprecated, please rename it to discard_mode. Configure discard mode
for port.
type: str
dot1x-enable:
choices:
- disable
- enable
description: Deprecated, please rename it to dot1x_enable.
type: str
dsl-profile:
description: Deprecated, please rename it to dsl_profile. DSL policy configuration.
type: str
edge-port:
choices:
- disable
- enable
description: Deprecated, please rename it to edge_port. Enable/disable this interface
as an edge port, bridging connections between wor...
type: str
encrypted-port:
description: Deprecated, please rename it to encrypted_port.
type: int
export-to-pool-flag:
description: Deprecated, please rename it to export_to_pool_flag. Switch controller
export port to pool-list.
type: int
fec-capable:
description: Deprecated, please rename it to fec_capable. FEC capable.
type: int
fec-state:
choices:
- disabled
- cl74
- cl91
- detect-by-module
description: Deprecated, please rename it to fec_state. State of forward error
correction.
type: str
flap-duration:
description: Deprecated, please rename it to flap_duration. Period over which
flap events are calculated
type: int
flap-rate:
description: Deprecated, please rename it to flap_rate. Number of stage change
events needed within flap-duration.
type: int
flap-timeout:
description: Deprecated, please rename it to flap_timeout. Flap guard disabling
protection
type: int
flapguard:
choices:
- disable
- enable
description: Enable/disable flap guard.
type: str
flow-control:
choices:
- disable
- tx
- rx
- both
description: Deprecated, please rename it to flow_control. Flow control direction.
type: str
fortiswitch-acls:
description: (list) Deprecated, please rename it to fortiswitch_acls.
type: raw
igmp-snooping:
choices:
- disable
- enable
description: Deprecated, please rename it to igmp_snooping. Set IGMP snooping
mode for the physical port interface.
type: str
igmp-snooping-flood-reports:
choices:
- disable
- enable
description: Deprecated, please rename it to igmp_snooping_flood_reports. Enable/disable
flooding of IGMP reports to this interface whe...
type: str
igmps-flood-reports:
choices:
- disable
- enable
description: Deprecated, please rename it to igmps_flood_reports. Enable/disable
flooding of IGMP reports to this interface when igmp-s...
type: str
igmps-flood-traffic:
choices:
- disable
- enable
description: Deprecated, please rename it to igmps_flood_traffic. Enable/disable
flooding of IGMP snooping traffic to this interface.
type: str
interface-tags:
description: (list or str) Deprecated, please rename it to interface_tags.
type: raw
ip-source-guard:
choices:
- disable
- enable
description: Deprecated, please rename it to ip_source_guard. Enable/disable IP
source guard.
type: str
isl-peer-device-sn:
description: Deprecated, please rename it to isl_peer_device_sn.
type: str
lacp-speed:
choices:
- slow
- fast
description: Deprecated, please rename it to lacp_speed. End Link Aggregation
Control Protocol
type: str
learning-limit:
description: Deprecated, please rename it to learning_limit. Limit the number
of dynamic MAC addresses on this Port
type: int
link-status:
choices:
- down
- up
description: Deprecated, please rename it to link_status.
type: str
lldp-profile:
description: Deprecated, please rename it to lldp_profile. LLDP port TLV profile.
type: str
lldp-status:
choices:
- disable
- rx-only
- tx-only
- tx-rx
description: Deprecated, please rename it to lldp_status. LLDP transmit and receive
status.
type: str
loop-guard:
choices:
- disabled
- enabled
description: Deprecated, please rename it to loop_guard. Enable/disable loop-guard
on this interface, an STP optimization used to preve...
type: str
loop-guard-timeout:
description: Deprecated, please rename it to loop_guard_timeout. Loop-guard timeout
type: int
mac-addr:
description: Deprecated, please rename it to mac_addr. Port/Trunk MAC.
type: str
matched-dpp-intf-tags:
description: Deprecated, please rename it to matched_dpp_intf_tags. Matched interface
tags in the dynamic port policy.
type: str
matched-dpp-policy:
description: Deprecated, please rename it to matched_dpp_policy. Matched child
policy in the dynamic port policy.
type: str
max-bundle:
description: Deprecated, please rename it to max_bundle. Maximum size of LAG bundle
type: int
max-miss-heartbeats:
description: Deprecated, please rename it to max_miss_heartbeats. Maximum tolerant
missed heartbeats.
type: int
mcast-snooping-flood-traffic:
choices:
- disable
- enable
description: Deprecated, please rename it to mcast_snooping_flood_traffic. Enable/disable
flooding of IGMP snooping traffic to this int...
type: str
mclag:
choices:
- disable
- enable
description: Enable/disable multi-chassis link aggregation
type: str
mclag-icl-port:
description: Deprecated, please rename it to mclag_icl_port.
type: int
media-type:
description: Deprecated, please rename it to media_type.
type: str
member-withdrawal-behavior:
choices:
- forward
- block
description: Deprecated, please rename it to member_withdrawal_behavior. Port
behavior after it withdraws because of loss of control pa...
type: str
members:
description: (list) No description.
type: raw
min-bundle:
description: Deprecated, please rename it to min_bundle. Minimum size of LAG bundle
type: int
mode:
choices:
- static
- lacp-passive
- lacp-active
description: LACP mode
type: str
p2p-port:
description: Deprecated, please rename it to p2p_port.
type: int
packet-sample-rate:
description: Deprecated, please rename it to packet_sample_rate. Packet sampling
rate
type: int
packet-sampler:
choices:
- disabled
- enabled
description: Deprecated, please rename it to packet_sampler. Enable/disable packet
sampling on this interface.
type: str
pause-meter:
description: Deprecated, please rename it to pause_meter. Configure ingress pause
metering rate, in kbps
type: int
pause-meter-resume:
choices:
- 25%
- 50%
- 75%
description: Deprecated, please rename it to pause_meter_resume. Resume threshold
for resuming traffic on ingress port.
type: str
poe-max-power:
description: Deprecated, please rename it to poe_max_power.
type: str
poe-mode-bt-cabable:
description: Deprecated, please rename it to poe_mode_bt_cabable. PoE mode IEEE
802.
type: int
poe-port-mode:
choices:
- ieee802-3af
- ieee802-3at
- ieee802-3bt
description: Deprecated, please rename it to poe_port_mode. Configure PoE port
mode.
type: str
poe-port-power:
choices:
- normal
- perpetual
- perpetual-fast
description: Deprecated, please rename it to poe_port_power. Configure PoE port
power.
type: str
poe-port-priority:
choices:
- critical-priority
- high-priority
- low-priority
- medium-priority
description: Deprecated, please rename it to poe_port_priority. Configure PoE
port priority.
type: str
poe-pre-standard-detection:
choices:
- disable
- enable
description: Deprecated, please rename it to poe_pre_standard_detection. Enable/disable
PoE pre-standard detection.
type: str
poe-standard:
description: Deprecated, please rename it to poe_standard.
type: str
poe-status:
choices:
- disable
- enable
description: Deprecated, please rename it to poe_status. Enable/disable PoE status.
type: str
port-name:
description: Deprecated, please rename it to port_name. Switch port name.
required: true
type: str
port-owner:
description: Deprecated, please rename it to port_owner. Switch port name.
type: str
port-policy:
description: Deprecated, please rename it to port_policy. Switch controller dynamic
port policy from available options.
type: str
port-security-policy:
description: Deprecated, please rename it to port_security_policy. Switch controller
authentication policy to apply to this managed swi...
type: str
port-selection-criteria:
choices:
- src-mac
- dst-mac
- src-dst-mac
- src-ip
- dst-ip
- src-dst-ip
description: Deprecated, please rename it to port_selection_criteria. Algorithm
for aggregate port selection.
type: str
ptp-status:
choices:
- disable
- enable
description: Deprecated, please rename it to ptp_status. Enable/disable PTP policy
on this FortiSwitch port.
type: str
qos-policy:
description: Deprecated, please rename it to qos_policy. Switch controller QoS
policy from available options.
type: str
restricted-auth-port:
description: Deprecated, please rename it to restricted_auth_port.
type: int
rpvst-port:
choices:
- disabled
- enabled
description: Deprecated, please rename it to rpvst_port. Enable/disable inter-operability
with rapid PVST on this interface.
type: str
sample-direction:
choices:
- rx
- tx
- both
description: Deprecated, please rename it to sample_direction. SFlow sample direction.
type: str
sflow-counter-interval:
description: Deprecated, please rename it to sflow_counter_interval. SFlow sampler
counter polling interval
type: int
sflow-sample-rate:
description: Deprecated, please rename it to sflow_sample_rate. SFlow sampler
sample rate
type: int
sflow-sampler:
choices:
- disabled
- enabled
description: Deprecated, please rename it to sflow_sampler. Enable/disable sFlow
protocol on this interface.
type: str
status:
choices:
- down
- up
description: Switch port admin status
type: str
sticky-mac:
choices:
- disable
- enable
description: Deprecated, please rename it to sticky_mac. Enable or disable sticky-mac
on the interface.
type: str
storm-control-policy:
description: Deprecated, please rename it to storm_control_policy. Switch controller
storm control policy from available options.
type: str
stp-bpdu-guard:
choices:
- disabled
- enabled
description: Deprecated, please rename it to stp_bpdu_guard. Enable/disable STP
BPDU guard on this interface.
type: str
stp-bpdu-guard-timeout:
description: Deprecated, please rename it to stp_bpdu_guard_timeout. BPDU Guard
disabling protection
type: int
stp-root-guard:
choices:
- disabled
- enabled
description: Deprecated, please rename it to stp_root_guard. Enable/disable STP
root guard on this interface.
type: str
stp-state:
choices:
- disabled
- enabled
description: Deprecated, please rename it to stp_state. Enable/disable Spanning
Tree Protocol
type: str
trunk-member:
description: Deprecated, please rename it to trunk_member. Trunk member.
type: int
type:
choices:
- physical
- trunk
description: Interface type
type: str
untagged-vlans:
description: (list or str) Deprecated, please rename it to untagged_vlans. Configure
switch port untagged vlans
type: raw
vlan:
description: Assign switch ports to a VLAN.
type: str
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list