fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge 模块 – 配置计费建议。

注意

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

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

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

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

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 客户端进行身份验证。

hotspot20_h2qpadviceofcharge

字典

设置的顶级参数。

aoc_list

别名：aoc-list

列表 / 元素=字典

计费建议列表。

nai_realm

别名：nai-realm

字符串

NAI 领域列表名称。

nai_realm_encoding

别名：nai-realm-encoding

字符串

NAI 领域编码。

name

字符串

计费建议 ID。

plan_info

别名：plan-info

列表 / 元素=字典

套餐信息。

currency

字符串

货币代码。

info_file

别名：info-file

字符串

信息文件。

lang

字符串

语言代码。

name

字符串

套餐名称。

type

字符串

计费类型。

选项

  • “time-based”

  • “volume-based”

  • “time-and-volume-based”

  • “unlimited”

name

字符串 / 必填

套餐名称。

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 advice of charge.
      fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge:
        # 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_h2qpadviceofcharge:
          aoc_list:
            -
              nai_realm: <string>
              nai_realm_encoding: <string>
              name: <string>
              plan_info:
                -
                  currency: <string>
                  info_file: <string>
                  lang: <string>
                  name: <string>
              type: <value in [time-based, volume-based, time-and-volume-based, ...]>
          name: <string>

返回值

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

键

描述

元数据

字典

请求的结果。

返回值：始终返回

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)