fortinet.fortimanager.fmgr_extendercontroller_extenderprofile 模块 – FortiExtender 扩展程序配置文件配置。

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括在使用前需要调整为数据源的所有参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

extendercontroller_extenderprofile

字典

设置的顶级参数。

allowaccess

列表 / 元素=字符串

控制对受管理扩展程序的管理访问。

选项

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

bandwidth_limit

别名：bandwidth-limit

整数

FortiExtender LAN 扩展带宽限制

cellular

字典

蜂窝网络。

controller_report

别名：controller-report

字典

控制器报告。

interval

整数

控制器报告间隔。

signal_threshold

别名：signal-threshold

整数

控制器报告信号阈值。

status

字符串

FortiExtender 控制器报告状态。

选项

  • "disable"

  • "enable"

dataplan

任意

(列表或字符串) 数据计划名称。

modem1

字典

调制解调器1。

auto_switch

别名：auto-switch

字典

自动切换。

dataplan

字符串

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

选项

  • "disable"

  • "enable"

disconnect

字符串

通过断开连接自动切换。

选项

  • "disable"

  • "enable"

disconnect_period

别名：disconnect-period

整数

根据断开连接周期自动切换。

disconnect_threshold

别名：disconnect-threshold

整数

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

signal

字符串

根据信号强度自动切换。

选项

  • "disable"

  • "enable"

switch_back

别名：switch-back

列表 / 元素=字符串

带切换回多选项的自动切换。

选项

  • "time"

  • "timer"

switch_back_time

别名：switch-back-time

字符串

在 UTC 指定的时间自动切换到首选 SIM 卡/运营商

switch_back_timer

别名：switch-back-timer

整数

在给定时间后自动切换到首选 SIM 卡/运营商

conn_status

别名：conn-status

整数

连接状态。

default_sim

别名：default-sim

字符串

默认 SIM 卡选择。

选项

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

字符串

FortiExtender GPS 启用/禁用。

选项

  • "disable"

  • "enable"

modem_id

别名：modem-id

整数

调制解调器 ID。

preferred_carrier

别名: preferred-carrier

字符串

首选运营商。

redundant_intf

别名: redundant-intf

字符串

冗余接口。

redundant_mode

别名: redundant-mode

字符串

FortiExtender模式。

选项

  • "disable"

  • "enable"

sim1_pin

别名: sim1-pin

字符串

SIM卡PIN码

选项

  • "disable"

  • "enable"

sim1_pin_code

别名: sim1-pin-code

任意

(列表) SIM卡PIN码

sim2_pin

别名: sim2-pin

字符串

SIM卡PIN码

选项

  • "disable"

  • "enable"

sim2_pin_code

别名: sim2-pin-code

任意

(列表) SIM卡PIN码

调制解调器2

字典

调制解调器2。

auto_switch

别名：auto-switch

字典

自动切换。

dataplan

字符串

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

选项

  • "disable"

  • "enable"

disconnect

字符串

通过断开连接自动切换。

选项

  • "disable"

  • "enable"

disconnect_period

别名：disconnect-period

整数

根据断开连接周期自动切换。

disconnect_threshold

别名：disconnect-threshold

整数

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

signal

字符串

根据信号强度自动切换。

选项

  • "disable"

  • "enable"

switch_back

别名：switch-back

列表 / 元素=字符串

带切换回多选项的自动切换。

选项

  • "time"

  • "timer"

switch_back_time

别名：switch-back-time

字符串

在 UTC 指定的时间自动切换到首选 SIM 卡/运营商

switch_back_timer

别名：switch-back-timer

整数

在给定时间后自动切换到首选 SIM 卡/运营商

conn_status

别名：conn-status

整数

连接状态。

default_sim

别名：default-sim

字符串

默认 SIM 卡选择。

选项

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

字符串

FortiExtender GPS 启用/禁用。

选项

  • "disable"

  • "enable"

modem_id

别名：modem-id

整数

调制解调器 ID。

preferred_carrier

别名: preferred-carrier

字符串

首选运营商。

redundant_intf

别名: redundant-intf

字符串

冗余接口。

redundant_mode

别名: redundant-mode

字符串

FortiExtender模式。

选项

  • "disable"

  • "enable"

sim1_pin

别名: sim1-pin

字符串

SIM卡PIN码

选项

  • "disable"

  • "enable"

sim1_pin_code

别名: sim1-pin-code

任意

(列表) SIM卡PIN码

sim2_pin

别名: sim2-pin

字符串

SIM卡PIN码

选项

  • "disable"

  • "enable"

sim2_pin_code

别名: sim2-pin-code

任意

(列表) SIM卡PIN码

sms_notification

别名: sms-notification

字典

短信通知。

alert

字典

告警。

data_exhausted

别名: data-exhausted

字符串

数据耗尽时显示的字符串。

fgt_backup_mode_switch

别名: fgt-backup-mode-switch

字符串

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

low_signal_strength

别名: low-signal-strength

字符串

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

mode_switch

别名: mode-switch

字符串

模式切换时显示的字符串。

os_image_fallback

别名: os-image-fallback

字符串

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

session_disconnect

别名: session-disconnect

字符串

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

system_reboot

别名: system-reboot

字符串

系统重新启动时显示的字符串。

receiver

列表 / 元素=字典

接收者。

alert

列表 / 元素=字符串

告警多选项。

选项

  • "system-reboot"

  • "data-exhausted"

  • "session-disconnect"

  • "low-signal-strength"

  • "mode-switch"

  • "os-image-fallback"

  • "fgt-backup-mode-switch"

name

字符串

FortiExtender短信通知接收者名称。

phone_number

别名: phone-number

字符串

接收者电话号码。

status

字符串

短信通知接收者状态。

