fortinet.fortios.fortios_system_pppoe_interface 模块 – 配置 Fortinet FortiOS 和 FortiGate 中的 PPPoE 接口。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备，允许用户设置和修改系统功能和 pppoe_interface 类别。示例包括所有参数，使用前需要将值调整到数据源。在 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_pppoe_interface

字典

配置 PPPoE 接口。

ac_name

字符串

PPPoE AC 名称。

auth_type

字符串

要使用的 PPP 身份验证类型。

选项

  • "auto"

  • "pap"

  • "chap"

  • "mschapv1"

  • "mschapv2"

device

字符串

物理接口的名称。源 system.interface.name。

dial_on_demand

字符串

启用/禁用按需拨号，以便在将数据包路由到 PPPoE 接口时拨打 PPPoE 接口。

选项

  • "enable"

  • "disable"

disc_retry_timeout

整数

PPPoE 发现初始化超时值（0-4294967295 秒）。

idle_timeout

整数

空闲超时后 PPPoE 自动断开连接（0-4294967295 秒）。

ipunnumbered

字符串

PPPoE 无编号 IP。

ipv6

字符串

启用/禁用 IPv6 控制协议 (IPv6CP)。

选项

  • "enable"

  • "disable"

lcp_echo_interval

整数

PPPoE 链路控制协议 (LCP) 回显请求之间的时间（以秒为单位）。

lcp_max_echo_fails

整数

断开连接前丢失的最大 LCP 回显消息数。

name

字符串 / 必需

PPPoE 接口的名称。

padt_retry_timeout

整数

PPPoE 终止超时值（0-4294967295 秒）。

password

字符串

输入密码。

pppoe_egress_cos

字符串

出站 PPPoE/PPP 数据包的 VLAN 标记中的 CoS。

选项

  • "cos0"

  • "cos1"

  • "cos2"

  • "cos3"

  • "cos4"

  • "cos5"

  • "cos6"

  • "cos7"

pppoe_unnumbered_negotiate

字符串

启用/禁用 PPPoE 无编号协商。

选项

  • "enable"

  • "disable"

service_name

字符串

PPPoE 服务名称。

username

字符串

用户名。

vdom

字符串

虚拟域，在之前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以将其配置和用作不同的单元。

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式。

  • 此模块支持 check_mode。

示例

- name: Configure the PPPoE interfaces.
  fortinet.fortios.fortios_system_pppoe_interface:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_pppoe_interface:
          ac_name: "<your_own_value>"
          auth_type: "auto"
          device: "<your_own_value> (source system.interface.name)"
          dial_on_demand: "enable"
          disc_retry_timeout: "1"
          idle_timeout: "0"
          ipunnumbered: "<your_own_value>"
          ipv6: "enable"
          lcp_echo_interval: "5"
          lcp_max_echo_fails: "3"
          name: "default_name_13"
          padt_retry_timeout: "1"
          password: "<your_own_value>"
          pppoe_egress_cos: "cos0"
          pppoe_unnumbered_negotiate: "enable"
          service_name: "<your_own_value>"
          username: "<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"

作者

  • 郑凌 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)