cisco.dnac.tag – Resource module for Tag

Note

This plugin is part of the cisco.dnac collection (version 4.1.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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create, update and delete of the resource Tag.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.0

• python >= 3.5

Parameters

Parameter			Choices/Defaults	Comments
description string				Tag's description.
dnac_debug boolean			Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required				The Cisco DNA Center hostname.
dnac_password string				The Cisco DNA Center password to authenticate.
dnac_port string			Default: 443	The Cisco DNA Center port.
dnac_username string			Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean			Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string			Default: "2.2.3.3"	Informs the SDK which version of Cisco DNA Center to use.
dynamicRules list / elements=string				Tag's dynamicRules.
	memberType string			Tag's memberType.
	rules dictionary			Tag's rules.
		items list / elements=dictionary		Tag's items.
		name string		Tag's name.
		operation string		Tag's operation.
		value string		Tag's value.
		values list / elements=string		Tag's values.
id string				Tag's id.
instanceTenantId string				Tag's instanceTenantId.
name string				Tag's name.
systemTag boolean			Choices: no yes	SystemTag flag.
validate_response_schema boolean			Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• 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

See Also

See also

Tag reference

Complete reference of the Tag object model.

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	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "version": "string", "response": { "taskId": "string", "url": "string" } }

Authors

• Rafael Campos (@racampos)