fortinet.fortimanager.fmgr_extendercontroller_simprofile 模块 – 扩展器控制器 SIM 配置文件

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选择

  • false ←（默认）

  • true

enable_log

布尔值

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

选择

  • false ←（默认）

  • true

extendercontroller_simprofile

字典

设置的顶级参数。

auto_switch_profile

别名：auto-switch_profile

字典

自动切换配置文件。

dataplan

字符串

数据计划。

选择

  • "disable"

  • "enable"

disconnect

字符串

断开连接。

选择

  • "disable"

  • "enable"

disconnect_period

别名：disconnect-period

整数

断开连接时间段。

disconnect_threshold

别名：disconnect-threshold

整数

断开连接阈值。

signal

字符串

信号。

选择

  • "disable"

  • "enable"

status

字符串

状态。

选择

  • "disable"

  • "enable"

switch_back

别名：switch-back

列表 / elements=字符串

切换回去。

选择

  • "time"

  • "timer"

switch_back_time

别名：switch-back-time

字符串

切换回时间。

switch_back_timer

别名：switch-back-timer

整数

切换回计时器。

conn_status

别名：conn-status

整数

连接状态。

default_sim

别名：default-sim

字符串

默认 SIM 卡。

选择

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

description

字符串

描述。

gps

字符串

GPS。

选择

  • "disable"

  • "enable"

modem_id

别名：modem-id

整数

调制解调器 ID。

name

字符串 / 必需

名称。

preferred_carrier

别名：preferred-carrier

字符串

首选运营商。

redundant_intf

别名：redundant-intf

字符串

冗余接口。

redundant_mode

别名：redundant-mode

字符串

冗余模式。

选择

  • "disable"

  • "enable"

sim1_pin

别名：sim1-pin

字符串

SIM1 PIN 码。

选择

  • "disable"

  • "enable"

sim1_pin_code

别名：sim1-pin-code

任意

（列表）SIM1 PIN 码。

sim2_pin

别名：sim2-pin

字符串

SIM2 PIN 码。

选择

  • "disable"

  • "enable"

sim2_pin_code

别名：sim2-pin-code

任意

（列表）SIM2 PIN 码。

status

字符串

状态。

选择

  • "disable"

  • "enable"

forticloud_access_token

字符串

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

proposed_method

字符串

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

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=整数

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

rc_succeeded

列表 / elements=整数

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

state

字符串 / 必需

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

选择

  • "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: Extender controller sim profile
      fortinet.fortimanager.fmgr_extendercontroller_simprofile:
        # 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_simprofile:
          auto_switch_profile:
            dataplan: <value in [disable, enable]>
            disconnect: <value in [disable, enable]>
            disconnect_period: <integer>
            disconnect_threshold: <integer>
            signal: <value in [disable, enable]>
            status: <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, ...]>
          description: <string>
          gps: <value in [disable, enable]>
          modem_id: <integer>
          name: <string>
          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>
          status: <value in [disable, enable]>

返回值

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

键

描述

meta

字典

请求的结果。

返回: 总是

request_url

字符串

请求的完整 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 总是

示例: 0

response_data

列表 / elements=字符串

API 响应。

返回: 总是

response_message

字符串

API 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

列表 / elements=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)