cisco.dnac.tag_info module – Information module for Tag Info

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 3.1.0

Synopsis

  • This module represents an alias of the module tag_v1_info

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • 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:

  • false ← (default)

  • true

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:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

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

float

Limit query parameter. The number of tags to be retrieved. If not specified, the default is 500. The maximum allowed limit is 500.

name

string

Name query parameter. Tag name is mandatory when filter operation is used.

offset

float

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:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are tag.Tag.get_tag_by_id_v1, tag.Tag.get_tag_v1,

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

  • It should be noted that this module is an alias of tag_v1_info

  • 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

See Also

See also

Cisco DNA Center documentation for Tag GetTagByIdV1

Complete reference of the GetTagByIdV1 API.

Cisco DNA Center documentation for Tag GetTagV1

Complete reference of the GetTagV1 API.

Examples

- 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

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: {"response": {"description": "string", "dynamicRules": [{"memberType": "string", "rules": {"items": [{}], "name": "string", "operation": "string", "value": "string", "values": ["string"]}}], "id": "string", "instanceTenantId": "string", "name": "string", "systemTag": true}, "version": "string"}

Authors

  • Rafael Campos (@racampos)