cisco.mso.ndo_dhcp_option_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_option_policy

概要

  • 管理 Cisco Nexus Dashboard Orchestrator (NDO) 上的 DHCP 选项策略。

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

要求

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

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

参数

参数

注释

描述

字符串

DHCP 选项策略的描述。

host

别名:hostname

字符串

ACI 多站点编排器主机的 IP 地址或主机名。

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

login_domain

字符串

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

默认值为 Local。

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

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

option_policy

别名:name

字符串

DHCP 选项策略的名称。

option_policy_uuid

别名:uuid

字符串

DHCP 选项策略的 UUID。

当需要更新 option_policy 时,此参数是必需的。

options

列表 / 元素=字典

附加到 DHCP 选项策略的选项列表。

配置的选项列表必须包含至少一个选项。

当选项列表为空时,更新不会更改现有的选项配置。

data

字符串

选项的数据。

id

整数

选项的 ID。

name

字符串 / 必需

选项的名称。

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

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

validate_certs

布尔值

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

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

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

默认值为 true

选择

  • false

  • true

注释

注意

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

示例

- name: Create a new dhcp option policy
  cisco.mso.ndo_dhcp_option_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    option_policy: ansible_test_option_policy
    options:
      - name: option_1
        id: 1
        data: data_1
    state: present

- name: Query a dhcp option policy with template_name
  cisco.mso.ndo_dhcp_option_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    option_policy: ansible_test_option_policy
    state: query
  register: query_one

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

- name: Delete a dhcp option policy
  cisco.mso.ndo_dhcp_option_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    option_policy: ansible_test_option_policy
    state: absent

作者

  • Akini Ross (@akinross)