fortinet.fortimanager.fmgr_mpskprofile module – Configure MPSK profile.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The top level parameters set. |
|
Deprecated, please rename it to mpsk_concurrent_clients. Maximum number of concurrent clients that connect using the same … |
|
(list) Deprecated, please rename it to mpsk_external_server. RADIUS server to be used to authenticate MPSK users. |
|
Deprecated, please rename it to mpsk_external_server_auth. Enable/Disable MPSK external server authentication Choices:
|
|
Deprecated, please rename it to mpsk_group. Mpsk group. |
|
Deprecated, please rename it to mpsk_key. Mpsk key. |
|
Comment. |
|
Deprecated, please rename it to concurrent_client_limit_type. MPSK client limit type options. Choices:
|
|
Deprecated, please rename it to concurrent_clients. Number of clients that can connect using this pre-shar… |
|
Deprecated, please rename it to key_type. Select the type of the key. Choices:
|
|
MAC address. |
|
(list or str) Deprecated, please rename it to mpsk_schedules. Firewall schedule for MPSK passphrase. |
|
Pre-shared key name. |
|
(list) WPA Pre-shared key. |
|
(list) WPA PMK. |
|
(list) Deprecated, please rename it to sae_password. WPA3 SAE password. |
|
Deprecated, please rename it to sae_pk. Enable/disable WPA3 SAE-PK Choices:
|
|
Deprecated, please rename it to sae_private_key. Private key used for WPA3 SAE-PK authentication. |
|
MPSK group name. |
|
Deprecated, please rename it to vlan_id. Optional VLAN ID. |
|
Deprecated, please rename it to vlan_type. MPSK group VLAN options. Choices:
|
|
Deprecated, please rename it to mpsk_type. Select the security type of keys for this profile. Choices:
|
|
MPSK profile name. |
|
SSID of the VAP in which the MPSK profile is configured. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |