cisco.mso.ndo_schema_template_bd_dhcp_policy 模块 – 管理模式模板中的 BD DHCP 策略

注意

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

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

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

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

概要

  • 管理 Cisco ACI Multi-Site 上模式模板中的 BD DHCP 策略。

要求

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

  • 多站点编排器 v2.1 或更高版本

参数

参数

注释

bd

字符串 / 必需

要管理的 BD 的名称。

dhcp_option_policy

字符串

DHCP 选项策略的名称。

当提供 dhcp_option_policy 时,还必须提供 dhcp_relay_policy

dhcp_relay_policy

字符串

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 添加信息输出,包括 previousproposedsent 字典

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

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

选择

  • "debug"

  • "info"

  • "normal" ← (默认)

password

字符串

用于身份验证的密码。

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

port

整数

用于 REST 连接的端口号。

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

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

schema

字符串 / 必需

模式的名称。

state

字符串

使用 presentabsent 添加或删除。

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

选择

  • "absent"(不存在)

  • "present" ← (默认)

  • "query"(查询)

template(模板)

字符串 / 必需

要更改的模板的名称。

timeout(超时)

整数

套接字级别的超时时间,以秒为单位。

默认值为 30 秒。

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

use_proxy(使用代理)

boolean(布尔值)

如果为 false,即使目标主机上的环境变量中定义了代理,也不会使用代理。

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

默认值为 true

选择

  • false(假)

  • true(真)

use_ssl(使用 SSL)

boolean(布尔值)

如果为 false,将使用 HTTP 连接而不是默认的 HTTPS 连接。

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

当使用 HTTPAPI 连接插件时,如果未指定此属性,将使用 inventory 变量 ansible_httpapi_use_ssl

当使用 HTTPAPI 连接插件 (mso 或 nd) 时,默认值为 false;当使用旧的连接方法(仅适用于 mso)时,默认值为 true

选择

  • false(假)

  • true(真)

username(用户名)

字符串

用于身份验证的用户名。

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

validate_certs(验证证书)

boolean(布尔值)

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

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

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

默认值为 true

选择

  • false(假)

  • true(真)

注意

注意

  • 此模块只能在 NDO 4.1 或更高版本上使用。

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

示例

- name: Add a new DHCP policy to a BD
  cisco.mso.ndo_schema_template_bd_dhcp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    template: Template1
    bd: BD1
    dhcp_relay_policy: ansible_test_relay
    dhcp_option_policy: ansible_test_option
    state: present

- name: Query a specific BD DHCP Policy
  cisco.mso.ndo_schema_template_bd_dhcp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    template: Template1
    bd: BD1
    dhcp_relay_policy: ansible_test_relay
    state: query
  register: query_result

- name: Query all BD DHCP Policies
  cisco.mso.ndo_schema_template_bd_dhcp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    template: Template1
    bd: BD1
    state: query
  register: query_result

- name: Remove a DHCP policy from a BD
  cisco.mso.ndo_schema_template_bd_dhcp_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    schema: Schema1
    template: Template1
    bd: BD1
    dhcp_relay_policy: ansible_test_relay
    state: absent

作者

  • Akini Ross (@akinross)