ansible.builtin.fortios_wireless_controller_inter_controller (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

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.5

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"
   ssl_verify: "False"
  tasks:
  - name: Configure inter wireless controller operation.
    fortios_wireless_controller_inter_controller:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      wireless_controller_inter_controller:
        fast_failover_max: "3"
        fast_failover_wait: "4"
        inter_controller_key: "<your_own_value>"
        inter_controller_mode: "disable"
        inter_controller_peer:
         -
            id:  "8"
            peer_ip: "<your_own_value>"
            peer_port: "10"
            peer_priority: "primary"
        inter_controller_pri: "primary"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

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

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

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

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.
        suboptions:
          id:
            description:
            - ID.
            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
    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