cisco.dnac.tag_v1 模块 – Tag V1 资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。要使用此模块，您需要其他需求，有关详细信息，请参见需求。

要在 playbook 中使用它，请指定：cisco.dnac.tag_v1。

cisco.dnac 3.1.0 中的新增功能

概要 

管理 Tag V1 资源的创建、更新和删除操作。
创建具有指定标签属性的标签。
删除由 ID 指定的标签。
更新由 ID 指定的标签。

注意

此模块具有相应的 action 插件。

需求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
description 字符串	标签的描述。
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"`
dynamicRules 列表 / 元素=字典	标签的 dynamicRules。
memberType 字符串	标签的 MemberType（例如 Networkdevice、interface）。
rules 字典	标签的规则。
items 列表 / 元素=字符串	项目详情，可以通过 items 定义多个规则（例如，“items” {“operation” “ILIKE”, “name” “managementIpAddress”, “value” “%10%”}, {“operation” “ILIKE”, “name” “hostname”, “value” “%NA%”}）。
name 字符串	参数的名称（例如，对于接口 portName、adminStatus、speed、status、description。对于网络设备 family、series、hostname、managementIpAddress、groupNameHierarchy、softwareVersion）。
operation 字符串	在规则中使用的操作（例如 OR、IN、EQ、LIKE、ILIKE、AND）。
value 字符串	参数的值（例如，对于 portName 1/0/1，对于 adminStatus、status up/down，对于 speed 任何整数值，对于 description 任何有效字符串，对于 family switches，对于 series C3650，对于 managementIpAddress 10.197.124.90，groupNameHierarchy Global，softwareVersion 16.9.1）。
values 列表 / 元素=字符串	参数的值，对于给定的参数，只能使用 value 或 values 中的一个。（对于 managementIpAddress 例如，“10.197.124.90”，“10.197.124.91”）。
id 字符串	需要更新的标签的必填 instanceUuid。
instanceTenantId 字符串	为标签生成的 InstanceTenantId。
name 字符串	标签的名称。
systemTag 布尔值	系统创建的标签为 True，用户定义的标签为 False。选项 `false` `true`
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

使用的 SDK 方法是 tag.Tag.create_tag_v1、tag.Tag.delete_tag_v1、tag.Tag.update_tag_v1，
使用的路径是 post /dna/intent/api/v1/tag、delete /dna/intent/api/v1/tag/{id}、put /dna/intent/api/v1/tag，
不支持 check_mode
插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 `dnac_` 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

参见 

另见

Cisco DNA Center 关于 Tag CreateTagV1 的文档: CreateTagV1 API 的完整参考。
Cisco DNA Center 关于 Tag DeleteTagV1 的文档: DeleteTagV1 API 的完整参考。
Cisco DNA Center 关于 Tag UpdateTagV1 的文档: UpdateTagV1 API 的完整参考。

示例 

- name: Update all
  cisco.dnac.tag_v1:
    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
    description: string
    dynamicRules:
    - memberType: string
      rules:
        items:
        - string
        name: string
        operation: string
        value: string
        values:
        - string
    id: string
    instanceTenantId: string
    name: string
    systemTag: true

- name: Create
  cisco.dnac.tag_v1:
    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
    description: string
    dynamicRules:
    - memberType: string
      rules:
        items:
        - string
        name: string
        operation: string
        value: string
        values:
        - string
    id: string
    instanceTenantId: string
    name: string
    systemTag: true

- name: Delete by id
  cisco.dnac.tag_v1:
    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

返回值 

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

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

作者

Rafael Campos (@racampos)