Skip to content

Latest commit

 

History

History
394 lines (350 loc) · 18 KB

fortios_switch_controller_fortilink_settings.rst

File metadata and controls

394 lines (350 loc) · 18 KB
Raw
source:fortios_switch_controller_fortilink_settings.py
orphan:

fortios_switch_controller_fortilink_settings -- Configure integrated FortiLink settings for FortiSwitch in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and fortilink_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_switch_controller_fortilink_settings v7.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • switch_controller_fortilink_settings - Configure integrated FortiLink settings for FortiSwitch. type: dict more...
    Supported Version Ranges
    switch_controller_fortilink_settings v7.0.0 -> latest
    • access_vlan_mode - Intra VLAN traffic behavior with loss of connection to the FortiGate. type: str choices: legacy, fail-open, fail-close more...
      Supported Version Ranges
      access_vlan_mode v7.4.1 -> latest
      [legacy] v6.0.0 -> latest
      [fail-open] v6.0.0 -> latest
      [fail-close] v6.0.0 -> latest
    • fortilink - FortiLink interface to which this fortilink-setting belongs. Source system.interface.name. type: str more...
      Supported Version Ranges
      fortilink v7.0.2 -> latest
    • inactive_timer - Time interval(minutes) to be included in the inactive devices expiry calculation (mac age-out + inactive-time + periodic scan interval). type: int more...
      Supported Version Ranges
      inactive_timer v7.0.0 -> latest
    • link_down_flush - Clear NAC and dynamic devices on switch ports on link down event. type: str choices: disable, enable more...
      Supported Version Ranges
      link_down_flush v7.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • nac_ports - NAC specific configuration. type: dict more...
      Supported Version Ranges
      nac_ports v7.0.0 -> latest
      • bounce_nac_port - Enable/disable bouncing (administratively bring the link down, up) of a switch port when NAC mode is configured on the port. Helps to re-initiate the DHCP process for a device. type: str choices: disable, enable more...
        Supported Version Ranges
        bounce_nac_port v7.0.0 -> v7.0.3
        [disable] v6.0.0 -> latest
        [enable] v6.0.0 -> latest
      • lan_segment - Enable/disable LAN segment feature on the FortiLink interface. type: str choices: enabled, disabled more...
        Supported Version Ranges
        lan_segment v7.0.1 -> latest
        [enabled] v6.0.0 -> latest
        [disabled] v6.0.0 -> latest
      • member_change - Member change flag. type: int more...
        Supported Version Ranges
        member_change v7.0.1 -> v7.0.5 v7.2.0 -> v7.2.0
      • nac_lan_interface - Configure NAC LAN interface. Source system.interface.name. type: str more...
        Supported Version Ranges
        nac_lan_interface v7.0.1 -> latest
      • nac_segment_vlans - Configure NAC segment VLANs. type: list member_path: nac_ports/nac_segment_vlans:vlan_name more...
        Supported Version Ranges
        nac_segment_vlans v7.0.1 -> latest
        • vlan_name - VLAN interface name. Source system.interface.name. type: str required: true more...
          Supported Version Ranges
          vlan_name v7.0.1 -> latest
      • onboarding_vlan - Default NAC Onboarding VLAN when NAC devices are discovered. Source system.interface.name. type: str more...
        Supported Version Ranges
        onboarding_vlan v7.0.0 -> latest
      • parent_key - Parent key name. type: str more...
        Supported Version Ranges
        parent_key v7.0.1 -> v7.0.5 v7.2.0 -> v7.2.0
    • name - FortiLink settings name. type: str required: true more...
      Supported Version Ranges
      name v7.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure integrated FortiLink settings for FortiSwitch.
  fortinet.fortios.fortios_switch_controller_fortilink_settings:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_fortilink_settings:
          access_vlan_mode: "legacy"
          fortilink: "<your_own_value> (source system.interface.name)"
          inactive_timer: "15"
          link_down_flush: "disable"
          nac_ports:
              bounce_nac_port: "disable"
              lan_segment: "enabled"
              member_change: "0"
              nac_lan_interface: "<your_own_value> (source system.interface.name)"
              nac_segment_vlans:
                  -
                      vlan_name: "<your_own_value> (source system.interface.name)"
              onboarding_vlan: "<your_own_value> (source system.interface.name)"
              parent_key: "<your_own_value>"
          name: "default_name_16"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.