pyats-version

Display version of all packages

$ pyats version check

$ pyats version check --outdated

$ pyats version update

$ pyats version update [version]

pyats-version [-h] [--json] [-f | --full]

-h, --help
    Displays a help message for the command and exits, providing information on its usage and available options.

--json
    Outputs the version information in a structured JSON format. This is particularly useful for scripting, parsing the output programmatically, or integrating into automated reporting systems.

-f, --full
    Provides a comprehensive and detailed breakdown of all installed pyATS components and their respective versions. This includes core packages like aetest, genie, unicon, and other dependencies, offering a complete overview of the pyATS ecosystem setup.

pyats-version is a fundamental utility command within the Cisco pyATS framework, a powerful and extensible Python-based solution for automated network device testing and verification. The primary purpose of this command is to quickly and accurately retrieve the installed version of the pyATS core package and, optionally, its associated sub-packages and dependencies.

In complex network automation environments, knowing the exact software versions is critical for troubleshooting, ensuring compatibility between test scripts and the framework, and verifying the correct setup of a development or test environment. This command provides a straightforward way for developers, QA engineers, and network automation specialists to confirm their pyATS installation details.

It helps in identifying whether an outdated version is in use, or if specific components required for certain test functionalities are present and at the expected version. The output can be tailored to be human-readable or machine-parseable (JSON), making it versatile for both interactive use and integration into larger automation workflows or CI/CD pipelines.

This command requires the Cisco pyATS framework to be installed in your Python environment. The exact details provided by the --full option may vary slightly depending on your specific pyATS installation (e.g., installed via pip, from source, or specific distribution). Ensure your Python environment is correctly activated if using virtual environments.

To display the basic pyATS version:
pyats-version

To get the full version details of all components:
pyats-version --full

To output the version information in JSON format:
pyats-version --json

The pyats-version command has been an integral part of the pyATS framework since its early development. Initially conceived as an internal Cisco tool, pyATS was later open-sourced, and the version command remained a core utility for users to quickly ascertain their framework's status. Its functionality has largely remained consistent, with enhancements like the JSON output option being added to cater to modern automation and scripting needs.

pip(1), python(1)