cisco.dnac.tag_info (6.13.3) — module

Information module for Tag

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Tag.

Get Tag by id.

Returns tag specified by Id.

Returns the tags for given filter criteria.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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}}"
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

Inputs

    
id:
    description:
    - Id path parameter. Tag ID.
    type: str

name:
    description:
    - Name query parameter. Tag name is mandatory when filter operation is used.
    type: str

size:
    description:
    - Size query parameter. Size in kilobytes(KB).
    type: str

field:
    description:
    - 'Field query parameter. Available field names are ''name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes''.

      '
    type: str

level:
    description:
    - Level query parameter.
    type: str

limit:
    description:
    - Limit query parameter.
    type: int

order:
    description:
    - Order query parameter. Available values are asc and des.
    type: str

offset:
    description:
    - Offset query parameter.
    type: int

sortBy:
    description:
    - SortBy query parameter. Only supported attribute is name. SortyBy is mandatory when
      order is used.
    type: str

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

systemTag:
    description:
    - SystemTag query parameter.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

additionalInfo_nameSpace:
    description:
    - AdditionalInfo.nameSpace query parameter.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

additionalInfo_attributes:
    description:
    - AdditionalInfo.attributes query parameter.
    type: str

Outputs

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

See also