cisco.dnac.assign_device_to_site_v1 模块 – 用于将设备分配到站点 V1 的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,请参阅 要求 以了解详细信息。

要在剧本中使用它,请指定:cisco.dnac.assign_device_to_site_v1

cisco.dnac 6.0.0 中的新增功能

概要

  • 管理资源“将设备分配到站点 V1”的创建操作。

  • 将未分配的设备分配到站点。此 API 不会将已分配的设备移动到其他站点。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

device

列表 / 元素=字典

将设备分配到站点的设备。

ip

字符串

设备 IP。它可以是 IPv4 或 IPv6。IPV4 例如 10.104.240.64。IPV6 例如 2001 420 284 2004 4 181 500 183。

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"

headers

字典

其他标头。

siteId

字符串

SiteId 路径参数。需要分配设备的一个或多个站点的站点 ID。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求主体的标志。

选择

  • false

  • true ←(默认)

注意

注意

  • SDK 使用的方法是 sites.Sites.assign_devices_to_site_v1。

  • 使用的路径是 post /dna/intent/api/v1/assign-device-to-site/{siteId}/device。

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于站点 AssignDevicesToSiteV1 的文档

AssignDevicesToSiteV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.assign_device_to_site_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}}"
    device:
    - ip: string
    headers: '{{my_headers | from_json}}'
    siteId: string

返回值

通用返回值记录在 此处,以下是此模块独有的字段

描述

dnac_response

字典

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

已返回: 始终

示例: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

作者

  • Rafael Campos (@racampos)