fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_switchcontroller_fortilinksettings Configure integrated FortiLink settings for FortiSwitch. | "added in version" 2.2.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 communityfortinet.fortimanager.fmgr_switchcontroller_fortilinksettings (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure integrated FortiLink settings for FortiSwitch. fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings: # bypass_validation: false workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] adom: <your own value> state: present # <value in [present, absent]> switchcontroller_fortilinksettings: fortilink: <string> inactive_timer: <integer> link_down_flush: <value in [disable, enable]> nac_ports: lan_segment: <value in [disabled, enabled]> member_change: <integer> nac_lan_interface: <string> nac_segment_vlans: <list or string> onboarding_vlan: <string> parent_key: <string> bounce_nac_port: <value in [disable, enable]> name: <string> access_vlan_mode: <value in [legacy, fail-open, fail-close]>
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 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_fortilinksettings: description: The top level parameters set. required: false suboptions: access-vlan-mode: choices: - legacy - fail-open - fail-close description: Deprecated, please rename it to access_vlan_mode. Intra VLAN traffic behavior with loss of connection to the FortiGate. type: str fortilink: description: FortiLink interface to which this fortilink-setting belongs. type: str inactive-timer: description: Deprecated, please rename it to inactive_timer. Time interval type: int link-down-flush: choices: - disable - enable description: Deprecated, please rename it to link_down_flush. Clear NAC and dynamic devices on switch ports on link down event. type: str nac-ports: description: Deprecated, please rename it to nac_ports. suboptions: bounce-nac-port: choices: - disable - enable description: Deprecated, please rename it to bounce_nac_port. Enable/disable bouncing type: str lan-segment: choices: - disabled - enabled description: Deprecated, please rename it to lan_segment. Enable/disable LAN segment feature on the FortiLink interface. type: str member-change: description: Deprecated, please rename it to member_change. type: int nac-lan-interface: description: Deprecated, please rename it to nac_lan_interface. Configure NAC LAN interface. type: str nac-segment-vlans: description: (list) Deprecated, please rename it to nac_segment_vlans. type: raw onboarding-vlan: description: Deprecated, please rename it to onboarding_vlan. Default NAC Onboarding VLAN when NAC devices are discovered. type: str parent-key: description: Deprecated, please rename it to parent_key. type: str type: dict name: description: FortiLink settings name. required: true 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