pyATS Library: Genie

Getting started

  • Introduction
  • Installation
  • Getting Started

Documentation

  • User Guide
  • pyATS Clean
    • Supported Platforms and PowerCyclers
    • User Guide
      • Quick Start
      • Writing a Clean (YAML File)
        • Getting Ready
        • Adding the Cleaner Class
        • Intro to Stages (Clean Step)
        • Cleaning Devices
        • Cleaning Like Devices
        • Image Management
        • Device Recovery
      • Executing a Clean
      • Viewing Clean Logs
      • Run Stages Inside a Testscript
    • Developer Guide
    • Features
    • Glossary
    • Support
  • pyATS Blitz
  • pyATS Health Check
  • Genie Command Line
  • Genie Solutions
  • Internal Documentation

Library

  • Available APIs
  • Available Clean Stages
  • Available Models (Conf/Ops)
  • Available Parsers
  • Available Triggers
  • Available Verifications

Developer Docs

  • Library Abstraction
  • Metaparsers
  • CLI Auto-Parser
  • Predicates

Reference

  • Roadmap
  • Changelog
pyATS Library: Genie
  • Introduction to pyATS Clean
  • User Guide
  • Writing a Clean (YAML File)

Writing a Clean (YAML File)

This topic goes over writing a Clean YAML file in detail. It is recommended to read this section top-down as both Intro to Stages (Clean Step) and Intro to Device Recovery provide preliminary information.

Topics you will discover include:

  • 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
Previous Next

© Copyright 2025, Cisco Systems Inc.. Last updated on Apr 25, 2025.