fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings module – Configure integrated FortiLink settings for FortiSwitch.

Note

This module is part of the fortinet.fortimanager collection (version 2.9.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings.

New in fortinet.fortimanager 2.2.0

Synopsis

• 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.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
switchcontroller_fortilinksettings dictionary	The top level parameters set.
access_vlan_mode aliases: access-vlan-mode string	Intra VLAN traffic behavior with loss of connection to the FortiGate. Choices: "legacy" "fail-open" "fail-close"
fortilink string	FortiLink interface to which this fortilink-setting belongs.
inactive_timer aliases: inactive-timer integer	Time interval
link_down_flush aliases: link-down-flush string	Clear NAC and dynamic devices on switch ports on link down event. Choices: "disable" "enable"
nac_ports aliases: nac-ports dictionary	Nac ports.
bounce_nac_port aliases: bounce-nac-port string	Enable/disable bouncing Choices: "disable" "enable"
lan_segment aliases: lan-segment string	Enable/disable LAN segment feature on the FortiLink interface. Choices: "disabled" "enabled"
member_change aliases: member-change integer	Member change.
nac_lan_interface aliases: nac-lan-interface string	Configure NAC LAN interface.
nac_segment_vlans aliases: nac-segment-vlans any	(list) Configure NAC segment VLANs.
onboarding_vlan aliases: onboarding-vlan string	Default NAC Onboarding VLAN when NAC devices are discovered.
parent_key aliases: parent-key string	Parent key.
name string / required	FortiLink settings name.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• 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

- 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:
          name: "your value" # Required variable, string
          # 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]>
          # access_vlan_mode: <value in [legacy, fail-open, fail-close]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)