fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1 模块 – 调制解调器 1 的配置选项。

注意

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

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

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

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

fortinet.fortimanager 2.1.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)。

extendercontroller_extenderprofile_cellular_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卡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码

forticloud_access_token

字符串

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

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

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有助于完成此工作。

  • 通常，当返回非零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: Configuration options for modem 1.
      fortinet.fortimanager.fmgr_extendercontroller_extenderprofile_cellular_modem1:
        # 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>
        extendercontroller_extenderprofile_cellular_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>

返回值

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

键

描述

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)