fortinet.fortios.fortios_extender_controller_extender_profile 模块 – 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_extender_profile

在 fortinet.fortios 2.0.0 中新增

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ←(默认)

  • true

extender_controller_extender_profile

字典

FortiExtender 扩展器配置文件配置。

allowaccess

列表 / 元素=字符串

控制对托管扩展器的管理访问。用空格分隔条目。

选项

  • "ping"

  • "telnet"

  • "http"

  • "https"

  • "ssh"

  • "snmp"

bandwidth_limit

整数

FortiExtender LAN 扩展带宽限制(Mbps)。

cellular

字典

FortiExtender 蜂窝配置。

controller_report

字典

FortiExtender 控制器报告配置。

interval

整数

控制器报告间隔。

signal_threshold

整数

控制器报告信号阈值。

status

字符串

FortiExtender 控制器报告状态。

选项

  • "disable"

  • "enable"

dataplan

列表 / 元素=字典

数据计划名称。

name

字符串 / 必填

数据计划名称。源 extender-controller.dataplan.name。

modem1

字典

调制解调器 1 的配置选项。

auto_switch

字典

FortiExtender 自动切换配置。

dataplan

字符串

根据数据使用情况自动切换。

选项

  • "disable"

  • "enable"

disconnect

字符串

按断开连接自动切换。

选项

  • "disable"

  • "enable"

disconnect_period

整数

根据断开连接时间段自动切换。

disconnect_threshold

整数

根据断开连接阈值自动切换。

signal

字符串

根据信号强度自动切换。

选项

  • "disable"

  • "enable"

switch_back

列表 / 元素=字符串

具有切换回多个选项的自动切换。

选项

  • "time"

  • "timer"

switch_back_time

字符串

在指定的 UTC 时间 (HH:MM) 自动切换回首选 SIM 卡/运营商。

switch_back_timer

整数

在给定的时间(3600 - 2147483647 秒)后自动切换回首选 SIM 卡/运营商。

conn_status

整数

连接状态。

default_sim

字符串

默认 SIM 卡选择。

选项

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

字符串

FortiExtender GPS 启用/禁用。

选项

  • "disable"

  • "enable"

preferred_carrier

字符串

首选运营商。

redundant_intf

字符串

冗余接口。

redundant_mode

字符串

FortiExtender 模式。

选项

  • "disable"

  • "enable"

sim1_pin

字符串

SIM

选项

  • "disable"

  • "enable"

sim1_pin_code

字符串

SIM

sim2_pin

字符串

SIM

选项

  • "disable"

  • "enable"

sim2_pin_code

字符串

SIM

modem2

字典

调制解调器 2 的配置选项。

auto_switch

字典

FortiExtender 自动切换配置。

dataplan

字符串

根据数据使用情况自动切换。

选项

  • "disable"

  • "enable"

disconnect

字符串

按断开连接自动切换。

选项

  • "disable"

  • "enable"

disconnect_period

整数

根据断开连接时间段自动切换。

disconnect_threshold

整数

根据断开连接阈值自动切换。

signal

字符串

根据信号强度自动切换。

选项

  • "disable"

  • "enable"

switch_back

列表 / 元素=字符串

具有切换回多个选项的自动切换。

选项

  • "time"

  • "timer"

switch_back_time

字符串

在指定的 UTC 时间 (HH:MM) 自动切换回首选 SIM 卡/运营商。

switch_back_timer

整数

在给定的时间(3600 - 2147483647 秒)后自动切换回首选 SIM 卡/运营商。

conn_status

整数

连接状态。

default_sim

字符串

默认 SIM 卡选择。

选项

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

字符串

FortiExtender GPS 启用/禁用。

选项

  • "disable"

  • "enable"

preferred_carrier

字符串

首选运营商。

redundant_intf

字符串

冗余接口。

redundant_mode

字符串

FortiExtender 模式。

选项

  • "disable"

  • "enable"

sim1_pin

字符串

SIM

选项

  • "disable"

  • "enable"

sim1_pin_code

字符串

SIM

sim2_pin

字符串

SIM

选项

  • "disable"

  • "enable"

sim2_pin_code

字符串

SIM

sms_notification

字典

FortiExtender 蜂窝 SMS 通知配置。

alert

字典

SMS 警报列表。

data_exhausted

字符串

数据耗尽时显示字符串。

fgt_backup_mode_switch

字符串

FortiGate 备份模式切换时显示字符串。

low_signal_strength

字符串

信号强度低时显示字符串。

mode_switch

字符串

模式切换时显示字符串。

os_image_fallback

字符串

回退到以前的操作系统映像时显示字符串。

session_disconnect

字符串

会话断开连接时显示字符串。

system_reboot

字符串

系统重启时显示字符串。

receiver

列表 / 元素=字典

SMS 通知接收者列表。

alert

列表 / 元素=字符串

警报多个选项。

选项

  • "system-reboot"

  • "data-exhausted"

  • "session-disconnect"

  • "low-signal-strength"

  • "mode-switch"

  • "os-image-fallback"

  • "fgt-backup-mode-switch"

name

字符串 / 必填

FortiExtender 短信通知接收器名称。

phone_number

字符串

接收器电话号码。格式:[+][国家代码][地区代码][本地电话号码]。例如,+16501234567。

status

字符串

短信通知接收器状态。

