cisco.dnac.pnp_device_claim_to_site_v1 模块 – 用于 PnP 设备声明到站点 V1 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源 Pnp 设备声明到站点 V1 的创建操作。
基于 Catalyst Center 基于站点的设计过程声明设备。一些必需的参数因设备平台而异。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
configInfo 字典在 cisco.dnac 4.2.0 中添加	Pnp 设备声明到站点的 configInfo。
configId 字符串	配置 ID。
configParameters 列表 / elements=dictionary	Pnp 设备声明到站点的 configParameters。
key 字符串	键。
value 字符串	值。
deviceId 字符串	设备 ID。
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"`
gateway 字符串在 cisco.dnac 6.4.0 中添加	适用于 CatalystWLC/MobilityExpress。
hostname 字符串在 cisco.dnac 4.2.0 中添加	要在设备上配置的主机名。
imageInfo 字典在 cisco.dnac 4.2.0 中添加	Pnp 设备声明到站点的 imageInfo。
imageId 字符串	镜像 ID。
skip 布尔值	跳过。选项 `false` `true`
ipInterfaceName 字符串在 cisco.dnac 6.4.0 中添加	适用于 Catalyst 9800 WLC。
rfProfile 字符串在 cisco.dnac 6.1.0 中添加	适用于接入点。
sensorProfile 字符串	适用于传感器。
siteId 字符串	站点 ID。
staticIP 字符串在 cisco.dnac 6.4.0 中添加	适用于 CatalystWLC/MobilityExpress。
subnetMask 字符串	适用于 CatalystWLC/MobilityExpress。
type 字符串	类型。
validate_response_schema 布尔值	Cisco DNA Center SDK 启用针对 JSON 模式验证请求正文的标志。选项 `false` `true` ← (默认)
vlanId 字符串在 cisco.dnac 6.4.0 中添加	适用于 Catalyst 9800 WLC。

注意 

注意

使用的 SDK 方法是 device_onboarding_pnp.DeviceOnboardingPnp.claim_a_device_to_a_site_v1，
使用的路径是 post /dna/intent/api/v1/onboarding/pnp-device/site-claim，
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数供 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 文档，了解设备入职 (PnP) ClaimADeviceToASiteV1: ClaimADeviceToASiteV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.pnp_device_claim_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}}"
    configInfo:
      configId: string
      configParameters:
      - key: string
        value: string
    deviceId: string
    gateway: string
    hostname: string
    imageInfo:
      imageId: string
      skip: true
    ipInterfaceName: string
    rfProfile: string
    sensorProfile: string
    siteId: string
    staticIP: string
    subnetMask: string
    type: string
    vlanId: string

返回值 

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

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

作者

Rafael Campos (@racampos)