cisco.dnac.pnp_device_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_v1。
cisco.dnac 3.1.0 中的新增功能
概要
管理 PnP 设备 V1 资源的创建、更新和删除操作。
将设备添加到 PnP 数据库。
从 PnP 数据库中删除指定的设备。
更新 PnP 数据库中由设备 ID 指定的设备详细信息。
注意
此模块具有相应的 动作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
PnP 设备的 deviceInfo。 |
|
描述。 |
|
设备 Sudi 序列号。 |
|
主机名。 |
|
MAC 地址。 |
|
PID。 |
|
序列号。 |
|
站点 ID。 |
|
堆叠。 选项
|
|
PnP 设备的 stackInfo。 |
|
是否为完整环。 选项
|
|
PnP 设备的 stackMemberList。 |
|
硬件版本。 |
|
许可证级别。 |
|
许可证类型。 |
|
MAC 地址。 |
|
PID。 |
|
优先级。 |
|
角色。 |
|
序列号。 |
|
软件版本。 |
|
堆叠编号。 |
|
状态。 |
|
Sudi 序列号。 |
|
堆叠环协议。 |
|
是否支持堆叠工作流。 选项
|
|
总成员数。 |
|
有效的许可证级别。 |
|
是否需要 Sudi。 选项
|
|
用户 Mic 编号。 |
|
执行 SUDI 授权所需的 Secure Unique Device Identifier (SUDI) 序列号列表，如果 sudiRequired 为 true，则需要此参数。 |
|
工作流 ID。 |
|
工作流名称。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
用于启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
ID。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 架构验证请求正文。 选项
|
注释
注意
使用的 SDK 方法是 device_onboarding_pnp.DeviceOnboardingPnp.add_device、device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp_v1、device_onboarding_pnp.DeviceOnboardingPnp.update_device_v1，
使用的路径是 post /dna/intent/api/v1/onboarding/pnp-device、delete /dna/intent/api/v1/onboarding/pnp-device/{id}、put /dna/intent/api/v1/onboarding/pnp-device/{id}，
不支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 `dnac_` 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
参见
另请参见
- Cisco DNA Center 设备上线（PnP）AddDeviceV1 的文档
AddDeviceV1 API 的完整参考。
- Cisco DNA Center 设备上线（PnP）DeleteDeviceByIdFromPnPV1 的文档
DeleteDeviceByIdFromPnPV1 API 的完整参考。
- Cisco DNA Center 设备上线（PnP）UpdateDeviceV1 的文档
UpdateDeviceV1 API 的完整参考。
示例
- name: Create
cisco.dnac.pnp_device_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}}"
state: present
deviceInfo:
description: string
deviceSudiSerialNos:
- string
hostname: string
macAddress: string
pid: string
serialNumber: string
siteId: string
stack: true
stackInfo:
isFullRing: true
stackMemberList:
- hardwareVersion: string
licenseLevel: string
licenseType: string
macAddress: string
pid: string
priority: 0
role: string
serialNumber: string
softwareVersion: string
stackNumber: 0
state: string
sudiSerialNumber: string
stackRingProtocol: string
supportsStackWorkflows: true
totalMemberCount: 0
validLicenseLevels:
- string
sudiRequired: true
userMicNumbers:
- string
userSudiSerialNos:
- string
workflowId: string
workflowName: string
- name: Update by id
cisco.dnac.pnp_device_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}}"
state: present
deviceInfo:
hostname: string
pid: string
serialNumber: string
stack: true
sudiRequired: true
userSudiSerialNos:
- string
id: string
- name: Delete by id
cisco.dnac.pnp_device_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}}"
state: absent
id: string
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
Cisco DNAC Python SDK 返回的响应字典或列表。 返回值：始终返回 Sample: |