drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_switchcontroller_fortilinksettings Configure integrated FortiLink settings for FortiSwitch. | "added in version" 2.2.0 of drmofu.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 communitydrmofu.fortimanager.fmgr_switchcontroller_fortilinksettings (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- hosts: fortimanager-inventory collections: - fortinet.fortimanager 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. 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: <value in [present, absent]> switchcontroller_fortilinksettings: fortilink: <value of string> inactive-timer: <value of integer> link-down-flush: <value in [disable, enable]> nac-ports: lan-segment: <value in [disabled, enabled]> member-change: <value of integer> nac-lan-interface: <value of string> nac-segment-vlans: <value of string> onboarding-vlan: <value of string> parent-key: <value of string> bounce-nac-port: <value in [disable, enable]> name: <value of string>
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 required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false 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. required: false 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. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int switchcontroller_fortilinksettings: description: the top level parameters set required: false suboptions: fortilink: description: FortiLink interface to which this fortilink-setting belongs. type: str inactive-timer: description: Time interval type: int link-down-flush: choices: - disable - enable description: Clear NAC and dynamic devices on switch ports on link down event. type: str nac-ports: description: no description required: false suboptions: bounce-nac-port: choices: - disable - enable description: Enable/disable bouncing type: str lan-segment: choices: - disabled - enabled description: Enable/disable LAN segment feature on the FortiLink interface. type: str member-change: description: no description type: int nac-lan-interface: description: Configure NAC LAN interface. type: str nac-segment-vlans: description: description type: str onboarding-vlan: description: Default NAC Onboarding VLAN when NAC devices are discovered. type: str parent-key: description: no description type: str type: dict name: description: FortiLink settings name. 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