cisco.dnac.templates_details_info 模块 – 模板详细信息的信息模块

注意

此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。

如果您使用的是 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.templates_details_info

cisco.dnac 4.0.0 中的新增功能

概要

  • 此模块表示模块 templates_details_v2_info 的别名

注意

此模块具有相应的 操作插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

allTemplateAttributes

布尔值

AllTemplateAttributes 查询参数。返回所有模板属性。

选择

  • false

  • true

dnac_debug

布尔值

用于启用 Cisco DNA Center SDK 调试的标志。

选择

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

布尔值

用于启用或禁用 SSL 证书验证的标志。

选择

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值: "2.3.7.6"

filterConflictingTemplates

布尔值

FilterConflictingTemplates 查询参数。根据冲突的模板筛选模板。

选择

  • false

  • true

headers

字典

其他标头。

id

字符串

Id 查询参数。要搜索的模板的 ID。

includeVersionDetails

布尔值

IncludeVersionDetails 查询参数。包含模板版本详细信息。

选择

  • false

  • true

limit

整数

Limit 查询参数。限制结果数量。

name

字符串

Name 查询参数。要搜索的模板的名称。

offset

整数

Offset 查询参数。第一个结果的索引。

productFamily

字符串

ProductFamily 查询参数。根据设备系列筛选模板。

productSeries

字符串

ProductSeries 查询参数。根据设备系列筛选模板。

productType

字符串

ProductType 查询参数。根据设备类型筛选模板。

projectId

字符串

ProjectId 查询参数。根据项目 ID 筛选模板。

projectName

字符串

ProjectName 查询参数。根据项目名称筛选模板。

softwareType

字符串

SoftwareType 查询参数。根据软件类型筛选模板。

softwareVersion

字符串

SoftwareVersion 查询参数。根据软件版本筛选模板。

sortOrder

字符串

SortOrder 查询参数。排序顺序,升序 (asc) 或降序 (dsc)。

tags

列表 / 元素=字符串

Tags 查询参数。根据标签筛选模板。

unCommitted

布尔值

UnCommitted 查询参数。返回未提交的模板。

选择

  • false

  • true

validate_response_schema

布尔值

用于启用 Cisco DNA Center SDK 针对 JSON 模式验证请求正文的标志。

选择

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 configuration_templates.ConfigurationTemplates.get_templates_details_v2,

  • 使用的路径是 get /dna/intent/api/v2/template-programmer/template,

  • 应该注意的是,此模块是 templates_details_v2_info 的别名

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 文档,了解配置模板 GetTemplatesDetailsV2

GetTemplatesDetailsV2 API 的完整参考。

示例

- name: Get all Templates Details Info
  cisco.dnac.templates_details_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}}"
    id: string
    name: string
    projectId: string
    projectName: string
    softwareType: string
    softwareVersion: string
    productFamily: string
    productSeries: string
    productType: string
    filterConflictingTemplates: True
    tags: []
    unCommitted: True
    sortOrder: string
    allTemplateAttributes: True
    includeVersionDetails: True
    offset: 0
    limit: 0
  register: result

返回值

常见的返回值记录在此处,以下是此模块特有的字段

描述

dnac_response

字典

一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应

已返回:始终

示例: {"author": "string", "composite": true, "containingTemplates": [{"composite": true, "description": "string", "deviceTypes": [{"productFamily": "string", "productSeries": "string", "productType": "string"}], "id": "string", "language": "string", "name": "string", "projectName": "string", "rollbackTemplateParams": [{"binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [{"id": "string", "maxValue": 0, "minValue": 0}], "required": true, "selection": {"defaultSelectedValues": ["string"], "id": "string", "selectionType": "string", "selectionValues": {}}}], "tags": [{"id": "string", "name": "string"}], "templateContent": "string", "templateParams": [{"binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [{"id": "string", "maxValue": 0, "minValue": 0}], "required": true, "selection": {"defaultSelectedValues": ["string"], "id": "string", "selectionType": "string", "selectionValues": {}}}], "version": "string"}], "createTime": 0, "customParamsOrder": true, "description": "string", "deviceTypes": [{"productFamily": "string", "productSeries": "string", "productType": "string"}], "failurePolicy": "string", "id": "string", "language": "string", "lastUpdateTime": 0, "latestVersionTime": 0, "name": "string", "parentTemplateId": "string", "projectAssociated": true, "projectId": "string", "projectName": "string", "rollbackTemplateContent": "string", "rollbackTemplateParams": [{"binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [{"id": "string", "maxValue": 0, "minValue": 0}], "required": true, "selection": {"defaultSelectedValues": ["string"], "id": "string", "selectionType": "string", "selectionValues": {}}}], "softwareType": "string", "softwareVariant": "string", "softwareVersion": "string", "tags": [{"id": "string", "name": "string"}], "templateContent": "string", "templateParams": [{"binding": "string", "customOrder": 0, "dataType": "string", "defaultValue": "string", "description": "string", "displayName": "string", "group": "string", "id": "string", "instructionText": "string", "key": "string", "notParam": true, "order": 0, "paramArray": true, "parameterName": "string", "provider": "string", "range": [{"id": "string", "maxValue": 0, "minValue": 0}], "required": true, "selection": {"defaultSelectedValues": ["string"], "id": "string", "selectionType": "string", "selectionValues": {}}}], "validationErrors": {"rollbackTemplateErrors": {}, "templateErrors": {}, "templateId": "string", "templateVersion": "string"}, "version": "string", "versionsInfo": [{"author": "string", "description": "string", "id": "string", "version": "string", "versionComment": "string", "versionTime": 0}]}

作者

  • Rafael Campos (@racampos)