VBoxManageHelp.cpp revision 01b2e367e947049139a5d5813ccc1fa162b11f76
3853N/A * VBoxManage - help and other message output. 3853N/A * Copyright (C) 2006-2012 Oracle Corporation 3853N/A * This file is part of VirtualBox Open Source Edition (OSE), as 3853N/A * you can redistribute it and/or modify it under the terms of the GNU 3853N/A * General Public License (GPL) as published by the Free Software 3853N/A * Foundation, in version 2 as it comes in the "COPYING" file of the 3853N/A * VirtualBox OSE distribution. VirtualBox OSE is distributed in the 3853N/A * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. 3853N/A/******************************************************************************* 3853N/A*******************************************************************************/ 3853N/A "VBoxManage [-v|--version] print version number and exit\n" 3853N/A "VBoxManage [-q|--nologo] ... suppress the logo\n" 3853N/A "VBoxManage [--settingspw <pw>] ...\n" 3853N/A "VBoxManage [--settingspwfile] ... provide the settings password\n" 3853N/A "VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n" 3853N/A " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n" 3853N/A " bridgedifs|dhcpservers|hostinfo|\n" 3853N/A " hostcpuids|hddbackends|hdds|dvds|floppies|\n" 3853N/A " usbhost|usbfilters|systemproperties|extpacks\n" 4500N/A "VBoxManage showvminfo <uuid>|<name> [--details]\n" 4500N/A "VBoxManage showvminfo <uuid>|<name> --log <idx>\n" 3853N/A "VBoxManage registervm <filename>\n" 3853N/A "VBoxManage unregistervm <uuid>|<name> [--delete]\n" 3853N/A "VBoxManage createvm --name <name>\n" 3853N/A "VBoxManage modifyvm <uuid|name>\n" 3853N/A " [--memory <memorysize in MB>]\n" 3853N/A " [--vram <vramsize in MB>]\n" 3853N/A " [--pciattach 03:04.0@02:01.0]\n" 3853N/A " [--hwvirtexexcl on|off]\n" 3853N/A " [--nestedpaging on|off]\n" 3853N/A " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n" 3853N/A " [--cpuidremove <leaf>]\n" 3853N/A " [--hardwareuuid <uuid>]\n" 4060N/A " [--cpuexecutioncap <1-100>]\n" 4060N/A " [--monitorcount <number>]\n" 4060N/A " [--accelerate3d on|off]\n" 4060N/A " [--accelerate2dvideo on|off]\n" 4060N/A " [--firmware bios|efi|efi32|efi64]\n" 4060N/A " [--chipset ich9|piix3]\n" 4060N/A " [--bioslogofadein on|off]\n" 4060N/A " [--bioslogofadeout on|off]\n" 4060N/A " [--bioslogodisplaytime <msec>]\n" 4060N/A " [--bioslogoimagepath <imagepath>]\n" 4060N/A " [--biosbootmenu disabled|menuonly|messageandmenu]\n" 4060N/A " [--biossystemtimeoffset <msec>]\n" 4803N/A " [--biospxedebug on|off]\n" 4060N/A " [--boot<1-4> none|floppy|dvd|disk|net>]\n" 4060N/A " [--nic<1-N> none|null|nat|bridged|intnet" 4803N/A " [--nictype<1-N> Am79C970A|Am79C973" 3853N/A "|\n 82540EM|82543GC|82545EM" 3853N/A#
endif /* VBOX_WITH_VIRTIO */ 3853N/A " [--cableconnected<1-N> on|off]\n" 4803N/A " [--nictrace<1-N> on|off]\n" 3853N/A " [--nictracefile<1-N> <filename>]\n" 3853N/A " [--nicproperty<1-N> name=[value]]\n" 3853N/A " [--nicspeed<1-N> <kbps>]\n" 3853N/A " [--nicbootprio<1-N> <priority>]\n" 3853N/A " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n" 4803N/A " [--nicbandwidthgroup<1-N> none|<name>]\n" 4803N/A " [--bridgeadapter<1-N> none|<devicename>]\n" 4803N/A " [--hostonlyadapter<1-N> none|<devicename>]\n" 4803N/A " [--intnet<1-N> <network name>]\n" 4803N/A " [--natnet<1-N> <network>|default]\n" 4803N/A " [--nicgenericdrv<1-N> <driver>\n" 4803N/A " [--natsettings<1-N> [<mtu>],[<socksnd>],\n" 4803N/A " [<sockrcv>],[<tcpsnd>],\n" 4803N/A " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n" 4803N/A " <hostport>,[<guestip>],<guestport>]\n" 4803N/A " [--natpf<1-N> delete <rulename>]\n" 4803N/A " [--nattftpprefix<1-N> <prefix>]\n" 4803N/A " [--nattftpfile<1-N> <file>]\n" 4803N/A " [--nattftpserver<1-N> <ip>]\n" 4803N/A " [--natbindip<1-N> <ip>\n" 4803N/A " [--natdnspassdomain<1-N> on|off]\n" 4803N/A " [--natdnsproxy<1-N> on|off]\n" 4803N/A " [--natdnshostresolver<1-N> on|off]\n" 4803N/A " [--nataliasmode<1-N> default|[log],[proxyonly],\n" 4803N/A " [--macaddress<1-N> auto|<mac>]\n" 4803N/A " [--mouse ps2|usb|usbtablet\n" 4803N/A " [--uart<1-N> off|<I/O base> <IRQ>]\n" 4803N/A " [--uartmode<1-N> disconnected|\n" 4803N/A " [--lpt<1-N> off|<I/O base> <IRQ>]\n" 4803N/A " [--lptmode<1-N> <devicename>]\n" 4803N/A " [--guestmemoryballoon <balloonsize in MB>]\n" 3853N/A " [--gueststatisticsinterval <seconds>]\n" 3853N/A /* Get the line break sorted when dumping all option variants. */ 3853N/A " [--audiocontroller ac97|hda|sb16]\n" 3853N/A " [--clipboard disabled|hosttoguest|guesttohost|\n" 3853N/A " [--vrdeextpack default|<name>\n" 3853N/A " [--vrdeproperty <name=[value]>]\n" 3853N/A " [--vrdeport <hostport>]\n" 3853N/A " [--vrdeaddress <hostip>]\n" 3853N/A " [--vrdeauthtype null|external|guest]\n" 3853N/A " [--vrdeauthlibrary default|<name>\n" 3853N/A " [--vrdemulticon on|off]\n" 3853N/A " [--vrdereusecon on|off]\n" 3853N/A " [--vrdevideochannel on|off]\n" 3853N/A " [--vrdevideochannelquality <percent>]\n");
3853N/A " [--snapshotfolder default|<path>]\n" 3853N/A " [--teleporterport <port>]\n" 3853N/A " [--teleporteraddress <address|empty>\n" 3853N/A " [--teleporterpassword <password>]\n" 4518N/A " [--teleporterpasswordfile <file>|stdin]\n" 4518N/A " [--tracing-enabled on|off]\n" 4518N/A " [--tracing-config <config-string>]\n" 4518N/A " [--tracing-allow-vm-access on|off]\n" 4518N/A " [--iocachesize <I/O cache size in MB>]\n" 4518N/A " [--faulttolerance master|standby]\n" 4518N/A " [--faulttoleranceaddress <name>]\n" 4518N/A " [--faulttoleranceport <port>]\n" 4518N/A " [--faulttolerancesyncinterval <msec>]\n" 4518N/A " [--faulttolerancepassword <password>]\n" 4518N/A " [--usbcardreader on|off]\n" 3853N/A " [--autostart-enabled on|off]\n" 3853N/A " [--autostart-delay <seconds>]\n" 3853N/A " [--autostop-type disabled|savestate|poweroff|acpishutdown]\n" 3853N/A "VBoxManage clonevm <uuid>|<name>\n" 3853N/A " [--snapshot <uuid>|<name>]\n" 3853N/A " [--mode machine|machineandchildren|all]\n" 3853N/A " [--options link|keepallmacs|keepnatmacs|\n" 4500N/A " [--basefolder <basefolder>]\n" 3853N/A " [--options keepallmacs|keepnatmacs]\n" 3853N/A " (run with -n to have options displayed\n" 3853N/A " for a particular OVF)\n\n");
4500N/A " [--legacy09|--ovf09|--ovf10|--ovf20]\n" 4500N/A " [--vsys <number of virtual system>]\n" 4500N/A " [--product <product name>]\n" 4500N/A " [--producturl <product url>]\n" 4500N/A " [--vendor <vendor name>]\n" 3853N/A " [--vendorurl <vendor url>]\n" 3853N/A " [--version <version info>]\n" 3853N/A " [--eula <license text>]\n" 3853N/A " [--eulafile <filename>]\n" 4500N/A "VBoxManage startvm <uuid>|<name>...\n");
3853N/A "VBoxManage controlvm <uuid>|<name>\n" 3853N/A " pause|resume|reset|poweroff|savestate|\n" 3853N/A " acpipowerbutton|acpisleepbutton|\n" 3853N/A " keyboardputscancode <hex> [<hex> ...]|\n" 3853N/A " setlinkstate<1-N> on|off |\n" 4500N/A " nic<1-N> null|nat|bridged|intnet|hostonly|generic" 4500N/A#
else /* !VBOX_WITH_NETFLT */ 4500N/A " nic<1-N> null|nat|bridged|intnet|generic\n" 4500N/A#
endif /* !VBOX_WITH_NETFLT */ 3853N/A " nictracefile<1-N> <filename>\n" 3853N/A " nicproperty<1-N> name=[value]\n" 3853N/A " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n" 3853N/A " <hostport>,[<guestip>],<guestport>\n" 3853N/A " natpf<1-N> delete <rulename>\n" 3853N/A " guestmemoryballoon <balloonsize in MB>]\n" 3853N/A " gueststatisticsinterval <seconds>]\n" 3853N/A " usbattach <uuid>|<address> |\n" 3853N/A " usbdetach <uuid>|<address> |\n" 3853N/A " clipboard disabled|hosttoguest|guesttohost|\n" 3853N/A " vrdeproperty <name=[value]> |\n" 3853N/A " vrdevideochannelquality <percent>\n" 3853N/A " setvideomodehint <xres> <yres> <bpp> [display] |\n" 3853N/A " screenshotpng <file> [display] |\n" 3853N/A " setcredentials <username> <password> <domain>\n" 3853N/A " [--allowlocallogon <yes|no>] |\n" 3853N/A " teleport --host <name> --port <port>\n" 3853N/A " [--maxdowntime <msec>] [--password password]\n" 3853N/A " cpuexecutioncap <1-100>\n" 3853N/A "VBoxManage discardstate <uuid>|<name>\n" 3853N/A "VBoxManage adoptstate <uuid>|<name> <state_file>\n" 3853N/A "VBoxManage snapshot <uuid>|<name>\n" 3853N/A " take <name> [--description <desc>] [--pause] |\n" 3853N/A " delete <uuid>|<name> |\n" 3853N/A " restore <uuid>|<name> |\n" 3898N/A " edit <uuid>|<name>|--current\n" 3898N/A " [--description <desc>] |\n" 3898N/A " list [--details|--machinereadable]\n" 3898N/A " showvminfo <uuid>|<name>\n" 4518N/A "VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n" 3853N/A "VBoxManage storageattach <uuid|vmname>\n" 3853N/A " [--type dvddrive|hdd|fdd]\n" 3853N/A " [--medium none|emptydrive|\n" 3853N/A " <uuid>|<filename>|host:<drive>|iscsi]\n" 3853N/A " [--mtype normal|writethrough|immutable|shareable|\n" 3853N/A " [--setparentuuid <uuid>]\n" 3853N/A " [--passthrough on|off]\n" 3853N/A " [--nonrotational on|off]\n" 3853N/A " [--bandwidthgroup <name>]\n" 3853N/A " [--server <name>|<ip>]\n" 3853N/A " [--username <username>]\n" 3853N/A " [--password <password>]\n" 3853N/A "VBoxManage storagectl <uuid|vmname>\n" 3853N/A " [--add ide|sata|scsi|floppy|sas]\n" 3853N/A " [--controller LSILogic|LSILogicSAS|BusLogic|\n" 3853N/A " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n" 3853N/A " [--sataideemulation<1-4> <1-30>]\n" 3853N/A " [--sataportcount <1-30>]\n" 3853N/A " [--hostiocache on|off]\n" 3858N/A "VBoxManage bandwidthctl <uuid|vmname>\n" 3853N/A " add <name> --type disk|network --limit <megabytes per second>[k|m|g|K|M|G] |\n" 3853N/A " set <name> --limit <megabytes per second>[k|m|g|K|M|G] |\n" 3853N/A " list [--machinereadable]\n" 3853N/A " (limit units: k=kilobit, m=megabit, g=gigabit, K=kilobyte, M=megabyte, G=gigabyte)\n" 3853N/A "VBoxManage showhdinfo <uuid>|<filename>\n" 3853N/A "VBoxManage createhd --filename <filename>\n" 3853N/A " [--size <megabytes>|--sizebyte <bytes>]\n" 3853N/A " [--diffparent <uuid>|<filename>\n" 3858N/A " [--format VDI|VMDK|VHD] (default: VDI)\n" 3853N/A " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 3853N/A "VBoxManage modifyhd <uuid>|<filename>\n" 3853N/A " [--type normal|writethrough|immutable|shareable|\n" 3853N/A " [--resize <megabytes>|--resizebyte <bytes>]\n" 3853N/A "VBoxManage clonehd <uuid>|<filename> <uuid>|<outputfile>\n" 3853N/A " [--format VDI|VMDK|VHD|RAW|<other>]\n" 3853N/A " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 3853N/A "VBoxManage convertfromraw <filename> <outputfile>\n" 3853N/A " [--format VDI|VMDK|VHD]\n" 3853N/A " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 3853N/A "VBoxManage convertfromraw stdin <outputfile> <bytes>\n" 3853N/A " [--format VDI|VMDK|VHD]\n" 3853N/A " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 3853N/A "VBoxManage getextradata global|<uuid>|<name>\n" 4500N/A "VBoxManage setextradata global|<uuid>|<name>\n" 4500N/A " [<value>] (no value deletes key)\n" 4500N/A "VBoxManage setproperty machinefolder default|<folder> |\n" 4500N/A " vrdeauthlibrary default|<library> |\n" 4500N/A " websrvauthlibrary default|null|<library> |\n" 4500N/A " vrdeextpack null|<library> |\n" 4500N/A " loghistorycount <value>\n" 4500N/A "VBoxManage usbfilter add <index,0-N>\n" 4500N/A " --target <uuid>|<name>|global\n" 4500N/A " --action ignore|hold (global filters only)\n" 4500N/A " [--active yes|no] (yes)\n" 4500N/A " [--vendorid <XXXX>] (null)\n" 4500N/A " [--productid <XXXX>] (null)\n" 4500N/A " [--revision <IIFF>] (null)\n" 4500N/A " [--manufacturer <string>] (null)\n" 4500N/A " [--product <string>] (null)\n" 4500N/A " [--remote yes|no] (null, VM filters only)\n" 4500N/A " [--serialnumber <string>] (null)\n" 4500N/A " [--maskedinterfaces <XXXXXXXX>]\n" 3853N/A "VBoxManage usbfilter modify <index,0-N>\n" 3853N/A " --target <uuid>|<name>|global\n" 3853N/A " [--action ignore|hold] (global filters only)\n" 3853N/A " [--vendorid <XXXX>|\"\"]\n" 3853N/A " [--productid <XXXX>|\"\"]\n" 3853N/A " [--revision <IIFF>|\"\"]\n" 3853N/A " [--manufacturer <string>|\"\"]\n" 3853N/A " [--product <string>|\"\"]\n" 3853N/A " [--remote yes|no] (null, VM filters only)\n" 3853N/A " [--serialnumber <string>|\"\"]\n" 3853N/A " [--maskedinterfaces <XXXXXXXX>]\n" 3853N/A "VBoxManage usbfilter remove <index,0-N>\n" 3853N/A " --target <uuid>|<name>|global\n" 3853N/A "VBoxManage sharedfolder add <vmname>|<uuid>\n" 3853N/A " --name <name> --hostpath <hostpath>\n" 3853N/A " [--transient] [--readonly] [--automount]\n" 3853N/A "VBoxManage sharedfolder remove <vmname>|<uuid>\n" 3853N/A " --name <name> [--transient]\n" 4803N/A#
endif /* VBOX_WITH_GUEST_PROPS defined */ 4803N/A#
endif /* VBOX_WITH_GUEST_CONTROL defined */ 4803N/A "VBoxManage debugvm <uuid>|<name>\n" 4803N/A " dumpguestcore --filename <name> |\n" 4803N/A " log [--release|--debug] <settings> ...|\n" 4803N/A " logdest [--release|--debug] <settings> ...|\n" 4803N/A " logflags [--release|--debug] <settings> ...|\n" 4803N/A " getregisters [--cpu <id>] <reg>|all ... |\n" 4803N/A " setregisters [--cpu <id>] <reg>=<value> ... |\n" 4803N/A " show [--human-readable|--sh-export|--sh-eval|--cmd-set] \n" 4803N/A " <logdbg-settings|logrel-settings> [[opt] what ...] |\n" 4803N/A " statistics [--reset] [--pattern <pattern>]\n" 4803N/A "VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n" 4803N/A "VBoxManage metrics setup\n" 4803N/A " [--period <seconds>] (default: 1)\n" 4803N/A " [--samples <count>] (default: 1)\n" 3853N/A " [*|host|<vmname> [<metric_list>]]\n\n" 3853N/A "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n" 3853N/A "VBoxManage metrics enable\n" 3853N/A " [*|host|<vmname> [<metric_list>]]\n\n" 3853N/A "VBoxManage metrics disable\n" 3853N/A " [*|host|<vmname> [<metric_list>]]\n\n" 3853N/A "VBoxManage metrics collect\n" 3853N/A " [--period <seconds>] (default: 1)\n" 3853N/A " [--samples <count>] (default: 1)\n" 3853N/A " [*|host|<vmname> [<metric_list>]]\n" 3853N/A "VBoxManage hostonlyif ipconfig <name>\n" 3853N/A " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n" 3853N/A " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n" 3853N/A "VBoxManage dhcpserver add|modify --netname <network_name> |\n" 3853N/A " --ifname <hostonly_if_name>\n" 3853N/A " --netmask <network_mask>\n" 3853N/A " [--enable | --disable]\n\n" 3853N/A "VBoxManage dhcpserver remove --netname <network_name> |\n" 3853N/A " --ifname <hostonly_if_name>\n" 3853N/A "VBoxManage extpack install [--replace] <tarball> |\n" 3853N/A " uninstall [--force] <name> |\n" 3853N/A * Print a usage synopsis and the syntax error message. 3853N/A * @returns RTEXITCODE_SYNTAX. 3853N/A#
endif /* !VBOX_ONLY_DOCS */ 3853N/A * errorSyntax for RTGetOpt users. 3853N/A * @returns RTEXITCODE_SYNTAX. 3853N/A * @param fUsageCategory The usage category of the command. 3853N/A * @param rc The RTGetOpt return code. 3853N/A * @param pValueUnion The value union. 3853N/A * Check if it is an unhandled standard option. 3853N/A#
endif /* !VBOX_ONLY_DOCS */ 3853N/A * Print an error message without the syntax stuff. 3853N/A * @returns RTEXITCODE_SYNTAX.