- Overview
- Product Documentation
- CML 2.4 Release Notes
- CML 2.4 Installation Guide
- CML 2.4 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
- External Connectivity for Simulations
- Link Packet Capture
- Lab Sharing
- Console Server
- Breakout Tool
- Custom VM Images
- Creating a New Node Definition
- CML 2.4 Admin Guide
- Resources
Installing the Breakout Tool¶
Procedure
Log into the CML server UI.
Click the Tools button and choose .
The CML2 Breakout page will open in a new window. The page includes instructions for using the Breakout Tool.
Click Download in the navigation bar on the left side of the
page. There is a list of links to breakout executable binaries for a
variety of platforms.
Click on the appropriate breakout executable file for your local
computer’s operating system to download the file.
Save the breakout binary to its own folder. The Breakout Tool will
generate configuration and labs files to this folder.
(macOS and Linux) Open a terminal application.
On macOS and Linux operating systems, you must make the binary executable before you can run it.
- (macOS and Linux) Change directory to the Breakout Tool’s location:
cd /path/to/breakout_tool
(macOS and Linux) Change permissions to set the execution bit:
chmod u+x breakout-platform-x86_amd64
You have downloaded and installed the Breakout Tool and are ready to run it on your local machine.
You must configure the Breakout Tool before you can start using it with your labs.