lix_fortinet.fortios.fortios_wireless_controller_global (102.2.120) — module

Configure wireless controller global settings in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_fortinet.fortios"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure wireless controller global settings.
    fortios_wireless_controller_global:
      vdom:  "{{ vdom }}"
      wireless_controller_global:
        ap_log_server: "enable"
        ap_log_server_ip: "<your_own_value>"
        ap_log_server_port: "0"
        control_message_offload: "ebp-frame"
        data_ethernet_II: "enable"
        discovery_mc_addr: "<your_own_value>"
        fiapp_eth_type: "5252"
        image_download: "enable"
        ipsec_base_ip: "<your_own_value>"
        link_aggregation: "enable"
        location: "<your_own_value>"
        max_clients: "0"
        max_retransmit: "3"
        mesh_eth_type: "8755"
        nac_interval: "120"
        name: "default_name_18"
        rogue_scan_mac_adjacency: "7"
        tunnel_mode: "compatible"
        wtp_share: "enable"

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

wireless_controller_global:
    default: null
    description:
    - Configure wireless controller global settings.
    suboptions:
      ap_log_server:
        choices:
        - enable
        - disable
        description:
        - Enable/disable configuring FortiGate to redirect wireless event log messages
          or FortiAPs to send UTM log messages to a syslog server .
        type: str
      ap_log_server_ip:
        description:
        - IP address that FortiGate or FortiAPs send log messages to.
        type: str
      ap_log_server_port:
        description:
        - Port that FortiGate or FortiAPs send log messages to.
        type: int
      control_message_offload:
        choices:
        - ebp-frame
        - aeroscout-tag
        - ap-list
        - sta-list
        - sta-cap-list
        - stats
        - aeroscout-mu
        - sta-health
        - spectral-analysis
        description:
        - Configure CAPWAP control message data channel offload.
        elements: str
        type: list
      data_ethernet_II:
        choices:
        - enable
        - disable
        description:
        - Configure the wireless controller to use Ethernet II or 802.3 frames with 802.3
          data tunnel mode .
        type: str
      discovery_mc_addr:
        description:
        - Multicast IP address for AP discovery .
        type: str
      fiapp_eth_type:
        description:
        - Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f,
          packets (0 - 65535).
        type: int
      image_download:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WTP image download at join time.
        type: str
      ipsec_base_ip:
        description:
        - Base IP address for IPsec VPN tunnels between the access points and the wireless
          controller .
        type: str
      link_aggregation:
        choices:
        - enable
        - disable
        description:
        - Enable/disable calculating the CAPWAP transmit hash to load balance sessions
          to link aggregation nodes .
        type: str
      location:
        description:
        - Description of the location of the wireless controller.
        type: str
      max_clients:
        description:
        - Maximum number of clients that can connect simultaneously .
        type: int
      max_retransmit:
        description:
        - Maximum number of tunnel packet retransmissions (0 - 64).
        type: int
      mesh_eth_type:
        description:
        - Mesh Ethernet identifier included in backhaul packets (0 - 65535).
        type: int
      nac_interval:
        description:
        - Interval in seconds between two WiFi network access control (NAC) checks (10
          - 600).
        type: int
      name:
        description:
        - Name of the wireless controller.
        type: str
      rogue_scan_mac_adjacency:
        description:
        - Maximum numerical difference between an AP"s Ethernet and wireless MAC values
          to match for rogue detection (0 - 31).
        type: int
      tunnel_mode:
        choices:
        - compatible
        - strict
        description:
        - Compatible/strict tunnel mode.
        type: str
      wtp_share:
        choices:
        - enable
        - disable
        description:
        - Enable/disable sharing of WTPs between VDOMs.
        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