cisco.mso.mso_dhcp_option_policy_option 模块 – 在 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_option_policy_option

概要

  • 在 Cisco 多站点编排器上管理 DHCP 选项策略中的 DHCP 选项。

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

要求

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

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

参数

参数

注释

data

字符串

DHCP 选项策略中 DHCP 选项的数据

dhcp_option_policy

字符串 / 必需

DHCP 选项策略的名称

host

别名:hostname

字符串

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

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

id

整数

DHCP 选项策略中选项的 ID

login_domain

字符串

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

默认值为 Local。

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

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

name

别名:option

字符串

DHCP 选项策略中选项的名称

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

字符串

使用 presentabsent 来添加或删除。

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

选项

  • "absent"

  • "present" ← (默认)

  • "query"

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

用户名

字符串

用于身份验证的用户名。

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

验证证书

布尔值

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

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

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

默认为 true

选项

  • false

  • true

注释

注意

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

示例

- name: Add a new option to a DHCP Option Policy
  cisco.mso.mso_dhcp_option_policy_option:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_option_policy: my_test_dhcp_policy
    name: ansible_test
    id: 1
    data: Data stored in the option
    state: present

- name: Remove a option to a DHCP Option Policy
  cisco.mso.mso_dhcp_option_policy_option:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_option_policy: my_test_dhcp_policy
    name: ansible_test
    state: absent

- name: Query a option to a DHCP Option Policy
  cisco.mso.mso_dhcp_option_policy_option:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_option_policy: my_test_dhcp_policy
    name: ansible_test
    state: query
  register: query_result

- name: Query all option of a DHCP Option Policy
  cisco.mso.mso_dhcp_option_policy_option:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    dhcp_option_policy: my_test_dhcp_policy
    state: query
  register: query_result

作者

  • Lionel Hercot (@lhercot)