选项

  • "disable"

  • "enable"

status

字符串

FortiExtender 短信通知状态。

选项

  • "disable"

  • "enable"

enforce_bandwidth

字符串

启用/禁用 LAN 扩展接口上的带宽强制执行。

选项

  • "enable"

  • "disable"

extension

字符串

扩展选项。

选项

  • "wan-extension"

  • "lan-extension"

id

整数

ID。

lan_extension

字典

FortiExtender LAN 扩展配置。

backhaul

列表 / 元素=字典

LAN 扩展回程隧道配置。

name

字符串 / 必填

FortiExtender LAN 扩展回程名称。

port

字符串

FortiExtender 上行链路端口。

选项

  • "wan"

  • "lte1"

  • "lte2"

  • "port1"

  • "port2"

  • "port3"

  • "port4"

  • "port5"

  • "sfp"

role

字符串

FortiExtender 上行链路端口。

选项

  • "primary"

  • "secondary"

weight

整数

WRR 权重参数。

backhaul_interface

字符串

IPsec phase1 接口。源 system.interface.name。

backhaul_ip

字符串

IPsec phase1 IPv4/FQDN。用于指定当 FortiGate 设备位于 NAT 设备之后时的外部 IP/FQDN。

ipsec_tunnel

字符串

IPsec 隧道名称。

字符串

LAN 扩展链路负载均衡策略。

选项

  • "activebackup"

  • "loadbalance"

login_password

字符串

设置被管理扩展器的管理员密码。

login_password_change

字符串

更改或重置被管理扩展器的管理员密码(yes、default 或 no)。

选项

  • "yes"

  • "default"

  • "no"

model

字符串

型号。

选项

  • "FX201E"

  • "FX211E"

  • "FX200F"

  • "FXA11F"

  • "FXE11F"

  • "FXA21F"

  • "FXE21F"

  • "FXA22F"

  • "FXE22F"

  • "FX212F"

  • "FX311F"

  • "FX312F"

  • "FX511F"

  • "FVG21F"

  • "FVA21F"

  • "FVG22F"

  • "FVA22F"

  • "FX04DA"

  • "FX04DN"

  • "FX04DI"

name

字符串 / 必填

FortiExtender 配置文件名称。

member_path

字符串

要操作的成员属性路径。

如果有多个属性,则用斜杠字符分隔。

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

state

字符串 / 必填

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

注释

注意

  • 传统的 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式

示例

- name: FortiExtender extender profile configuration.
  fortinet.fortios.fortios_extender_controller_extender_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_extender_profile:
          allowaccess: "ping"
          bandwidth_limit: "1024"
          cellular:
              controller_report:
                  interval: "300"
                  signal_threshold: "10"
                  status: "disable"
              dataplan:
                  -
                      name: "default_name_11 (source extender-controller.dataplan.name)"
              modem1:
                  auto_switch:
                      dataplan: "disable"
                      disconnect: "disable"
                      disconnect_period: "600"
                      disconnect_threshold: "3"
                      signal: "disable"
                      switch_back: "time"
                      switch_back_time: "<your_own_value>"
                      switch_back_timer: "86400"
                  conn_status: "0"
                  default_sim: "sim1"
                  gps: "disable"
                  preferred_carrier: "<your_own_value>"
                  redundant_intf: "<your_own_value>"
                  redundant_mode: "disable"
                  sim1_pin: "disable"
                  sim1_pin_code: "<your_own_value>"
                  sim2_pin: "disable"
                  sim2_pin_code: "<your_own_value>"
              modem2:
                  auto_switch:
                      dataplan: "disable"
                      disconnect: "disable"
                      disconnect_period: "600"
                      disconnect_threshold: "3"
                      signal: "disable"
                      switch_back: "time"
                      switch_back_time: "<your_own_value>"
                      switch_back_timer: "86400"
                  conn_status: "0"
                  default_sim: "sim1"
                  gps: "disable"
                  preferred_carrier: "<your_own_value>"
                  redundant_intf: "<your_own_value>"
                  redundant_mode: "disable"
                  sim1_pin: "disable"
                  sim1_pin_code: "<your_own_value>"
                  sim2_pin: "disable"
                  sim2_pin_code: "<your_own_value>"
              sms_notification:
                  alert:
                      data_exhausted: "<your_own_value>"
                      fgt_backup_mode_switch: "<your_own_value>"
                      low_signal_strength: "<your_own_value>"
                      mode_switch: "<your_own_value>"
                      os_image_fallback: "<your_own_value>"
                      session_disconnect: "<your_own_value>"
                      system_reboot: "<your_own_value>"
                  receiver:
                      -
                          alert: "system-reboot"
                          name: "default_name_63"
                          phone_number: "<your_own_value>"
                          status: "disable"
                  status: "disable"
          enforce_bandwidth: "enable"
          extension: "wan-extension"
          id: "69"
          lan_extension:
              backhaul:
                  -
                      name: "default_name_72"
                      port: "wan"
                      role: "primary"
                      weight: "1"
              backhaul_interface: "<your_own_value> (source system.interface.name)"
              backhaul_ip: "<your_own_value>"
              ipsec_tunnel: "<your_own_value>"
              link_loadbalance: "activebackup"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          model: "FX201E"
          name: "default_name_83"

返回值

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

描述

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"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)