community.windows.win_dhcp_lease 模块 – 管理 Windows Server DHCP 租约
注意
此模块是 community.windows 集合（版本 2.3.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.windows。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定：community.windows.win_dhcp_lease。
概要
管理 Windows Server DHCP 租约（仅限 IPv4）
添加、删除和修改 DHCP 租约和预留
任务应委托给 Windows DHCP 服务器
要求
执行此模块的主机上需要满足以下要求。
此模块需要 Windows Server 2012 或更高版本
参数
参数 |
注释 |
|---|---|
指定要创建的预留的描述。 仅适用于 l(type=reservation)。 |
|
指定要添加 IP 地址租约的客户端的 DNS 主机名。 |
|
指示 DHCP 服务器服务为此租约注册的 DNS 记录类型。 l(a) 导致注册 A 记录。 l(aptr) 导致注册 A 和 PTR 记录。 l(noreg) 导致不注册任何 DNS 记录。 选项
|
|
指定 DHCP 租约的持续时间（以天为单位）。 持续时间值仅适用于 l(type=lease)。 默认为 DHCP 服务器配置指定的持续时间。 仅适用于 l(type=lease)。 |
|
客户端服务器/计算机的 IPv4 地址。 如果未设置 l(mac)，则这是一个必需的参数。 可以用来代替 l(mac) 来标识现有租约/预留。 |
|
指定要在 IPv4 地址上设置的客户端标识符。 如果未设置 l(ip)，则这是一个必需的参数。 Windows 客户端使用 MAC 地址作为客户端 ID。 Linux 和其他操作系统可以使用其他类型的标识符。 可以用来代替 l(ip) 来标识现有租约/预留。 |
|
指定要创建的预留的名称。 仅适用于 l(type=reservation)。 |
|
指定 DHCP 服务器定义的范围标识符。 如果 l(state=present) 并且预留或租约尚不存在，则这是一个必需的参数。如果更新现有租约或预留，则不是必需的。 |
|
指定 DHCP 租约或预留的所需状态。 选项
|
|
DHCP 地址的类型。 租约按照 l(duration) 的定义过期。 当未指定 l(duration) 时，将使用服务器默认值。 预留是永久的。 选项
|
示例
- name: Ensure DHCP reservation exists
community.windows.win_dhcp_lease:
type: reservation
ip: 192.168.100.205
scope_id: 192.168.100.0
mac: 00:B1:8A:D1:5A:1F
dns_hostname: "{{ ansible_inventory }}"
description: Testing Server
- name: Ensure DHCP lease or reservation does not exist
community.windows.win_dhcp_lease:
mac: 00:B1:8A:D1:5A:1F
state: absent
- name: Ensure DHCP lease or reservation does not exist
community.windows.win_dhcp_lease:
ip: 192.168.100.205
state: absent
- name: Convert DHCP lease to reservation & update description
community.windows.win_dhcp_lease:
type: reservation
ip: 192.168.100.205
description: Testing Server
- name: Convert DHCP reservation to lease
community.windows.win_dhcp_lease:
type: lease
ip: 192.168.100.205
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
新的/更新的 DHCP 对象参数 返回：当 l(state=present) 时 示例： |