This is the cl-virtualbox Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:48:39 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-virtualboxControl VirtualBox from Common Lisp
Fernando Borretti
MIT
‘cl-virtualbox‘ is a library that allows you to control VirtualBox from Common
Lisp, by calling the ‘vboxmanage‘ command.
# Usage
## Listing VMs
* ‘list-vms ()‘: Return a list of plists with the :name and :uuid of every
virtual machine.
* ‘list-running-vms ()‘: Like ‘list-vms‘, but only return the VMs that are
running.
Examples:
~~~lisp
virtualbox> (list-vms)
((:uuid "68fdde1a-a009-4c6f-af6e-250ef879e3e7" :name
"crane_ubuntu_1410013141185_11153")
(:uuid "b0ebec92-85cb-408c-b32c-c969e6392d5f" :name
"vm_ubuntu_1410966111913_95217")
(:uuid "9ad98045-5109-4233-8b82-4c9a49b4cab7" :name
"trivial-ssh_default_1411575480546_50302")
(:uuid "5d287f3c-9b17-4a66-990a-80d4db3167ae" :name "windows"))
virtualbox> (list-running-vms)
nil
~~~
## Finding VMs
* ‘find-by-name (name)‘: Find a virtual machine by name.
* ‘find-by-uuid (uuid)‘: Find a virtual machine by UUID.
Examples:
~~~lisp
virtualbox> (find-by-name "crane_ubuntu_1410013141185_11153")
(:uuid "68fdde1a-a009-4c6f-af6e-250ef879e3e7" :name
"crane_ubuntu_1410013141185_11153")
virtualbox> (find-by-uuid "9ad98045-5109-4233-8b82-4c9a49b4cab7")
(:uuid "9ad98045-5109-4233-8b82-4c9a49b4cab7" :name
"trivial-ssh_default_1411575480546_50302")
~~~
## Creating and Modifying VMs
* ‘create-vm (name)‘: Create a new virtual machine named ‘name‘.
* ‘set-vm-memory (name memory)‘: Set the VM’s memory (In megabytes)
* ‘set-vm-vram (name memory)‘: The the VM’s video memory (In megabytes).
* ‘set-vm-cpu-count (name count)‘: Set the number of virtual CPUs the VM has.
* ‘set-vm-acpi (name state)‘: Turn ACPI support on/off.
* ‘set-vm-ioapic (name state)‘: Turn IOAPIC support on/off.
* ‘set-vm-pae (name state)‘: Enable/disable PAE.
* ‘set-vm-longmode (name state)‘: Enable/disable longmode.
* ‘set-vm-hpet (name state)‘: Enable/disable the High-Precision Event Timer
(HPET).
* ‘set-vm-3d-acceleration (name state)‘: Enable/disable 3D acceleration.
## Network Configuration
* ‘map-vm-ports (name host-port guest-port)‘: Map TCP traffic from ‘host-port‘
to ‘guest-ip:guest-port‘ in the guest.
## Controlling VM State
* ‘start-vm (name &key (type headless))‘: Start the virtual machine.
* ‘pause-vm (name)‘: Pause the virtual machine.
* ‘resume-vm (name)‘: Resume the virtual machine after pausing it.
* ‘cold-reboot-vm (name)‘: Reboot the virtual machine.
* ‘poweroff-vm (name)‘: Power off the virtual machine.
## Managing Hard Drives
* ‘create-hd (path &key size (format vdi))‘: Create a virtual hard drive on ‘path‘, with size ‘size‘ (In megabytes) and type ‘type‘ (:vdi by default).
## Managing DVDs
* ‘mount-dvd (name path)‘: Mount a DVD to the virtual machine.
* ‘unmount-dvd (name)‘: Remove the DVD from the virtual DVD drive.
# License
Copyright (c) 2014-2018 Fernando Borretti (eudoxiahp@gmail.com)
Licensed under the MIT License.
0.1
cl-ppcre (system).
uiop (system).
alexandria (system).
usocket (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-virtualbox/srccl-virtualbox (system).
cl-virtualbox.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-virtualbox/cl-virtualbox.asdcl-virtualbox (system).
cl-virtualbox/src/cl-virtualbox.lispsrc (module).
*vboxmanage-path* (special variable).
attach-hd (function).
cold-reboot-vm (function).
configure-network (function).
create-hd (function).
create-vm (function).
execute (function).
find-by-name (function).
find-by-uuid (function).
import-vm (function).
list-host-only-ifs (function).
list-running-vms (function).
list-vms (function).
map-vm-ports (function).
mount-dvd (function).
pause-vm (function).
poweroff-vm (function).
resume-vm (function).
send-virtual-input (function).
set-vm-3d-acceleration (function).
set-vm-acpi (function).
set-vm-cpu-count (function).
set-vm-hpet (function).
set-vm-ioapic (function).
set-vm-ip (function).
set-vm-longmode (function).
set-vm-memory (function).
set-vm-pae (function).
set-vm-vram (function).
start-vm (function).
unmount-dvd (function).
+character-scancode-map+ (special variable).
+special-scancode-map+ (special variable).
bool->str (function).
cmd (function).
keyword->scancodes (function).
keyword->str (function).
parse-key-value (function).
parse-list-line (function).
parse-report (function).
parse-vm-list (function).
run-cmd (function).
send-scancodes (function).
split-by-double-newlines (function).
split-by-newlines (function).
string->scancodes (function).
Packages are listed by definition order.
cl-virtualboxvirtualbox
common-lisp.
*vboxmanage-path* (special variable).
attach-hd (function).
cold-reboot-vm (function).
configure-network (function).
create-hd (function).
create-vm (function).
execute (function).
find-by-name (function).
find-by-uuid (function).
import-vm (function).
list-host-only-ifs (function).
list-running-vms (function).
list-vms (function).
map-vm-ports (function).
mount-dvd (function).
pause-vm (function).
poweroff-vm (function).
resume-vm (function).
send-virtual-input (function).
set-vm-3d-acceleration (function).
set-vm-acpi (function).
set-vm-cpu-count (function).
set-vm-hpet (function).
set-vm-ioapic (function).
set-vm-ip (function).
set-vm-longmode (function).
set-vm-memory (function).
set-vm-pae (function).
set-vm-vram (function).
start-vm (function).
unmount-dvd (function).
+character-scancode-map+ (special variable).
+special-scancode-map+ (special variable).
bool->str (function).
cmd (function).
keyword->scancodes (function).
keyword->str (function).
parse-key-value (function).
parse-list-line (function).
parse-report (function).
parse-vm-list (function).
run-cmd (function).
send-scancodes (function).
split-by-double-newlines (function).
split-by-newlines (function).
string->scancodes (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The path to the VBoxManage command.
Reboot the virtual machine.
The hard way to set an IP address.
Create a virtual hard drive on ‘path‘, with size ‘size‘ (In megabytes) and type ‘type‘ (:vdi by default).
Create a new virtual machine named ‘name‘.
Execute ‘image‘ on the virtual machine ‘name‘, under the account ‘username‘ and ‘password‘. If ‘wait-stdout‘ is true, wait for the program to finish and print its output.
Find a virtual machine by name.
Find a virtual machine by UUID.
Import a virtual machine from an OVF file.
List host only interfaces.
Like ‘list-vms‘, but only return the VMs that are running.
Return a list of plists with the :name and :uuid of every virtual machine.
Map TCP traffic from ‘host-port‘ to ‘guest-ip:guest-port‘ in the guest.
Mount a DVD to the virtual machine.
Pause the virtual machine.
Power off the virtual machine.
Resume the virtual machine after pausing it.
Enable/disable 3D acceleration.
Turn ACPI support on/off.
Set the number of virtual CPUs the VM has.
Enable/disable the High-Precision Event Timer (HPET).
Turn IOAPIC support on/off.
The easy way to set an IP address.
Enable/disable longmode.
Set the VM’s memory (In megabytes)
Enable/disable PAE.
The the VM’s video memory (In megabytes).
Start the virtual machine.
Remove the DVD from the virtual DVD drive.
| Jump to: | A B C E F I K L M P R S U |
|---|
| Jump to: | A B C E F I K L M P R S U |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | C F M P S |
|---|
| Jump to: | C F M P S |
|---|