community.general.omapi_host 模块 – 设置 OMAPI 主机
注意
此模块是 community.general 集合(版本 10.1.0)的一部分。
如果您使用的是 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.general
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定:community.general.omapi_host
。
概要
管理 OMAPI 主机到兼容的 DHCPd 服务器
要求
执行此模块的主机需要以下要求。
pypureomapi
参数
参数 |
注释 |
---|---|
为此主机启用动态 DNS 更新。 选项
|
|
设置要与之交互的 OMAPI 服务器主机。 默认值: |
|
设置主机租约主机名(如果 state=present 则必须)。 |
|
设置租约主机 IP 地址。 |
|
设置用于针对 OMAPI 服务器进行身份验证的 TSIG 密钥内容。 |
|
设置用于针对 OMAPI 服务器进行身份验证的 TSIG 密钥名称。 |
|
设置租约主机 MAC 地址。 |
|
设置要与之交互的 OMAPI 服务器端口。 默认值: |
|
创建或删除 OMAPI 主机。 选项
|
|
将 OMAPI DHCP 语句列表附加到主机租约(不带结尾的分号)。 默认值: |
属性
属性 |
支持 |
描述 |
---|---|---|
支持: 无 |
可以在 |
|
支持: 无 |
当处于差异模式时,将返回有关已更改内容(或可能需要在 |
示例
- name: Add a host using OMAPI
community.general.omapi_host:
key_name: defomapi
key: +bFQtBCta6j2vWkjPkNFtgA==
host: 10.98.4.55
macaddr: 44:dd:ab:dd:11:44
name: server01
ip: 192.168.88.99
ddns: true
statements:
- filename "pxelinux.0"
- next-server 1.1.1.1
state: present
- name: Remove a host using OMAPI
community.general.omapi_host:
key_name: defomapi
key: +bFQtBCta6j2vWkjPkNFtgA==
host: 10.1.1.1
macaddr: 00:66:ab:dd:11:44
state: absent
返回值
常见的返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
包含主机信息的字典 返回: 成功 |
|
MAC 地址 返回: 成功 示例: |
|
硬件类型,通常为 '1' 返回: 成功 示例: |
|
IP 地址,如果存在。 返回: 成功 示例: |
|
主机名 返回: 成功 示例: |