cisco.dnac.tag 模块 – 标签资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 tag_v1 的别名

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

description

string

标签的描述。

dnac_debug

boolean

Cisco DNA Center SDK 启用调试的标志。

选项

  • false ←（默认）

  • true

dnac_host

string / 必填

Cisco DNA Center 主机名。

dnac_password

string

用于身份验证的 Cisco DNA Center 密码。

dnac_port

integer

Cisco DNA Center 端口。

默认值： 443

dnac_username

别名：user

string

用于身份验证的 Cisco DNA Center 用户名。

默认值： "admin"

dnac_verify

boolean

启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ←（默认）

dnac_version

string

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值： "2.3.7.6"

dynamicRules

list / elements=dictionary

标签的 dynamicRules。

memberType

string

标签的 MemberType（例如 Networkdevice、interface）。

rules

dictionary

标签的规则。

items

list / elements=string

项目详细信息，可以通过 items 定义多个规则（例如，“items” {“operation” “ILIKE”, “name” “managementIpAddress”, “value” “%10%”}, {“operation” “ILIKE”, “name” “hostname”, “value” “%NA%”}）。

name

string

参数的名称（例如，对于接口 portName、adminStatus、speed、status、description。对于网络设备 family、series、hostname、managementIpAddress、groupNameHierarchy、softwareVersion）。

operation

string

规则中使用的操作（例如 OR、IN、EQ、LIKE、ILIKE、AND）。

value

string

参数的值（例如，对于 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

list / elements=string

参数的值，对于给定的参数，只能使用 value 或 values 中的一个。（对于 managementIpAddress，例如“10.197.124.90”、“10.197.124.91”）。

id

string

需要更新的标签的强制 instanceUuid。

instanceTenantId

string

为标签生成的 InstanceTenantId。

name

string

标签的名称。

systemTag

boolean

对于系统创建的标签为 True，对于用户定义的标签为 false。

选项

  • false

  • true

validate_response_schema

boolean

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，

  • 应该注意的是，此模块是 tag_v1 的别名

  • 不支持 check_mode

  • 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关 Tag CreateTagV1 的 Cisco DNA Center 文档

CreateTagV1 API 的完整参考。

有关 Tag DeleteTagV1 的 Cisco DNA Center 文档

DeleteTagV1 API 的完整参考。

有关 Tag UpdateTagV1 的 Cisco DNA Center 文档

UpdateTagV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.tag:
    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:
    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:
    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

dictionary

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

已返回： 始终

示例： {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)