fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider 模块 – 配置在线注册

注意

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

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

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

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider。

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 客户端。

hotspot20_h2qposuprovider

字典

设置的顶级参数。

friendly_name

别名：friendly-name

列表 / 元素=字典

友好名称。

friendly_name

别名：friendly-name

字符串

OSU 提供商友好名称。

index

整数

OSU 提供商友好名称索引。

lang

字符串

语言代码。

icon

字符串

OSU 提供商图标。

name

字符串 / 必需

OSU 提供商 ID。

osu_method

别名：osu-method

列表 / 元素=字符串

OSU 方法列表。

选项

  • "oma-dm"

  • "soap-xml-spp"

  • "reserved"

osu_nai

别名：osu-nai

字符串

OSU NAI。

server_uri

别名：server-uri

字符串

服务器 URI。

service_description

别名：service-description

列表 / 元素=字典

服务描述。

lang

字符串

语言代码。

service_description

别名：service-description

字符串

服务描述。

service_id

别名：service-id

整数

OSU 服务 ID。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，该值可以是 global 和其他值，包括 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 online sign up
      fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider:
        # 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]>
        hotspot20_h2qposuprovider:
          friendly_name:
            -
              friendly_name: <string>
              index: <integer>
              lang: <string>
          icon: <string>
          name: <string>
          osu_method:
            - "oma-dm"
            - "soap-xml-spp"
            - "reserved"
          osu_nai: <string>
          server_uri: <string>
          service_description:
            -
              lang: <string>
              service_description: <string>
              service_id: <integer>

返回值

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

键

描述

元数据 (meta)

字典

请求的结果。

返回值：始终返回

请求URL (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)