fortinet.fortios.fortios_system_modem 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 MODEM。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您正在使用 ansible
软件包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install fortinet.fortios
。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。
要在 playbook 中使用它,请指定: fortinet.fortios.fortios_system_modem
。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改系统功能和调制解调器类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,在使用前需要将值调整到数据源。已在 FOS v6.0.0 上测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 FortiGate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性,则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选项
|
|
配置 MODEM。 |
|
拨号/停止 MODEM。 选项
|
|
在中国使用 PPP 安装时启用/禁用 altmode。 选项
|
|
允许用于 ISP 1 的身份验证类型。 选项
|
|
允许用于 ISP 2 的身份验证类型。 选项
|
|
允许用于 ISP 3 的身份验证类型。 选项
|
|
在重新引导或断开连接后启用/禁用自动拨号。 选项
|
|
连接完成超时 (30-255 秒)。 |
|
拨号命令(这通常是 ATD 或 ATDT 命令)。 |
|
拨号命令(这通常是 ATD 或 ATDT 命令)。 |
|
拨号命令(这通常是 ATD 或 ATDT 命令)。 |
|
启用/禁用在数据包路由到调制解调器接口时拨打调制解调器。 选项
|
|
学习路由的距离 (1-255)。 |
|
连接时不发送 CR (ISP1)。 选项
|
|
连接时不发送 CR (ISP2)。 选项
|
|
连接时不发送 CR (ISP3)。 选项
|
|
向 ISP 1 发送额外的初始化字符串。 |
|
向 ISP 2 发送额外的初始化字符串。 |
|
向 ISP 3 发送额外的初始化字符串。 |
|
保持计时器,单位为秒 (1-60 秒)。 |
|
MODEM 连接空闲时间 (1-9999 分钟)。 |
|
冗余接口的名称。源 system.interface.name。 |
|
只允许连接到指定的地理位置区域代码 (LAC)。 |
|
将 MODEM 操作模式设置为冗余或独立。 选项
|
|
设置网络名称/类型的 AT 命令 (AT+COPS=<mode>,[<format>,<oper>[,<AcT>]])。 |
|
访问指定的拨号帐户的密码。 |
|
访问指定的拨号帐户的密码。 |
|
访问指定的拨号帐户的密码。 |
|
指定电话 1 的对等 MODEM 类型。 选项
|
|
指定电话 2 的对等 MODEM 类型。 选项
|
|
指定电话 3 的对等 MODEM 类型。 选项
|
|
要连接到的拨号帐户的电话号码(不得包含空格,应包含标准特殊字符)。 |
|
要连接到的拨号帐户的电话号码(不得包含空格,应包含标准特殊字符)。 |
|
要连接到的拨号帐户的电话号码(不得包含空格,应包含标准特殊字符)。 |
|
设置 PIN 的 AT 命令 (AT+PIN=<pin>)。 |
|
启用/禁用对 ISP 1 的 PPP 回显请求。 选项
|
|
启用/禁用对 ISP 2 的 PPP 回显请求。 选项
|
|
启用/禁用对 ISP 3 的 PPP 回显请求。 选项
|
|
学习路由的优先级 (1-65535)。 |
|
重拨限制 (1-10 次尝试,无 = 永久重拨)。 选项
|
|
重置调制解调器之前的拨号尝试次数 (0 = 从不重置)。 |
|
启用/禁用调制解调器支持(相当于启用或禁用接口)。 选项
|
|
启用/禁用流量检查。 选项
|
|
访问指定的拨号帐户的用户名。 |
|
访问指定的拨号帐户的用户名。 |
|
访问指定的拨号帐户的用户名。 |
|
输入无线端口号:0 为默认值,1 为第一个端口,依此类推 (0-4294967295)。 |
|
虚拟域,在先前定义的那些虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。 默认值: |
注释
注意
旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方法。
示例
- name: Configure MODEM.
fortinet.fortios.fortios_system_modem:
vdom: "{{ vdom }}"
system_modem:
action: "dial"
altmode: "enable"
authtype1: "pap"
authtype2: "pap"
authtype3: "pap"
auto_dial: "enable"
connect_timeout: "90"
dial_cmd1: "<your_own_value>"
dial_cmd2: "<your_own_value>"
dial_cmd3: "<your_own_value>"
dial_on_demand: "enable"
distance: "1"
dont_send_CR1: "enable"
dont_send_CR2: "enable"
dont_send_CR3: "enable"
extra_init1: "<your_own_value>"
extra_init2: "<your_own_value>"
extra_init3: "<your_own_value>"
holddown_timer: "60"
idle_timer: "5"
interface: "<your_own_value> (source system.interface.name)"
lockdown_lac: "<your_own_value>"
mode: "standalone"
network_init: "<your_own_value>"
passwd1: "<your_own_value>"
passwd2: "<your_own_value>"
passwd3: "<your_own_value>"
peer_modem1: "generic"
peer_modem2: "generic"
peer_modem3: "generic"
phone1: "<your_own_value>"
phone2: "<your_own_value>"
phone3: "<your_own_value>"
pin_init: "<your_own_value>"
ppp_echo_request1: "enable"
ppp_echo_request2: "enable"
ppp_echo_request3: "enable"
priority: "1"
redial: "none"
reset: "0"
status: "enable"
traffic_check: "enable"
username1: "<your_own_value>"
username2: "<your_own_value>"
username3: "<your_own_value>"
wireless_port: "0"
返回值
常见返回值已记录在 此处,以下是此模块特有的字段。
键 |
描述 |
---|---|
FortiGate 镜像的版本号 返回:始终 示例: |
|
最后用于将内容置备到 FortiGate 的方法 返回:始终 示例: |
|
FortiGate 上次操作返回的最后结果 返回:始终 示例: |
|
最后一次调用 FortiGate 时使用的主密钥 (ID) 返回:成功 示例: |
|
用于完成请求的表名称 返回:始终 示例: |
|
用于完成请求的表路径 返回:始终 示例: |
|
内部版本号 返回:始终 示例: |
|
设备序列号 返回:始终 示例: |
|
操作结果指示 返回:始终 示例: |
|
使用的虚拟域 返回:始终 示例: |
|
FortiGate 版本 返回:始终 示例: |