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 或更高版本

参数

参数

注释

description

字符串

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)