Table of Contents

Virtual machines list and status (vmlist)

Usage

Description

Display the list of managed virtual machines and their status

Parameters

-h           : display help text

-l or --lite : display only configuration file name, service status, model and description.

Example

Virtual machine log view (logview)

Usage

The log files can also be viewed from the menu → "Service management" → "View latest guest log file"

Description

Uses 'vim' editor to view a CHARON virtual machine log file with highlights.

If <logfile> is empty, the script will look for available log files in the virtual machines list managed by the Toolkit. If only one is managed, the current log will be selected, if more than one virtual machine is present, a selection menu will appear.

It is recommended to enlarge the current terminal window to at least 132 columns. If using the graphical version of 'vim' (# logview -g) the window size is set to 32 lines and 160 columns by default.

Parameters

-h            : display help text

-g or --gui   : use 'gvim' instead of 'vim' (if installed)

-s or --short : edit a copy of the log file without 'regular license check'  messages

Example

For ease of use, it is also possible to copy the charonlog.vimrc file to $HOME/.vimrc. Doing so will make 'vim' highlight log lines by default (if you prefer to use 'vim' rather than 'logview')

Virtual machine log tail (logtail)

Usage

The log files can also be continuously viewed from the menu → "Service management" → "View latest guest log file"

Description

Continuous view of a CHARON virtual machine log file with highlights.

Press <CTRL-C> to stop the view.

If <logfile> is empty, the script will look for available log files in the virtual machines list managed by the Toolkit. If only one is managed, the current log will be selected, if more than one virtual machine is present, a selection menu will appear.

It is recommended to enlarge the current terminal window to at least 132 columns.

Parameters

  -h : display help text

Example

Virtual machine start (vmstart)

Usage

Description

Starts the virtual machine specified. If only one virtual machine exists on the server there is no need to specify it (so "vmstart" is enough). If there is more than one virtual machine defined:

• The configuration file name that can be shortened must be passed (Example: to start the virtual machine corresponding to /charon/rp7400.cfg, the command can be "vmstart rp7400").
• If the virtual machine is not specified the latest specified one is used (it is highlighted with a star in the "vmlist" command)

Parameters

  -h : display help text

Virtual machine stop (vmstop)

Usage

Description

Stops the virtual machine specified (confirmation required if -f is not specified). If only one virtual machine exists on the server there is no need to specify it (so "vmstop" is enough). If there is more than one virtual machine defined:

• The configuration file name that can be shortened must be passed (Example: to stop the virtual machine corresponding to /charon/rp7400.cfg, the command can be "vmstop rp7400")
• If the virtual machine is not specified the latest specified one is used (it is highlighted with a star in the "vmlist" command)

If a shutdown script has been defined (see VM management - Create/Edit guest stop script), it will be executed before the service is stopped.

Parameters

  -h : display help text

  -f : force the virtual machine to stop without asking confirmation

Connection to console (vmconsole)

Usage

Description

Connects to the running virtual machine console specified. If only one virtual machine exists on the server there is no need to specify it (so "vmconsole" is enough). If there is more than one virtual machine defined:

• The configuration file name that can be shortened must be passed (Example: to connect to the virtual machine console corresponding to /charon/rp7400.cfg, the command can be "vmconsole rp7400")
• If the virtual machine is not specified the latest specified one is used (it is highlighted with a star in the "vmlist" command)

If the corresponding virtual machine is running, updates in the configuration file will be taken into account on Charon emulator restart.

Parameters

  -h : display help text

Configuration file editing (vmcfg)

Usage

Description

Edits the virtual machine configuration file specified and perform some checks upon exit. If only one virtual machine exists on the server there is no need to specify it (so "vmcfg" is enough). If there is more than one virtual machine defined:

• The configuration file name that can be shortened must be passed (Example: to edit virtual machine configuration file /charon/rp7400.cfg, the command can be "vmcfg rp7400").
• If the virtual machine is not specified the latest specified one is used (it is highlighted with a star in the "vmlist" command)

Parameters

  -h : display help text