.. breakout documentation master file, created by

CML :sup:`2` Breakout Tool Documentation
==========================================

This is the CML :sup:`2` Breakout tool documentation. The Breakout tool
provides users connectivity to the device console ports that are operating in a
lab environment.

.. image:: _static/overview.png
   :width: 800px
   :align: center
   :alt: CML2 breakout overview

By using the Breakout tool, all access to the serial consoles and remote device
framebuffers (via VNC) is encrypted and authenticated. This minimizes the
exposure of often unauthenticated router consoles or VNC connections and
increases the security of the overall solution.

The tool acts like a a local terminal server that embeds the various
serial ports / lines into an single HTTPS connection to the control server.
Console access is done via Telnet and the graphics framebuffer is accessed via
the VNC protocol.

The CML :sup:`2` Breakout Tool allows for users to use their favorite external
terminal emulator like Putty, Kitty, SecureCRT, etc. to devices running inside a
topology on a CML :sup:`2` server.

.. seealso:: For the easiest and quickest way to use the Breakout tool see the
   :ref:`ui_usage` documentation page.


.. toctree::
    :maxdepth: 2
    :caption: Content
    :glob:

    general
    download
    ui_usage
    macos
    windows
    protocol_handlers
    appendix
