racampos.dnac.tag (0.0.1) — module

Manage Tag objects of Tag

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Returns the Tags for given filter criteria.

Creates Tag with specified Tag attributes.

Updates a Tag specified by id.

Deletes a Tag specified by id.

Returns Tag specified by Id.

Returns Tag count.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_tag
  cisco.dnac.tag:
    state: query  # required
    additional_info_attributes: SomeValue  # string
    additional_info_name_space: SomeValue  # string
    field: SomeValue  # string
    level: SomeValue  # string
    limit: SomeValue  # string
    name: SomeValue  # string
    offset: SomeValue  # string
    order: SomeValue  # string
    size: SomeValue  # string
    sort_by: SomeValue  # string
    system_tag: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: create_tag
  cisco.dnac.tag:
    state: present  # required
    description: SomeValue  # string
    dynamicRules:
    - memberType: SomeValue  # string
      rules:
        values:
        - SomeValue  # string
        items: None
        operation: SomeValue  # string
        name: SomeValue  # string
        value: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    name: SomeValue  # string
    systemTag: True  # boolean
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_tag
  cisco.dnac.tag:
    state: present  # required
    description: SomeValue  # string
    dynamicRules:
    - memberType: SomeValue  # string
      rules:
        values:
        - SomeValue  # string
        items: None
        operation: SomeValue  # string
        name: SomeValue  # string
        value: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    name: SomeValue  # string
    systemTag: True  # boolean
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: delete_tag
  cisco.dnac.tag:
    state: absent  # required
    id: SomeValue  # string, required
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_tag_by_id
  cisco.dnac.tag:
    state: query  # required
    id: SomeValue  # string, required
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_tag_count
  cisco.dnac.tag:
    state: query  # required
    count: True  # boolean, required
    attribute_name: SomeValue  # string
    level: SomeValue  # string
    name: SomeValue  # string
    name_space: SomeValue  # string
    size: SomeValue  # string
    system_tag: SomeValue  # string
  register: query_result

Inputs

    
id:
    description:
    - TagDTO's id.
    - Tag ID.
    - Required for states absent and query.
    type: str

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

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

count:
    description:
    - If true gets the number of objects.
    - Required for state query.
    type: bool

field:
    description:
    - 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: str

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

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

sort_by:
    description:
    - Only supported attribute is name. SortyBy is mandatory when order is used.
    type: str

systemTag:
    description:
    - TagDTO's systemTag.
    type: bool

name_space:
    description:
    - NameSpace query parameter.
    type: str

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

description:
    description:
    - TagDTO's description.
    type: str

dynamicRules:
    description:
    - TagDTO's dynamicRules (list of objects).
    elements: dict
    suboptions:
      memberType:
        description:
        - It is the Tag's memberType.
        type: str
      rules:
        description:
        - It is the Tag's rules.
        suboptions:
          items:
            description:
            - It is the Tag's items.
            type: list
          name:
            description:
            - It is the Tag's name.
            type: str
          operation:
            description:
            - It is the Tag's operation.
            type: str
          value:
            description:
            - It is the Tag's value.
            type: str
          values:
            description:
            - It is the Tag's values.
            type: list
        type: dict
    type: list

attribute_name:
    description:
    - AttributeName query parameter.
    type: str

instanceTenantId:
    description:
    - TagDTO's instanceTenantId.
    type: str

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

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

Outputs

create_tag:
  contains: null
  description: Creates Tag with specified Tag attributes.
  response:
    contains:
      taskId:
        description: It is the Tag's taskId.
        returned: success
        type: dict
      url:
        description: It is the Tag's url.
        returned: success
        sample: <url>
        type: str
    description: TagDTO's response.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: TagDTO's version.
    returned: success
    sample: '1.0'
    type: str
delete_tag:
  contains: null
  description: Deletes a Tag specified by id.
  response:
    contains:
      taskId:
        description: It is the Tag's taskId.
        returned: success
        type: dict
      url:
        description: It is the Tag's url.
        returned: success
        sample: <url>
        type: str
    description: Response, property of the response body.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: Version, property of the response body.
    returned: success
    sample: '1.0'
    type: str
get_tag:
  contains: null
  description: Returns the Tags for given filter criteria.
  response:
    contains:
      description:
        description: It is the Tag's description.
        returned: always
        sample: <description>
        type: str
      dynamicRules:
        contains:
          memberType:
            description: It is the Tag's memberType.
            returned: always
            sample: <membertype>
            type: str
          rules:
            contains:
              items:
                description: It is the Tag's items.
                returned: always
                type: list
              name:
                description: It is the Tag's name.
                returned: always
                sample: <name>
                type: str
              operation:
                description: It is the Tag's operation.
                returned: always
                sample: <operation>
                type: str
              value:
                description: It is the Tag's value.
                returned: always
                sample: <value>
                type: str
              values:
                description: It is the Tag's values.
                returned: always
                type: list
            description: It is the Tag's rules.
            returned: always
            type: dict
        description: It is the Tag's dynamicRules.
        returned: always
        type: list
      id:
        description: It is the Tag's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the Tag's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      name:
        description: It is the Tag's name.
        returned: always
        sample: <name>
        type: str
      systemTag:
        description: It is the Tag's systemTag.
        returned: always
        sample: false
        type: bool
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_tag_by_id:
  contains: null
  description: Returns Tag specified by Id.
  response:
    contains:
      description:
        description: It is the Tag's description.
        returned: always
        sample: <description>
        type: str
      dynamicRules:
        contains:
          memberType:
            description: It is the Tag's memberType.
            returned: always
            sample: <membertype>
            type: str
          rules:
            contains:
              items:
                description: It is the Tag's items.
                returned: always
                type: list
              name:
                description: It is the Tag's name.
                returned: always
                sample: <name>
                type: str
              operation:
                description: It is the Tag's operation.
                returned: always
                sample: <operation>
                type: str
              value:
                description: It is the Tag's value.
                returned: always
                sample: <value>
                type: str
              values:
                description: It is the Tag's values.
                returned: always
                type: list
            description: It is the Tag's rules.
            returned: always
            type: dict
        description: It is the Tag's dynamicRules.
        returned: always
        type: list
      id:
        description: It is the Tag's id.
        returned: always
        sample: '478012'
        type: str
      instanceTenantId:
        description: It is the Tag's instanceTenantId.
        returned: always
        sample: <instancetenantid>
        type: str
      name:
        description: It is the Tag's name.
        returned: always
        sample: <name>
        type: str
      systemTag:
        description: It is the Tag's systemTag.
        returned: always
        sample: false
        type: bool
    description: Response, property of the response body.
    returned: always
    type: dict
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_tag_count:
  contains: null
  description: Returns Tag count.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
update_tag:
  contains: null
  description: Updates a Tag specified by id.
  response:
    contains:
      taskId:
        description: It is the Tag's taskId.
        returned: changed
        type: dict
      url:
        description: It is the Tag's url.
        returned: changed
        sample: <url>
        type: str
    description: TagDTO's response.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: TagDTO's version.
    returned: changed
    sample: '1.0'
    type: str

See also