Skip to content

Latest commit

 

History

History
344 lines (300 loc) · 14.9 KB

fortios_switch_controller_system.rst

File metadata and controls

344 lines (300 loc) · 14.9 KB
Raw
source:fortios_switch_controller_system.py
orphan:

fortios_switch_controller_system -- Configure system-wide switch controller settings 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 system 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_system v6.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
  • switch_controller_system - Configure system-wide switch controller settings. type: dict more...
    Supported Version Ranges
    switch_controller_system v6.0.0 -> latest
    • caputp_echo_interval - Echo interval for the caputp echo requests from swtp. type: int more...
      Supported Version Ranges
      caputp_echo_interval v7.4.0 -> latest
    • caputp_max_retransmit - Maximum retransmission count for the caputp tunnel packets. type: int more...
      Supported Version Ranges
      caputp_max_retransmit v7.4.0 -> latest
    • data_sync_interval - Time interval between collection of switch data (30 - 1800 sec). type: int more...
      Supported Version Ranges
      data_sync_interval v6.2.0 -> latest
    • dynamic_periodic_interval - Periodic time interval to run Dynamic port policy engine (5 - 60 sec). type: int more...
      Supported Version Ranges
      dynamic_periodic_interval v7.0.0 -> latest
    • iot_holdoff - MAC entry"s creation time. Time must be greater than this value for an entry to be created (0 - 10080 mins). type: int more...
      Supported Version Ranges
      iot_holdoff v6.4.0 -> latest
    • iot_mac_idle - MAC entry"s idle time. MAC entry is removed after this value (0 - 10080 mins). type: int more...
      Supported Version Ranges
      iot_mac_idle v6.4.0 -> latest
    • iot_scan_interval - IoT scan interval (2 - 10080 mins). type: int more...
      Supported Version Ranges
      iot_scan_interval v6.4.0 -> latest
    • iot_weight_threshold - MAC entry"s confidence value. Value is re-queried when below this value . type: int more...
      Supported Version Ranges
      iot_weight_threshold v6.4.0 -> latest
    • nac_periodic_interval - Periodic time interval to run NAC engine (5 - 60 sec). type: int more...
      Supported Version Ranges
      nac_periodic_interval v7.0.0 -> latest
    • parallel_process - Maximum number of parallel processes. type: int more...
      Supported Version Ranges
      parallel_process v6.0.0 -> latest
    • parallel_process_override - Enable/disable parallel process override. type: str choices: disable, enable more...
      Supported Version Ranges
      parallel_process_override v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • tunnel_mode - Compatible/strict tunnel mode. type: str choices: compatible, strict more...
      Supported Version Ranges
      tunnel_mode v7.0.0 -> latest
      [compatible] v6.0.0 -> latest
      [strict] v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure system-wide switch controller settings.
  fortinet.fortios.fortios_switch_controller_system:
      vdom: "{{ vdom }}"
      switch_controller_system:
          caputp_echo_interval: "30"
          caputp_max_retransmit: "5"
          data_sync_interval: "60"
          dynamic_periodic_interval: "60"
          iot_holdoff: "5"
          iot_mac_idle: "1440"
          iot_scan_interval: "60"
          iot_weight_threshold: "1"
          nac_periodic_interval: "60"
          parallel_process: "1"
          parallel_process_override: "disable"
          tunnel_mode: "compatible"

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.