cisco.dnac.pnp_device_reset_v1 模块 – PNP 设备重置 V1 资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅要求了解更多详情。

要在剧本中使用它，请指定：cisco.dnac.pnp_device_reset_v1。

cisco.dnac 3.1.0 中的新增功能

摘要 

管理资源 PNP 设备重置 V1 的创建操作。
从工作流执行错误状态恢复设备。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
deviceResetList 列表 / 元素=字典	PNP 设备重置的 deviceResetList。
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"`
projectId 字符串	PNP 设备重置的 projectId。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构验证请求正文。选项 `false` `true` ← (默认)
workflowId 字符串	PNP 设备重置的 workflowId。

备注 

注意

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

另请参阅 

另请参阅

Cisco DNA Center 设备上线 (PnP) ResetDeviceV1 文档: ResetDeviceV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.pnp_device_reset_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}}"
    deviceResetList:
    - configList:
      - configId: string
        configParameters:
        - key: string
          value: string
      deviceId: string
      licenseLevel: string
      licenseType: string
      topOfStackSerialNumber: string
    projectId: string
    workflowId: string

返回值 

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

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

作者

Rafael Campos (@racampos)