VBoxManageHelp.cpp revision bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0
"VBoxManage [-v|--version] print version number and exit\n" "VBoxManage [-q|--nologo] ... suppress the logo\n" "VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n" " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n" " bridgedifs|dhcpservers|hostinfo|\n" " hostcpuids|hddbackends|hdds|dvds|floppies|\n" " usbhost|usbfilters|systemproperties|extpacks\n" "VBoxManage showvminfo <uuid>|<name> [--details]\n" "VBoxManage showvminfo <uuid>|<name> --log <idx>\n" "VBoxManage registervm <filename>\n" "VBoxManage unregistervm <uuid>|<name> [--delete]\n" "VBoxManage createvm --name <name>\n" " [--basefolder <path>]\n" "VBoxManage modifyvm <uuid|name>\n" " [--memory <memorysize in MB>]\n" " [--pagefusion on|off]\n" " [--vram <vramsize in MB>]\n" " [--pciattach 03:04.0]\n" " [--pciattach 03:04.0@02:01.0]\n" " [--pcidetach 03:04.0]\n" " [--hwvirtexexcl on|off]\n" " [--nestedpaging on|off]\n" " [--largepages on|off]\n" " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n" " [--cpuidremove <leaf>]\n" " [--hardwareuuid <uuid>]\n" " [--cpuhotplug on|off]\n" " [--cpuexecutioncap <1-100>]\n" " [--rtcuseutc on|off]\n" " [--monitorcount <number>]\n" " [--accelerate3d on|off]\n" " [--accelerate2dvideo on|off]\n" " [--firmware bios|efi|efi32|efi64]\n" " [--chipset ich9|piix3]\n" " [--bioslogofadein on|off]\n" " [--bioslogofadeout on|off]\n" " [--bioslogodisplaytime <msec>]\n" " [--bioslogoimagepath <imagepath>]\n" " [--biosbootmenu disabled|menuonly|messageandmenu]\n" " [--biossystemtimeoffset <msec>]\n" " [--biospxedebug on|off]\n" " [--boot<1-4> none|floppy|dvd|disk|net>]\n" " [--nic<1-N> none|null|nat|bridged|intnet" " [--nictype<1-N> Am79C970A|Am79C973" "|\n 82540EM|82543GC|82545EM" #
endif /* VBOX_WITH_VIRTIO */ " [--cableconnected<1-N> on|off]\n" " [--nictrace<1-N> on|off]\n" " [--nictracefile<1-N> <filename>]\n" " [--nicproperty<1-N> name=[value]]\n" " [--nicspeed<1-N> <kbps>]\n" " [--nicbootprio<1-N> <priority>]\n" " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n" " [--nicbandwidthgroup<1-N> none|<name>]\n" " [--bridgeadapter<1-N> none|<devicename>]\n" " [--hostonlyadapter<1-N> none|<devicename>]\n" " [--intnet<1-N> <network name>]\n" " [--natnet<1-N> <network>|default]\n" " [--nicgenericdrv<1-N> <driver>\n" " [--natsettings<1-N> [<mtu>],[<socksnd>],\n" " [<sockrcv>],[<tcpsnd>],\n" " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n" " <hostport>,[<guestip>],<guestport>]\n" " [--natpf<1-N> delete <rulename>]\n" " [--nattftpprefix<1-N> <prefix>]\n" " [--nattftpfile<1-N> <file>]\n" " [--nattftpserver<1-N> <ip>]\n" " [--natbindip<1-N> <ip>\n" " [--natdnspassdomain<1-N> on|off]\n" " [--natdnsproxy<1-N> on|off]\n" " [--natdnshostresolver<1-N> on|off]\n" " [--nataliasmode<1-N> default|[log],[proxyonly],\n" " [--macaddress<1-N> auto|<mac>]\n" " [--mouse ps2|usb|usbtablet\n" " [--uart<1-N> off|<I/O base> <IRQ>]\n" " [--uartmode<1-N> disconnected|\n" " [--guestmemoryballoon <balloonsize in MB>]\n" " [--gueststatisticsinterval <seconds>]\n" /* Get the line break sorted when dumping all option variants. */ " [--audiocontroller ac97|hda|sb16]\n" " [--clipboard disabled|hosttoguest|guesttohost|\n" " [--vrdeextpack default|<name>\n" " [--vrdeproperty <name=[value]>]\n" " [--vrdeport <hostport>]\n" " [--vrdeaddress <hostip>]\n" " [--vrdeauthtype null|external|guest]\n" " [--vrdeauthlibrary default|<name>\n" " [--vrdemulticon on|off]\n" " [--vrdereusecon on|off]\n" " [--vrdevideochannel on|off]\n" " [--vrdevideochannelquality <percent>]\n");
" [--snapshotfolder default|<path>]\n" " [--teleporter on|off]\n" " [--teleporterport <port>]\n" " [--teleporteraddress <address|empty>\n" " [--teleporterpassword <password>]\n" " [--iocachesize <I/O cache size in MB>]\n" " [--faulttolerance master|standby]\n" " [--faulttoleranceaddress <name>]\n" " [--faulttoleranceport <port>]\n" " [--faulttolerancesyncinterval <msec>]\n" " [--faulttolerancepassword <password>]\n" "VBoxManage clonevm <uuid>|<name>\n" " [--snapshot <uuid>|<name>]\n" " [--mode machine|machineandchilds|all]\n" " [--options link|keepallmacs|keepnatmacs|\n" " [--basefolder <basefolder>]\n" "VBoxManage import <ovf/ova>\n" " [--options keepallmacs|keepnatmacs]\n" " (run with -n to have options displayed\n" " for a particular OVF)\n\n");
"VBoxManage export <machines> --output|-o <ovf/ova>\n" " [--vsys <number of virtual system>]\n" " [--product <product name>]\n" " [--producturl <product url>]\n" " [--vendor <vendor name>]\n" " [--vendorurl <vendor url>]\n" " [--version <version info>]\n" " [--eula <license text>]\n" " [--eulafile <filename>]\n" "VBoxManage startvm <uuid>|<name>\n");
"VBoxManage controlvm <uuid>|<name>\n" " pause|resume|reset|poweroff|savestate|\n" " acpipowerbutton|acpisleepbutton|\n" " keyboardputscancode <hex> [<hex> ...]|\n" " setlinkstate<1-N> on|off |\n" " nic<1-N> null|nat|bridged|intnet|hostonly|generic" #
else /* !VBOX_WITH_NETFLT */ " nic<1-N> null|nat|bridged|intnet|generic\n" #
endif /* !VBOX_WITH_NETFLT */ " nictrace<1-N> on|off\n" " nictracefile<1-N> <filename>\n" " nicproperty<1-N> name=[value]\n" " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n" " <hostport>,[<guestip>],<guestport>\n" " natpf<1-N> delete <rulename>\n" " guestmemoryballoon <balloonsize in MB>]\n" " gueststatisticsinterval <seconds>]\n" " usbattach <uuid>|<address> |\n" " usbdetach <uuid>|<address> |\n");
" vrdeproperty <name=[value]> |\n" " vrdevideochannelquality <percent>\n");
" setvideomodehint <xres> <yres> <bpp> [display] |\n" " screenshotpng <file> [display] |\n" " setcredentials <username> <password> <domain>\n" " [--allowlocallogon <yes|no>] |\n" " teleport --host <name> --port <port>\n" " [--maxdowntime <msec>] [--password password]\n" " cpuexecutioncap <1-100>\n" "VBoxManage discardstate <uuid>|<name>\n" "VBoxManage adoptstate <uuid>|<name> <state_file>\n" "VBoxManage snapshot <uuid>|<name>\n" " take <name> [--description <desc>] [--pause] |\n" " delete <uuid>|<name> |\n" " restore <uuid>|<name> |\n" " edit <uuid>|<name>|--current\n" " [--description <desc>] |\n" " showvminfo <uuid>|<name>\n" "VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n" "VBoxManage storageattach <uuid|vmname>\n" " [--type dvddrive|hdd|fdd]\n" " [--medium none|emptydrive|\n" " <uuid>|<filename>|host:<drive>|iscsi]\n" " [--mtype normal|writethrough|immutable|shareable|\n" " readonly|multiattach]\n" " [--setparentuuid <uuid>]\n" " [--passthrough on|off]\n" " [--tempeject on|off]\n" " [--nonrotational on|off]\n" " [--bandwidthgroup <name>]\n" " [--server <name>|<ip>]\n" " [--encodedlun <lun>]\n" " [--username <username>]\n" " [--password <password>]\n" "VBoxManage storagectl <uuid|vmname>\n" " [--add ide|sata|scsi|floppy|sas]\n" " [--controller LSILogic|LSILogicSAS|BusLogic|\n" " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n" " [--sataideemulation<1-4> <1-30>]\n" " [--sataportcount <1-30>]\n" " [--hostiocache on|off]\n" "VBoxManage bandwidthctl <uuid|vmname>\n" " [--add disk|network]\n" " [--limit <megabytes per second>\n" "VBoxManage showhdinfo <uuid>|<filename>\n" "VBoxManage createhd --filename <filename>\n" " --size <megabytes>|--sizebyte <bytes>\n" " [--format VDI|VMDK|VHD] (default: VDI)\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" "VBoxManage modifyhd <uuid>|<filename>\n" " [--type normal|writethrough|immutable|shareable|\n" " readonly|multiattach]\n" " [--autoreset on|off]\n" " [--resize <megabytes>|--resizebyte <bytes>]\n" "VBoxManage clonehd <uuid>|<filename> <uuid>|<outputfile>\n" " [--format VDI|VMDK|VHD|RAW|<other>]\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" "VBoxManage convertfromraw <filename> <outputfile>\n" " [--format VDI|VMDK|VHD]\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" "VBoxManage convertfromraw stdin <outputfile> <bytes>\n" " [--format VDI|VMDK|VHD]\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" "VBoxManage getextradata global|<uuid>|<name>\n" "VBoxManage setextradata global|<uuid>|<name>\n" " [<value>] (no value deletes key)\n" "VBoxManage setproperty machinefolder default|<folder> |\n" " vrdeauthlibrary default|<library> |\n" " websrvauthlibrary default|null|<library> |\n" " vrdeextpack null|<library> |\n" " loghistorycount <value>\n" "VBoxManage usbfilter add <index,0-N>\n" " --target <uuid>|<name>|global\n" " --action ignore|hold (global filters only)\n" " [--active yes|no] (yes)\n" " [--vendorid <XXXX>] (null)\n" " [--productid <XXXX>] (null)\n" " [--revision <IIFF>] (null)\n" " [--manufacturer <string>] (null)\n" " [--product <string>] (null)\n" " [--remote yes|no] (null, VM filters only)\n" " [--serialnumber <string>] (null)\n" " [--maskedinterfaces <XXXXXXXX>]\n" "VBoxManage usbfilter modify <index,0-N>\n" " --target <uuid>|<name>|global\n" " [--action ignore|hold] (global filters only)\n" " [--vendorid <XXXX>|\"\"]\n" " [--productid <XXXX>|\"\"]\n" " [--revision <IIFF>|\"\"]\n" " [--manufacturer <string>|\"\"]\n" " [--product <string>|\"\"]\n" " [--remote yes|no] (null, VM filters only)\n" " [--serialnumber <string>|\"\"]\n" " [--maskedinterfaces <XXXXXXXX>]\n" "VBoxManage usbfilter remove <index,0-N>\n" " --target <uuid>|<name>|global\n" "VBoxManage sharedfolder add <vmname>|<uuid>\n" " --name <name> --hostpath <hostpath>\n" " [--transient] [--readonly] [--automount]\n" "VBoxManage sharedfolder remove <vmname>|<uuid>\n" " --name <name> [--transient]\n" #
endif /* VBOX_WITH_GUEST_PROPS defined */#
endif /* VBOX_WITH_GUEST_CONTROL defined */ "VBoxManage debugvm <uuid>|<name>\n" " dumpguestcore --filename <name> |\n" " info <item> [args] |\n" " getregisters [--cpu <id>] <reg>|all ... |\n" " setregisters [--cpu <id>] <reg>=<value> ... |\n" " statistics [--reset] [--pattern <pattern>]\n" "VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n" "VBoxManage metrics setup\n" " [--period <seconds>] (default: 1)\n" " [--samples <count>] (default: 1)\n" " [*|host|<vmname> [<metric_list>]]\n\n" "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n" "VBoxManage metrics enable\n" " [*|host|<vmname> [<metric_list>]]\n\n" "VBoxManage metrics disable\n" " [*|host|<vmname> [<metric_list>]]\n\n" "VBoxManage metrics collect\n" " [--period <seconds>] (default: 1)\n" " [--samples <count>] (default: 1)\n" " [*|host|<vmname> [<metric_list>]]\n" "VBoxManage hostonlyif ipconfig <name>\n" " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n" " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n" "VBoxManage dhcpserver add|modify --netname <network_name> |\n" " --ifname <hostonly_if_name>\n" " --netmask <network_mask>\n" " --lowerip <lower_ip>\n" " --upperip <upper_ip>]\n" " [--enable | --disable]\n\n" "VBoxManage dhcpserver remove --netname <network_name> |\n" " --ifname <hostonly_if_name>\n" "VBoxManage extpack install [--replace] <tarball> |\n" " uninstall [--force] <name> |\n" * Print a usage synopsis and the syntax error message. * @returns RTEXITCODE_SYNTAX. #
endif /* !VBOX_ONLY_DOCS */ * errorSyntax for RTGetOpt users. * @returns RTEXITCODE_SYNTAX. * @param fUsageCategory The usage category of the command. * @param rc The RTGetOpt return code. * @param pValueUnion The value union. * Check if it is an unhandled standard option. #
endif /* !VBOX_ONLY_DOCS */ * Print an error message without the syntax stuff. * @returns RTEXITCODE_SYNTAX.