cisco.catalystcenter.tag_info module -- Information module for Tag

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.catalystcenter 3.1.0

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.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

additionalInfo_attributes

string

AdditionalInfo.attributes query parameter.

additionalInfo_nameSpace

string

AdditionalInfo.nameSpace query parameter.

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

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

Default: :ansible-option-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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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 uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Tag GetTag

Complete reference of the GetTag API.

Cisco DNA Center documentation for Tag GetTagById

Complete reference of the GetTagById API.

Examples

---
- name: Get all Tag
  cisco.catalystcenter.tag_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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 by id
  cisco.catalystcenter.tag_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"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)