fortinet.fortios.fortios_extension_controller_dataplan 模块 – Fortinet FortiOS 和 FortiGate 中的 FortiExtender 数据计划配置。

注意

此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_extension_controller_dataplan。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 该模块能够配置 FortiGate 或 FortiOS (FOS) 设备，允许用户设置和修改 extension_controller 功能和 dataplan 类别。示例包括所有参数和值都需要在使用前调整为数据源。使用 FOS v6.0.0 测试。

要求

在执行此模块的主机上需要满足以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

extension_controller_dataplan

字典

FortiExtender 数据计划配置。

apn

字符串

APN 配置。

auth_type

字符串

身份验证类型。

选择

  • "none"

  • "pap"

  • "chap"

billing_date

整数

每月账单日（1 - 31）。

capacity

整数

以 MB 为单位的容量 (0 - 102400000)。

carrier

字符串

运营商配置。

iccid

字符串

ICCID 配置。

modem_id

字符串

数据计划的调制解调器详细信息（如果有）。

选择

  • "modem1"

  • "modem2"

  • "all"

monthly_fee

整数

数据计划的月费（0 - 100000，以当地货币计）。

name

字符串 / 必需

FortiExtender 数据计划名称。

overage

字符串

启用/禁用数据计划超额检测。

选择

  • "disable"

  • "enable"

password

字符串

密码。

pdn

字符串

PDN 类型。

选择

  • "ipv4-only"

  • "ipv6-only"

  • "ipv4-ipv6"

preferred_subnet

整数

首选子网掩码 (0 - 32)。

private_network

字符串

启用/禁用数据计划私有网络支持。

选择

  • "disable"

  • "enable"

signal_period

整数

信号周期（600 到 18000 秒）。

signal_threshold

整数

信号阈值。指定 50 - 100 之间的范围，其中 50/100 表示 -50/-100 dBm。

slot

字符串

SIM 卡槽配置。

选择

  • "sim1"

  • "sim2"

type

字符串

类型首选项配置。

选择

  • "carrier"

  • "slot"

  • "iccid"

  • "generic"

username

字符串

用户名。

member_path

字符串

要操作的成员属性路径。

如果存在多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选择

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选择

  • "present"

  • "absent"

vdom

字符串

虚拟域，在先前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认： "root"

注释

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例

- name: FortiExtender dataplan configuration.
  fortinet.fortios.fortios_extension_controller_dataplan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extension_controller_dataplan:
          apn: "<your_own_value>"
          auth_type: "none"
          billing_date: "1"
          capacity: "0"
          carrier: "<your_own_value>"
          iccid: "<your_own_value>"
          modem_id: "modem1"
          monthly_fee: "0"
          name: "default_name_11"
          overage: "disable"
          password: "<your_own_value>"
          pdn: "ipv4-only"
          preferred_subnet: "0"
          private_network: "disable"
          signal_period: "3600"
          signal_threshold: "100"
          slot: "sim1"
          type: "carrier"
          username: "<your_own_value>"

返回值

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

键

描述

build

字符串

Fortigate 映像的内部版本号

返回： 始终

示例： "1547"

http_method

字符串

用于将内容配置到 FortiGate 中的最后一种方法

返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在应用的最后一次操作中给出的最后一个结果

返回： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

返回： 成功

示例： "id"

name

字符串

用于满足请求的表名称

返回： 始终

示例： "urlfilter"

path

字符串

用于满足请求的表的路径

返回： 始终

示例: "webfilter"

修订版本

字符串

内部修订版本号

返回： 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

返回： 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例: "root"

版本

字符串

FortiGate 的版本

返回： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)