cisco.aci.aci_dhcp_relay_provider 模块 – 管理 DHCP 中继策略提供程序 (dhcp:RsProv)

注意

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

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

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

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

概要

  • 管理 Cisco ACI 架构上的 DHCP 中继策略提供程序配置。

参数

参数

注释

annotation

字符串

用于注释对象的用户定义字符串。

如果任务中未指定该值，则将使用环境变量 ACI_ANNOTATION 的值。

如果任务中未指定该值，并且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。

默认值： "orchestrator:ansible"

anp

字符串

EPG 所在的应用配置文件。

仅当 epg_type 为 app_epg 时使用。

certificate_name

别名: cert_name

字符串

附加到用于基于签名认证的 APIC AAA 用户的 X.509 证书名称。

如果提供了 private_key 文件名，则此值默认为 private_key 的基本名称，不带扩展名。

如果为 private_key 提供了 PEM 格式的内容，则此值默认为 username 值。

如果任务中未指定该值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。

dhcp_server_addr

字符串

DHCP 服务器地址

dn

字符串

DHCP 服务器所在的 EPG 的 dn

仅当 epg_type 为 dn 时使用

epg

别名: app_epg

字符串

DHCP 服务器所在的应用 EPG 的名称。

仅当 epg_type 为 epg 时使用

epg_type

字符串

DHCP 服务器所在的 EPG 类型

选项

  • "epg"

  • "l2_external"

  • "l3_external"

  • "dn"

external_epg

别名: external_net

字符串

DHCP 服务器所在的外部网络对象的名称。

仅当 epg_type 为 l2_external 或 l3_external 时使用。

host

别名: hostname

字符串

Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。

如果任务中未指定该值，则将使用环境变量 ACI_HOST 的值。

l2out_name

字符串

DHCP 服务器所在的 L2out 的名称。

仅当 epg_type 为 l2_external 时使用

l3out_name

字符串

DHCP 服务器所在的 L3out 的名称。

仅当 epg_type 为 l3_external 时使用。

output_level

字符串

影响此 ACI 模块的输出。

normal 表示标准输出，包括 current 字典

info 添加信息输出，包括 previous、proposed 和 sent 字典

debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息

如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_LEVEL 的值。

选项

  • "debug"

  • "info"

  • "normal" ← (默认)

output_path

字符串

用于转储模块生成的 ACI JSON 配置对象的文件路径。

如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_PATH 的值。

password

字符串

用于身份验证的密码。

此选项与 private_key 互斥。如果也提供了 private_key，则将使用它。

如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。

port

整数

用于 REST 连接的端口号。

默认值取决于参数 use_ssl。

如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值。

private_key

别名: cert_key

字符串

用于基于签名身份验证的 PEM 格式的私钥文件或私钥内容。

此值还会影响所使用的默认 certificate_name。

此选项与 password 互斥。如果也提供了 password，则会忽略它。

如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。

provider_tenant

字符串

epg 或 external_epg 所在的租户的名称

当 epg 或 external_epg 与 relay_policy 位于不同的租户中时，需要此项

当全局 (infra) 中继策略配置为 epg 或 external_epg 类型时，此为必选项。

relay_policy

别名: relay_policy_name

字符串

现有 DHCP 中继策略的名称

状态

字符串

使用 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

租户

字符串

中继策略所在的租户的名称。

当未提供租户时，该模块将应用于全局 (infra) 策略。

超时

整数

套接字级别的超时时间（秒）。

如果任务中未指定该值，则将改为使用环境变量 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

字符串

用于身份验证的用户名。

如果任务中未指定该值，则将改为使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。

默认值为 admin。

validate_certs

布尔值

如果为 false，则不会验证 SSL 证书。

仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。

如果任务中未指定该值，则将改为使用环境变量 ACI_VALIDATE_CERTS 的值。

默认值为 true。

选项

  • false

  • true

注释

注意

  • 在 playbook 中使用此模块之前，必须存在 tenant 和 relay_policy。可以使用 cisco.aci.aci_tenant 和 cisco.aci.aci_dhcp_relay 模块来实现此目的。

另请参阅

另请参阅

APIC 管理信息模型参考

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

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new DHCP relay App EPG provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    dhcp_server_addr: 10.20.30.40
    state: present
  delegate_to: localhost

- name: Add a new Global (infra) DHCP relay App EPG provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    relay_policy: my_dhcp_relay
    provider_tenant: Auto-Demo
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    dhcp_server_addr: 10.20.30.40
    state: present
  delegate_to: localhost

- name: Add a new DHCP relay L3out provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: l3_external
    l3out_name: my_l3out
    external_net: my_l3out_ext_net
    dhcp_server_addr: 10.20.30.40
    state: present
  delegate_to: localhost

- name: Remove a DHCP relay provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    state: absent
  delegate_to: localhost

- name: Remove a Global (infra) DHCP relay provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    relay_policy: my_dhcp_relay
    provider_tenant: Auto-Demo
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    state: absent
  delegate_to: localhost

- name: Query a DHCP relay provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a Global (infra) DHCP relay provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    relay_policy: my_dhcp_relay
    provider_tenant: Auto-Demo
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all DHCP relay providers in a specific tenant
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all DHCP relay providers
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键

描述

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

字符串

用于请求的筛选字符串

已返回: 失败或调试

示例: "?rsp-prop-include=config-only"

method

字符串

用于向 APIC 发出请求的 HTTP 方法

已返回: 失败或调试

示例: "POST"

previous

list / elements=string

模块启动之前，来自 APIC 的原始配置

已返回: 信息

示例: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

字典

从用户提供的参数组装的配置

已返回: 信息

示例: {"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}

raw

字符串

APIC REST API 返回的原始输出 (xml 或 json)

已返回: 解析错误

示例: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"未知托管对象类 \"/></imdata>"

response

字符串

来自 APIC 的 HTTP 响应

已返回: 失败或调试

示例: "OK (30 字节)"

sent

list / elements=string

推送到 APIC 的实际/最小配置

已返回: 信息

示例: {"fvTenant": {"attributes": {"descr": "生产环境"}}}

status

整数

来自 APIC 的 HTTP 状态

已返回: 失败或调试

示例: 200

url

字符串

用于向 APIC 发出请求的 HTTP URL

已返回: 失败或调试

示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

  • Tim Cragg (@timcragg)

  • Akini Ross (@akinross)