Try SpotterManage TagMember objects of Tag
| "added in version" 1.0.0 of cisco.dnac"
Authors: Rafael Campos (@racampos)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.dnac:==2.0.7
collections:
- name: cisco.dnac
version: 2.0.7Returns tag members specified by id.
Adds members to the tag specified by id.
Removes Tag member from the tag specified by id.
Returns the number of members in a given tag.
Updates tag membership. As part of the request payload through this API, only the specified members are added / retained to the given input tags. Possible values of memberType attribute in the request payload can be queried by using the /tag/member/type API.
Returns list of supported resource types.
- name: get_tag_members_by_id
cisco.dnac.tag_member:
state: query # required
id: SomeValue # string, required
member_type: SomeValue # string, required
level: SomeValue # string
limit: SomeValue # string
member_association_type: SomeValue # string
offset: SomeValue # string
register: nm_get_tag_members_by_id
- name: add_members_to_the_tag
cisco.dnac.tag_member:
state: create # required
id: SomeValue # string, required
- name: remove_tag_member
cisco.dnac.tag_member:
state: delete # required
id: SomeValue # string, required
member_id: SomeValue # string, required
- name: get_tag_member_count
cisco.dnac.tag_member:
state: query # required
id: SomeValue # string, required
member_type: SomeValue # string, required
count: True # boolean, required
level: SomeValue # string
member_association_type: SomeValue # string
register: nm_get_tag_member_count
- name: updates_tag_membership
cisco.dnac.tag_member:
state: update # required
memberToTags:
key:
- SomeValue # string
memberType: SomeValue # string
- name: get_tag_resource_types
cisco.dnac.tag_member:
state: query # required
register: nm_get_tag_resource_types
id:
description:
- Tag ID.
required: true
type: str
count:
description:
- If true gets the number of objects.
- Required for state query.
type: bool
level:
description:
- Level query parameter.
type: str
limit:
description:
- Used to Number of maximum members to return in the result.
type: str
offset:
description:
- Used for pagination. It indicates the starting row number out of available member
records.
type: str
member_id:
description:
- TagMember id to be removed from tag.
- Required for state delete.
type: str
memberType:
description:
- TagMemberDTO's memberType.
type: str
member_type:
description:
- Entity type of the member. Possible values can be retrieved by using /tag/member/type
API.
- MemberType query parameter.
required: true
type: str
memberToTags:
description:
- TagMemberDTO's memberToTags.
suboptions:
key:
description:
- It is the tag member's key.
type: list
type: dict
member_association_type:
description:
- "Indicates how the member is associated with the tag. Possible values and description.\
\ 1) DYNAMIC The member is associated to the tag through rules. 2) STATIC \u2013\
\ The member is associated to the tag manually. 3) MIXED \u2013 The member is associated\
\ manually and also satisfies the rule defined for the tag.\n"
- MemberAssociationType query parameter.
type: str
dnac_response:
description: A dictionary with the response returned by the DNA Center Python SDK
returned: always
sample:
response: 29
version: '1.0'
type: dict
missing_params:
description: Provided arguments do not comply with the schema of the DNA Center
Python SDK function
returned: when the function request schema is not satisfied
sample: null
type: list
sdk_function:
description: The DNA Center SDK function used to execute the task
returned: always
sample: tag.add_members_to_the_tag
type: str