cisco.dnac.configuration_template_v1_info 模块 – 配置模板 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您正在使用 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定： cisco.dnac.configuration_template_v1_info。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有配置模板 V1。
按 ID 获取配置模板 V1。
按其 ID 获取模板的详细信息。
列出可用的模板。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
filterConflictingTemplates 查询参数。根据冲突的模板过滤模板。 选项
|
|
附加标头。 |
|
LatestVersion 查询参数。LatestVersion 标志用于获取最新版本的模板。 选项
|
|
ProductFamily 查询参数。根据设备系列过滤模板。 |
|
ProductSeries 查询参数。根据设备系列过滤模板。 |
|
ProductType 查询参数。根据设备类型过滤模板。 |
|
ProjectId 查询参数。根据项目 UUID 过滤模板。 |
|
ProjectNames 查询参数。根据项目名称过滤模板。 |
|
SoftwareType 查询参数。根据软件类型过滤模板。 |
|
SoftwareVersion 查询参数。根据软件版本过滤模板。 |
|
SortOrder 查询参数。升序 (asc) 或降序 (des) 排序。 |
|
Tags 查询参数。根据标签过滤模板。 |
|
TemplateId 路径参数。用于获取模板详细信息的 TemplateId (UUID)。 |
|
UnCommitted 查询参数。根据模板是否已提交进行过滤。 选项
|
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
备注
注意
使用的 SDK 方法是 configuration_templates.ConfigurationTemplates.get_template_details、configuration_templates.ConfigurationTemplates.gets_the_templates_available_v1，
使用的路径是 get /dna/intent/api/v1/template-programmer/template、get /dna/intent/api/v1/template-programmer/template/{templateId}，
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 配置模板 GetsDetailsOfAGivenTemplateV1 文档
GetsDetailsOfAGivenTemplateV1 API 的完整参考。
- Cisco DNA Center 配置模板 GetsTheTemplatesAvailableV1 文档
GetsTheTemplatesAvailableV1 API 的完整参考。
示例
- name: Get all Configuration Template V1
cisco.dnac.configuration_template_v1_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
projectId: string
softwareType: string
softwareVersion: string
productFamily: string
productSeries: string
productType: string
filterConflictingTemplates: True
tags: []
projectNames: []
unCommitted: True
sortOrder: string
register: result
- name: Get Configuration Template V1 by id
cisco.dnac.configuration_template_v1_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers: "{{my_headers | from_json}}"
latestVersion: True
templateId: string
register: result
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回：始终 示例： |