选项

  • "disable"

  • "enable"

status

字符串

FortiExtender短信通知状态。

选项

  • "disable"

  • "enable"

enforce_bandwidth

别名: enforce-bandwidth

字符串

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

选项

  • "disable"

  • "enable"

扩展

字符串

扩展选项。

选项

  • "wan-extension"

  • "lan-extension"

ID

整数 / 必填

ID。

lan_extension

别名: lan-extension

字典

LAN扩展。

backhaul

列表 / 元素=字典

回程。

name

字符串

FortiExtender LAN扩展回程名称。

port

字符串

FortiExtender上行端口。

选项

  • "wan"

  • "lte1"

  • "lte2"

  • "port1"

  • "port2"

  • "port3"

  • "port4"

  • "port5"

  • "sfp"

role

字符串

FortiExtender上行端口。

选项

  • "primary"

  • "secondary"

weight

整数

WRR权重参数。

backhaul_interface

别名: backhaul-interface

字符串

IPsec阶段1接口。

backhaul_ip

别名: backhaul-ip

字符串

IPsec阶段1 IPv4/FQDN。

ipsec_tunnel

别名: ipsec-tunnel

字符串

IPsec隧道名称。

link_loadbalance

别名: link-loadbalance

字符串

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

选项

  • "activebackup"

  • "loadbalance"

login_password

别名: login-password

任意

(列表) 设置受管理的扩展器的管理员密码。

login_password_change

别名: login-password-change

字符串

更改或重置受管理扩展器的管理员密码

选项

  • "no"

  • "yes"

  • "default"

型号

字符串

型号。

选项

  • "FX201E"

  • "FX211E"

  • "FX200F"

  • "FXA11F"

  • "FXE11F"

  • "FXA21F"

  • "FXE21F"

  • "FXA22F"

  • "FXE22F"

  • "FX212F"

  • "FX311F"

  • "FX312F"

  • "FX511F"

  • "FVG21F"

  • "FVA21F"

  • "FVG22F"

  • "FVA22F"

  • "FX04DA"

  • "FX04DN"

  • "FX04DI"

名称

字符串

FortiExtender配置文件名称。

forticloud_access_token

字符串

使用FortiCloud API访问令牌验证Ansible客户端。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

状态

字符串 / 必需

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

选项

  • “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: FortiExtender extender profile configuration.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile:
        # 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]>
        extendercontroller_extenderprofile:
          allowaccess:
            - "https"
            - "ping"
            - "ssh"
            - "snmp"
            - "http"
            - "telnet"
          bandwidth_limit: <integer>
          cellular:
            controller_report:
              interval: <integer>
              signal_threshold: <integer>
              status: <value in [disable, enable]>
            dataplan: <list or string>
            modem1:
              auto_switch:
                dataplan: <value in [disable, enable]>
                disconnect: <value in [disable, enable]>
                disconnect_period: <integer>
                disconnect_threshold: <integer>
                signal: <value in [disable, enable]>
                switch_back:
                  - "time"
                  - "timer"
                switch_back_time: <string>
                switch_back_timer: <integer>
              conn_status: <integer>
              default_sim: <value in [sim1, sim2, carrier, ...]>
              gps: <value in [disable, enable]>
              modem_id: <integer>
              preferred_carrier: <string>
              redundant_intf: <string>
              redundant_mode: <value in [disable, enable]>
              sim1_pin: <value in [disable, enable]>
              sim1_pin_code: <list or string>
              sim2_pin: <value in [disable, enable]>
              sim2_pin_code: <list or string>
            modem2:
              auto_switch:
                dataplan: <value in [disable, enable]>
                disconnect: <value in [disable, enable]>
                disconnect_period: <integer>
                disconnect_threshold: <integer>
                signal: <value in [disable, enable]>
                switch_back:
                  - "time"
                  - "timer"
                switch_back_time: <string>
                switch_back_timer: <integer>
              conn_status: <integer>
              default_sim: <value in [sim1, sim2, carrier, ...]>
              gps: <value in [disable, enable]>
              modem_id: <integer>
              preferred_carrier: <string>
              redundant_intf: <string>
              redundant_mode: <value in [disable, enable]>
              sim1_pin: <value in [disable, enable]>
              sim1_pin_code: <list or string>
              sim2_pin: <value in [disable, enable]>
              sim2_pin_code: <list or string>
            sms_notification:
              alert:
                data_exhausted: <string>
                fgt_backup_mode_switch: <string>
                low_signal_strength: <string>
                mode_switch: <string>
                os_image_fallback: <string>
                session_disconnect: <string>
                system_reboot: <string>
              receiver:
                -
                  alert:
                    - "system-reboot"
                    - "data-exhausted"
                    - "session-disconnect"
                    - "low-signal-strength"
                    - "mode-switch"
                    - "os-image-fallback"
                    - "fgt-backup-mode-switch"
                  name: <string>
                  phone_number: <string>
                  status: <value in [disable, enable]>
              status: <value in [disable, enable]>
          enforce_bandwidth: <value in [disable, enable]>
          extension: <value in [wan-extension, lan-extension]>
          id: <integer>
          lan_extension:
            backhaul:
              -
                name: <string>
                port: <value in [wan, lte1, lte2, ...]>
                role: <value in [primary, secondary]>
                weight: <integer>
            backhaul_interface: <string>
            backhaul_ip: <string>
            ipsec_tunnel: <string>
            link_loadbalance: <value in [activebackup, loadbalance]>
          login_password: <list or string>
          login_password_change: <value in [no, yes, default]>
          model: <value in [FX201E, FX211E, FX200F, ...]>
          name: <string>

返回值

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

键

描述

meta

字典

请求的结果。

返回：始终

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)