fortinet.fortimanager.fmgr_mpskprofile – Configure MPSK profile.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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 version 2.10: of fortinet.fortimanager

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				Choices/Defaults	Comments
adom string / required					the parameter (adom) in requested url
bypass_validation boolean				Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean				Choices: no ← yes	Enable/Disable logging for task
mpskprofile dictionary					the top level parameters set
	mpsk-concurrent-clients integer				Maximum number of concurrent clients that connect using the same passphrase in multiple PSK authentication (0 - 65535, default...
	mpsk-group list / elements=string				no description
		mpsk-key list / elements=string			no description
			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, default is 256).
			mac string		MAC address.
			mpsk-schedules string		Firewall schedule for MPSK passphrase. The passphrase will be effective only when at least one schedule is valid.
			name string		Pre-shared key name.
			passphrase string		no description
			pmk string		no description
		name string			MPSK group name.
		vlan-id integer			Optional VLAN ID.
		vlan-type string		Choices: no-vlan fixed-vlan	MPSK group VLAN options.
	name string				MPSK profile name.
	ssid string				SSID of the VAP in which the MPSK profile is configured.
proposed_method string				Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string					the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string					the rc codes list with which the conditions to succeed will be overriden
state string / required				Choices: present absent	the directive to create, update or delete an object
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				Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure MPSK profile.
     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: <value in [present, absent]>
        mpskprofile:
           mpsk-concurrent-clients: <value of integer>
           mpsk-group:
             -
                 mpsk-key:
                   -
                       comment: <value of string>
                       concurrent-client-limit-type: <value in [default, unlimited, specified]>
                       concurrent-clients: <value of integer>
                       mac: <value of string>
                       mpsk-schedules: <value of string>
                       name: <value of string>
                       passphrase: <value of string>
                       pmk: <value of string>
                 name: <value of string>
                 vlan-id: <value of integer>
                 vlan-type: <value in [no-vlan, fixed-vlan]>
           name: <value of string>
           ssid: <value of string>

Return Values

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

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 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/fortimanager/fmgr_mpskprofile_module.html

Docs

Docs4dev

Title here