fortinet.fortios.fortios_wireless_controller_inter_controller (2.3.6) — module

Configure inter wireless controller operation in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of 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 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 wireless_controller feature and inter_controller 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.
- name: Configure inter wireless controller operation.
  fortinet.fortios.fortios_wireless_controller_inter_controller:
      vdom: "{{ vdom }}"
      wireless_controller_inter_controller:
          fast_failover_max: "10"
          fast_failover_wait: "10"
          inter_controller_key: "<your_own_value>"
          inter_controller_mode: "disable"
          inter_controller_peer:
              -
                  id: "8"
                  peer_ip: "<your_own_value>"
                  peer_port: "5246"
                  peer_priority: "primary"
          inter_controller_pri: "primary"
          l3_roaming: "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_inter_controller:
    default: null
    description:
    - Configure inter wireless controller operation.
    suboptions:
      fast_failover_max:
        description:
        - Maximum number of retransmissions for fast failover HA messages between peer
          wireless controllers (3 - 64).
        type: int
      fast_failover_wait:
        description:
        - Minimum wait time before an AP transitions from secondary controller to primary
          controller (10 - 86400 sec).
        type: int
      inter_controller_key:
        description:
        - Secret key for inter-controller communications.
        type: str
      inter_controller_mode:
        choices:
        - disable
        - l2-roaming
        - 1+1
        description:
        - Configure inter-controller mode (disable, l2-roaming, 1+1).
        type: str
      inter_controller_peer:
        description:
        - Fast failover peer wireless controller list.
        elements: dict
        suboptions:
          id:
            description:
            - ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          peer_ip:
            description:
            - Peer wireless controller"s IP address.
            type: str
          peer_port:
            description:
            - Port used by the wireless controller"s for inter-controller communications
              (1024 - 49150).
            type: int
          peer_priority:
            choices:
            - primary
            - secondary
            description:
            - Peer wireless controller"s priority (primary or secondary).
            type: str
        type: list
      inter_controller_pri:
        choices:
        - primary
        - secondary
        description:
        - Configure inter-controller"s priority (primary or secondary).
        type: str
      l3_roaming:
        choices:
        - enable
        - disable
        description:
        - Enable/disable layer 3 roaming .
        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