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

New in version 2.0.0.


  • 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


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

  • ansible>=2.14


Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges
fortios_wireless_controller_mpsk_profile v6.4.0 -> v6.4.0 v6.4.4 -> latest


  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • wireless_controller_mpsk_profile - Configure MPSK profile. type: dict more...
    • mpsk_concurrent_clients - Maximum number of concurrent clients that connect using the same passphrase in multiple PSK authentication (0 - 65535). type: int more...
    • mpsk_group - List of multiple PSK groups. type: list member_path: mpsk_group:name more...
      • mpsk_key - List of multiple PSK entries. type: list member_path: mpsk_group:name/mpsk_key:name more...
        • comment - Comment. type: str more...
        • concurrent_client_limit_type - MPSK client limit type options. type: str choices: default, unlimited, specified more...
        • concurrent_clients - Number of clients that can connect using this pre-shared key (1 - 65535). type: int more...
        • mac - MAC address. type: str more...
        • mpsk_schedules - Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid. type: list member_path: mpsk_group:name/mpsk_key:name/mpsk_schedules:name more...
          • name - Schedule name. Source firewall.schedule.onetime .name. type: str required: true more...
        • name - Pre-shared key name. type: str required: true more...
        • passphrase - WPA Pre-shared key. type: str more...
      • name - MPSK group name. type: str required: true more...
      • vlan_id - Optional VLAN ID. type: int more...
      • vlan_type - MPSK group VLAN options. type: str choices: no-vlan, fixed-vlan more...
    • name - MPSK profile name. type: str required: true more...



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


- name: Configure MPSK profile.
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
          mpsk_concurrent_clients: "0"
                          comment: "Comment."
                          concurrent_client_limit_type: "default"
                          concurrent_clients: "256"
                          mac: "<your_own_value>"
                                  name: "default_name_11 (source"
                          name: "default_name_12"
                          passphrase: "<your_own_value>"
                  name: "default_name_14"
                  vlan_id: "0"
                  vlan_type: "no-vlan"
          name: "default_name_17"

Return Values

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

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample:
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3


  • This module is not guaranteed to have a backwards compatible interface.


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


If you notice any issues in this documentation, you can create a pull request to improve it.