cisco.dnac.tag_info module – Information module for Tag

Note

This module is part of the cisco.dnac collection (version 6.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.tag_info.

New in version 3.1.0: of cisco.dnac

Synopsis

• Get all Tag.

• Get Tag by id.

• Returns tag specified by Id.

• Returns the tags for given filter criteria.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.4.8

• python >= 3.5

Parameters

Parameter	Comments
additionalInfo_attributes string	AdditionalInfo.attributes query parameter.
additionalInfo_nameSpace string	AdditionalInfo.nameSpace query parameter.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: “admin”
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
field string	Field query parameter. Available field names are ‘name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes’.
headers dictionary	Additional headers.
id string	Id path parameter. Tag ID.
level string	Level query parameter.
limit string	Limit query parameter.
name string	Name query parameter. Tag name is mandatory when filter operation is used.
offset string	Offset query parameter.
order string	Order query parameter. Available values are asc and des.
size string	Size query parameter. Size in kilobytes(KB).
sortBy string	SortBy query parameter. Only supported attribute is name. SortyBy is mandatory when order is used.
systemTag string	SystemTag query parameter.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)

Notes

Note

• SDK Method used are tag.Tag.get_tag, tag.Tag.get_tag_by_id,

• Paths used are get /dna/intent/api/v1/tag, get /dna/intent/api/v1/tag/{id},

• Supports check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples

- name: Get all Tag
  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:
      custom: value
    name: string
    additionalInfo_nameSpace: string
    additionalInfo_attributes: string
    level: string
    offset: string
    limit: string
    size: string
    field: string
    sortBy: string
    order: string
    systemTag: string
  register: result

- name: Get Tag 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:
      custom: value
    id: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: “{\n \”version\”: \”string\”,\n \”response\”: {\n \”systemTag\”: true,\n \”description\”: \”string\”,\n \”dynamicRules\”: [\n {\n \”memberType\”: \”string\”,\n \”rules\”: {\n \”values\”: [\n \”string\”\n ],\n \”items\”: [\n {}\n ],\n \”operation\”: \”string\”,\n \”name\”: \”string\”,\n \”value\”: \”string\”\n }\n }\n ],\n \”name\”: \”string\”,\n \”id\”: \”string\”,\n \”instanceTenantId\”: \”string\”\n }\n}\n”

Authors

• Rafael Campos (@racampos)