User Guide

Note

The User Guide does not contain any information related to developing/contributing to pyATS Clean. We encourage contributions and you can find the required information in the Developer Guide.

The User Guide is intended to be read top-down, front-to-back, as early topics may contain information that is important to know for later topics. This Guide contains everything required to use pyATS Clean and is suitable for new users and advanced users.

The User Guide includes the following topics and subtopics:

• Quick Start
  • Getting Ready
    • pyATS and Genie installed (latest version)
    • Testbed YAML File
    • Clean YAML File
  • Defining the Cleaner Class
  • Defining a Device to Clean
  • Defining a Stage (Clean Step)
  • Finishing Up
    • To Execute the Clean
    • Moving Forward
• Writing a Clean (YAML File)
  • Getting Ready
    • pyATS and Genie installed (latest version)
    • Testbed YAML File
    • Clean YAML File
  • Adding the Cleaner Class
    • Cleaner Class for pyATS Clean
    • Combining a different clean with pyATS Clean
  • Intro to Stages (Clean Step)
    • The Methodology Behind Clean Stages
    • What Clean Stages are Available
    • Developing New Clean Stages
  • Cleaning Devices
    • Adding the Devices Block
    • Adding a Device
    • Adding Stages
  • Cleaning Like Devices
    • How to Specify Device Groups?
    • How to add Stages to Device Groups?
  • Image Management
    • Images key structure for Image Management
    • Images override behavior
  • Device Recovery
    • The Methodology Behind Device Recovery
    • How Device Recovery Works
    • How to Enable Device Recovery
• Executing a Clean
  • Prerequisites
  • Running before a pyATS Script
  • Running without a pyATS Script
  • Passing images through CLI
  • Clean Schema Validation
• Viewing Clean Logs
• Run Stages Inside a Testscript
  • Example