ansible.builtin.fortios_wireless_controller_global (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS 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.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure wireless controller global settings.
    fortios_wireless_controller_global:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      wireless_controller_global:
        ap-log-server: "enable"
        ap-log-server-ip: "<your_own_value>"
        ap-log-server-port: "5"
        control-message-offload: "ebp-frame"
        data-ethernet-II: "enable"
        discovery-mc-addr: "<your_own_value>"
        fiapp-eth-type: "9"
        image-download: "enable"
        ipsec-base-ip: "<your_own_value>"
        link-aggregation: "enable"
        location: "<your_own_value>"
        max-clients: "14"
        max-retransmit: "15"
        mesh-eth-type: "16"
        name: "default_name_17"
        rogue-scan-mac-adjacency: "18"
        wtp-share: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

wireless_controller_global:
    default: null
    description:
    - Configure wireless controller global settings.
    suboptions:
      ap-log-server:
        choices:
        - enable
        - disable
        description:
        - Enable/disable configuring APs or FortiAPs to send log messages to a syslog
          server (default = disable).
      ap-log-server-ip:
        description:
        - IP address that APs or FortiAPs send log messages to.
      ap-log-server-port:
        description:
        - Port that APs or FortiAPs send log messages to.
      control-message-offload:
        choices:
        - ebp-frame
        - aeroscout-tag
        - ap-list
        - sta-list
        - sta-cap-list
        - stats
        - aeroscout-mu
        description:
        - Configure CAPWAP control message data channel offload.
      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 (default = disable).
      discovery-mc-addr:
        description:
        - Multicast IP address for AP discovery (default = 244.0.1.140).
      fiapp-eth-type:
        description:
        - Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f,
          packets (0 - 65535, default = 5252).
      image-download:
        choices:
        - enable
        - disable
        description:
        - Enable/disable WTP image download at join time.
      ipsec-base-ip:
        description:
        - Base IP address for IPsec VPN tunnels between the access points and the wireless
          controller (default = 169.254.0.1).
      link-aggregation:
        choices:
        - enable
        - disable
        description:
        - Enable/disable calculating the CAPWAP transmit hash to load balance sessions
          to link aggregation nodes (default = disable).
      location:
        description:
        - Description of the location of the wireless controller.
      max-clients:
        description:
        - Maximum number of clients that can connect simultaneously (default = 0, meaning
          no limitation).
      max-retransmit:
        description:
        - Maximum number of tunnel packet retransmissions (0 - 64, default = 3).
      mesh-eth-type:
        description:
        - Mesh Ethernet identifier included in backhaul packets (0 - 65535, default =
          8755).
      name:
        description:
        - Name of the wireless controller.
      rogue-scan-mac-adjacency:
        description:
        - Maximum numerical difference between an AP's Ethernet and wireless MAC values
          to match for rogue detection (0 - 31, default = 7).
      wtp-share:
        choices:
        - enable
        - disable
        description:
        - Enable/disable sharing of WTPs between VDOMs.

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