cisco.catalystcenter.pnp_device module -- Resource module for Pnp Device
Note
This module is part of the cisco.catalystcenter collection (version 2.3.1).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.pnp_device.
New in cisco.catalystcenter 3.1.0
Synopsis
Manage operations create, update and delete of the resource Pnp Device.
Adds a device to the PnP database.
Deletes specified device from PnP database.
Updates device details specified by device id in PnP database.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.1.6.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Pnp Device's deviceInfo. |
|
Description. |
|
Device Sudi Serial Nos. |
|
Hostname. |
|
Mac Address. |
|
Pid. |
|
Serial Number. |
|
Site Id. |
|
Pnp Device's stackInfo. |
|
Pnp Device's stackMemberList. |
|
Hardware Version. |
|
License Level. |
|
License Type. |
|
Mac Address. |
|
Pid. |
|
Priority. |
|
Role. |
|
Serial Number. |
|
Software Version. |
|
Stack Number. |
|
State. |
|
Sudi Serial Number. |
|
Stack Ring Protocol. |
|
Supports Stack Workflows. Choices: |
|
Total Member Count. |
|
Valid License Levels. |
|
Is Sudi Required. Choices: |
|
User Mic Numbers. |
|
List of Secure Unique Device Identifier (SUDI) serial numbers to perform SUDI authorization, Required if sudiRequired is true. |
|
Workflow Id. |
|
Workflow Name. |
|
Id path parameter. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.add_device, device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp, device_onboarding_pnp.DeviceOnboardingPnp.update_device,
Paths used are 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},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
See Also
See also
- Cisco DNA Center documentation for Device Onboarding (PnP) AddDeviceSiteManagement
Complete reference of the AddDeviceSiteManagement API.
- Cisco DNA Center documentation for Device Onboarding (PnP) DeleteDeviceByIdFromPnP
Complete reference of the DeleteDeviceByIdFromPnP API.
- Cisco DNA Center documentation for Device Onboarding (PnP) UpdateDevice
Complete reference of the UpdateDevice API.
Examples
---
- name: Create
cisco.catalystcenter.pnp_device:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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: Delete by id
cisco.catalystcenter.pnp_device:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: absent
id: string
- name: Update by id
cisco.catalystcenter.pnp_device:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: present
deviceInfo:
hostname: string
pid: string
serialNumber: string
stack: true
sudiRequired: true
userSudiSerialNos:
- string
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|