Tuesday, September 04, 2012

VirtualBox VM manager command line


C:\Program Files\Oracle\VirtualBox>VBoxManage.exe
Oracle VM VirtualBox Command Line Management Interface Version 4.1.20
(C) 2005-2012 Oracle Corporation
All rights reserved.

Usage:

VBoxManage [-v|--version]    print version number and exit
VBoxManage [-q|--nologo] ... suppress the logo

VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|
                            bridgedifs|hostonlyifs|dhcpservers|hostinfo|
                            hostcpuids|hddbackends|hdds|dvds|floppies|
                            usbhost|usbfilters|systemproperties|extpacks

VBoxManage showvminfo       | [--details]
                            [--machinereadable]
VBoxManage showvminfo       | --log

VBoxManage registervm      

VBoxManage unregistervm     | [--delete]

VBoxManage createvm         --name
                            [--ostype ]
                            [--register]
                            [--basefolder ]
                            [--uuid ]

VBoxManage modifyvm        
                            [--name ]
                            [--ostype ]
                            [--memory ]
                            [--pagefusion on|off]
                            [--vram ]
                            [--acpi on|off]
                            [--pciattach 03:04.0]
                            [--pciattach 03:04.0@02:01.0]
                            [--pcidetach 03:04.0]
                            [--ioapic on|off]
                            [--pae on|off]
                            [--hpet on|off]
                            [--hwvirtex on|off]
                            [--hwvirtexexcl on|off]
                            [--nestedpaging on|off]
                            [--largepages on|off]
                            [--vtxvpid on|off]
                            [--synthcpu on|off]
                            [--cpuidset ]
                            [--cpuidremove ]
                            [--cpuidremoveall]
                            [--hardwareuuid ]
                            [--cpus ]
                            [--cpuhotplug on|off]
                            [--plugcpu ]
                            [--unplugcpu ]
                            [--cpuexecutioncap <1 -100="-100">]
                            [--rtcuseutc on|off]
                            [--monitorcount ]
                            [--accelerate3d on|off]
                            [--accelerate2dvideo on|off]
                            [--firmware bios|efi|efi32|efi64]
                            [--chipset ich9|piix3]
                            [--bioslogofadein on|off]
                            [--bioslogofadeout on|off]
                            [--bioslogodisplaytime ]
                            [--bioslogoimagepath ]
                            [--biosbootmenu disabled|menuonly|messageandmenu]
                            [--biossystemtimeoffset ]
                            [--biospxedebug on|off]
                            [--boot<1 -4="-4"> none|floppy|dvd|disk|net>]
                            [--nic<1 -n="-n"> none|null|nat|bridged|intnet|hostonly|
                                        generic]
                            [--nictype<1 -n="-n"> Am79C970A|Am79C973|
                                            82540EM|82543GC|82545EM|
                                            virtio]
                            [--cableconnected<1 -n="-n"> on|off]
                            [--nictrace<1 -n="-n"> on|off]
                            [--nictracefile<1 -n="-n"> ]
                            [--nicproperty<1 -n="-n"> name=[value]]
                            [--nicspeed<1 -n="-n"> ]
                            [--nicbootprio<1 -n="-n"> ]
                            [--nicpromisc<1 -n="-n"> deny|allow-vms|allow-all]
                            [--nicbandwidthgroup<1 -n="-n"> none|]
                            [--bridgeadapter<1 -n="-n"> none|]
                            [--hostonlyadapter<1 -n="-n"> none|]
                            [--intnet<1 -n="-n"> ]
                            [--natnet<1 -n="-n"> |default]
                            [--nicgenericdrv<1 -n="-n">
                            [--natsettings<1 -n="-n"> [],[],
                                                [],[],
                                                []]
                            [--natpf<1 -n="-n"> [],tcp|udp,[],
                                          ,[],]
                            [--natpf<1 -n="-n"> delete ]
                            [--nattftpprefix<1 -n="-n"> ]
                            [--nattftpfile<1 -n="-n"> ]
                            [--nattftpserver<1 -n="-n"> ]
                            [--natbindip<1 -n="-n">
                            [--natdnspassdomain<1 -n="-n"> on|off]
                            [--natdnsproxy<1 -n="-n"> on|off]
                            [--natdnshostresolver<1 -n="-n"> on|off]
                            [--nataliasmode<1 -n="-n"> default|[log],[proxyonly],
                                                         [sameports]]
                            [--macaddress<1 -n="-n"> auto|]
                            [--mouse ps2|usb|usbtablet
                            [--keyboard ps2|usb
                            [--uart<1 -n="-n"> off| ]
                            [--uartmode<1 -n="-n"> disconnected|
                                             server |
                                             client |
                                             file |
                                             ]
                            [--guestmemoryballoon ]
                            [--gueststatisticsinterval ]
                            [--audio none|null|dsound]
                            [--audiocontroller ac97|hda|sb16]
                            [--clipboard disabled|hosttoguest|guesttohost|
                                         bidirectional]
                            [--vrde on|off]
                            [--vrdeextpack default|
                            [--vrdeproperty ]
                            [--vrdeport ]
                            [--vrdeaddress ]
                            [--vrdeauthtype null|external|guest]
                            [--vrdeauthlibrary default|
                            [--vrdemulticon on|off]
                            [--vrdereusecon on|off]
                            [--vrdevideochannel on|off]
                            [--vrdevideochannelquality ]
                            [--usb on|off]
                            [--usbehci on|off]
                            [--snapshotfolder default|]
                            [--teleporter on|off]
                            [--teleporterport ]
                            [--teleporteraddress

                            [--teleporterpassword ]
                            [--teleporterpasswordfile  |stdin]
                            [--usbcardreader on|off]

VBoxManage clonevm          |
                            [--snapshot |]
                            [--mode machine|machineandchildren|all]
                            [--options link|keepallmacs|keepnatmacs|
                                       keepdisknames]
                            [--name ]
                            [--basefolder ]
                            [--uuid ]
                            [--register]

VBoxManage import          
                            [--dry-run|-n]
                            [--options keepallmacs|keepnatmacs]
                            [more options]
                            (run with -n to have options displayed
                             for a particular OVF)

VBoxManage export           --output|-o
                            [--legacy09]
                            [--manifest]
                            [--vsys ]
                                    [--product ]
                                    [--producturl ]
                                    [--vendor ]
                                    [--vendorurl ]
                                    [--version ]
                                    [--eula ]
                                    [--eulafile ]

VBoxManage startvm          |...
                            [--type gui|sdl|headless]

VBoxManage controlvm        |
                            pause|resume|reset|poweroff|savestate|
                            acpipowerbutton|acpisleepbutton|
                            keyboardputscancode [ ...]|
                            setlinkstate<1 -n="-n"> on|off |
                            nic<1 -n="-n"> null|nat|bridged|intnet|hostonly|generic
                                     [] |
                            nictrace<1 -n="-n"> on|off
                            nictracefile<1 -n="-n">
                            nicproperty<1 -n="-n"> name=[value]
                            natpf<1 -n="-n"> [],tcp|udp,[],
                                          ,[],
                            natpf<1 -n="-n"> delete
                            guestmemoryballoon ]
                            gueststatisticsinterval ]
                            usbattach |
|

                            usbdetach |
|

                            vrde on|off |
                            vrdeport |
                            vrdeproperty |
                            vrdevideochannelquality
                            setvideomodehint [display] |
                            screenshotpng [display] |
                            setcredentials
                                           [--allowlocallogon ] |
                            teleport --host --port
                                   [--maxdowntime ] [--password password]
                            plugcpu
                            unplugcpu
                            cpuexecutioncap <1 -100="-100">

VBoxManage discardstate     |

VBoxManage adoptstate       |

VBoxManage snapshot         |
                            take [--description ] [--pause] |
                            delete | |
                            restore | |
                            restorecurrent |
                            edit ||--current
                                 [--name ]
                                 [--description ] |
                            list [--details|--machinereadable]
                            showvminfo |

VBoxManage closemedium      disk|dvd|floppy |
                            [--delete]

VBoxManage storageattach    
                            --storagectl
                            [--port ]
                            [--device ]
                            [--type dvddrive|hdd|fdd]
                            [--medium none|emptydrive|
                                      ||host:|iscsi]
                            [--mtype normal|writethrough|immutable|shareable|
                                     readonly|multiattach]
                            [--comment ]
                            [--setuuid ]
                            [--setparentuuid ]
                            [--passthrough on|off]
                            [--tempeject on|off]
                            [--nonrotational on|off]
                            [--bandwidthgroup ]
                            [--forceunmount]
                            [--server |]
                            [--target ]
                            [--tport ]
                            [--lun ]
                            [--encodedlun ]
                            [--username ]
                            [--password ]
                            [--intnet]

VBoxManage storagectl      
                            --name
                            [--add ide|sata|scsi|floppy|sas]
                            [--controller LSILogic|LSILogicSAS|BusLogic|
                                          IntelAHCI|PIIX3|PIIX4|ICH6|I82078]
                            [--sataideemulation<1 -4="-4"> <1 -30="-30">]
                            [--sataportcount <1 -30="-30">]
                            [--hostiocache on|off]
                            [--bootable on|off]
                            [--remove]

VBoxManage bandwidthctl    
                            --name
                            [--add disk|network]
                            [--limit
                            [--delete]

VBoxManage showhdinfo       |

VBoxManage createhd         --filename
                            --size |--sizebyte
                            [--format VDI|VMDK|VHD] (default: VDI)
                            [--variant Standard,Fixed,Split2G,Stream,ESX]

VBoxManage modifyhd         |
                            [--type normal|writethrough|immutable|shareable|
                                    readonly|multiattach]
                            [--autoreset on|off]
                            [--compact]
                            [--resize |--resizebyte ]

VBoxManage clonehd          | |
                            [--format VDI|VMDK|VHD|RAW|]
                            [--variant Standard,Fixed,Split2G,Stream,ESX]
                            [--existing]

VBoxManage convertfromraw  
                            [--format VDI|VMDK|VHD]
                            [--variant Standard,Fixed,Split2G,Stream,ESX]
                            [--uuid

VBoxManage getextradata     global||
                            |enumerate

VBoxManage setextradata     global||
                           
                            [] (no value deletes key)

VBoxManage setproperty      machinefolder default| |
                            vrdeauthlibrary default| |
                            websrvauthlibrary default|null| |
                            vrdeextpack null| |
                            loghistorycount

VBoxManage usbfilter        add
                            --target ||global
                            --name
                            --action ignore|hold (global filters only)
                            [--active yes|no] (yes)
                            [--vendorid ] (null)
                            [--productid ] (null)
                            [--revision ] (null)
                            [--manufacturer ] (null)
                            [--product ] (null)
                            [--remote yes|no] (null, VM filters only)
                            [--serialnumber ] (null)
                            [--maskedinterfaces ]

VBoxManage usbfilter        modify
                            --target ||global
                            [--name ]
                            [--action ignore|hold] (global filters only)
                            [--active yes|no]
                            [--vendorid |""]
                            [--productid |""]
                            [--revision |""]
                            [--manufacturer |""]
                            [--product |""]
                            [--remote yes|no] (null, VM filters only)
                            [--serialnumber |""]
                            [--maskedinterfaces ]

VBoxManage usbfilter        remove
                            --target ||global

VBoxManage sharedfolder     add |
                            --name --hostpath
                            [--transient] [--readonly] [--automount]

VBoxManage sharedfolder     remove |
                            --name [--transient]

VBoxManage guestproperty    get |
                            [--verbose]

VBoxManage guestproperty    set |
                            [ [--flags ]]

VBoxManage guestproperty    enumerate |
                            [--patterns ]

VBoxManage guestproperty    wait |
                            [--timeout ] [--fail-on-timeout]

VBoxManage guestcontrol     |
                            exec[ute]
                            --image
                            --username --password
                            [--dos2unix]
                            [--environment "= [=]"]
                            [--timeout ] [--unix2dos] [--verbose]
                            [--wait-exit] [--wait-stdout] [--wait-stderr]
                            [-- [] ... []]

                            copyfrom
                           
                            --username --password
                            [--dryrun] [--follow] [--recursive] [--verbose]

                            copyto|cp
                           
                            --username --password
                            [--dryrun] [--follow] [--recursive] [--verbose]

                            createdir[ectory]|mkdir|md
                           
                            --username --password
                            [--parents] [--mode ] [--verbose]

                            stat
                           
                            --username --password
                            [--verbose]

                            updateadditions
                            [--source ] [--verbose]

VBoxManage debugvm          |
                            dumpguestcore --filename |
                            info [args] |
                            injectnmi |
                            log [--release|--debug] ...|
                            logdest [--release|--debug] ...|
                            logflags [--release|--debug] ...|
                            osdetect |
                            osinfo |
                            getregisters [--cpu ] |all ... |
                            setregisters [--cpu ] = ... |
                            statistics [--reset] [--pattern ]
                            [--descriptions]

VBoxManage metrics          list [*|host| []]
                                                 (comma-separated)

VBoxManage metrics          setup
                            [--period ] (default: 1)
                            [--samples ] (default: 1)
                            [--list]
                            [*|host| []]

VBoxManage metrics          query [*|host| []]

VBoxManage metrics          enable
                            [--list]
                            [*|host| []]

VBoxManage metrics          disable
                            [--list]
                            [*|host| []]

VBoxManage metrics          collect
                            [--period ] (default: 1)
                            [--samples ] (default: 1)
                            [--list]
                            [--detach]
                            [*|host| []]

VBoxManage hostonlyif       ipconfig
                            [--dhcp |
                            --ip [--netmask (def: 255.255.255.0)] |
                            --ipv6 [--netmasklengthv6 (def: 64)]]
                            create |
                            remove

VBoxManage dhcpserver       add|modify --netname |
                                       --ifname
                            [--ip
                            --netmask
                            --lowerip
                            --upperip ]
                            [--enable | --disable]

VBoxManage dhcpserver       remove --netname |
                                   --ifname

VBoxManage extpack          install [--replace] |
                            uninstall [--force] |
                            cleanup

No comments: