Genie Libs Clean (version 26.3) is a component of the CiscoTestAutomation's Genie framework, providing functionalities for cleaning network devices. It automates tasks such as removing configurations, upgrading/downgrading OS, and reloading devices to prepare them for new test runs or restore them to a known state. It is actively maintained as part of the broader Genie/pyATS ecosystem, with a release cadence tied to the pyATS framework.
pip install genie-libs-cleanVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to instantiate and prepare a `Clean` object with a device and a basic clean YAML process. It shows the correct import and initialization. Note that `clean_obj.go()` is commented out to prevent actual device interaction in a basic runnable example; in a real environment, it would execute the defined clean stages on the device.
Always install `pyats` and `genie` packages from the same release train (e.g., `pip install pyats==<X> genie==<X> genie.libs.clean==<X>`). Refer to Cisco's official pyATS/Genie documentation for version compatibility matrices.
Thoroughly review your pyATS testbed file, ensure the device OS is correctly specified, and verify that the required Genie parsers and device-specific functionalities are available for your device and OS version. Check detailed logs for underlying errors during clean execution.
Always validate your clean YAML against the expected schema provided in the Genie documentation. Pay close attention to stage names (e.g., `install_os`, `apply_configuration`, `reload`) and their required arguments.