cisco.dnac.tag_info – Information module for Tag

Note

This plugin is part of the cisco.dnac collection (version 3.1.0).

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all Tag.

• Get Tag by id.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
additionalInfo_attributes string		AdditionalInfo.attributes query parameter.
additionalInfo_nameSpace string		AdditionalInfo.nameSpace query parameter.
field string		Field query parameter. Available field names are 'name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes'.
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.

See Also

See also

Tag reference

Complete reference of the Tag object model.

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}}"
    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}}"
    id: string
  register: result

Return Values

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

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

Authors

• Rafael Campos (@racampos)