fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular 模块 – FortiExtender 蜂窝配置。

注意

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

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

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

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

fortinet.fortimanager 2.2.0 中的新功能

概要

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

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。

adom

字符串 / 必选

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ←（默认）

  • true

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

extender-profile

字符串

已弃用，请使用“extender_profile”

extender_profile

字符串

请求的 URL 中的参数 (extender-profile)。

extensioncontroller_extenderprofile_cellular

字典

设置的顶级参数。

controller_report

别名：controller-report

字典

控制器报告。

interval

整数

控制器报告间隔。

signal_threshold

别名：signal-threshold

整数

控制器报告信号阈值。

status

字符串

FortiExtender 控制器报告状态。

选项

  • "disable"

  • "enable"

dataplan

任何

（列表）数据套餐名称。

modem1

字典

Modem1。

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 卡

选项

  • "disable"

  • "enable"

sim1_pin_code

别名: sim1-pin-code

任何

(列表) SIM 卡

sim2_pin

别名: sim2-pin

字符串

SIM 卡

选项

  • "disable"

  • "enable"

sim2_pin_code

别名: sim2-pin-code

任何

(列表) SIM 卡

modem2

字典

Modem2。

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 卡

选项

  • "disable"

  • "enable"

sim1_pin_code

别名: sim1-pin-code

任何

(列表) SIM 卡

sim2_pin

别名: sim2-pin

字符串

SIM 卡

选项

  • "disable"

  • "enable"

sim2_pin_code

别名: sim2-pin-code

任何

(列表) SIM 卡

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

list / elements=dictionary

接收者。

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"

forticloud_access_token

字符串

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

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

workspace_locking_adom

字符串

在工作区模式下锁定的 FortiManager 的 ADOM，该值可以是全局的，也可以是包括 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 有助于完成此项工作。

  • 通常，当返回非零 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 cellular configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular:
        # 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>
        extender_profile: <your own value>
        extensioncontroller_extenderprofile_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]>

返回值

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

键

描述

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 版本不支持 playbook 中使用的参数，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)