fortinet.fortios.fortios_wireless_controller_apcfg_profile (1.1.7) — module

Configure AP local configuration profiles in Fortinet's FortiOS and FortiGate.

| "added in version" 2.10 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:==1.1.7


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

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 apcfg_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.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 AP local configuration profiles.
    fortios_wireless_controller_apcfg_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_apcfg_profile:
        ac_ip: "<your_own_value>"
        ac_port: "4"
        ac_timer: "5"
        ac_type: "default"
        command_list:
         -
            id:  "8"
            name: "default_name_9"
            passwd_value: "<your_own_value>"
            type: "non-password"
            value: "<your_own_value>"
        comment: "Comment."
        name: "default_name_14"

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

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

wireless_controller_apcfg_profile:
    default: null
    description:
    - Configure AP local configuration profiles.
    suboptions:
      ac_ip:
        description:
        - IP address of the validation controller that AP must be able to join after applying
          AP local configuration.
        type: str
      ac_port:
        description:
        - Port of the validation controller that AP must be able to join after applying
          AP local configuration (1024 - 49150).
        type: int
      ac_timer:
        description:
        - Maximum waiting time for the AP to join the validation controller after applying
          AP local configuration (3 - 30 min).
        type: int
      ac_type:
        choices:
        - default
        - specify
        - apcfg
        description:
        - Validation controller type .
        type: str
      command_list:
        description:
        - AP local configuration command list.
        suboptions:
          id:
            description:
            - Command ID.
            required: true
            type: int
          name:
            description:
            - AP local configuration command name.
            type: str
          passwd_value:
            description:
            - AP local configuration command password value.
            type: str
          type:
            choices:
            - non-password
            - password
            description:
            - The command type .
            type: str
          value:
            description:
            - AP local configuration command value.
            type: str
        type: list
      comment:
        description:
        - Comment.
        type: str
      name:
        description:
        - AP local configuration profile name.
        required: true
        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