fortinet.fortimanager.fmgr_mpskprofile module – Configure MPSK profile.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_mpskprofile.

New in fortinet.fortimanager 2.1.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

mpskprofile

dictionary

The top level parameters set.

mpsk_concurrent_clients

aliases: mpsk-concurrent-clients

integer

Maximum number of concurrent clients that connect using the same passphrase in multiple PSK authentication

mpsk_external_server

aliases: mpsk-external-server

any

(list) RADIUS server to be used to authenticate MPSK users.

mpsk_external_server_auth

aliases: mpsk-external-server-auth

string

Enable/Disable MPSK external server authentication

Choices:

  • "disable"

  • "enable"

mpsk_group

aliases: mpsk-group

list / elements=dictionary

Mpsk group.

mpsk_key

aliases: mpsk-key

list / elements=dictionary

Mpsk key.

comment

string

Comment.

concurrent_client_limit_type

aliases: concurrent-client-limit-type

string

MPSK client limit type options.

Choices:

  • "default"

  • "unlimited"

  • "specified"

concurrent_clients

aliases: concurrent-clients

integer

Number of clients that can connect using this pre-shared key

key_type

aliases: key-type

string

Select the type of the key.

Choices:

  • "wpa2-personal"

  • "wpa3-sae"

mac

string

MAC address.

mpsk_schedules

aliases: mpsk-schedules

any

(list or str) Firewall schedule for MPSK passphrase.

name

string

Pre-shared key name.

passphrase

any

(list) WPA Pre-shared key.

pmk

any

(list) WPA PMK.

sae_password

aliases: sae-password

any

(list) WPA3 SAE password.

sae_pk

aliases: sae-pk

string

Enable/disable WPA3 SAE-PK

Choices:

  • "disable"

  • "enable"

sae_private_key

aliases: sae-private-key

string

Private key used for WPA3 SAE-PK authentication.

name

string

MPSK group name.

vlan_id

aliases: vlan-id

integer

Optional VLAN ID.

vlan_type

aliases: vlan-type

string

MPSK group VLAN options.

Choices:

  • "no-vlan"

  • "fixed-vlan"

mpsk_type

aliases: mpsk-type

string

Select the security type of keys for this profile.

Choices:

  • "wpa2-personal"

  • "wpa3-sae"

  • "wpa3-sae-transition"

name

string / required

MPSK profile name.

ssid

string

SSID of the VAP in which the MPSK profile is configured.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure MPSK profile.
      fortinet.fortimanager.fmgr_mpskprofile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        mpskprofile:
          mpsk_concurrent_clients: <integer>
          mpsk_group:
            -
              mpsk_key:
                -
                  comment: <string>
                  concurrent_client_limit_type: <value in [default, unlimited, specified]>
                  concurrent_clients: <integer>
                  mac: <string>
                  mpsk_schedules: <list or string>
                  name: <string>
                  passphrase: <list or string>
                  pmk: <list or string>
                  key_type: <value in [wpa2-personal, wpa3-sae]>
                  sae_password: <list or string>
                  sae_pk: <value in [disable, enable]>
                  sae_private_key: <string>
              name: <string>
              vlan_id: <integer>
              vlan_type: <value in [no-vlan, fixed-vlan]>
          name: <string>
          ssid: <string>
          mpsk_external_server: <list or string>
          mpsk_external_server_auth: <value in [disable, enable]>
          mpsk_type: <value in [wpa2-personal, wpa3-sae, wpa3-sae-transition]>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)