In the current version of cvprac the device_decommissioning() function uses get_device_by_serial() to check if the device exists in CloudVision however that API works strictly for provisioned devices, so if you have a device that is not provisioned you cannot decommission it and you'd get the following error
>>> clnt.api.device_decommissioning(device_id, request_id)
2023-Jul-13 21:33:06 IST <WARNING> cvp_api device_decommissioning: Device with JPE19290408 serial number does not exist (or is not registered) to decommission
to improve on this instead of using get_device_by_serial(), I've used get_inventory(), however in its current state get_inventory() had the provisioned query parameter always set to True, so I've added a positional argument at the end of get_inventory() set provisioned=True by default, and then in the device_decommissioning() I'm calling the get_inventory(provisioned=False) to fetch all devices in the inventory of CloudVision. This will enable decommissioning every device regardless of their streaming status and provisioning status.
Description
In the current version of cvprac the
device_decommissioning()function usesget_device_by_serial()to check if the device exists in CloudVision however that API works strictly for provisioned devices, so if you have a device that is not provisioned you cannot decommission it and you'd get the following errorto improve on this instead of using
get_device_by_serial(), I've usedget_inventory(), however in its current stateget_inventory()had theprovisionedquery parameter always set to True, so I've added a positional argument at the end ofget_inventory()setprovisioned=Trueby default, and then in thedevice_decommissioning()I'm calling theget_inventory(provisioned=False)to fetch all devices in the inventory of CloudVision. This will enable decommissioning every device regardless of their streaming status and provisioning status.Test
Haven't added additional tests as this should be transparent for any current script. To locally test the following lab example can be used: https://github.com/aristanetworks/cvprac/blob/develop/docs/labs/lab02-inventory-operations/remove_and_decommission_device.py