cisco.dnac.pnp_device_claim_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_v1。

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源 Pnp 设备声明 V1 的创建操作。
使用指定的工作流程声明一个或多个设备。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
authorizationNeeded 布尔值	用于启用/禁用 PnP 设备授权的标志。（true 表示启用）。选择 `false` `true`
configFileUrl 字符串	Pnp 设备声明的 configFileUrl。
configId 字符串	Pnp 设备声明的 configId。
deviceClaimList 列表 / 元素=字典	Pnp 设备声明的 deviceClaimList。
configList 列表 / 元素=字典	Pnp 设备声明的 configList。
configId 字符串	Pnp 设备声明的 configId。
configParameters 列表 / 元素=字典	Pnp 设备声明的 configParameters。
key 字符串	Pnp 设备声明的 key。
value 字符串	Pnp 设备声明的 value。
deviceId 字符串	Pnp 设备声明的 deviceId。
licenseLevel 字符串	Pnp 设备声明的 licenseLevel。
licenseType 字符串	Pnp 设备声明的 licenseType。
topOfStackSerialNumber 字符串	Pnp 设备声明的 topOfStackSerialNumber。
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"`
fileServiceId 字符串	Pnp 设备声明的 fileServiceId。
imageId 字符串	Pnp 设备声明的 imageId。
imageUrl 字符串	Pnp 设备声明的 imageUrl。
populateInventory 布尔值	PopulateInventory 标志。选择 `false` `true`
projectId 字符串	Pnp 设备声明的 projectId。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用针对 JSON 模式验证请求正文的标志。选择 `false` `true` ← (默认)
workflowId 字符串	Pnp 设备声明的 workflowId。

备注 

注意

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

另请参阅 

另请参阅

Cisco DNA Center 设备加入 (PnP) ClaimDeviceV1 的文档: ClaimDeviceV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.pnp_device_claim_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}}"
    authorizationNeeded: true
    configFileUrl: string
    configId: string
    deviceClaimList:
    - configList:
      - configId: string
        configParameters:
        - key: string
          value: string
      deviceId: string
      licenseLevel: string
      licenseType: string
      topOfStackSerialNumber: string
    fileServiceId: string
    imageId: string
    imageUrl: string
    populateInventory: true
    projectId: string
    workflowId: string

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回：始终示例： `{"jsonArrayResponse": [{}], "jsonResponse": {}, "message": "string", "statusCode": 0}`

作者

Rafael Campos (@racampos)