fortinet.fortimanager.fmgr_mpskprofile (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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>
              name: <string>
              vlan_id: <integer>
              vlan_type: <value in [no-vlan, fixed-vlan]>
          name: <string>
          ssid: <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
    type: list

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

mpskprofile:
    description: The top level parameters set.
    required: false
    suboptions:
      mpsk-concurrent-clients:
        description: Deprecated, please rename it to mpsk_concurrent_clients. Maximum
          number of concurrent clients that connect using the same ...
        type: int
      mpsk-group:
        description: Deprecated, please rename it to mpsk_group. Mpsk-Group.
        elements: dict
        suboptions:
          mpsk-key:
            description: Deprecated, please rename it to mpsk_key. Mpsk-Key.
            elements: dict
            suboptions:
              comment:
                description: Comment.
                type: str
              concurrent-client-limit-type:
                choices:
                - default
                - unlimited
                - specified
                description: Deprecated, please rename it to concurrent_client_limit_type.
                  MPSK client limit type options.
                type: str
              concurrent-clients:
                description: Deprecated, please rename it to concurrent_clients. Number
                  of clients that can connect using this pre-shar...
                type: int
              mac:
                description: MAC address.
                type: str
              mpsk-schedules:
                description: (list or str) Deprecated, please rename it to mpsk_schedules.
                  Firewall schedule for MPSK passphrase.
                type: raw
              name:
                description: Pre-shared key name.
                type: str
              passphrase:
                description: (list) WPA Pre-shared key.
                type: raw
              pmk:
                description: (list) WPA PMK.
                type: raw
            type: list
          name:
            description: MPSK group name.
            type: str
          vlan-id:
            description: Deprecated, please rename it to vlan_id. Optional VLAN ID.
            type: int
          vlan-type:
            choices:
            - no-vlan
            - fixed-vlan
            description: Deprecated, please rename it to vlan_type. MPSK group VLAN options.
            type: str
        type: list
      name:
        description: MPSK profile name.
        required: true
        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.
    type: str

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    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.
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    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