cisco.dnac.configuration_template_info 模块 – 配置模板信息的 Information 模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。 您需要进一步的要求才能使用此模块，请参阅 要求 以获取详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.configuration_template_info。
cisco.dnac 3.1.0 中的新增功能
概要
此模块表示模块 configuration_template_v1_info 的别名
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要满足以下要求。
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}，
应该注意的是，此模块是 configuration_template_v1_info 的别名
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关配置模板 GetsDetailsOfAGivenTemplateV1 的 Cisco DNA Center 文档
GetsDetailsOfAGivenTemplateV1 API 的完整参考。
- 有关配置模板 GetsTheTemplatesAvailableV1 的 Cisco DNA Center 文档
GetsTheTemplatesAvailableV1 API 的完整参考。
示例
- name: Get all Configuration Template Info
cisco.dnac.configuration_template_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 Info by id
cisco.dnac.configuration_template_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 返回的响应。 返回: 总是 示例: |