W3cubDocs

/Ansible

cisco.dnac.tag module – Resource module for Tag

Note

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

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.

New in cisco.dnac 3.1.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

This module represents an alias of the module tag_v1

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
description string	Description of the tag.
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"`
dynamicRules list / elements=dictionary	Tag’s dynamicRules.
memberType string	MemberType of the tag (e.g. Networkdevice, interface).
rules dictionary	Tag’s rules.
items list / elements=dictionary	Items details,multiple rules can be defined by items(e.g. “items” {“operation” “ILIKE”, “name” “managementIpAddress”, “value” “%10%”}, {“operation” “ILIKE”, “name” “hostname”, “value” “%NA%”} ).
name string	Name of the parameter (e.g. For interface portName,adminStatus,speed,status,description. For networkdevice family,series,hostname,managementIpAddress,groupNameHierarchy,softwareVersion).
operation string	Opeartion used in the rules (e.g. OR,IN,EQ,LIKE,ILIKE,AND).
value string	Value of the parameter (e.g. For portName 1/0/1,for adminStatus,status up/down, for speed any integer value, for description any valid string, for family switches, for series C3650, for managementIpAddress 10.197.124.90, groupNameHierarchy Global, softwareVersion 16.9.1).
values list / elements=string	Values of the parameter,Only one of the value or values can be used for the given parameter. (for managementIpAddress e.g. “10.197.124.90”,”10.197.124.91”).
id string	Mandatory instanceUuid of the tag that needs to be updated.
instanceTenantId string	InstanceTenantId generated for the tag.
name string	Name of the tag.
systemTag boolean	True for system created tags, false for user defined tags. Choices: `false` `true`
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.create_tag_v1, tag.Tag.delete_tag_v1, tag.Tag.update_tag_v1,
Paths used are post /dna/intent/api/v1/tag, delete /dna/intent/api/v1/tag/{id}, put /dna/intent/api/v1/tag,
It should be noted that this module is an alias of tag_v1
Does not support 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: Update all
  cisco.dnac.tag:
    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}}"
    state: present
    description: string
    dynamicRules:
      - memberType: string
        rules:
          items:
            - {}
          name: string
          operation: string
          value: string
          values:
            - string
    id: string
    instanceTenantId: string
    name: string
    systemTag: true
- name: Create
  cisco.dnac.tag:
    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}}"
    state: present
    description: string
    dynamicRules:
      - memberType: string
        rules:
          items:
            - {}
          name: string
          operation: string
          value: string
          values:
            - string
    id: string
    instanceTenantId: string
    name: string
    systemTag: true
- name: Delete by id
  cisco.dnac.tag:
    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}}"
    state: absent
    id: string

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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

Rafael Campos (@racampos)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/tag_module.html

cisco.dnac.tag module – Resource module for Tag

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links