TestingBytes / magic_carpet

Transforming the classic Command-Line Interface

Magic Carpet

Powered by Genie

And the pyATS framework

Welcome!

Magic Carpet is an infrastructure as code and network automation tool that transforms CLI command and REST API data, using the Cisco Genie parsers, the Cisco pyATS Python library, and Python to automatically generate, at scale, better documentation from the output; send #chatbots; #voicebots; even #phonebots!

A Nice JSON file (command_output.json)

A Nice YAML file (command_output.yaml)

A CSV spreadsheet (command_output.csv)

A Markdown file (command_output.md)

An HTML page (comand_output.html)

Instant messages to WebEx, Slack, Discord, and others

Text-to-Speech, in over 200 languages, creating customized MP3 audio files in a human voice

Phone calls to any phone number in the world

Instantly. With the push of a button.

Genie and pyATS

The main Genie documentation guide:

https://developer.cisco.com/docs/genie-docs/

The main pyATS documentation guide: https://developer.cisco.com/docs/pyats/

The Cisco's Test Automation Solution

The Cisco Test Automation GitHub repository

https://github.com/CiscoTestAutomation

Here are the pyATS documentation guides on Testbed files and Device Connectivity:

Testbed and Topology Information: https://pubhub.devnetcloud.com/media/pyats/docs/topology/index.html

Device Connection: https://pubhub.devnetcloud.com/media/pyats-getting-started/docs/quickstart/manageconnections.html

Testbed File Example: https://pubhub.devnetcloud.com/media/pyats/docs/topology/example.html

Device Connections: https://developer.cisco.com/docs/pyats/#!connection-to-devices

Secret Strings (how I encrypted the enable secret in my testbed file): https://pubhub.devnetcloud.com/media/pyats/docs/utilities/secret_strings.html

Simply a better way; a magical way; to collect and transform network state information

Install pyATS

pip install pyats[full]

pip install rich

Update the testbed file to reflect your devices.

Ensure SSH connectivity and run the pyATS job

pyats run job IOS_XE_magic_carpet_job.py --testbed-file testbed/testbed.yaml

First - you will get onto the Magic Carpet

Next - Genie Magic

Finally - We escape the Cave of Wonders with the network data

To View the log in a Web Browser

pyats logs view

IOS-XE Tests

Tested on Cisco Catalyst 4500X-16 03.11.03a.E

Tested on Cisco Catalyst 3850-12X48U Gibraltar 16.12.04

Tested on Cisco Catalyst 9300-48UXM Gibraltar

The World's First Talking Network is Powered by Magic Carpet