cisco.dnac.device_replacement 模块 – 设备替换资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

此模块具有相应的 action 插件。

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

payload

列表 / 元素=字典

设备替换的有效负载。

creationTime

整数

标记设备需要替换的日期和时间。

family

字符串

故障设备系列。

faultyDeviceId

字符串

故障设备的唯一标识符。

faultyDeviceName

字符串

故障设备名称。

faultyDevicePlatform

字符串

故障设备平台。

faultyDeviceSerialNumber

字符串

故障设备序列号。

id

字符串

设备替换资源的唯一标识符。

neighbourDeviceId

字符串

要创建 DHCP 服务器的邻居设备的唯一标识符。

networkReadinessTaskId

字符串

网络就绪任务的唯一标识符。

replacementDevicePlatform

字符串

替换设备平台。

replacementDeviceSerialNumber

字符串

替换设备序列号。

replacementStatus

字符串

设备替换状态。使用 NON-FAULTY 取消标记设备以进行替换。

replacementTime

整数

设备替换的日期和时间。

workflowId

字符串

设备替换工作流程的唯一标识符。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 device_replacement.DeviceReplacement.mark_device_for_replacement_v1、device_replacement.DeviceReplacement.unmark_device_for_replacement_v1，

  • 使用的路径是 post /dna/intent/api/v1/device-replacement、put /dna/intent/api/v1/device-replacement，

  • 需要注意的是，此模块是 device_replacement_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 设备替换 MarkDeviceForReplacementV1 文档

MarkDeviceForReplacementV1 API 的完整参考。

Cisco DNA Center 设备替换 UnMarkDeviceForReplacementV1 文档

UnMarkDeviceForReplacementV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.device_replacement:
    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
    payload:
    - creationTime: 0
      family: string
      faultyDeviceId: string
      faultyDeviceName: string
      faultyDevicePlatform: string
      faultyDeviceSerialNumber: string
      id: string
      neighbourDeviceId: string
      networkReadinessTaskId: string
      replacementDevicePlatform: string
      replacementDeviceSerialNumber: string
      replacementStatus: string
      replacementTime: 0
      workflowId: string

- name: Create
  cisco.dnac.device_replacement:
    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
    payload:
    - creationTime: 0
      family: string
      faultyDeviceId: string
      faultyDeviceName: string
      faultyDevicePlatform: string
      faultyDeviceSerialNumber: string
      id: string
      neighbourDeviceId: string
      networkReadinessTaskId: string
      replacementDevicePlatform: string
      replacementDeviceSerialNumber: string
      replacementStatus: string
      replacementTime: 0
      workflowId: string

返回值

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

键

描述

dnac_response

字典

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

返回： 始终

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

作者

  • Rafael Campos (@racampos)