fortinet.fortios.fortios_wireless_controller_mpsk_profile – Configure MPSK profile in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_mpsk_profile.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and mpsk_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
Default:
"root"
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.
wireless_controller_mpsk_profile
dictionary
Configure MPSK profile.
mpsk_concurrent_clients
integer
Maximum number of concurrent clients that connect using the same passphrase in multiple PSK authentication (0 - 65535).
mpsk_group
list / elements=string
List of multiple PSK groups.
mpsk_key
list / elements=string
List of multiple PSK entries.
comment
string
Comment.
concurrent_client_limit_type
string
    Choices:
  • default
  • unlimited
  • specified
MPSK client limit type options.
concurrent_clients
integer
Number of clients that can connect using this pre-shared key (1 - 65535).
mac
string
MAC address.
mpsk_schedules
list / elements=string
Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid.
name
string / required
Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime .name.
name
string / required
Pre-shared key name.
passphrase
string
WPA Pre-shared key.
name
string / required
MPSK group name.
vlan_id
integer
Optional VLAN ID.
vlan_type
string
    Choices:
  • no-vlan
  • fixed-vlan
MPSK group VLAN options.
name
string / required
MPSK profile name.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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 MPSK profile.
    fortios_wireless_controller_mpsk_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_mpsk_profile:
        mpsk_concurrent_clients: "3"
        mpsk_group:
         -
            mpsk_key:
             -
                comment: "Comment."
                concurrent_client_limit_type: "default"
                concurrent_clients: "8"
                mac: "<your_own_value>"
                mpsk_schedules:
                 -
                    name: "default_name_11 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
                name: "default_name_12"
                passphrase: "<your_own_value>"
            name: "default_name_14"
            vlan_id: "15"
            vlan_type: "no-vlan"
        name: "default_name_17"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_mpsk_profile_module.html