cisco.dnac.tag_member 模块 – 标签成员的资源模块

注意

此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅要求获取详细信息。

要在剧本中使用它，请指定：cisco.dnac.tag_member。

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 tag_member_v1 的别名

注意

此模块具有相应的操作插件。

要求 

执行此模块的主机需要满足以下要求。

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
dnac_debug 布尔值	用于启用 Cisco DNA Center SDK 调试的标志。选项 `false` ← (默认) `true`
dnac_host 字符串 / 必需	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。默认值： `443`
dnac_username 别名：user 字符串	用于身份验证的 Cisco DNA Center 用户名。默认值： `"admin"`
dnac_verify 布尔值	用于启用或禁用 SSL 证书验证的标志。选项 `false` `true` ← (默认)
dnac_version 字符串	告知 SDK 要使用的 Cisco DNA Center 版本。默认值： `"2.3.7.6"`
id 字符串	Id 路径参数。标签 ID。
memberId 字符串	MemberId 路径参数。要从标签中删除的 TagMember ID。
memberType 列表 / 元素=字符串	标签成员的 memberType。
validate_response_schema 布尔值	用于启用 Cisco DNA Center SDK 验证请求正文是否符合 JSON 模式的标志。选项 `false` `true` ← (默认)

注释 

注意

使用的 SDK 方法是 tag.Tag.add_members_to_the_tag_v1, tag.Tag.remove_tag_member_v1,
使用的路径是 post /dna/intent/api/v1/tag/{id}/member, delete /dna/intent/api/v1/tag/{id}/member/{memberId},
应该注意的是，此模块是 tag_member_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

有关 Tag AddMembersToTheTagV1 的 Cisco DNA Center 文档: AddMembersToTheTagV1 API 的完整参考。
有关 Tag RemoveTagMemberV1 的 Cisco DNA Center 文档: RemoveTagMemberV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.tag_member:
    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}}"
    state: present
    id: string
    memberType:
    - string
    payload:
      networkinterface:
      - string

- name: Delete by id
  cisco.dnac.tag_member:
    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}}"
    state: absent
    id: string
    memberId: string

返回值 

常见的返回值已记录在此处，以下是此模块特有的字段

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回：始终示例： `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)