VBoxManageHelp.cpp revision 83e0da18877bbce83f52a975d9102fbbdb9727a8
RTPrintf(
"VBoxManage [-v|--version] print version number and exit\n" "VBoxManage [-q|--nologo] ... suppress the logo\n" RTPrintf(
"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\n" " natrules<1-N> <name>\n" RTPrintf(
"VBoxManage showvminfo <uuid>|<name> [--details] [--statistics]\n" "VBoxManage showvminfo <uuid>|<name> --log <idx>\n" RTPrintf(
"VBoxManage registervm <filename>\n" RTPrintf(
"VBoxManage unregistervm <uuid>|<name> [--delete]\n" RTPrintf(
"VBoxManage createvm --name <name>\n" " [--basefolder <path> | --settingsfile <path>]\n" RTPrintf(
"VBoxManage modifyvm <uuid|name>\n" " [--memory <memorysize in MB>]\n" " [--vram <vramsize in MB>]\n" " [--nestedpaging on|off]\n" " [--largepages on|off]\n" " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n" " [--cpuidremove <leaf>]\n" " [--hardwareuuid <uuid>]\n" " [--monitorcount <number>]\n" " [--accelerate3d on|off]\n" " [--accelerate2dvideo on|off]\n" " [--firmware bios|efi|efi32|efi64]\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|hostonly]\n" #
else /* !RT_OS_LINUX && !RT_OS_DARWIN */ " [--nic<1-N> none|null|nat|bridged|intnet]\n" #
endif /* !RT_OS_LINUX && !RT_OS_DARWIN */ " [--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" " [--nicspeed<1-N> <kbps>]\n" " [--nicbootprio<1-N> <priority>]\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" " [--natsettings<1-N> \"[<mtu>],[<socksnd>],[<sockrcv>],\n" " [<tcpsnd>],[<tcprcv>]\"]\n" " [--natpf<1-N> \"[<rulename>],tcp|udp,\n" " [<hostip>],<hostport>,\n" " [<guestip>],<guestport>\"]\n" " [--natpf<1-N> delete <rulename>]\n" " [--nattftpprefix<1-N> <prefix>]\n" " [--nattftpfile<1-N> <file>]\n" " [--nattftpserver<1-N> <ip>]\n" " [--natdnspassdomain<1-N> on|off]\n" " [--natdnsproxy<1-N> on|off]\n" " [--natdnshostresolver<1-N> on|off]\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" RTPrintf(
" [--audiocontroller ac97|sb16]\n" " [--clipboard disabled|hosttoguest|guesttohost|\n" " [--vrdpport default|<ports>]\n" " [--vrdpaddress <host>]\n" " [--vrdpauthtype null|external|guest]\n" " [--vrdpmulticon on|off]\n" " [--vrdpreusecon on|off]\n");
" [--snapshotfolder default|<path>]\n" " [--teleporter on|off]\n" " [--teleporterport <port>]\n" " [--teleporteraddress <address|empty>\n" " [--teleporterpassword <password>]\n" " [--iomgr simple|async]\n" " [--iobackend buffered|unbuffered]\n" " [--iocachesize <I/O cache size in MB>]\n" " [--iobandwidthmax <Maximum I/O bandwidth in MB>]\n" RTPrintf(
"VBoxManage import <ovf> [--dry-run|-n] [more options]\n" " (run with -n to have options displayed\n" " for a particular OVF)\n\n");
RTPrintf(
"VBoxManage export <machines> --output|-o <ovf>\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" RTPrintf(
"VBoxManage startvm <uuid>|<name>\n");
RTPrintf(
"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\n" #
else /* !RT_OS_LINUX && !RT_OS_DARWIN */ " nic<1-N> null|nat|bridged|intnet\n" #
endif /* !RT_OS_LINUX && !RT_OS_DARWIN */ " nictrace<1-N> on|off\n" " nictracefile<1-N> <filename>\n" #
endif /* VBOX_DYNAMIC_NET_ATTACH */ " guestmemoryballoon <balloonsize in MB>]\n" " gueststatisticsinterval <seconds>]\n" " usbattach <uuid>|<address> |\n" " usbdetach <uuid>|<address> |\n");
RTPrintf(
" vrdpport default|<ports> |\n");
RTPrintf(
" setvideomodehint <xres> <yres> <bpp> [display] |\n" " setcredentials <username> <password> <domain>\n" " [--allowlocallogon <yes|no>] |\n" " teleport --host <name> --port <port>\n" " [--maxdowntime <msec>] [--password password]\n" RTPrintf(
"VBoxManage discardstate <uuid>|<name>\n" RTPrintf(
"VBoxManage adoptstate <uuid>|<name> <state_file>\n" RTPrintf(
"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" RTPrintf(
"VBoxManage openmedium disk|dvd|floppy <filename>\n" " [--type normal|immutable|writethrough] (disk only)\n" " [--parentuuid <uuid>] (disk only)\n" RTPrintf(
"VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n" RTPrintf(
"VBoxManage storageattach <uuid|vmname>\n" " [--type dvddrive|hdd|fdd\n" " --medium none|emptydrive|uuid|filename|host:<drive>]\n" " [--passthrough on|off]\n" RTPrintf(
"VBoxManage storagectl <uuid|vmname>\n" " [--add ide|sata|scsi|floppy|sas]\n" " [--controller LSILogic|LSILogicSAS|BusLogic|IntelAHCI|\n" " PIIX3|PIIX4|ICH6|I82078]\n" " [--sataideemulation<1-4> <1-30>]\n" " [--sataportcount <1-30>]\n" RTPrintf(
"VBoxManage showhdinfo <uuid>|<filename>\n" RTPrintf(
"VBoxManage createhd --filename <filename>\n" " [--format VDI|VMDK|VHD] (default: VDI)\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" " [--type normal|writethrough] (default: normal)\n" " [--comment <comment>]\n" RTPrintf(
"VBoxManage modifyhd <uuid>|<filename>\n" " [--type normal|writethrough|immutable]\n" " [--autoreset on|off]\n" RTPrintf(
"VBoxManage clonehd <uuid>|<filename> <outputfile>\n" " [--format VDI|VMDK|VHD|RAW|<other>]\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" " [--type normal|writethrough|immutable]\n" " [--remember] [--existing]\n" RTPrintf(
"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" RTPrintf(
"VBoxManage addiscsidisk --server <name>|<ip>\n" " [--encodedlun <lun>]\n" " [--username <username>]\n" " [--password <password>]\n" " [--type normal|writethrough|immutable]\n" RTPrintf(
"VBoxManage getextradata global|<uuid>|<name>\n" RTPrintf(
"VBoxManage setextradata global|<uuid>|<name>\n" " [<value>] (no value deletes key)\n" RTPrintf(
"VBoxManage setproperty hdfolder default|<folder> |\n" " machinefolder default|<folder> |\n" " vrdpauthlibrary default|<library> |\n" " websrvauthlibrary default|null|<library> |\n" " loghistorycount <value>\n" RTPrintf(
"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" RTPrintf(
"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" RTPrintf(
"VBoxManage usbfilter remove <index,0-N>\n" " --target <uuid>|<name>|global\n" RTPrintf(
"VBoxManage sharedfolder add <vmname>|<uuid>\n" " --name <name> --hostpath <hostpath>\n" " [--transient] [--readonly]\n" RTPrintf(
"VBoxManage sharedfolder remove <vmname>|<uuid>\n" " --name <name> [--transient]\n" RTPrintf(
"VBoxManage vmstatistics <vmname>|<uuid> [--reset]\n" " [--pattern <pattern>] [--descriptions]\n" #
endif /* VBOX_WITH_GUEST_PROPS defined */#
endif /* VBOX_WITH_GUEST_CONTROL defined */ RTPrintf(
"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" RTPrintf(
"VBoxManage hostonlyif ipconfig <name>\n" " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n" " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n" RTPrintf(
"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" * Print a usage synopsis and the syntax error message. showLogo();
// show logo even if suppressed #
endif /* !VBOX_ONLY_DOCS */ * errorSyntax for RTGetOpt users. * @param fUsageCategory The usage category of the command. * @param rc The RTGetOpt return code. * @param pValueUnion The value union. showLogo();
// show logo even if suppressed #
endif /* !VBOX_ONLY_DOCS */ return RTPrintf(
"error: Invalid option -%c\n",
rc);
return RTPrintf(
"error: Invalid option case %i\n",
rc);
* Print an error message without the syntax stuff.