cisco.aci.aci_bd_dhcp_label 模块 – 管理 DHCP 标签 (dhcp:Lbl)

注意

此模块是 cisco.aci 集合（版本 2.10.1）的一部分。

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

要安装它，请使用：ansible-galaxy collection install cisco.aci。

要在 playbook 中使用它，请指定：cisco.aci.aci_bd_dhcp_label。

概要

• 管理 Cisco ACI 结构上的 DHCP 标签。

参数

参数	注释
annotation string	用于注释对象的用户定义字符串。 如果在任务中未指定值，则将使用环境变量 ACI_ANNOTATION 的值。 如果在任务中未指定值且环境变量 ACI_ANNOTATION 未设置，则将使用默认值。 默认值： "orchestrator:ansible"
bd 别名：bd_name string	桥域的名称。
certificate_name 别名：cert_name string	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果在任务中未指定值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
description 别名：descr string	DHCP 标签的描述。
dhcp_label 别名：name string	DHCP 中继标签的名称。
dhcp_option string	要与 DCHP 中继策略关联的 DHCP 选项策略的名称。此策略需要与桥域位于同一租户中。 DHCP 选项用于向 DHCP 客户端提供配置参数，例如域名、名称服务器、子网和网络地址。
host 别名：hostname string	可通过 Ansible 控制主机解析的 APIC 的 IP 地址或主机名。 如果在任务中未指定值，则将使用环境变量 ACI_HOST 的值。
output_level string	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息性输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果在任务中未指定值，则将使用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ←（默认值）
output_path string	将用于转储模块生成的 ACI JSON 配置对象的文件的路径。 如果在任务中未指定值，则将使用环境变量 ACI_OUTPUT_PATH 的值。
owner_key string	用于 ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示一个键，使客户端能够拥有其用于实体关联的数据。 如果在任务中未指定值，则将使用环境变量 ACI_OWNER_KEY 的值。
owner_tag string	用于 ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，使客户端能够添加自己的数据。 例如，指示谁创建了此对象。 如果在任务中未指定值，则将使用环境变量 ACI_OWNER_TAG 的值。
password string	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将使用它。 如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
端口 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值。
private_key 别名：cert_key string	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将被忽略。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
scope 别名：owner string	表示目标中继服务器的所有权。 选项 "infra" ← (默认) "tenant"
state string	使用 present 或 absent 进行添加或删除。 使用 query 列出一个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous 别名：no_previous, ignore_previous 布尔值	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 请求来检查先前的状态。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 将不检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 true，则在向 APIC 发送 POST 更新之后，不会发送验证 GET 请求。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 在单个任务中，无法验证包含默认值的当前对象。 选项 false true
tenant 别名：tenant_name string	租户的名称。
超时 整数	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
use_proxy 布尔值	如果为 false，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将使用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false true
use_ssl 布尔值	如果为 false，将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将使用环境变量 ACI_USE_SSL 的值。 当连接是本地连接时，默认值为 true。 选项 false true
username 别名：user string	用于身份验证的用户名。 如果任务中未指定该值，则将使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
validate_certs 布尔值	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将使用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true

说明

注意

• DHCP 中继标签包含标签的 name、scope 和 DHCP 选项策略。范围是中继服务器的 owner，DHCP 选项策略为 DHCP 客户端提供配置参数，例如域、名称服务器和子网路由器地址。

• 在使用此模块之前，必须存在所使用的 tenant 和 bd。可以使用 cisco.aci.aci_tenant 模块和 cisco.aci.aci_bd 来完成这些操作。

另请参阅

另请参阅

cisco.aci.aci_bd

管理桥域 (BD) 对象 (fv:BD)。

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

APIC 管理信息模型参考

有关内部 APIC 类 dhcp:Lbl 的更多信息。

Cisco ACI 指南

有关如何使用 Ansible 管理 ACI 基础设施的详细信息。

开发 Cisco ACI 模块

有关如何编写自己的 Cisco ACI 模块以进行贡献的详细指南。

示例

- name: Create a new DHCP Relay Label to a Bridge Domain
  cisco.aci.aci_bd_dhcp_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    dhcp_label: label1
    scope: infra
    state: present

- name: Query a DHCP Relay Label of a Bridge Domain
  cisco.aci.aci_bd_dhcp_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    dhcp_label: label1
    scope: infra
    state: query

- name: Query all DHCP Relay Labels of a Bridge Domain
  cisco.aci.aci_bd_dhcp_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    state: query

- name: Remove a DHCP Relay Label for a Bridge Domain
  cisco.aci.aci_bd_dhcp_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    dhcp_label: label1
    scope: infra
    state: absent

返回值

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

键	描述
current list / elements=string	模块完成后，来自 APIC 的现有配置 已返回： 成功 示例： [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 APIC 返回的错误信息 已返回： 失败 示例： {"code": "122", "text": "未知的托管对象类 foo"}
filter_string string	用于请求的筛选字符串 已返回： 失败或调试 示例： "?rsp-prop-include=config-only"
method string	用于向 APIC 发出请求的 HTTP 方法 已返回： 失败或调试 示例： "POST"
previous list / elements=string	模块启动前来自 APIC 的原始配置 已返回： 信息 示例： [{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	从用户提供的参数组装的配置 已返回： 信息 示例： {"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}
raw string	APIC REST API 返回的原始输出（xml 或 json） 已返回： 解析错误 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"未知的托管对象类 foo\"/></imdata>"
response string	来自 APIC 的 HTTP 响应 已返回： 失败或调试 示例： "OK (30 字节)"
sent list / elements=string	推送到 APIC 的实际/最小配置 已返回： 信息 示例： {"fvTenant": {"attributes": {"descr": "生产环境"}}}
status 整数	来自 APIC 的 HTTP 状态 已返回： 失败或调试 示例： 200
url string	用于向 APIC 发出请求的 HTTP url 已返回： 失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• sig9 (@sig9org)

• Dag Wieers (@dagwieers)

集合链接

• 问题跟踪器
• 存储库（源代码）