cisco.dnac.configuration_template_project_info 模块 – 用于配置模板项目信息的 Information 模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.configuration_template_project_info

cisco.dnac 3.1.0 中的新功能

概要

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

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

headers

字典

其他标头。

name

字符串

名称查询参数。要搜索的项目名称。

projectId

字符串

ProjectId 路径参数。要获取项目详细信息的项目的 ProjectId (UUID)。

sortOrder

字符串

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

validate_response_schema

布尔值

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

选择

  • false

  • true ← (默认)

注释

注意

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

  • 使用的路径是 get /dna/intent/api/v1/template-programmer/project, get /dna/intent/api/v1/template-programmer/project/{projectId},

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

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

GetsAListOfProjectsV1 API 的完整参考。

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

GetsTheDetailsOfAGivenProjectV1 API 的完整参考。

示例

- name: Get all Configuration Template Project Info
  cisco.dnac.configuration_template_project_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}}"
    name: string
    sortOrder: string
  register: result

- name: Get Configuration Template Project Info by id
  cisco.dnac.configuration_template_project_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
  register: result

返回值

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

描述

dnac_response

字典

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

返回: 总是

示例: {"createTime": 0, "description": "字符串", "id": "字符串", "lastUpdateTime": 0, "name": "字符串", "tags": [{"id": "字符串", "name": "字符串"}], "templates": {}}

作者

  • Rafael Campos (@racampos)