Breakout Tool Configuration Settings

Other than the controller address, username, and password, the following settings for the Breakout Tool may not be empty, but for most applications you may simply use the default values. The Breakout Tool’s config command and the Breakout UI can both write a default config.yaml with default configuration values for these settings.

Setting	Description
Controller Address	The URL for the CML server.
Username	The CML application user; normally, the value is just the owner of the lab.
Password	The application password for the specified user.
Console Start Port	Connections to console ports will be enumerated starting with the specified port number.
VNC Start Port	Connections to VNC consoles will be enumerated starting with the specified port number.
Listen Address	Local IP address or interface used by the Breakout UI web interface when it is run with the Breakout Tool’s ui command.
UI Server Port	The local TCP port used by the Breakout UI web interface when it is run with the Breakout Tool’s ui command.
Labs Filename	The Breakout UI uses the Labs Filename (labs.yaml) to save the settings for all running labs from the CML server. This file is not the same as the individual lab topology files shown in the Dashboard. Settings for all running labs and running (default) nodes will be written to this file when you click Save labs to local disk in the Breakout UI.