Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-virtualbox Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 04:08:49 2022 GMT+0.
Next: Systems, Previous: The cl-virtualbox Reference Manual, Up: The cl-virtualbox Reference Manual [Contents][Index]
cl-virtualbox
is a library that allows you to control VirtualBox from Common
Lisp, by calling the vboxmanage
command.
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:
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
find-by-name (name)
: Find a virtual machine by name.
find-by-uuid (uuid)
: Find a virtual machine by UUID.
Examples:
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")
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.
map-vm-ports (name host-port guest-port)
: Map TCP traffic from host-port
to guest-ip:guest-port
in the guest.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.
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).mount-dvd (name path)
: Mount a DVD to the virtual machine.
unmount-dvd (name)
: Remove the DVD from the virtual DVD drive.
Copyright (c) 2014-2018 Fernando Borretti (eudoxiahp@gmail.com)
Licensed under the MIT License.
Next: Modules, Previous: Introduction, Up: The cl-virtualbox Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Control 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
src (module).
Next: Files, Previous: Systems, Up: The cl-virtualbox Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
cl-virtualbox (system).
cl-virtualbox.lisp (file).
Next: Packages, Previous: Modules, Up: The cl-virtualbox Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-virtualbox/src/cl-virtualbox.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-virtualbox (system).
Previous: cl-virtualbox/cl-virtualbox.asd, Up: Lisp [Contents][Index]
src (module).
Next: Definitions, Previous: Files, Up: The cl-virtualbox Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: cl-virtualbox-asd, Previous: Packages, Up: Packages [Contents][Index]
virtualbox
common-lisp.
Previous: cl-virtualbox, Up: Packages [Contents][Index]
Next: Indexes, Previous: Packages, Up: The cl-virtualbox Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
The path to the VBoxManage command.
Previous: Special variables, Up: Public Interface [Contents][Index]
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.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
Previous: Special variables, Up: Internals [Contents][Index]
Previous: Definitions, Up: The cl-virtualbox Reference Manual [Contents][Index]
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 |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
+
S |
---|
Jump to: | *
+
S |
---|
Jump to: | C F M P S |
---|
Jump to: | C F M P S |
---|