- Overview
- Product Documentation
- CML 2.5 Release Notes
- CML 2.5 Installation Guide
- CML 2.5 User Guide
- CML User's Guide
- Overview of CML 2.x
- Using CML and the HTML5 UI
- Dashboard
- Workbench
- Adding Nodes to a Lab
- Starting, Stopping, and Wiping Nodes
- Deleting Nodes
- Creating Links
- Rules for Creating Links and Interface Overprovisioning
- Adding Interfaces and Overprovisioning
- Overprovisioning Interfaces with Link Creation
- Hiding Links
- Starting Simulations
- Connecting to a Node's Console
- Changing Global Console Settings
- Download the Console History
- Setting CPU limit on node
- Launch sequencing and CPU limiting
- Stopping Simulations
- Annotations
- External Connectivity for Simulations
- Link Packet Capture
- Lab Sharing
- Console Server
- Breakout Tool
- Custom VM Images
- Creating a New Node Definition
- Viewing Resource Limits
- CML 2.5 Admin Guide
- Resources
Breakout Tool Overview¶
The Breakout Tool gives you local access to consoles and graphical interfaces of
VMs running in a remote lab. The telnet protocol is used for console access, and
VNC protocol is used for graphics-capable VMs. The Breakout Tool is a single
executable file that you run on the command line. It provides a kind of proxy
connection from the local machine, where the tool has been configured and
started, to the nodes in the lab simulation. Once you install it, you can
configure the Breakout Tool using a web interface that is accessible via the
localhost (i.e. 127.0.0.1or [::1]) or loopback address on port
8080 by default. The port and listen address and the CML server’s URL can be
configured via command line options or the tool’s configuration file
(config.yaml). Using the Breakout Tool, you can use your favorite terminal
emulator app to connect to your nodes’ consoles on configurable local ports.