cisco.mso.mso_dhcp_relay_policy_provider 模块 – 在 DHCP 中继策略中管理 DHCP 提供程序。

注意

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

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

要安装它,请使用: ansible-galaxy collection install cisco.mso。您需要其他要求才能使用此模块,请参阅 需求 以了解详细信息。

要在 playbook 中使用它,请指定: cisco.mso.mso_dhcp_relay_policy_provider

概要

  • 在 Cisco Multi-Site Orchestrator 上管理 DHCP 中继策略中的 DHCP 提供程序。

  • 此模块仅支持 v4.0 之前的 NDO 版本。

需求

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

  • Multi Site Orchestrator v2.1 或更高版本

参数

参数

注释

application_profile

别名:anp

字符串

配置 DHCP 提供程序的应用程序配置文件

dhcp_relay_policy

别名:name

字符串 / 必需

DHCP 中继策略的名称

endpoint_group

别名:epg

字符串

配置 DHCP 提供程序的 EPG

external_endpoint_group

别名:ext_epg, external_epg

字符串

配置 DHCP 提供程序的外部 EPG

host

别名:hostname

字符串

ACI Multi Site Orchestrator 主机的 IP 地址或主机名。

如果任务中未指定值,则将使用环境变量 MSO_HOST 的值。

ip

字符串

DHCP 服务器的 IP 地址

login_domain

字符串

用于身份验证的登录域名称。

默认值为 Local。

如果任务中未指定值,则将使用环境变量 MSO_LOGIN_DOMAIN 的值。

使用 HTTPAPI 连接插件时,如果未指定此属性,将使用清单变量 ansible_httpapi_login_domain

output_level

字符串

影响此 MSO 模块的输出。

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

info 添加信息输出,包括 previousproposedsent 字典

debug 添加调试输出,包括 filter_stringmethodresponsestatusurl 信息

如果任务中未指定值,则将使用环境变量 MSO_OUTPUT_LEVEL 的值。

选项

  • "debug"

  • "info"

  • "normal" ← (默认)

password

字符串

用于身份验证的密码。

如果任务中未指定值,则将使用环境变量 MSO_PASSWORDANSIBLE_NET_PASSWORD 的值。

port

整数

用于 REST 连接的端口号。

默认值取决于参数 `use_ssl`。

如果任务中未指定值,则将使用环境变量 MSO_PORT 的值。

schema

字符串

配置 DHCP 提供程序的架构

state

字符串

使用 presentabsent 来添加或删除。

使用 query 来列出一个对象或多个对象。

选项

  • "absent"

  • "present" ← (默认)

  • "query"

template

字符串

配置 DHCP 提供程序的模板

tenant

字符串

DHCP 提供程序所在的租户。

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_USERNAMEANSIBLE_NET_USERNAME的值。

validate_certs

布尔值

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

只有在使用自签名证书的个人控制站点上时,才应将其设置为false

如果任务中未指定值,则将使用环境变量MSO_VALIDATE_CERTS的值。

默认为true

选项

  • false

  • true

注释

注意

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

示例

- name: Add a new provider to a DHCP Relay Policy
  cisco.mso.mso_dhcp_relay_policy_provider:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_relay_policy: my_test_dhcp_policy
    tenant: ansible_test
    schema: ansible_test
    template: Template 1
    application_profile: ansible_test
    endpoint_group: ansible_test
    state: present

- name: Remove a provider to a DHCP Relay Policy
  cisco.mso.mso_dhcp_relay_policy_provider:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_relay_policy: my_test_dhcp_policy
    tenant: ansible_test
    schema: ansible_test
    template: Template 1
    application_profile: ansible_test
    endpoint_group: ansible_test
    state: absent

- name: Query a provider to a DHCP Relay Policy
  cisco.mso.mso_dhcp_relay_policy_provider:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_relay_policy: my_test_dhcp_policy
    tenant: ansible_test
    schema: ansible_test
    template: Template 1
    application_profile: ansible_test
    endpoint_group: ansible_test
    state: query
  register: query_result

- name: Query all provider of a DHCP Relay Policy
  cisco.mso.mso_dhcp_relay_policy_provider:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_relay_policy: my_test_dhcp_policy
    state: query
  register: query_result

作者

  • Jorge Gomez (@jorgegome2307)