fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_8021x 模块 – 配置 802.1X

注意

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

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

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

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

fortinet.fortimanager 2.0.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 客户端进行身份验证。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。选项 `"present"` `"absent"`
switchcontroller_securitypolicy_8021x 字典	设置的顶级参数。
auth_fail_vlan 别名：auth-fail-vlan 字符串	启用允许对无法进行身份验证的客户端进行有限访问。选项 `"disable"` `"enable"`
auth_fail_vlan_id 别名：auth-fail-vlan-id 字符串	身份验证失败的 VLAN ID。
auth_fail_vlanid 别名：auth-fail-vlanid 整数	身份验证失败的 VLAN ID。
auth_order 别名：auth-order 字符串	配置身份验证顺序。选项 `"dot1x-mab"` `"mab-dot1x"` `"mab"`
auth_priority 别名：auth-priority 字符串	配置身份验证优先级。选项 `"dot1x-mab"` `"mab-dot1x"` `"legacy"`
authserver_timeout_period 别名：authserver-timeout-period 整数	身份验证服务器超时周期
authserver_timeout_tagged 别名：authserver-timeout-tagged 字符串	为允许在身份验证服务器不可用时进行有限访问的标记 VLAN 配置超时选项。选项 `"static"` `"disable"` `"lldp-voice"`
authserver_timeout_tagged_vlanid 别名：authserver-timeout-tagged-vlanid 任意	(列表) 应用超时选项的标记 VLAN 名称
authserver_timeout_vlan 别名：authserver-timeout-vlan 字符串	启用/禁用身份验证服务器超时 VLAN，以便在 RADIUS 不可用时允许有限访问。选项 `"disable"` `"enable"`
authserver_timeout_vlanid 别名：authserver-timeout-vlanid 字符串	身份验证服务器超时 VLAN 名称。
dacl 字符串	启用/禁用此接口上的动态访问控制列表。选项 `"disable"` `"enable"`
eap_auto_untagged_vlans 别名：eap-auto-untagged-vlans 字符串	启用/禁用自动包含未标记的 VLAN。选项 `"disable"` `"enable"`
eap_passthru 别名：eap-passthru 字符串	启用/禁用 EAP 直通模式，允许协议选项 `"disable"` `"enable"`
framevid_apply 别名：framevid-apply 字符串	启用/禁用将 EAP/MAB 帧 VLAN 应用于端口原生 VLAN 的功能。选项 `"disable"` `"enable"`
guest_auth_delay 别名：guest-auth-delay 整数	访客身份验证延迟
guest_vlan 别名：guest-vlan 字符串	启用访客 VLAN 功能，允许对非 802.1X 客户端进行有限访问。选项 `"disable"` `"enable"`
guest_vlan_id 别名：guest-vlan-id 字符串	访客 VLAN 名称。
guest_vlanid 别名：guest-vlanid 整数	访客 VLAN ID。
mac_auth_bypass 别名：mac-auth-bypass 字符串	启用/禁用此策略的 MAB。选项 `"disable"` `"enable"`
name 字符串 / 必需	策略名称。
open_auth 别名：open-auth 字符串	启用/禁用此策略的开放式身份验证。选项 `"disable"` `"enable"`
policy_type 别名：policy-type 字符串	策略类型。选项 `"802.1X"`
radius_timeout_overwrite 别名：radius-timeout-overwrite 字符串	启用以覆盖全局 RADIUS 会话超时。选项 `"disable"` `"enable"`
security_mode 别名：security-mode 字符串	基于端口或MAC地址的802.1X。选项 `"802.1X"` `"802.1X-mac-based"`
user_group 别名：user-group 任意	(列表或字符串) 为此 MAC 身份验证旁路分配的用户组名称。
workspace_locking_adom 字符串	在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是 global 和其他 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 802.
      fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_8021x:
        # 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]>
        switchcontroller_securitypolicy_8021x:
          auth_fail_vlan: <value in [disable, enable]>
          auth_fail_vlan_id: <string>
          auth_fail_vlanid: <integer>
          eap_passthru: <value in [disable, enable]>
          guest_auth_delay: <integer>
          guest_vlan: <value in [disable, enable]>
          guest_vlan_id: <string>
          guest_vlanid: <integer>
          mac_auth_bypass: <value in [disable, enable]>
          name: <string>
          open_auth: <value in [disable, enable]>
          policy_type: <value in [802.1X]>
          radius_timeout_overwrite: <value in [disable, enable]>
          security_mode: <value in [802.1X, 802.1X-mac-based]>
          user_group: <list or string>
          framevid_apply: <value in [disable, enable]>
          eap_auto_untagged_vlans: <value in [disable, enable]>
          authserver_timeout_period: <integer>
          authserver_timeout_vlan: <value in [disable, enable]>
          authserver_timeout_vlanid: <string>
          authserver_timeout_tagged: <value in [static, disable, lldp-voice]>
          authserver_timeout_tagged_vlanid: <list or string>
          dacl: <value in [disable, enable]>
          auth_order: <value in [dot1x-mab, mab-dot1x, mab]>
          auth_priority: <value in [dot1x-mab, mab-dot1x, legacy]>

返回值 

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

键	描述
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)