fortinet.fortios.fortios_switch_controller_system (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

switch_controller_system:
    default: null
    description:
    - Configure system-wide switch controller settings.
    suboptions:
      caputp_echo_interval:
        description:
        - Echo interval for the caputp echo requests from swtp.
        type: int
      caputp_max_retransmit:
        description:
        - Maximum retransmission count for the caputp tunnel packets.
        type: int
      data_sync_interval:
        description:
        - Time interval between collection of switch data (30 - 1800 sec).
        type: int
      dynamic_periodic_interval:
        description:
        - Periodic time interval to run Dynamic port policy engine (5 - 60 sec).
        type: int
      iot_holdoff:
        description:
        - MAC entry"s creation time. Time must be greater than this value for an entry
          to be created (0 - 10080 mins).
        type: int
      iot_mac_idle:
        description:
        - MAC entry"s idle time. MAC entry is removed after this value (0 - 10080 mins).
        type: int
      iot_scan_interval:
        description:
        - IoT scan interval (2 - 10080 mins).
        type: int
      iot_weight_threshold:
        description:
        - MAC entry"s confidence value. Value is re-queried when below this value .
        type: int
      nac_periodic_interval:
        description:
        - Periodic time interval to run NAC engine (5 - 60 sec).
        type: int
      parallel_process:
        description:
        - Maximum number of parallel processes.
        type: int
      parallel_process_override:
        choices:
        - disable
        - enable
        description:
        - Enable/disable parallel process override.
        type: str
      tunnel_mode:
        choices:
        - compatible
        - moderate
        - strict
        description:
        - Compatible/strict tunnel mode.
        type: str
    type: dict

Outputs

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