/ home / drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_mpskprofile

drmofu.fortimanager.fmgr_mpskprofile (2.2.2) — module

Configure MPSK profile.

| "added in version" 2.1.0 of drmofu.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

 - 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>

Inputs

adom:
description: the parameter (adom) in requested url
required: true
type: str

state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str

rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list

enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool

mpskprofile:
description: the top level parameters set
required: false
suboptions:
mpsk-concurrent-clients:
description: Maximum number of concurrent clients that connect using the same
passphrase in multiple PSK authentication
type: int
mpsk-group:
description: Mpsk-Group.
elements: dict
suboptions:
mpsk-key:
description: Mpsk-Key.
elements: dict
suboptions:
comment:
description: Comment.
type: str
concurrent-client-limit-type:
choices:
- default
- unlimited
- specified
description: MPSK client limit type options.
type: str
concurrent-clients:
description: Number of clients that can connect using this pre-shared
key
type: int
mac:
description: MAC address.
type: str
mpsk-schedules:
description: Firewall schedule for MPSK passphrase.
type: str
name:
description: Pre-shared key name.
type: str
passphrase:
description: WPA Pre-shared key.
type: str
pmk:
description: WPA PMK.
type: str
type: list
name:
description: MPSK group name.
type: str
vlan-id:
description: Optional VLAN ID.
type: int
vlan-type:
choices:
- no-vlan
- fixed-vlan
description: MPSK group VLAN options.
type: str
type: list
name:
description: MPSK profile name.
type: str
ssid:
description: SSID of the VAP in which the MPSK profile is configured.
type: str
type: dict

access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str

rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list

proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str

bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool

workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list