Changeset 63375 in vbox for trunk/doc/manual/en_US
- Timestamp:
- Aug 12, 2016 5:22:52 PM (8 years ago)
- Location:
- trunk/doc/manual/en_US
- Files:
-
- 2 edited
-
user_AdvancedTopics.xml (modified) (1 diff)
-
user_VBoxManage.xml (modified) (51 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/user_AdvancedTopics.xml
r62555 r63375 3264 3264 For additional information on how launchd services could be 3265 3265 configured see <literal><ulink 3266 url="http ://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html">http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html</ulink></literal>.</para>3266 url="https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html">https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html</ulink></literal>.</para> 3267 3267 </sect2> 3268 3268 </sect1> -
trunk/doc/manual/en_US/user_VBoxManage.xml
r62611 r63375 172 172 <itemizedlist> 173 173 <listitem> 174 <para><computeroutput>- -version</computeroutput>: show the version of174 <para><computeroutput>-v|--version</computeroutput>: show the version of 175 175 this tool and exit.</para> 176 176 </listitem> … … 242 242 243 243 <listitem> 244 <para><computeroutput>intnets</computeroutput> displays information 245 about the internal networks.</para> 246 </listitem> 247 248 <listitem> 244 249 <para><computeroutput>bridgedifs</computeroutput>, 245 <computeroutput>hostonlyifs</computeroutput> and 250 <computeroutput>hostonlyifs</computeroutput>, 251 <computeroutput>natnets</computeroutput> and 246 252 <computeroutput>dhcpservers</computeroutput>, respectively, list 247 bridged network interfaces, host-only network interfaces and DHCP 248 servers currently available on the host. Please see <xref 253 bridged network interfaces, host-only network interfaces, 254 NAT network interfaces and DHCP servers currently available on the 255 host. Please see <xref 249 256 linkend="networkingdetails" /> for details on these.</para> 250 257 </listitem> … … 307 314 linkend="vboxmanage-extpack" /> for more information.</para> 308 315 </listitem> 316 317 <listitem> 318 <para><computeroutput>groups</computeroutput> displays 319 details of the VM Groups; see <xref linkend="gui-vmgroups" /> 320 for more information.</para> 321 </listitem> 322 323 <listitem> 324 <para><computeroutput>webcams</computeroutput> displays a list of 325 webcams attached to the running VM. The output format is a list of 326 absolute paths or aliases that were used for attaching the webcams 327 to the VM using the 'webcam attach' command.</para> 328 </listitem> 329 330 <listitem> 331 <para><computeroutput>screenshotformats</computeroutput> displays a 332 list of available screenshot formats.</para> 333 </listitem> 334 309 335 </itemizedlist></para> 310 336 </sect1> … … 340 366 IOAPIC: on 341 367 ... 342 </screen></para> 368 </screen></para> 369 <para>Use the <computeroutput>--machinereadable</computeroutput> option 370 to produce the same output, but in machine readable format: property="value" on a 371 line by line basis, e.g.:</para> 372 <para><screen> 373 name="VBoxSDL --startvm OL7.2" 374 groups="/" 375 ostype="Oracle (64-bit)" 376 UUID="457af700-bc0a-4258-aa3c-13b03da171f2" 377 ... 378 </screen></para> 343 379 </sect1> 344 380 … … 398 434 used by default as the file name of the settings file (with the extension 399 435 <computeroutput>.xml</computeroutput>) and the machine folder (a subfolder 400 of the <computeroutput>.config/VirtualBox/Machines</computeroutput> folder - this folder name may vary depending on the operating system and the version of VirtualBox which you are using), it 401 must conform to your host operating system's requirements for file name 402 specifications. If the VM is later renamed, the file and folder names will 403 change automatically.</para> 436 of the <computeroutput>.config/VirtualBox/Machines</computeroutput> folder 437 - this folder name may vary depending on the operating system and the 438 version of VirtualBox which you are using), it must conform to your host 439 operating system's requirements for file name specifications. If the VM 440 is later renamed, the file and folder names will change automatically.</para> 404 441 405 442 <para>However, if the <computeroutput>--basefolder … … 408 445 names of the file and the folder will not change if the virtual machine is 409 446 renamed.</para> 447 448 <para>If the <computeroutput>--group <group>, ...</computeroutput> 449 option is used, the machine will be assigned membership of the specified 450 VM groups in the list. Note that group ids always start with a 451 <computeroutput>/</computeroutput> and can be nested. By default, 452 VMs are always assigned membership of the group 453 <computeroutput>/</computeroutput>.</para> 454 455 <para>If the <computeroutput>--ostype <ostype></computeroutput>: 456 option is used, <ostype> specifies the guest operating system 457 to run in the VM. To learn about the available OS options, 458 run <computeroutput>VBoxManage list ostypes</computeroutput> .</para> 459 460 <para>If the <computeroutput>--uuid <uuid></computeroutput>: 461 option is used, <uuid> specifies the VM uuid. This must be 462 unique within the namespace of the host, or that of the VM Group if 463 it is assigned to a VM group membership. By default, a unique uuid 464 within the appropriate namespace is automatically generated. 465 </para> 410 466 411 467 <para>By default, this command only creates the XML file without … … 415 471 <computeroutput>VBoxManage registervm</computeroutput> separately 416 472 afterwards.</para> 473 417 474 </sect1> 418 475 … … 732 789 733 790 <listitem> 734 <para><computeroutput>--nicbootprio<1-N> 735 <priority></computeroutput>: This specifies the order in which 736 NICs are tried for booting over the network (using PXE). The 737 priority is an integer in the 0 to 4 range. Priority 1 is the 738 highest, priority 4 is low. Priority 0, which is the default unless 739 otherwise specified, is the lowest. 740 </para> 741 <para> Note that this option only has effect when the Intel PXE boot 742 ROM is used. 743 </para> 791 <para><computeroutput>--biosapic 792 x2apic|apic|disabled</computeroutput>: This specifies 793 the firmware APIC level to be used. Options are: x2apic, apic or 794 disabled (no apic or x2apic) respectively.</para> 795 796 <para>Note that if x2apic is specified and x2apic is unsupported by the 797 VCPU, biosapic downgrades to apic, if supported - otherwise to 'disabled'. 798 Similarly, if apic is specified, and apic is unsupported results in a 799 downgrade to 'disabled'.</para> 800 </listitem> 801 802 <listitem> 803 <para><computeroutput>--biossystemtimeoffset <ms></computeroutput>: 804 This specifies a fixed time offset (milliseconds) of the guest relative to 805 the host time. If the offset is positive, the guest time runs ahead of the 806 host time.</para> 744 807 </listitem> 745 808 … … 769 832 option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga. 770 833 <xref linkend="settings-motherboard" />).</para> 771 </listitem>772 773 <listitem>774 <para><computeroutput>--biossystemtimeoffset <ms></computeroutput>:775 This allows you to set a fixed time offset of the guest relative to776 the host time. The offset is specified in milliseconds. If the offset777 is positive the guest time runs ahead the host time.</para>778 834 </listitem> 779 835 … … 841 897 842 898 <listitem> 899 <para><computeroutput>--nictype<1-N> 900 Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>: 901 This allows you, for each of the VM's virtual network cards, to 902 specify which networking hardware VirtualBox presents to the 903 guest; see <xref linkend="nichardware" />.</para> 904 </listitem> 905 906 <listitem> 907 <para><computeroutput>--cableconnected<1-N> 908 on|off</computeroutput>: This allows you to temporarily disconnect 909 a virtual network interface, as if a network cable had been pulled 910 from a real network card. This might be useful for resetting 911 certain software components in the VM.</para> 912 </listitem> 913 914 <listitem> 915 <para>With the "nictrace" options, you can optionally trace 916 network traffic by dumping it to a file, for debugging 917 purposes.</para> 918 919 <para>With <computeroutput>--nictrace<1-N> 920 on|off</computeroutput>, you can enable network tracing for a 921 particular virtual network card.</para> 922 923 <para>If enabled, you must specify with 924 <computeroutput>--nictracefile<1-N> 925 <filename></computeroutput> what file the trace should be 926 logged to.</para> 927 </listitem> 928 929 <listitem> 930 <para><computeroutput>--nicproperty<1-N> 931 <paramname>="paramvalue"</computeroutput>: 932 This option, in combination with "nicgenericdrv" allows you to 933 pass parameters to rarely-used network backends.</para> 934 935 <para>Those parameters are backend engine-specific, and are different 936 between UDP Tunnel and the VDE backend drivers. For example, 937 please see <xref linkend="network_udp_tunnel" />. 938 </para> 939 </listitem> 940 941 <listitem> 942 <para><computeroutput>--nicspeed<1-N> <kbps></computeroutput>: 943 If generic networking has been enabled for a virtual network card (see the 944 <computeroutput>--nic</computeroutput> option above; otherwise 945 this setting has no effect), this mode enables access 946 to rarely used networking sub-modes, such as VDE network or UDP Tunnel. 947 This option specifies the throughput rate in KBytes/sec. 948 </para> 949 </listitem> 950 951 <listitem> 952 <para><computeroutput>--nicbootprio<1-N> 953 <priority></computeroutput>: This specifies the order in which 954 NICs are tried for booting over the network (using PXE). The 955 priority is an integer in the 0 to 4 range. Priority 1 is the 956 highest, priority 4 is low. Priority 0, which is the default unless 957 otherwise specified, is the lowest.</para> 958 959 <para>Note that this option only has effect when the Intel PXE boot 960 ROM is used.</para> 961 </listitem> 962 963 <listitem> 843 964 <para><computeroutput>--nicpromisc<1-N> 844 965 deny|allow-vms|allow-all</computeroutput>: 845 966 This allows you, for each of the VM's virtual network cards, to 846 specify how the promisc ious mode is handled. This setting is only967 specify how the promiscuous mode is handled. This setting is only 847 968 relevant for bridged networking. 848 969 <computeroutput>deny</computeroutput> (default setting) hides … … 856 977 857 978 <listitem> 858 <para><computeroutput>--nictype<1-N> 859 Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>: 860 This allows you, for each of the VM's virtual network cards, to 861 specify which networking hardware VirtualBox presents to the 862 guest; see <xref linkend="nichardware" />.</para> 863 </listitem> 864 865 <listitem> 866 <para><computeroutput>--cableconnected<1-N> 867 on|off</computeroutput>: This allows you to temporarily disconnect 868 a virtual network interface, as if a network cable had been pulled 869 from a real network card. This might be useful for resetting 870 certain software components in the VM.</para> 871 </listitem> 872 873 <listitem> 874 <para>With the "nictrace" options, you can optionally trace 875 network traffic by dumping it to a file, for debugging 876 purposes.</para> 877 878 <para>With <computeroutput>--nictrace<1-N> 879 on|off</computeroutput>, you can enable network tracing for a 880 particular virtual network card.</para> 881 882 <para>If enabled, you must specify with 883 <computeroutput>--nictracefile<1-N> 884 <filename></computeroutput> what file the trace should be 885 logged to.</para> 886 </listitem> 887 888 <listitem> 889 <para><computeroutput>--natnet<1-N> 890 <network>|default</computeroutput>: 891 If the networking type is set to <computeroutput>nat</computeroutput> 892 (not <computeroutput>natnetwork</computeroutput>) then this 893 setting specifies the IP address range to be used for 894 this network. See <xref linkend="changenat" /> for an 895 example.</para> 896 </listitem> 897 898 <listitem> 899 <para><computeroutput>--nat-network<1-N> <network 900 name></computeroutput>: If the networking type is set to 901 <computeroutput>natnetwork</computeroutput> (not 902 <computeroutput>nat</computeroutput>) then this setting specifies 903 the name of the NAT network this adapter is connected to.</para> 979 <para><computeroutput>--nicbandwidthgroup<1-N> 980 none|<name></computeroutput>: This removes/adds an assignment 981 of a bandwidth group from/to the specified virtual network interface. 982 Specifying <computeroutput>none</computeroutput> removes any current 983 bandwidth group assignment from the specified virtual network interface. 984 Specifying <computeroutput><name></computeroutput> adds an 985 assignment of a bandwidth group to the specified virtual network 986 interface.</para> 987 <para>For details, please see <xref linkend="network_bandwidth_limit" />.</para> 904 988 </listitem> 905 989 … … 935 1019 </listitem> 936 1020 937 <listitem> 938 <para><computeroutput>--macaddress<1-N> 939 auto|<mac></computeroutput>: With this option you can set 940 the MAC address of a particular network adapter on the VM. Normally, each 941 network adapter is assigned a random address by VirtualBox at 942 VM creation.</para> 943 </listitem> 944 945 <listitem> 946 <para><computeroutput>--mouse <ps2|usb|usbtablet|usbmultitouch></computeroutput>: 947 Specifies the mode of the mouse to be used in the VM. Available options are: ps2, usb, 948 usbtablet, usbmultitouch. 949 </para> 950 </listitem> 951 952 <listitem> 953 <para><computeroutput>--keyboard <ps2|usb></computeroutput>: 954 Specifies the mode of the keyboard to be used in the VM. Available options are: ps2, usb. 955 </para> 1021 1022 <listitem> 1023 <para><computeroutput>--nat-network<1-N> <network 1024 name></computeroutput>: If the networking type is set to 1025 <computeroutput>natnetwork</computeroutput> (not 1026 <computeroutput>nat</computeroutput>) then this setting specifies 1027 the name of the NAT network this adapter is connected to.</para> 956 1028 </listitem> 957 1029 … … 967 1039 968 1040 <listitem> 969 <para><computeroutput>--nicproperty<1-N> 970 <paramname>="paramvalue"</computeroutput>: 971 This option, in combination with "nicgenericdrv" allows you to 972 pass parameters to rarely-used network backends.</para><para> 973 Those parameters are backend engine-specific, and are different 974 between UDP Tunnel and the VDE backend drivers. For example, 975 please see <xref linkend="network_udp_tunnel" />. 976 </para> 977 </listitem> 978 979 <listitem> 980 <para><computeroutput>--nicspeed<1-N> <kbps></computeroutput>: 981 If generic networking has been enabled for a virtual network card (see the 982 <computeroutput>--nic</computeroutput> option above; otherwise 983 this setting has no effect), this mode enables access 984 to rarely used networking sub-modes, such as VDE network or UDP Tunnel. 985 This option specifies the throughput rate in KBytes/sec. 986 </para> 1041 <para><computeroutput>--macaddress<1-N> 1042 auto|<mac></computeroutput>: With this option you can set 1043 the MAC address of a particular network adapter on the VM. Normally, each 1044 network adapter is assigned a random address by VirtualBox at 1045 VM creation.</para> 987 1046 </listitem> 988 1047 </itemizedlist></para> … … 996 1055 in the list below) specifies the virtual network adapter whose 997 1056 settings should be changed.<itemizedlist> 1057 1058 <listitem> 1059 <para><computeroutput>--natnet<1-N> 1060 <network>|default</computeroutput>: 1061 If the networking type is set to <computeroutput>nat</computeroutput> 1062 (not <computeroutput>natnetwork</computeroutput>) then this 1063 setting specifies the IP address range to be used for 1064 this network. See <xref linkend="changenat" /> for an 1065 example.</para> 1066 </listitem> 1067 998 1068 <listitem> 999 1069 <para><computeroutput>--natpf<1-N> … … 1091 1161 clipboard, drag and drop, monitor and USB settings are available through 1092 1162 <computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist> 1093 <listitem> 1094 <para><computeroutput>--uart<1-N> off|<I/O base> 1095 <IRQ></computeroutput>: With this option you can configure 1096 virtual serial ports for the VM; see <xref 1097 linkend="serialports" /> for an introduction.</para> 1098 </listitem> 1099 1100 <listitem> 1101 <para><computeroutput>--uartmode<1-N> 1102 <arg></computeroutput>: This setting controls how VirtualBox 1103 connects a given virtual serial port (previously configured with 1104 the <computeroutput>--uartX</computeroutput> setting, see above) 1105 to the host on which the virtual machine is running. As described 1106 in detail in <xref linkend="serialports" />, for each such port, 1107 you can specify <computeroutput><arg></computeroutput> as 1108 one of the following options:<itemizedlist> 1109 <listitem> 1110 <para><computeroutput>disconnected</computeroutput>: Even 1111 though the serial port is shown to the guest, it has no 1112 "other end" -- like a real COM port without a cable.</para> 1113 </listitem> 1114 1115 <listitem> 1116 <para><computeroutput>server 1117 <pipename></computeroutput>: On a Windows host, this 1118 tells VirtualBox to create a named pipe on the host named 1119 <computeroutput><pipename></computeroutput> and 1120 connect the virtual serial device to it. Note that Windows 1121 requires that the name of a named pipe begin with 1122 <computeroutput>\\.\pipe\</computeroutput>.</para> 1123 1124 <para>On a Linux host, instead of a named pipe, a local 1125 domain socket is used.</para> 1126 </listitem> 1127 1128 <listitem> 1129 <para><computeroutput>client 1130 <pipename></computeroutput>: This operates just like 1131 <computeroutput>server ...</computeroutput>, except that the 1132 pipe (or local domain socket) is not created by VirtualBox, 1133 but assumed to exist already.</para> 1134 </listitem> 1135 1136 <listitem> 1137 <para><computeroutput>tcpserver 1138 <port></computeroutput>: This 1139 tells VirtualBox to create a TCP socket on the host with TCP 1140 <computeroutput><port></computeroutput> and 1141 connect the virtual serial device to it. Note that UNIX-like 1142 systems require ports over 1024 for normal users.</para> 1143 </listitem> 1144 1145 <listitem> 1146 <para><computeroutput>tcpclient 1147 <hostname:port></computeroutput>: This operates just like 1148 <computeroutput>tcpserver ...</computeroutput>, except that the 1149 TCP socket is not created by VirtualBox, 1150 but assumed to exist already.</para> 1151 </listitem> 1152 1153 <listitem> 1154 <para><computeroutput><devicename></computeroutput>: 1155 If, instead of the above, the device name of a physical 1156 hardware serial port of the host is specified, the virtual 1157 serial port is connected to that hardware port. On a Windows 1158 host, the device name will be a COM port such as 1159 <computeroutput>COM1</computeroutput>; on a Linux host, the 1160 device name will look like 1161 <computeroutput>/dev/ttyS0</computeroutput>. This allows you 1162 to "wire" a real serial port to a virtual machine.</para> 1163 </listitem> 1164 </itemizedlist></para> 1165 </listitem> 1166 1167 <listitem> 1168 <para><computeroutput>--lptmode<1-N> 1169 <Device></computeroutput>: 1170 Specifies the Device Name of the parallel port that 1171 the Parallel Port feature will be using. Use this 1172 <emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>. 1173 This feature is host operating system specific.</para> 1174 </listitem> 1175 1176 <listitem> 1177 <para><computeroutput>--lpt<1-N> 1178 <I/O base> <IRQ></computeroutput>: 1179 Specifies the I/O address of the parallel port and the IRQ 1180 number that the Parallel Port feature will be using. Use this 1181 <emphasis>after</emphasis> 1182 <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are 1183 the values that guest sees i.e. the values avalable under guest Device Manager.</para> 1184 </listitem> 1185 1186 <listitem> 1187 <para><computeroutput>--audio none|null|oss|alsa|pulse</computeroutput>: With 1188 this option, you can set whether the VM should have audio 1189 support, and if so - which type.</para> 1190 </listitem> 1191 1192 <listitem> 1193 <para><computeroutput>--audiocontroller ac97|hda|sb16</computeroutput>: With 1194 this option, you can specify the audio controller to be used with this VM. 1195 </para> 1196 </listitem> 1197 1198 <listitem> 1199 <para><computeroutput>--audiocodec stac9700|ad1980|stac9221|sb16</computeroutput>: With 1200 this option, you can specify the audio codec to be used with this VM. 1201 </para> 1202 </listitem> 1203 1204 <listitem> 1205 <para><computeroutput>--clipboard 1206 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 1207 With this setting, you can select if and how the guest or host 1208 operating system's clipboard should be shared with the host or guest; 1209 see <xref linkend="generalsettings" />. This requires that the Guest 1210 Additions be installed in the virtual machine.</para> 1211 </listitem> 1212 1213 <listitem> 1214 <para><computeroutput>--draganddrop 1215 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 1216 With this setting, you can select the current drag and drop mode 1217 being used between the host and the virtual machine; 1218 see <xref linkend="guestadd-dnd" />. This requires that the Guest 1219 Additions be installed in the virtual machine.</para> 1220 </listitem> 1221 1222 <listitem> 1223 <para><computeroutput>--monitorcount 1224 <count></computeroutput>: This enables multi-monitor 1225 support; see <xref linkend="settings-display" />.</para> 1226 </listitem> 1227 1228 <listitem> 1229 <para><computeroutput>--usb on|off</computeroutput>: This option 1230 enables or disables the VM's virtual USB controller; see <xref 1231 linkend="settings-usb" /> for details.</para> 1232 </listitem> 1233 1234 <listitem> 1235 <para><computeroutput>--usbehci on|off</computeroutput>: This 1236 option enables or disables the VM's virtual USB 2.0 controller; 1237 see <xref linkend="settings-usb" /> for details.</para> 1238 </listitem> 1239 1240 <listitem> 1241 <para><computeroutput>--usbxhci on|off</computeroutput>: This 1242 option enables or disables the VM's virtual USB 3.0 controller; 1243 see <xref linkend="settings-usb" /> for details.</para> 1244 </listitem> 1245 <!-- @todo r=andy Document tracing-* commands --> 1246 </itemizedlist></para> 1163 <listitem> 1164 <para><computeroutput>--mouse <ps2|usb|usbtablet|usbmultitouch></computeroutput>: 1165 Specifies the mode of the mouse to be used in the VM. Available options are: ps2, usb, 1166 usbtablet, usbmultitouch. 1167 </para> 1168 </listitem> 1169 1170 <listitem> 1171 <para><computeroutput>--keyboard <ps2|usb></computeroutput>: 1172 Specifies the mode of the keyboard to be used in the VM. Available options are: ps2, usb. 1173 </para> 1174 </listitem> 1175 <listitem> 1176 <para><computeroutput>--uart<1-N> off|<I/O base> 1177 <IRQ></computeroutput>: With this option you can configure 1178 virtual serial ports for the VM; see <xref 1179 linkend="serialports" /> for an introduction.</para> 1180 </listitem> 1181 1182 <listitem> 1183 <para><computeroutput>--uartmode<1-N> 1184 <arg></computeroutput>: This setting controls how VirtualBox 1185 connects a given virtual serial port (previously configured with 1186 the <computeroutput>--uartX</computeroutput> setting, see above) 1187 to the host on which the virtual machine is running. As described 1188 in detail in <xref linkend="serialports" />, for each such port, 1189 you can specify <computeroutput><arg></computeroutput> as 1190 one of the following options:<itemizedlist> 1191 <listitem> 1192 <para><computeroutput>disconnected</computeroutput>: Even 1193 though the serial port is shown to the guest, it has no 1194 "other end" -- like a real COM port without a cable.</para> 1195 </listitem> 1196 1197 <listitem> 1198 <para><computeroutput>server 1199 <pipename></computeroutput>: On a Windows host, this 1200 tells VirtualBox to create a named pipe on the host named 1201 <computeroutput><pipename></computeroutput> and 1202 connect the virtual serial device to it. Note that Windows 1203 requires that the name of a named pipe begin with 1204 <computeroutput>\\.\pipe\</computeroutput>.</para> 1205 1206 <para>On a Linux host, instead of a named pipe, a local 1207 domain socket is used.</para> 1208 </listitem> 1209 1210 <listitem> 1211 <para><computeroutput>client 1212 <pipename></computeroutput>: This operates just like 1213 <computeroutput>server ...</computeroutput>, except that the 1214 pipe (or local domain socket) is not created by VirtualBox, 1215 but assumed to exist already.</para> 1216 </listitem> 1217 1218 <listitem> 1219 <para><computeroutput>tcpserver 1220 <port></computeroutput>: This 1221 tells VirtualBox to create a TCP socket on the host with TCP 1222 <computeroutput><port></computeroutput> and 1223 connect the virtual serial device to it. Note that UNIX-like 1224 systems require ports over 1024 for normal users.</para> 1225 </listitem> 1226 1227 <listitem> 1228 <para><computeroutput>tcpclient 1229 <hostname:port></computeroutput>: This operates just like 1230 <computeroutput>tcpserver ...</computeroutput>, except that the 1231 TCP socket is not created by VirtualBox, 1232 but assumed to exist already.</para> 1233 </listitem> 1234 1235 <listitem> 1236 <para><computeroutput>file <file></computeroutput>: 1237 This redirects the serial port output to a raw file <file> 1238 specified by its absolute path on the host file system.</para> 1239 </listitem> 1240 1241 <listitem> 1242 <para><computeroutput><devicename></computeroutput>: 1243 If, instead of the above, the device name of a physical 1244 hardware serial port of the host is specified, the virtual 1245 serial port is connected to that hardware port. On a Windows 1246 host, the device name will be a COM port such as 1247 <computeroutput>COM1</computeroutput>; on a Linux host, the 1248 device name will look like 1249 <computeroutput>/dev/ttyS0</computeroutput>. This allows you 1250 to "wire" a real serial port to a virtual machine.</para> 1251 </listitem> 1252 </itemizedlist></para> 1253 </listitem> 1254 1255 <listitem> 1256 <para><computeroutput>--lptmode<1-N> 1257 <Device></computeroutput>: 1258 Specifies the Device Name of the parallel port that 1259 the Parallel Port feature will be using. Use this 1260 <emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>. 1261 This feature is host operating system specific.</para> 1262 </listitem> 1263 1264 <listitem> 1265 <para><computeroutput>--lpt<1-N> 1266 <I/O base> <IRQ></computeroutput>: 1267 Specifies the I/O address of the parallel port and the IRQ 1268 number that the Parallel Port feature will be using. Use this <emphasis>after</emphasis> 1269 <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are 1270 the values that guest sees i.e. the values avalable under guest Device Manager.</para> 1271 </listitem> 1272 1273 <listitem> 1274 <para><computeroutput>--audio none|null|oss|alsa|pulse</computeroutput>: With 1275 this option, you can set whether the VM should have audio 1276 support, and if so - which type.</para> 1277 </listitem> 1278 1279 <listitem> 1280 <para><computeroutput>--audiocontroller ac97|hda|sb16</computeroutput>: With 1281 this option, you can specify the audio controller to be used with this VM. 1282 </para> 1283 </listitem> 1284 1285 <listitem> 1286 <para><computeroutput>--audiocodec stac9700|ad1980|stac9221|sb16</computeroutput>: With 1287 this option, you can specify the audio codec to be used with this VM. 1288 </para> 1289 </listitem> 1290 1291 <listitem> 1292 <para><computeroutput>--clipboard 1293 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 1294 With this setting, you can select if and how the guest or host 1295 operating system's clipboard should be shared with the host or guest; 1296 see <xref linkend="generalsettings" />. This requires that the Guest 1297 Additions be installed in the virtual machine.</para> 1298 </listitem> 1299 1300 <listitem> 1301 <para><computeroutput>--draganddrop 1302 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 1303 With this setting, you can select the current drag and drop mode 1304 being used between the host and the virtual machine; 1305 see <xref linkend="guestadd-dnd" />. This requires that the Guest 1306 Additions be installed in the virtual machine.</para> 1307 </listitem> 1308 1309 <listitem> 1310 <para><computeroutput>--monitorcount 1311 <count></computeroutput>: This enables multi-monitor 1312 support; see <xref linkend="settings-display" />.</para> 1313 </listitem> 1314 1315 <listitem> 1316 <para><computeroutput>--usb on|off</computeroutput>: This option 1317 enables or disables the VM's virtual USB controller; see <xref 1318 linkend="settings-usb" /> for details.</para> 1319 </listitem> 1320 1321 <listitem> 1322 <para><computeroutput>--usbehci on|off</computeroutput>: This 1323 option enables or disables the VM's virtual USB 2.0 controller; 1324 see <xref linkend="settings-usb" /> for details.</para> 1325 </listitem> 1326 1327 <listitem> 1328 <para><computeroutput>--usbxhci on|off</computeroutput>: This 1329 option enables or disables the VM's virtual USB 3.0 controller; 1330 see <xref linkend="settings-usb" /> for details.</para> 1331 </listitem> 1332 1333 <listitem> 1334 <para><computeroutput>--usbrename 1335 <oldname> <newname></computeroutput>: This 1336 option enables renaming of the VM's virtual USB controller from <oldname> 1337 to <newname>.</para> 1338 </listitem> 1339 </itemizedlist></para> 1247 1340 1248 1341 </sect2> … … 1670 1763 <para>These settings configure the VM autostart feature, 1671 1764 which automatically starts the VM at host system boot-up. 1672 Note that there are pre-requisit ies that need to be addressed before using this feature.1765 Note that there are pre-requisites that need to be addressed before using this feature. 1673 1766 See <xref lang="" linkend="autostart" /> for more details.</para> 1674 1767 <itemizedlist> … … 1734 1827 </listitem> 1735 1828 <listitem> 1829 <para><computeroutput>--groups <group>, ...</computeroutput> 1830 Enables the clone to be assigned membership of the specified 1831 VM groups in the list. Note that group ids always start with a 1832 <computeroutput>/</computeroutput> and can be nested. By default, 1833 clones are always assigned membership of the group 1834 <computeroutput>/</computeroutput>.</para> 1835 </listitem> 1836 <listitem> 1736 1837 <para><computeroutput>--basefolder <basefolder></computeroutput>: 1737 1838 Select the folder where the new virtual machine configuration should … … 1774 1875 imported into VirtualBox, together with the optional command-line options 1775 1876 to influence the import behavior.</para> 1877 1878 <para>Use of the <computeroutput>--options link|keepallmacs|keepnatmacs|keepdisknames</computeroutput>: 1879 option enables additional fine tuning of the clone operation. The first 1880 option defines that a linked clone should be created, which is 1881 only possible for a machine clone from a snapshot. The next two 1882 options enable specification of how the MAC addresses of every virtual 1883 network card should be handled. They can either be reinitialized 1884 (the default), left unchanged 1885 (<computeroutput>keepallmacs</computeroutput>) or left unchanged 1886 when the network type is NAT 1887 (<computeroutput>keepnatmacs</computeroutput>). If you add 1888 <computeroutput>keepdisknames</computeroutput> all new disk images 1889 are assigned the same names as the originals, otherwise they are 1890 renamed.</para> 1776 1891 1777 1892 <para>As an example, here is the screen output with a sample appliance … … 1849 1964 <computeroutput>--producturl</computeroutput>, 1850 1965 <computeroutput>--vendor</computeroutput>, 1851 <computeroutput>--vendorurl</computeroutput> and 1852 <computeroutput>--version</computeroutput> to specify this additional 1966 <computeroutput>--vendorurl</computeroutput>, 1967 <computeroutput>--version</computeroutput> and 1968 <computeroutput>--description</computeroutput> to specify this additional 1853 1969 information. For legal reasons you may add a license text or the content 1854 1970 of a license file by using the <computeroutput>--eula</computeroutput> and … … 1860 1976 <para>For virtualization products which aren't fully compatible with the 1861 1977 OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the 1862 <computeroutput>--legacy09</computeroutput> option.</para> 1978 <computeroutput>--legacy09</computeroutput> option. Other options are 1979 --ovf09, --ovf10, --ovf20.</para> 1863 1980 1864 1981 <para>To specify options controlling the exact content of the appliance … … 1949 2066 in gray to indicate that the VM is currently paused. (This is 1950 2067 equivalent to selecting the "Pause" item in the "Machine" menu of 1951 the GUI .)</para>2068 the GUI).</para> 1952 2069 </listitem> 1953 2070 … … 1967 2084 system again immediately. The state of the VM is not saved 1968 2085 beforehand, and data may be lost. (This is equivalent to selecting 1969 the "Reset" item in the "Machine" menu of the GUI .)</para>2086 the "Reset" item in the "Machine" menu of the GUI).</para> 1970 2087 </listitem> 1971 2088 … … 1977 2094 equivalent to selecting the "Close" item in the "Machine" menu of 1978 2095 the GUI or pressing the window's close button, and then selecting 1979 "Power off the machine" in the dialog .)</para>2096 "Power off the machine" in the dialog).</para> 1980 2097 1981 2098 <para>After this, the VM's state will be "Powered off". From there, … … 1994 2111 <para>After this, the VM's state will be "Saved". From there, it can 1995 2112 be started again; see <xref linkend="vboxmanage-startvm" />.</para> 2113 </listitem> 2114 2115 <listitem> 2116 <para><computeroutput>VBoxManage controlvm <vm> 2117 acpipowerbutton</computeroutput> will send an ACPI shutdown signal to 2118 the VM, as if the power button on a real computer had been pressed. 2119 So long as the VM is running a fairly modern guest operating system 2120 providing ACPI support, this should trigger a proper shutdown mechanism 2121 from within the VM.</para> 2122 </listitem> 2123 2124 <listitem> 2125 <para><computeroutput>VBoxManage controlvm <vm> 2126 keyboardputscancode <hex> [<hex>...]</computeroutput> 2127 Sends commands using keycodes to the VM. Keycodes are documented in the 2128 public domain, e.g. http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html.</para> 1996 2129 </listitem> 1997 2130 … … 2008 2141 details.</para> 2009 2142 </listitem> 2010 2143 </itemizedlist></para> 2011 2144 2012 2145 <para>A few extra options are available with … … 2015 2148 2016 2149 <itemizedlist> 2017 <!-- @todo r=andy Document keyboardputscancode -->2018 2019 2150 <listitem> 2020 2151 <para>The <computeroutput>setlinkstate<1-N></computeroutput> … … 2401 2532 <listitem> 2402 2533 <para><computeroutput>--maxdowntime <msec></computeroutput>: 2403 Optional - specifies the maximum downtime (mill seconds) for the2534 Optional - specifies the maximum downtime (milliseconds) for the 2404 2535 teleporting target VM.</para> 2405 2536 </listitem> … … 2602 2733 describe the snapshot. If <computeroutput>--live</computeroutput> 2603 2734 is specified, the VM will not be stopped during the snapshot creation 2604 (live s mapshotting).</para>2735 (live snapshotting).</para> 2605 2736 2606 2737 <para>The <computeroutput>delete</computeroutput> operation deletes a … … 2868 2999 <para>This switch allows to enable the non-rotational flag for virtual 2869 3000 hard disks. Some guests (i.e. Windows 7+) treat such disks like SSDs 2870 and don't perform disk fragmentation on such media. 2871 </para> 3001 and don't perform disk fragmentation on such media.</para> 3002 </glossdef> 3003 </glossentry> 3004 3005 <glossentry> 3006 <glossterm><computeroutput>--discard</computeroutput></glossterm> 3007 <glossdef> 3008 <para>This switch enables the auto-discard feature for the virtual 3009 hard disks. This specifies that a VDI image will be shrunk in response 3010 to the trim command from the guest OS. The following requirements 3011 must be met: 3012 3013 <itemizedlist> 3014 <listitem> 3015 <para>The disk format must be VDI.</para> 3016 </listitem> 3017 <listitem> 3018 <para>The size of the cleared area must be at least 1MB.</para> 3019 </listitem> 3020 <listitem> 3021 <para>VirtualBox will only trim whole 1MB blocks. The VDIs themselves are organized 3022 into 1MB blocks, so this will only work if the space being TRIM-med is at least 3023 a 1MB contiguous block at a 1MB boundary. On Windows, occasional defrag (with "defrag.exe /D"), 3024 or under Linux running "btrfs filesystem defrag" as a background cron job may be 3025 beneficial.</para> 3026 </listitem> 3027 </itemizedlist></para> 3028 3029 <para>Notes: the Guest OS must be configured to issue trim command, and typically this 3030 means that the guest OS is made to 'see' the disk as an SSD. Ext4 supports -o discard mount flag; 3031 OSX probably requires additional settings. Windows ought to automatically detect and 3032 support SSDs - at least in versions 7, 8 and 10. Linux exFAT driver (courtesy of Samsung) 3033 supports the trim command.</para> 3034 <para>It is unclear whether Microsoft's implementation of exFAT supports this feature, even 3035 though that file system was originally designed for flash.</para> 3036 <para>Alternatively, there are ad hoc methods to issue trim, e.g. Linux fstrim command, 3037 part of util-linux package. Earlier solutions required a user to zero out unused areas, 3038 e.g. using zerofree, and explicitly compact the disk - only possible when the VM is 3039 offline.</para> 2872 3040 </glossdef> 2873 3041 </glossentry> … … 2930 3098 <glossdef> 2931 3099 <para>Logical Unit Number of the target resource (optional). 3100 Often, this value is zero.</para> 3101 </glossdef> 3102 </glossentry> 3103 3104 <glossentry> 3105 <glossterm><computeroutput>--encodedlun</computeroutput></glossterm> 3106 3107 <glossdef> 3108 <para>Hex encoded Logical Unit Number of the target resource (optional). 2932 3109 Often, this value is zero.</para> 2933 3110 </glossdef> … … 2946 3123 the password is stored encrypted.</para> 2947 3124 </note></para> 3125 </glossdef> 3126 </glossentry> 3127 3128 <glossentry> 3129 <glossterm><computeroutput>--initiator</computeroutput></glossterm> 3130 3131 <glossdef> 3132 <para>iSCSI Initiator (optional). Note:</para> 3133 3134 <para>Microsoft iSCSI Initiator is a system, such as a server that attaches to an IP network and initiates requests and receives responses 3135 from an iSCSI target. The SAN components in Microsoft iSCSI Initiator are largely analogous to Fibre Channel SAN components, and 3136 they include the following:/</para> 3137 3138 <para>To transport blocks of iSCSI commands over the IP network, an iSCSI driver must be installed on the iSCSI host. 3139 An iSCSI driver is included with Microsoft iSCSI Initiator.</para> 3140 3141 <para>A gigabit Ethernet adapter that transmits 1000 megabits per second (Mbps) is recommended for the connection to an iSCSI target. Like 3142 standard 10/100 adapters, most gigabit adapters use a preexisting Category 5 or Category 6E cable that. Each port on the adapter is 3143 identified by a unique IP address.</para> 3144 3145 <para>An iSCSI target is any device that receives iSCSI commands. The device can be an end node, such as a storage device, or it can be an 3146 intermediate device, such as a network bridge between IP and Fibre Channel devices. Each port on the storage array controller or network 3147 bridge is identified by one or more IP addresses</para> 2948 3148 </glossdef> 2949 3149 </glossentry> … … 3066 3266 3067 3267 <para>This command creates/deletes/modifies/shows bandwidth groups of the given 3068 virtual machine:<screen>VBoxManage bandwidthctl <uuid|vmname> 3069 add <name> --type disk|network --limit <megabytes per second>[k|m|g|K|M|G] | 3070 set <name> --limit <megabytes per second>[k|m|g|K|M|G] | 3071 remove <name> | 3072 list [--machinereadable]</screen></para> 3268 virtual machine: 3269 <screen>VBoxManage bandwidthctl <uuid|vmname> 3270 add <name> --type disk|network --limit <megabytes per second>[k|m|g|K|M|G] | 3271 set <name> --limit <megabytes per second>[k|m|g|K|M|G] | 3272 remove <name> | 3273 list [--machinereadable]</screen></para> 3073 3274 3074 3275 <para>The following subcommands are available:<itemizedlist> 3075 3276 <listitem> 3076 3277 <para><computeroutput>add</computeroutput>, creates a new bandwidth 3077 3278 group of given type.</para> 3078 3279 </listitem> 3079 3280 <listitem> 3080 3281 <para><computeroutput>set</computeroutput>, modifies the limit for an 3081 3282 existing bandwidth group.</para> 3082 3283 </listitem> 3083 3284 <listitem> … … 3087 3288 <listitem> 3088 3289 <para><computeroutput>list</computeroutput>, shows all bandwidth groups 3089 defined for the given VM.</para> 3290 defined for the given VM. Use <computeroutput>--machinereadable</computeroutput> 3291 option to produce the same output, but in machine readable format. This is of the 3292 form: name="value" on a line by line basis.</para> 3090 3293 </listitem> 3091 3294 </itemizedlist> … … 3113 3316 <glossdef> 3114 3317 <para>Type of the bandwidth group. Mandatory. Two types are 3115 3116 3117 3118 3119 3318 supported: <computeroutput>disk</computeroutput> and 3319 <computeroutput>network</computeroutput>. See 3320 <xref linkend="storage-bandwidth-limit" /> or 3321 <xref linkend="network_bandwidth_limit" /> for a description of a 3322 particular type.</para> 3120 3323 </glossdef> 3121 3324 </glossentry> … … 3126 3329 <glossdef> 3127 3330 <para>Specifies the limit for the given group. Can be changed 3128 while the VM is running. The default unit is megabytes per 3129 second. The unit can be changed by specifying one of the 3130 following suffixes: <computeroutput>k</computeroutput> for kilobits/s, <computeroutput>m</computeroutput> for megabits/s, <computeroutput>g</computeroutput> for gigabits/s, <computeroutput>K</computeroutput> for kilobytes/s, <computeroutput>M</computeroutput> for megabytes/s, <computeroutput>G</computeroutput> for gigabytes/s.</para> 3331 while the VM is running. The default unit is megabytes per 3332 second. The unit can be changed by specifying one of the 3333 following suffixes: <computeroutput>k</computeroutput> for kilobits/s, 3334 <computeroutput>m</computeroutput> for megabits/s, 3335 <computeroutput>g</computeroutput> for gigabits/s, 3336 <computeroutput>K</computeroutput> for kilobytes/s, 3337 <computeroutput>M</computeroutput> for megabytes/s, 3338 <computeroutput>G</computeroutput> for gigabytes/s.</para> 3131 3339 </glossdef> 3132 3340 </glossentry> … … 3134 3342 <note> 3135 3343 <para>The network bandwidth limits apply only to the traffic being sent by 3136 3344 virtual machines. The traffic being received by VMs is unlimited.</para> 3137 3345 </note> 3138 3346 <note> 3139 3347 <para>To remove a bandwidth group it must not be referenced by any disks 3140 3348 or adapters in running VM.</para> 3141 3349 </note> 3142 3350 </para> … … 3144 3352 3145 3353 <sect1> 3146 <title>VBoxManage show hdinfo</title>3147 3148 <para>This command shows information about a virtual hard disk image,3354 <title>VBoxManage showmediuminfo</title> 3355 3356 <para>This command shows information about a medium, 3149 3357 notably its size, its size on disk, its type and the virtual machines 3150 3358 which use it.<note> 3151 3359 <para>For compatibility with earlier versions of VirtualBox, the 3152 3360 "showvdiinfo" command is also supported and mapped internally to the 3153 "show hdinfo" command.</para>3361 "showmediuminfo" command.</para> 3154 3362 </note></para> 3155 <para>The disk image must be specified either by its UUID (if the medium 3363 3364 <screen>VBoxManage showmediuminfo [disk|dvd|floppy] <uuid|filename></screen> 3365 3366 <para>The medium must be specified either by its UUID (if the medium 3156 3367 is registered) or by its filename. Registered images can be listed by 3157 <computeroutput>VBoxManage list hdds</computeroutput> (see <xref linkend="vboxmanage-list" /> 3158 for more information). A filename must be specified as valid path, either 3159 as an absolute path or as a relative path starting from the current 3160 directory.</para> 3368 <computeroutput>VBoxManage list hdds</computeroutput>, 3369 <computeroutput>VBoxManage list dvds</computeroutput>, 3370 or <computeroutput>VBoxManage list floppies</computeroutput>, as appropriate. 3371 (see <xref linkend="vboxmanage-list" /> 3372 for more information).</para> 3161 3373 </sect1> 3162 3374 … … 3164 3376 <title>VBoxManage createhd</title> 3165 3377 3166 <para>This command creates a new virtual hard disk image. The syntax is as3167 follows:</para> 3168 3169 <screen>VBoxManage createhd --filename <filename>3170 --size <megabytes>|--sizebyte <bytes>3378 <para>This command creates a new medium. The syntax is as follows:</para> 3379 3380 <screen>VBoxManage createmedium [disk|dvd|floppy] --filename <filename> 3381 [--size <megabytes>|--sizebyte <bytes>] 3382 [--diffparent <uuid>|<filename> 3171 3383 [--format VDI|VMDK|VHD] (default: VDI) 3172 3384 [--variant Standard,Fixed,Split2G,Stream,ESX]</screen> … … 3174 3386 <para>where the parameters mean:<glosslist> 3175 3387 <glossentry> 3176 <glossterm><computeroutput>--filename</computeroutput></glossterm> 3177 3178 <glossdef> 3179 <para>Allows to choose a file name. Mandatory.</para> 3180 </glossdef> 3181 </glossentry> 3182 3183 <glossentry> 3184 <glossterm><computeroutput>--size</computeroutput></glossterm> 3185 3186 <glossdef> 3187 <para>Allows to define the image capacity, in 1 MiB units. 3188 Mandatory.</para> 3189 </glossdef> 3190 </glossentry> 3191 3192 <glossentry> 3193 <glossterm><computeroutput>--format</computeroutput></glossterm> 3194 3195 <glossdef> 3196 <para>Allows to choose a file format for the output file different 3197 from the file format of the input file.</para> 3198 </glossdef> 3199 </glossentry> 3200 3201 <glossentry> 3202 <glossterm><computeroutput>--variant</computeroutput></glossterm> 3203 3204 <glossdef> 3205 <para>Allows to choose a file format variant for the output file. 3388 <glossterm><computeroutput>--filename <filename></computeroutput></glossterm> 3389 3390 <glossdef> 3391 <para>Specifies a file name <filename> as an absolute path on the host file 3392 system.. Mandatory.</para> 3393 </glossdef> 3394 </glossentry> 3395 3396 <glossentry> 3397 <glossterm><computeroutput>--size <megabytes></computeroutput></glossterm> 3398 3399 <glossdef> 3400 <para><megabytes> Specifies the image capacity, in 1 MB units. 3401 Optional.</para> 3402 </glossdef> 3403 </glossentry> 3404 3405 <glossentry> 3406 <glossterm><computeroutput>--diffparent <uuid>|<filename></computeroutput></glossterm> 3407 3408 <glossdef> 3409 <para>Specifies the differencing image parent, either as a UUID or 3410 by the absolute pathname of the file on the host file system. 3411 Useful for sharing a base box disk image among several VMs.</para> 3412 </glossdef> 3413 </glossentry> 3414 3415 <glossentry> 3416 <glossterm><computeroutput>--format VDI|VMDK|VHD</computeroutput></glossterm> 3417 3418 <glossdef> 3419 <para>Specifies the file format for the output file. Available 3420 options are VDI, VMDK, VHD. Default is VDI. Optional. </para> 3421 </glossdef> 3422 </glossentry> 3423 3424 <glossentry> 3425 <glossterm><computeroutput>--variant Standard,Fixed,Split2G,Stream,ESX</computeroutput></glossterm> 3426 3427 <glossdef> 3428 <para>Specifies any required file format variant(s) for the output file. 3206 3429 It is a comma-separated list of variant flags. Not all 3207 combinations are supported, and specifying inconsistent flags will3208 result in an error message.</para>3430 combinations are supported, and specifying mutually incompatible 3431 flags results in an error message. Optional.</para> 3209 3432 </glossdef> 3210 3433 </glossentry> … … 3212 3435 <para>For compatibility with earlier versions of VirtualBox, the 3213 3436 "createvdi" command is also supported and mapped internally to the 3214 "create hd" command.</para>3437 "createmedium" command.</para> 3215 3438 </note></para> 3216 3439 </sect1> 3217 3440 3218 3441 <sect1 id="vboxmanage-modifyvdi"> 3219 <title>VBoxManage modify hd</title>3220 3221 <para>With the <computeroutput>modify hd</computeroutput> command, you can3442 <title>VBoxManage modifymedium</title> 3443 3444 <para>With the <computeroutput>modifymedium</computeroutput> command, you can 3222 3445 change the characteristics of a disk image after it has been 3223 created:<screen>VBoxManage modifyhd <uuid|filename> 3224 [--type normal|writethrough|immutable|shareable| 3225 readonly|multiattach] 3226 [--autoreset on|off] 3227 [--property <name=[value]>] 3228 [--compact] 3229 [--resize <megabytes>|--resizebyte <bytes>]</screen><note> 3230 <para>Despite the "hd" in the subcommand name, the command works with 3231 all disk images, not only hard disks. For compatibility with earlier 3232 versions of VirtualBox, the "modifyvdi" command is also supported and 3233 mapped internally to the "modifyhd" command.</para> 3446 created:<screen>VBoxManage modifymedium [disk|dvd|floppy] <uuid|filename> 3447 [--type normal|writethrough|immutable|shareable| 3448 readonly|multiattach] 3449 [--autoreset on|off] 3450 [--property <name=[value]>] 3451 [--compact] 3452 [--resize <megabytes>|--resizebyte <bytes>] 3453 [--move <full path to a new location></screen><note> 3454 <para>For compatibility with earlier versions of VirtualBox, the "modifyvdi" and "modifyhd" 3455 commands are also supported and mapped internally to the "modifymedium" command.</para> 3234 3456 </note></para> 3235 3457 … … 3257 3479 3258 3480 <listitem> 3259 <para> With the <computeroutput>--compact</computeroutput> option,3481 <para>The <computeroutput>--compact</computeroutput> option, 3260 3482 can be used to compact disk images, i.e. remove blocks that only 3261 3483 contains zeroes. This will shrink a dynamically allocated image … … 3303 3525 instead of megabytes.</para> 3304 3526 </listitem> 3527 3528 <listitem> 3529 <para>The <computeroutput>--move <dest></computeroutput> option 3530 can be used to move an image to a different location <dest> on the host file system, 3531 specified by either the relative path to the current directory or absolute path.</para> 3532 </listitem> 3305 3533 </itemizedlist></para> 3306 3534 </sect1> … … 3368 3596 </sect1> 3369 3597 3598 <sect1 id="vboxmanage-mediumproperty"> 3599 <title>VBoxManage mediumproperty</title> 3600 3601 <para>This command sets up, gets or deletes a medium property. 3602 The syntax is as follows:</para> 3603 3604 <screen>VBoxManage mediumproperty [disk|dvd|floppy] set <uuid|filename> 3605 <property> <value></screen> 3606 3607 3608 <para><itemizedlist> 3609 <listitem> 3610 <para>Use <computeroutput><disk|dvd|floppy></computeroutput> to optionally specify 3611 the type of medium: disk (hard drive), dvd or floppy.</para> 3612 </listitem> 3613 3614 <listitem> 3615 <para>Use <computeroutput><uuid|filename></computeroutput> to supply either the uuid 3616 or absolute path of the medium/image to be encrypted.</para> 3617 </listitem> 3618 3619 <listitem> 3620 <para>Use <computeroutput><property></computeroutput> to supply the name of the 3621 property.</para> 3622 </listitem> 3623 3624 <listitem> 3625 <para>Use <computeroutput><value></computeroutput> to supply the property value.</para> 3626 </listitem> 3627 </itemizedlist></para> 3628 3629 <screen>VBoxManage mediumproperty [disk|dvd|floppy] get <uuid|filename> 3630 <property></screen> 3631 <para><itemizedlist> 3632 <listitem> 3633 <para>Use <computeroutput><disk|dvd|floppy></computeroutput> to optionally specify 3634 the type of medium: disk (hard drive), dvd or floppy.</para> 3635 </listitem> 3636 3637 <listitem> 3638 <para>Use <computeroutput><uuid|filename></computeroutput> to supply either the uuid 3639 or absolute path of the medium/image to be encrypted.</para> 3640 </listitem> 3641 3642 <listitem> 3643 <para>Use <computeroutput><property></computeroutput> to supply the name of the 3644 property.</para> 3645 </listitem> 3646 </itemizedlist></para> 3647 3648 <screen>VBoxManage mediumproperty [disk|dvd|floppy] delete <uuid|filename> 3649 <property></screen> 3650 3651 3652 <para><itemizedlist> 3653 <listitem> 3654 <para>Use <computeroutput><disk|dvd|floppy></computeroutput> to optionally specify 3655 the type of medium: disk (hard drive), dvd or floppy.</para> 3656 </listitem> 3657 3658 <listitem> 3659 <para>Use <computeroutput><uuid|filename></computeroutput> to supply either the uuid 3660 or absolute path of the medium/image.</para> 3661 </listitem> 3662 3663 <listitem> 3664 <para>Use <computeroutput><property></computeroutput> to supply the name of the 3665 property.</para> 3666 </listitem> 3667 </itemizedlist></para> 3668 </sect1> 3669 3670 <sect1 id="vboxmanage-encryptmedium"> 3671 <title>VBoxManage encryptmedium</title> 3672 3673 <para>This command is used to create a DEK encrypted medium/image. 3674 See <xref linkend="diskencryption-encryption" />" for details.</para> 3675 3676 <para>The syntax is as follows:</para> 3677 3678 <screen>VBoxManage encryptmedium <uuid|filename> 3679 [--newpassword <file|->] 3680 [--oldpassword <file|->] 3681 [--cipher <cipher id>] 3682 [--newpasswordid <password id>]</screen> 3683 3684 <para><itemizedlist> 3685 <listitem> 3686 <para>use <computeroutput><uuid|filename></computeroutput> to supply the 3687 uuid or absolute path of the medium/image to be encrypted.</para> 3688 </listitem> 3689 3690 <listitem> 3691 <para>Use <computeroutput>--newpassword <file|-></computeroutput> to supply a new 3692 encryption password; either specify the absolute pathname of a password file on the host operating system, 3693 or <computeroutput>-</computeroutput> to prompt you for the password on the command line. 3694 Always use the <computeroutput>--newpasswordid</computeroutput> option with this option.</para> 3695 </listitem> 3696 3697 <listitem> 3698 <para>use <computeroutput>--oldpassword <file|-></computeroutput> to supply any old 3699 encryption password; either specify the absolute pathname of a password file on the host operating system, 3700 or <computeroutput>-</computeroutput> to prompt you for the old password on the command line.</para> 3701 3702 <para>Use this option to gain access to an encrypted medium/image to change its password using 3703 <computeroutput>--newpassword</computeroutput> and/or change its encryption using 3704 <computeroutput>--cipher</computeroutput>.</para> 3705 </listitem> 3706 3707 <listitem> 3708 <para>Use <computeroutput>--cipher <cipher></computeroutput> to specify the cipher to use for 3709 encryption; this can be either <computeroutput>AES-XTS128-PLAIN64</computeroutput> or 3710 <computeroutput>AES-AXTS256-PLAIN64</computeroutput>.</para> 3711 3712 <para>Use this option to change any existing encryption on the medium/image, or setup new encryption on 3713 it for the 1st time.</para> 3714 </listitem> 3715 3716 <listitem> 3717 <para>Use <computeroutput>--newpasswordid <password id></computeroutput> to supply the new password identifier. 3718 This can be freely chosen by the user, and is used for correct identification when supplying multiple 3719 passwords during VM startup.</para> 3720 3721 <para>If the user uses the same password when encrypting multiple images and also the same password identifier, the 3722 user needs to supply the password only once during VM startup.</para> 3723 </listitem> 3724 </itemizedlist></para> 3725 3726 </sect1> 3727 3728 <sect1 id="vboxmanage-checkmediumpwd"> 3729 3730 <title>VBoxManage checkmediumpwd</title> 3731 3732 <para>This command is used to check the current encryption password on a DEK encrypted medium/image. 3733 See <xref linkend="diskencryption-encryption" />" for details.</para> 3734 3735 <para>The syntax is as follows:</para> 3736 3737 <screen>VBoxManage checkmediumpwd <uuid|filename> 3738 <pwd file|-></screen> 3739 <para><itemizedlist> 3740 <listitem> 3741 <para>Use <computeroutput><uuid|filename></computeroutput> to supply the uuid or absolute path of the 3742 medium/image to be checked.</para> 3743 </listitem> 3744 3745 <listitem> 3746 <para>Use <computeroutput><pwd file|-></computeroutput> to supply the password identifier to be checked. Either 3747 specify the absolute pathname of a password file on the host operating system, or <computeroutput>-</computeroutput> to 3748 prompt you for the password on the command line.</para> 3749 </listitem> 3750 </itemizedlist></para> 3751 3752 </sect1> 3753 3370 3754 <sect1> 3371 3755 <title>VBoxManage convertfromraw</title> … … 3398 3782 <glossdef> 3399 3783 <para>Select the disk image format to create. Default is 3400 VDI. </para>3784 VDI. Other options are VMDK and VHD.</para> 3401 3785 </glossdef> 3402 3786 </glossentry> … … 3456 3840 3457 3841 Value: 2006.01.01</screen> 3842 3843 <para>You could retrieve the information for all keys as follows:</para> 3844 3845 <screen>VBoxManage getextradata Fedora5 enum</screen> 3846 3458 3847 <para>To remove a key, the <computeroutput>setextradata</computeroutput> 3459 3848 command must be run without specifying data (only the key), for example: … … 3473 3862 <glossentry> 3474 3863 <glossterm><computeroutput>machinefolder</computeroutput></glossterm> 3475 3476 3864 <glossdef> 3477 3865 <para>This specifies the default folder in which virtual machine … … 3562 3950 <sect1> 3563 3951 <title>VBoxManage usbfilter add/modify/remove</title> 3952 3953 <screen>VBoxManage usbfilter add <index,0-N> 3954 --target <uuid|vmname>global 3955 --name <string> 3956 --action ignore|hold (global filters only) 3957 [--active yes|no (yes)] 3958 [--vendorid <XXXX> (null)] 3959 [--productid <XXXX> (null)] 3960 [--revision <IIFF> (null)] 3961 [--manufacturer <string> (null)] 3962 [--product <string> (null)] 3963 [--remote yes|no (null, VM filters only)] 3964 [--serialnumber <string> (null)] 3965 [--maskedinterfaces <XXXXXXXX>] 3966 </screen> 3967 3968 <screen>VBoxManage usbfilter modify <index,0-N> 3969 --target <uuid|vmname>global 3970 [--name <string>] 3971 [--action ignore|hold (global filters only)] 3972 [--active yes|no] 3973 [--vendorid <XXXX>] 3974 [--productid <XXXX>] 3975 [--revision <IIFF>] 3976 [--manufacturer <string>] 3977 [--product <string>] 3978 [--remote yes|no (null, VM filters only)] 3979 [--serialnumber <string>] 3980 [--maskedinterfaces <XXXXXXXX>] 3981 </screen> 3982 3983 <screen>VBoxManage usbfilter remove <index,0-N> 3984 --target <uuid|vmname>global 3985 </screen> 3564 3986 3565 3987 <para>The <computeroutput>usbfilter</computeroutput> commands are used for … … 3585 4007 to all virtual machines. <computeroutput>name</computeroutput> is a name 3586 4008 for the new filter and for global filters, 3587 <computeroutput>action</computeroutput> says whether to allow machines4009 <computeroutput>action</computeroutput> says whether to allow VMs 3588 4010 access to devices that fit the filter description ("hold") or not to give 3589 4011 them access ("ignore"). In addition, you should specify parameters to … … 3603 4025 add</computeroutput>. To remove a filter, use <computeroutput>usbfilter 3604 4026 remove</computeroutput> and specify the index and the target.</para> 4027 4028 <para>The following is a list of the additional 4029 <computeroutput>usbfilter add</computeroutput> and 4030 <computeroutput>usbfilter modify</computeroutput> options, with detailed 4031 explanations on how to use them.</para> 4032 4033 <para><itemizedlist> 4034 <listitem> 4035 <para><computeroutput>--action ignore|hold</computeroutput>Specifies 4036 whether devices that fit the filter description are allowed access by 4037 machines ("hold"), or have access denied ("ignore"). Applies to 4038 global filters only.</para> 4039 </listitem> 4040 4041 <listitem> 4042 <para><computeroutput>--active yes|no</computeroutput>Specifies whether 4043 the USB Filter is active or temporarily disabled. For 4044 <computeroutput>usbfilter create</computeroutput> the default is 4045 active.</para> 4046 </listitem> 4047 4048 <listitem> 4049 <para><computeroutput>--vendorid <XXXX>|""</computeroutput>Specifies 4050 a vendor ID filter - the string representation for the exact matching 4051 has the form XXXX, where X is the hex digit (including leading zeroes).</para> 4052 </listitem> 4053 4054 <listitem> 4055 <para><computeroutput>--productid <XXXX>|""</computeroutput>Specifies 4056 a product ID filter - The string representation for the exact matching has 4057 the form XXXX, where X is the hex digit (including leading zeroes).</para> 4058 </listitem> 4059 4060 <listitem> 4061 <para><computeroutput>--revision <IIFF>|""</computeroutput>Specifies 4062 a revision ID filter - the string representation for the exact matching has 4063 the form IIFF, where I is the decimal digit of the integer part of the revision, 4064 and F is the decimal digit of its fractional part (including leading and trailing zeros). 4065 Note that for interval filters, it's best to use the hex form, because the revision is 4066 stored as a 16 bit packed BCD value; so the expression int:0x0100-0x0199 will match 4067 any revision from 1.0 to 1.99 inclusive.</para> 4068 </listitem> 4069 4070 <listitem> 4071 <para><computeroutput>--manufacturer <string>|""</computeroutput>Specifies 4072 a manufacturer ID filter, as a string.</para> 4073 </listitem> 4074 4075 <listitem> 4076 <para><computeroutput>--product <string>|""</computeroutput>Specifies 4077 a product ID filter, as a string.</para> 4078 </listitem> 4079 4080 <listitem> 4081 <para><computeroutput>--remote yes|no""</computeroutput>Specifies 4082 a remote filter - indicating whether the device is physically connected to a 4083 remote VRDE client or to a local host machine. Applies to VM filters only.</para> 4084 </listitem> 4085 4086 <listitem> 4087 <para><computeroutput>--serialnumber <string>|""</computeroutput>Specifies 4088 a serial number filter, as a string.</para> 4089 </listitem> 4090 4091 <listitem> 4092 <para><computeroutput>--maskedinterfaces <XXXXXXXX></computeroutput>Specifies 4093 a masked interface filter, for hiding one or more USB interfaces from the guest. 4094 The value is a bit mask where the set bits correspond to the USB interfaces that 4095 should be hidden, or masked off. This feature only works on Linux hosts.</para> 4096 </listitem> 4097 </itemizedlist></para> 3605 4098 </sect1> 3606 4099 3607 4100 <sect1 id="vboxmanage-sharedfolder"> 3608 4101 <title>VBoxManage sharedfolder add/remove</title> 4102 4103 <screen> 4104 VBoxManage sharedfolder add <uuid|vmname> 4105 --name <name> --hostpath <hostpath> 4106 [--transient] [--readonly] [--automount] 4107 </screen> 4108 3609 4109 3610 4110 <para>This command allows you to share folders on the host computer with … … 3612 4112 of the VirtualBox Guest Additions installed which supports this 3613 4113 functionality.</para> 4114 4115 <para>Parameters are:</para> 4116 4117 <para><itemizedlist> 4118 <listitem> 4119 <para><computeroutput><uuid|vmname></computeroutput> 4120 Specifies the UUID or name of the VM whose guest operating system will be 4121 sharing folders with the host computer. Mandatory.</para> 4122 </listitem> 4123 4124 <listitem> 4125 <para><computeroutput>--name <name></computeroutput> 4126 Specifies the name of the share. Each share has a unique name within the 4127 namespace of the host operating system. Mandatory.</para> 4128 </listitem> 4129 4130 <listitem> 4131 <para><computeroutput>-hostpath <hostpath></computeroutput> 4132 Specifies the absolute path on the host operating system of the 4133 folder/directory to be shared with the guest operating system. 4134 Mandatory.</para> 4135 </listitem> 4136 4137 <listitem> 4138 <para><computeroutput>-transient</computeroutput> 4139 Specifies that the share is 'transient', meaning that it can be added 4140 and removed at runtime and does not persist after the VM has stopped. 4141 Optional.</para> 4142 </listitem> 4143 4144 <listitem> 4145 <para><computeroutput>-readonly</computeroutput> 4146 Specifies that the share has only read-only access to files at the host path.</para> 4147 4148 <para>By default, shared folders have read/write access to the files at the host 4149 path. More specifically, on Linux distros - shared folders are mounted with 4150 770 io permissions with root user and vboxsf as the group, and using this option 4151 the io permissions change to 700. Optional.</para> 4152 </listitem> 4153 4154 <listitem> 4155 <para><computeroutput>-automount</computeroutput> 4156 Specifies that the share will be automatically mounted. On Linux distros, this will 4157 be to either /media/USER/sf_<name> or /media/sf_<name> - depending on 4158 your guest OS. Where <name> is the share name. Optional.</para> 4159 </listitem> 4160 </itemizedlist></para> 4161 4162 <screen> 4163 VBoxManage sharedfolder remove <uuid|vmname> 4164 --name <name> [--transient] 4165 4166 </screen> 4167 4168 <para>This command allows you to delete shared folders on the host computer shares with 4169 the guest operating systems. For this, the guest systems must have a version 4170 of the VirtualBox Guest Additions installed which supports this 4171 functionality.</para> 4172 4173 <para>Parameters are:</para> 4174 4175 <para><itemizedlist> 4176 <listitem> 4177 <para><computeroutput><uuid|vmname></computeroutput> 4178 Specifies the UUID or name of the VM whose guest operating system is 4179 sharing folders with the host computer. Mandatory.</para> 4180 </listitem> 4181 4182 <listitem> 4183 <para><computeroutput>--name <name></computeroutput> 4184 Specifies the name of the share to be removed. Each share has a unique name within the 4185 namespace of the host operating system. Mandatory.</para> 4186 </listitem> 4187 4188 <listitem> 4189 <para><computeroutput>-transient</computeroutput> 4190 Specifies that the share is 'transient', meaning that it can be added 4191 and removed at runtime and does not persist after the VM has stopped. 4192 Optional.</para> 4193 </listitem> 4194 </itemizedlist></para> 4195 3614 4196 3615 4197 <para>Shared folders are described in detail in <xref … … 5156 5738 <computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use 5157 5739 <computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given 5158 network or host-only interface name.</para> 5740 network or host-only interface name. This has the same parameters as 5741 <computeroutput>VBoxManage dhcpserver add</computeroutput>.</para> 5159 5742 </sect1> 5743 5744 <sect1 id="vboxmanage-usbdevsource"> 5745 <title>VBoxManage usbdevsource</title> 5746 5747 <para>The "usbdevsource" commands enables you to add and remove USB devices 5748 globally.</para> 5749 5750 <para>The following command adds a USB device.</para> 5751 5752 <screen>VBoxManage usbdevsource add <source name> 5753 --backend <backend> 5754 --address <address> 5755 </screen> 5756 5757 <para>Where the command line options are:<itemizedlist> 5758 <listitem> 5759 <para><source name> specifies the ID of the 'source' USB 5760 device to be added. Mandatory.</para> 5761 </listitem> 5762 <listitem> 5763 <para>--backend <backend> specifies the USB proxy service 5764 backend to use. Mandatory.</para> 5765 </listitem> 5766 <listitem> 5767 <para>--address <address> specifies the backend specific 5768 address. Mandatory.</para> 5769 </listitem> 5770 </itemizedlist></para> 5771 5772 <para>The following command removes a USB device.</para> 5773 5774 <screen>VBoxManage usbdevsource remove <source name> 5775 </screen> 5776 5777 <para>Where the command line options are:<itemizedlist> 5778 <listitem> 5779 <para><source name> specifies the ID of the 'source' USB 5780 device to be removed. Mandatory.</para> 5781 </listitem> 5782 </itemizedlist></para> 5783 </sect1> 5784 5160 5785 5161 5786 <xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)"
Note:
See TracChangeset
for help on using the changeset viewer.
