cisco.dnac.tag_info 模块 – 标签信息的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要更多要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： cisco.dnac.tag_info。
cisco.dnac 3.1.0 中的新功能
概要
此模块表示模块 tag_v1_info 的别名
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
AdditionalInfo.attributes 查询参数。 |
|
AdditionalInfo.nameSpace 查询参数。 |
|
用于启用调试的 Cisco DNA Center SDK 标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认: |
|
Field 查询参数。可用的字段名称为“name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes”。 |
|
其他标头。 |
|
Id 路径参数。标签 ID。 |
|
Level 查询参数。 |
|
Limit 查询参数。 |
|
Name 查询参数。使用筛选操作时，标签名称是必需的。 |
|
Offset 查询参数。 |
|
Order 查询参数。可用值为 asc 和 des。 |
|
Size 查询参数。大小（以千字节 (KB) 为单位）。 |
|
SortBy 查询参数。唯一支持的属性是 name。使用 order 时，SortyBy 是必需的。 |
|
SystemTag 查询参数。 |
|
用于启用针对 JSON 架构验证请求正文的 Cisco DNA Center SDK 标志。 选项
|
备注
注意
SDK 使用的方法是 tag.Tag.get_tag_by_id_v1、tag.Tag.get_tag_v1，
使用的路径是 get /dna/intent/api/v1/tag、get /dna/intent/api/v1/tag/{id}，
应注意，此模块是 tag_v1_info 的别名
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关标签 GetTagByIdV1 的 Cisco DNA Center 文档
GetTagByIdV1 API 的完整参考。
- 有关标签 GetTagV1 的 Cisco DNA Center 文档
GetTagV1 API 的完整参考。
示例
- name: Get all Tag Info
cisco.dnac.tag_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
additionalInfo_nameSpace: string
additionalInfo_attributes: string
level: string
offset: 0
limit: 0
size: string
field: string
sortBy: string
order: string
systemTag: string
register: result
- name: Get Tag Info by id
cisco.dnac.tag_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
register: result
返回值
常见的返回值记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 已返回：始终 示例： |