fortinet.fortios.fortios_system_dhcp6_server 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 DHCPv6 服务器。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_dhcp6_server。

fortinet.fortios 2.0.0 中的新功能

概要

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

字典

配置 DHCPv6 服务器。

delegated_prefix_iaid

整数

从上游接口获取的委派前缀的 IAID。

dns_search_list

字符串

DNS 搜索列表选项。

选项

  • "delegated"

  • "specify"

dns_server1

字符串

DNS 服务器 1。

dns_server2

字符串

DNS 服务器 2。

dns_server3

字符串

DNS 服务器 3。

dns_server4

字符串

DNS 服务器 4。

dns_service

字符串

将 DNS 服务器分配给 DHCPv6 客户端的选项。

选项

  • "delegated"

  • "default"

  • "specify"

domain

字符串

DHCP 服务器分配给客户端的 IP 地址的域名后缀。

id

整数 / 必需

ID。 请参阅 <a href=’#notes’>备注</a>。

interface

字符串

DHCP 服务器可以将 IP 配置分配给连接到此接口的客户端。源 system.interface.name。

ip_mode

字符串

用于分配客户端 IP 的方法。

选项

  • "range"

  • "delegated"

ip_range

列表 / 元素=字典

DHCP IP 范围配置。

end_ip

字符串

IP 范围的结尾。

id

整数 / 必需

ID。 请参阅 <a href=’#notes’>备注</a>。

start_ip

字符串

IP 范围的开头。

vci_match

字符串

启用/禁用供应商类选项匹配。启用后，只有具有匹配 VC 的 DHCP 请求才会使用此范围。

选项

  • "disable"

  • "enable"

vci_string

列表 / 元素=字典

一个或多个 VCI 字符串，用空格分隔并用引号括起来。

vci_string

字符串 / 必需

VCI 字符串。

lease_time

整数

租用时间（以秒为单位），0 表示无限制。

option1

字符串

选项 1。

option2

字符串

选项 2。

option3

字符串

选项 3。

options

列表 / 元素=字典

DHCPv6 选项。

code

整数

DHCPv6 选项代码。

id

整数 / 必需

ID。 请参阅 <a href=’#notes’>备注</a>。

ip6

列表 / 元素=字符串

DHCP 选项 IP6s。

type

字符串

DHCPv6 选项类型。

选项

  • "hex"

  • "string"

  • "ip6"

  • "fqdn"

value

字符串

DHCPv6 选项值（十六进制值必须为偶数）。

vci_match

字符串

启用/禁用供应商类选项匹配。启用后，只有具有匹配 VCI 的 DHCP 请求才会使用此选项。

选项

  • "disable"

  • "enable"

vci_string

列表 / 元素=字典

一个或多个 VCI 字符串，用空格分隔并用引号括起来。

vci_string

字符串 / 必需

VCI 字符串。

prefix_mode

字符串

从 DHCPv6 客户端或 RA 分配前缀。

选项

  • "dhcp6"

  • "ra"

prefix_range

列表 / 元素=字典

DHCP 前缀配置。

end_prefix

字符串

前缀范围的结尾。

id

整数 / 必需

ID。 请参阅 <a href=’#notes’>备注</a>。

prefix_length

整数

前缀长度。

start_prefix

字符串

前缀范围的开头。

rapid_commit

字符串

启用/禁用允许/不允许快速提交。

选项

  • "disable"

  • "enable"

status

字符串

启用/禁用此 DHCPv6 配置。

选项

  • "disable"

  • "enable"

subnet

字符串

如果 IP 模式为委派，则为子网或子网 ID。

upstream_interface

字符串

提供委派信息的接口名称。源 system.interface.name。

vdom

字符串

虚拟域，在先前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认值： "root"

备注

注意

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

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

  • 该模块支持 check_mode。

示例

- name: Configure DHCPv6 servers.
  fortinet.fortios.fortios_system_dhcp6_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_dhcp6_server:
          delegated_prefix_iaid: "0"
          dns_search_list: "delegated"
          dns_server1: "<your_own_value>"
          dns_server2: "<your_own_value>"
          dns_server3: "<your_own_value>"
          dns_server4: "<your_own_value>"
          dns_service: "delegated"
          domain: "<your_own_value>"
          id: "11"
          interface: "<your_own_value> (source system.interface.name)"
          ip_mode: "range"
          ip_range:
              -
                  end_ip: "<your_own_value>"
                  id: "16"
                  start_ip: "<your_own_value>"
                  vci_match: "disable"
                  vci_string:
                      -
                          vci_string: "<your_own_value>"
          lease_time: "604800"
          option1: "<your_own_value>"
          option2: "<your_own_value>"
          option3: "<your_own_value>"
          options:
              -
                  code: "0"
                  id: "27"
                  ip6: "<your_own_value>"
                  type: "hex"
                  value: "<your_own_value>"
                  vci_match: "disable"
                  vci_string:
                      -
                          vci_string: "<your_own_value>"
          prefix_mode: "dhcp6"
          prefix_range:
              -
                  end_prefix: "<your_own_value>"
                  id: "37"
                  prefix_length: "0"
                  start_prefix: "<your_own_value>"
          rapid_commit: "disable"
          status: "disable"
          subnet: "<your_own_value>"
          upstream_interface: "<your_own_value> (source system.interface.name)"

返回值

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

键

描述

build

字符串

Fortigate 镜像的构建号

返回： 始终

示例： "1547"

http_method

字符串

用于将内容配置到 FortiGate 的最后使用的方法

返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回： 始终

示例： "200"

mkey

字符串

在上次调用 FortiGate 时使用的主密钥 (id)

返回： 成功

示例： "id"

name

字符串

用于完成请求的表名称

返回： 始终

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

返回： 始终

示例: "webfilter"

修订版本

字符串

内部修订号

返回： 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回： 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例: "root"

版本

字符串

FortiGate的版本

返回： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)