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。您需要其他要求才能使用此模块，有关详细信息，请参阅需求。

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

概要 

在 Cisco Nexus Dashboard Orchestrator (NDO) 上管理 DHCP 中继策略。
此模块仅在 ND v3.1 (NDO v4.3) 及更高版本上受支持。

需求 

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

Multi Site Orchestrator v2.1 或更高版本

参数 

参数	注释
description 字符串	DHCP 中继策略的描述。
host 别名：hostname 字符串	ACI Multi Site 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 列表 / 元素=字典	附加到 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)