cisco.mso.ndo_dhcp_relay_policy 模块 – 在 Cisco Nexus Dashboard Orchestrator (NDO) 上管理 DHCP 中继策略。

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.mso。您需要更多要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：cisco.mso.ndo_dhcp_relay_policy。

概要

• 在 Cisco Nexus Dashboard Orchestrator (NDO) 上管理 DHCP 中继策略。

• 此模块仅在 ND v3.1 (NDO v4.3) 及更高版本上受支持。

要求

在执行此模块的主机上需要以下要求。

• 多站点 Orchestrator v2.1 或更新版本

参数

参数	注释
描述 字符串	DHCP 中继策略的描述。
host 别名: hostname 字符串	ACI 多站点 Orchestrator 主机的 IP 地址或主机名。 如果未在任务中指定该值，则将改用环境变量 MSO_HOST 的值。
login_domain 字符串	用于身份验证的登录域名。 默认值为 Local。 如果未在任务中指定该值，则将改用环境变量 MSO_LOGIN_DOMAIN 的值。 当使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量 ansible_httpapi_login_domain。
output_level 字符串	影响此 MSO 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息性输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果未在任务中指定该值，则将改用环境变量 MSO_OUTPUT_LEVEL 的值。 选择 "debug" "info" "normal" ← (默认)
password 字符串	用于身份验证的密码。 如果未在任务中指定该值，则将改用环境变量 MSO_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数“use_ssl”。 如果未在任务中指定该值，则将改用环境变量 MSO_PORT 的值。
providers 列表 / elements=dictionary	附加到 DHCP 中继策略的提供程序列表。 已配置的提供程序列表必须至少包含一个提供程序。 当提供程序列表为空时，更新不会更改现有的提供程序配置。
anp 字符串	应用程序配置文件 (ANP) 的名称。 当提供 providers.epg 时，此参数是必需的。
epg 字符串	端点组 (EPG) 的名称。 providers.epg 和 providers.external_epg 是互斥的。 当未提供 providers.external_epg 时，需要 providers.epg。
external_epg 字符串	外部端点组 (EPG) 的名称。 providers.external_epg 和 providers.epg 是互斥的。 当未提供 providers.epg 时，则必须提供 providers.external_epg。
ip 字符串 / 必选	DHCP 服务器的 IP 地址。
schema 字符串 / 必选	（外部）EPG 的架构名称。
template 字符串 / 必选	（外部）EPG 的模板名称。
use_server_vrf 布尔值	使用服务器 VRF。 选择 false ← (默认) true
relay_policy 别名: name 字符串	DHCP 中继策略的名称。
relay_policy_uuid 别名: uuid 字符串	DHCP 中继策略的 UUID。 当需要更新 relay_policy 时，此参数是必需的。
state 字符串	使用 absent 进行删除。 使用 query 列出一个或多个对象。 使用 present 进行创建或更新。 选择 "absent" "query" ← (默认) "present"
template 字符串 / 必选	模板的名称。 该模板必须是租户模板。
timeout 整数	套接字级别的超时时间（秒）。 默认值为 30 秒。 如果在任务中未指定该值，则将使用环境变量 MSO_TIMEOUT 的值。
use_proxy 布尔值	如果为 false，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果在任务中未指定该值，则将使用环境变量 MSO_USE_PROXY 的值。 默认为 true。 选择 false true
use_ssl 布尔值	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果在任务中未指定该值，则将使用环境变量 MSO_USE_SSL 的值。 当使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量 ansible_httpapi_use_ssl。 当使用 HTTPAPI 连接插件（mso 或 nd）时，默认值为 false；当使用旧版连接方法（仅适用于 mso）时，默认值为 true。 选择 false true
username 字符串	用于身份验证的用户名。 如果在任务中未指定该值，则将使用环境变量 MSO_USERNAME 或 ANSIBLE_NET_USERNAME 的值。
validate_certs 布尔值	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果在任务中未指定该值，则将使用环境变量 MSO_VALIDATE_CERTS 的值。 默认为 true。 选择 false true

注意

注意

• 此模块旨在支持 Multi Site Orchestrator v2.1 或更高版本。某些或所有功能可能在早期版本上无法工作。

示例

- name: Create a new dhcp relay policy
  cisco.mso.ndo_dhcp_relay_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    relay_policy: ansible_test_relay_policy
    providers:
      - schema: ansible_test_schema
        template: ansible_test_template
        anp: ansible_test_anp
        epg: ansible_test_epg_1
        ip: 1.1.1.1
    state: present

- name: Query a dhcp relay policy with template_name
  cisco.mso.ndo_dhcp_relay_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    relay_policy: ansible_test_relay_policy
    state: query
  register: query_one

- name: Query all dhcp relay policy in the template
  cisco.mso.ndo_dhcp_relay_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    state: query
  register: query_all

- name: Delete a dhcp relay policy
  cisco.mso.ndo_dhcp_relay_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    relay_policy: ansible_test_relay_policy
    state: absent

作者

• Akini Ross (@akinross)

集合链接

• 问题跟踪器
• 主页
• 仓库 (源代码)