fortinet.fortios.fortios_system_3g_modem_custom 模块 – Fortinet FortiOS 和 FortiGate 中的 3G 调制解调器自定义。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_system_3g_modem_custom

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选择

  • "present"

  • "absent"

state

字符串 / 必需

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

选择

  • "present"

  • "absent"

system_3g_modem_custom

字典

3G 调制解调器自定义。

class_id

字符串

十六进制格式(00-ff)的 USB 接口类。

id

整数 / 必需

ID。请参阅 说明

init_string

字符串

十六进制格式的初始化字符串(偶数长度)。

model

字符串

调制解调器型号名称。

modeswitch_string

字符串

USB 模式切换参数。例如:“-v 1410 -p 9030 -V 1410 -P 9032 -u 3”。

product_id

字符串

十六进制格式(0000-ffff)的 USB 产品 ID。

vendor

字符串

调制解调器供应商名称。

vendor_id

字符串

十六进制格式(0000-ffff)的 USB 供应商 ID。

vdom

字符串

先前定义的虚拟域。vdom 是 FortiGate 的虚拟实例,可以配置为不同的单元并使用。

默认: "root"

说明

注意

  • 我们强烈建议使用您自己的值作为 id,而不是 0,虽然 “0” 是一个特殊的占位符,允许后端为对象分配最新的可用编号,但它确实存在限制。请在问答中找到更多详细信息。

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

  • 该模块支持 check_mode。

示例

- name: 3G MODEM custom.
  fortinet.fortios.fortios_system_3g_modem_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_3g_modem_custom:
          class_id: "<your_own_value>"
          id: "4"
          init_string: "<your_own_value>"
          model: "<your_own_value>"
          modeswitch_string: "<your_own_value>"
          product_id: "<your_own_value>"
          vendor: "<your_own_value>"
          vendor_id: "<your_own_value>"

返回值

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

描述

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)