fortinet.fortimanager.fmgr_mpskprofile 模块 – 配置 MPSK 配置文件。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_mpskprofile。

fortinet.fortimanager 2.1.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有参数和值，在使用前需要将其调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

mpskprofile

字典

设置的顶级参数。

mpsk_concurrent_clients

别名：mpsk-concurrent-clients

整数

使用相同密码短语在多个 PSK 身份验证中连接的并发客户端的最大数量

mpsk_external_server

别名：mpsk-external-server

任意

(列表) 用于验证 MPSK 用户的 RADIUS 服务器。

mpsk_external_server_auth

别名：mpsk-external-server-auth

字符串

启用/禁用 MPSK 外部服务器身份验证

选项

  • "disable"

  • "enable"

mpsk_group

别名：mpsk-group

列表 / 元素=字典

Mpsk 组。

mpsk_key

别名：mpsk-key

列表 / 元素=字典

Mpsk 密钥。

comment

字符串

注释。

concurrent_client_limit_type

别名：concurrent-client-limit-type

字符串

MPSK 客户端限制类型选项。

选项

  • "default"

  • "unlimited"

  • "specified"

concurrent_clients

别名：concurrent-clients

整数

可以使用此预共享密钥连接的客户端数量

key_type

别名：key-type

字符串

选择密钥的类型。

选项

  • "wpa2-personal"

  • "wpa3-sae"

mac

字符串

MAC 地址。

mpsk_schedules

别名：mpsk-schedules

任意

(列表或字符串) MPSK 密码短语的防火墙计划。

name

字符串

预共享密钥名称。

passphrase

任意

(列表) WPA 预共享密钥。

pmk

任意

(列表) WPA PMK。

sae_password

别名：sae-password

任意

(列表) WPA3 SAE 密码。

sae_pk

别名：sae-pk

字符串

启用/禁用 WPA3 SAE-PK

选项

  • "disable"

  • "enable"

sae_private_key

别名：sae-private-key

字符串

用于 WPA3 SAE-PK 身份验证的私钥。

name

字符串

MPSK 组名。

vlan_id

别名：vlan-id

整数

可选 VLAN ID。

vlan_type

别名：vlan-type

字符串

MPSK 组 VLAN 选项。

选项

  • "no-vlan"

  • "fixed-vlan"

mpsk_type

别名：mpsk-type

字符串

选择此配置文件的密钥的安全类型。

选项

  • "wpa2-personal"

  • "wpa3-sae"

  • "wpa3-sae-transition"

name

字符串 / 必需

MPSK 配置文件名。

ssid

字符串

配置 MPSK 配置文件的 VAP 的 SSID。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，值可以是全局和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 可帮助完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常情况下，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

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

返回值

常见的返回值已在此处记录，以下是此模块特有的字段。

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整 URL。

返回：始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回：始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回：始终

response_message

字符串

API 响应的描述性消息。

返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈峰 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)