/ home / cisco / cisco.dnac / 6.13.3 / module / tag_member_info

cisco.dnac.tag_member_info (6.13.3) — module

Information module for Tag Member

| "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 Member.

Returns tag members specified by id.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Tag Member
  cisco.dnac.tag_member_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}}"
    memberType: string
    offset: string
    limit: string
    memberAssociationType: string
    level: string
    id: string
  register: result

Inputs

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

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

limit:
    description:
    - Limit query parameter. Used to Number of maximum members to return in the result.
    type: str

offset:
    description:
    - Offset query parameter. Used for pagination. It indicates the starting row number
      out of available member records.
    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

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

memberType:
    description:
    - 'MemberType query parameter. Entity type of the member. Possible values can be retrieved
      by using /tag/member/type API.

      '
    type: str

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

memberAssociationType:
    description:
    - "MemberAssociationType query parameter. 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"
    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

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    {\n      \"instanceUuid\"\
    : \"string\"\n    }\n  ]\n}\n"
  type: dict