cisco.dnac.device_replacement_v1_info 模块 – 设备更换 V1 的信息模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,请参阅要求了解详细信息。
要在 Playbook 中使用它,请指定:cisco.dnac.device_replacement_v1_info
。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有设备更换 V1。
获取具有更换详细信息的更换设备列表,并且可以根据故障设备名称、故障设备平台、更换设备平台、故障设备序列号、更换设备序列号、设备更换状态、产品系列来筛选更换设备。
注意
此模块具有相应的 操作插件。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用于启用 Cisco DNA Center SDK 调试的标志。 选择
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认: |
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认: |
|
系列查询参数。系列路由器、交换机和集线器、AP 的列表。 |
|
FaultyDeviceName 查询参数。故障设备名称。 |
|
FaultyDevicePlatform 查询参数。故障设备平台。 |
|
FaultyDeviceSerialNumber 查询参数。故障设备序列号。 |
|
附加标头。 |
|
限制查询参数。 |
|
偏移查询参数。 |
|
ReplacementDevicePlatform 查询参数。更换设备平台。 |
|
ReplacementDeviceSerialNumber 查询参数。更换设备序列号。 |
|
ReplacementStatus 查询参数。设备更换状态 READY-FOR-REPLACEMENT、REPLACEMENT-IN-PROGRESS、REPLACEMENT-SCHEDULED、REPLACED、ERROR、NETWORK_READINESS_REQUESTED、NETWORK_READINESS_FAILED。 |
|
SortBy 查询参数。按此字段排序。使用 order 时,SortBy 是强制性的。 |
|
SortOrder 查询参数。displayNameASC、DESC 上的顺序。 |
|
用于启用 Cisco DNA Center SDK 根据 JSON 模式验证请求主体的标志。 选择
|
注释
注意
使用的 SDK 方法是 device_replacement.DeviceReplacement.return_replacement_devices_with_details,
使用的路径是 get /dna/intent/api/v1/device-replacement,
支持
check_mode
该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 文档,了解设备更换 ReturnListOfReplacementDevicesWithReplacementDetailsV1
ReturnListOfReplacementDevicesWithReplacementDetailsV1 API 的完整参考。
示例
- name: Get all Device Replacement V1
cisco.dnac.device_replacement_v1_info:
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}}"
headers: "{{my_headers | from_json}}"
faultyDeviceName: string
faultyDevicePlatform: string
replacementDevicePlatform: string
faultyDeviceSerialNumber: string
replacementDeviceSerialNumber: string
replacementStatus: []
family: []
sortBy: string
sortOrder: string
offset: 0
limit: 0
register: result
返回值
通用返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应 已返回:始终 示例: |