Skip to main content

Unicon Connection Library

Project description

Unicon is a package aiming to provide a unified connection experience to network devices through typical command-line management interface. By wrapping the underlying session (eg, telnet, ssh), Unicon provides:

  • direct and proxied connections through any common CLI interface (telnet, ssh, serial etc)
  • power of expect-like programming without having to deal with low-level logic
  • multi-vendor support through an agnostic API interface
  • seamless handling of CLI modes (eg, enable, configure, admin-configure mode)
  • rejected commands, command error detections
  • value-add statful services (specific to the platform)

and is extensible: platform supports and services are implemented via open-source plugins.

Unicon is the standard, go-to CLI connection implementation for Cisco pyATS framework.

This package was initially developed internally in Cisco, and is now release to the general public starting late 2017 through Cisco DevNet.

https://developer.cisco.com/pyats/

Requirements

  • Linux/macOS/WSL
  • Python 3.4+

Quick Start

bash$ pip install unicon

For more information on setting up your Python development environment, such as creating virtual environment and installing pip on your system, please refer to Virtual Environment and Packages in Python tutorials.

Examples

See example of a Unicon connection usage with Cisco IOS devices at:

https://github.com/CiscoDevNet/pyats-ios-sample

In addition, there is a sample plugin package you can follow to develop Unicon plugins for new platforms on top of Unicon:

https://github.com/CiscoDevNet/pyats-plugin-examples/tree/master/unicon_plugin_example

Support & Community

See https://developer.cisco.com/docs/pyats/#!license-support page for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distributions

unicon-22.4-cp310-cp310-manylinux1_x86_64.whl (11.9 MB view hashes)

Uploaded cp310

unicon-22.4-cp39-cp39-manylinux1_x86_64.whl (11.8 MB view hashes)

Uploaded cp39

unicon-22.4-cp38-cp38-manylinux1_x86_64.whl (13.2 MB view hashes)

Uploaded cp38

unicon-22.4-cp37-cp37m-manylinux1_x86_64.whl (10.4 MB view hashes)

Uploaded cp37

unicon-22.4-cp36-cp36m-manylinux1_x86_64.whl (10.5 MB view hashes)

Uploaded cp36

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page