LinuxCommandLibrary

pyats

Automate network testing and validation

TLDR

Run a pyATS subcommand

$ pyats [subcommand]
copy

Display help
$ pyats --help
copy

Display help about a specific subcommand
$ pyats [subcommand] --help
copy

Display version
$ pyats version check
copy

SYNOPSIS

pyats run job [options]

PARAMETERS

--testbed-file
    Specifies the testbed file to use for the test run.

--html-report
    Generates an HTML report of the test results.

--email-recipients
    Sends an email report to the specified email addresses.

--verbose
    Enables verbose output during the test run.

--trigger-datafile
    Specifies a data file for trigger-based tests.


    The path to the job file to be executed.

DESCRIPTION

pyATS is a Python-based ecosystem designed for automated network testing and validation. It provides a framework for developing reusable, structured, and easily maintainable test cases. pyATS simplifies the complexities of network testing by offering features such as device abstraction, data-driven testing, and result reporting. It allows engineers to automate network device configuration, verification, and validation, leading to faster release cycles and improved network reliability. Its core components include pyATS libraries that handle connectivity, parsing, and device interaction, and Genie, which adds a higher-level abstraction layer for common networking tasks. With pyATS, test automation becomes accessible, scalable, and adaptable to evolving network environments.

It's not a single command line utility but an Ecosystem, so the following would describe using a command in a pyATS project.

For Example, use the `pyats run job` command to execute a job file containing the test orchestration.

CAVEATS

pyATS requires a proper Python environment with the necessary packages installed. Job files and testbed files must be correctly formatted and configured. Understanding Python and networking concepts is beneficial for effectively using pyATS.

JOB FILES

Job files are Python scripts that define the test sequence, including which test cases to run and how to handle results. They orchestrate the entire testing process.

TESTBED FILES

Testbed files describe the network topology and device connection details. They allow pyATS to connect to and interact with network devices.

TRIGGERS

Triggers are mechanisms for automating the execution of test cases based on specific network events or conditions. They can be used to run tests automatically in response to configuration changes or network failures.

HISTORY

pyATS was developed by Cisco Systems to address the growing need for automated network testing. It has evolved into a widely adopted framework in the networking industry, with a strong community contributing to its development and providing support. Its origins lie in the need to streamline and automate complex network validation processes.

SEE ALSO

python(1)

Copied to clipboard