fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist 模块 – NAI 列表。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

  • 示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

anqp-nai-realm

字符串

已弃用，请使用“anqp_nai_realm”

anqp_nai_realm

字符串

请求的 URL 中的参数 (anqp-nai-realm)。

bypass_validation

布尔值

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

选择

  • false ← (默认)

  • true

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

forticloud_access_token

字符串

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

hotspot20_anqpnairealm_nailist

字典

顶级参数集。

eap_method

别名: eap-method

列表 / 元素=字典

Eap 方法。

auth_param

别名: auth-param

列表 / 元素=字典

身份验证参数。

id

字符串

身份验证参数的 ID。

选择

  • "non-eap-inner-auth"

  • "inner-auth-eap"

  • "credential"

  • "tunneled-credential"

index

整数

参数索引。

val

字符串

身份验证参数的值。

选择

  • "eap-identity"

  • "eap-md5"

  • "eap-tls"

  • "eap-ttls"

  • "eap-peap"

  • "eap-sim"

  • "eap-aka"

  • "eap-aka-prime"

  • "non-eap-pap"

  • "non-eap-chap"

  • "non-eap-mschap"

  • "non-eap-mschapv2"

  • "cred-sim"

  • "cred-usim"

  • "cred-nfc"

  • "cred-hardware-token"

  • "cred-softoken"

  • "cred-certificate"

  • "cred-user-pwd"

  • "cred-none"

  • "cred-vendor-specific"

  • "tun-cred-sim"

  • "tun-cred-usim"

  • "tun-cred-nfc"

  • "tun-cred-hardware-token"

  • "tun-cred-softoken"

  • "tun-cred-certificate"

  • "tun-cred-user-pwd"

  • "tun-cred-anonymous"

  • "tun-cred-vendor-specific"

index

整数

EAP 方法索引。

method

字符串

EAP 方法类型。

选择

  • "eap-identity"

  • "eap-md5"

  • "eap-tls"

  • "eap-ttls"

  • "eap-peap"

  • "eap-sim"

  • "eap-aka"

  • "eap-aka-prime"

encoding

字符串

启用/禁用符合 IETF RFC 4282 的格式。

选择

  • "disable"

  • "enable"

nai_realm

别名: nai-realm

字符串

配置 NAI 域

name

字符串 / 必需

NAI 域名称。

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: NAI list.
      fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist:
        # 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>
        anqp_nai_realm: <your own value>
        state: present # <value in [present, absent]>
        hotspot20_anqpnairealm_nailist:
          eap_method:
            -
              auth_param:
                -
                  id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]>
                  index: <integer>
                  val: <value in [eap-identity, eap-md5, eap-tls, ...]>
              index: <integer>
              method: <value in [eap-identity, eap-md5, eap-tls, ...]>
          encoding: <value in [disable, enable]>
          nai_realm: <string>
          name: <string>

返回值

常见的返回值记录在这里，以下是此模块独有的字段

键

描述

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

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)