fortinet.fortios.fortios_wireless_controller_mpsk_profile (2.3.6) — module

Configure MPSK profile in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and mpsk_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure MPSK profile.
  fortinet.fortios.fortios_wireless_controller_mpsk_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_mpsk_profile:
          mpsk_concurrent_clients: "0"
          mpsk_group:
              -
                  mpsk_key:
                      -
                          comment: "Comment."
                          concurrent_client_limit_type: "default"
                          concurrent_clients: "256"
                          mac: "<your_own_value>"
                          mpsk_schedules:
                              -
                                  name: "default_name_11 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
                          name: "default_name_12"
                          passphrase: "<your_own_value>"
                  name: "default_name_14"
                  vlan_id: "0"
                  vlan_type: "no-vlan"
          name: "default_name_17"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

wireless_controller_mpsk_profile:
    default: null
    description:
    - Configure MPSK profile.
    suboptions:
      mpsk_concurrent_clients:
        description:
        - Maximum number of concurrent clients that connect using the same passphrase
          in multiple PSK authentication (0 - 65535).
        type: int
      mpsk_group:
        description:
        - List of multiple PSK groups.
        elements: dict
        suboptions:
          mpsk_key:
            description:
            - List of multiple PSK entries.
            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 (1 - 65535).
                type: int
              mac:
                description:
                - MAC address.
                type: str
              mpsk_schedules:
                description:
                - Firewall schedule for MPSK passphrase. The passphrase will be effective
                  only when at least one schedule is valid.
                elements: dict
                suboptions:
                  name:
                    description:
                    - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name
                      firewall.schedule.onetime .name.
                    required: true
                    type: str
                type: list
              name:
                description:
                - Pre-shared key name.
                required: true
                type: str
              passphrase:
                description:
                - WPA Pre-shared key.
                type: str
            type: list
          name:
            description:
            - MPSK group name.
            required: true
            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.
        required: true
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str