fortinet.fortios.fortios_extender_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_extender_controller_dataplan。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 extender_controller 功能和数据平面类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

extender_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 的首选方法。

  • 该模块支持 check_mode。

示例

- name: FortiExtender dataplan configuration.
  fortinet.fortios.fortios_extender_controller_dataplan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_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: "32"
          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"

revision

字符串

内部修订号

返回：始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

version

字符串

FortiGate的版本

返回：始终

示例： "v5.6.3"

作者

  • 郑连 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆宏斌 (@fgtdev-hblu)

  • 沈峰 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)