fortinet.fortios.fortios_wireless_controller_wtp_group (2.3.6) — module

Configure WTP groups 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 wtp_group 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 WTP groups.
  fortinet.fortios.fortios_wireless_controller_wtp_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_wtp_group:
          ble_major_id: "0"
          name: "default_name_4"
          platform_type: "AP-11N"
          wtps:
              -
                  wtp_id: "<your_own_value> (source wireless-controller.wtp.wtp-id)"

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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    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_wtp_group:
    default: null
    description:
    - Configure WTP groups.
    suboptions:
      ble_major_id:
        description:
        - Override BLE Major ID.
        type: int
      name:
        description:
        - WTP group name.
        required: true
        type: str
      platform_type:
        choices:
        - AP-11N
        - C24JE
        - 421E
        - 423E
        - 221E
        - 222E
        - 223E
        - 224E
        - 231E
        - 321E
        - 431F
        - 431FL
        - 432F
        - 432FR
        - 433F
        - 433FL
        - 231F
        - 231FL
        - 234F
        - 23JF
        - 831F
        - 231G
        - 233G
        - 234G
        - 431G
        - 432G
        - 433G
        - 241K
        - 243K
        - 441K
        - 443K
        - U421E
        - U422EV
        - U423E
        - U221EV
        - U223EV
        - U24JEV
        - U321EV
        - U323EV
        - U431F
        - U433F
        - U231F
        - U234F
        - U432F
        - U231G
        - 220B
        - 210B
        - 222B
        - 112B
        - 320B
        - 11C
        - 14C
        - 223B
        - 28C
        - 320C
        - 221C
        - 25D
        - 222C
        - 224D
        - 214B
        - 21D
        - 24D
        - 112D
        - 223C
        - 321C
        - C220C
        - C225C
        - C23JD
        - S321C
        - S322C
        - S323C
        - S311C
        - S313C
        - S321CR
        - S322CR
        - S323CR
        - S421E
        - S422E
        - S423E
        - S221E
        - S223E
        - U441G
        description:
        - FortiAP models to define the WTP group platform type.
        type: str
      wtps:
        description:
        - WTP list.
        elements: dict
        suboptions:
          wtp_id:
            description:
            - WTP ID. Source wireless-controller.wtp.wtp-id.
            required: true
            type: str
        type: list
    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