Changeset 68977 in vbox
- Timestamp:
- Oct 4, 2017 12:11:16 PM (7 years ago)
- Location:
- trunk/doc/manual/en_US
- Files:
-
- 9 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/user_AdvancedTopics.xml
r68860 r68977 4317 4317 <computeroutput>usbip-host.ko</computeroutput> kernel drivers 4318 4318 are available, and that the USB/IP tools package is installed. 4319 The particular installation method for the necessary tools depends on which 4319 The particular installation method for the necessary tools depends on which 4320 4320 distribution is used. 4321 For example, for Debian based systems - the following command should be used to 4321 For example, for Debian based systems - the following command should be used to 4322 4322 install the required tools: 4323 4323 <screen>apt-get install usbip-utils</screen></para> … … 4344 4344 4345 4345 <para>By default, no device on the server is exported - and this must be done manually 4346 for each device. To export a device use: 4346 for each device. To export a device use: 4347 4347 <screen>usbip bind -b "bus identifier"</screen> 4348 4348 To export the multicard reader from above, for example - use: -
trunk/doc/manual/en_US/user_BasicConcepts.xml
r68280 r68977 1018 1018 distributions, the PulseAudio subsystem should be preferred.</para> 1019 1019 1020 <para>Since VirtualBox 5.0 only OSS is supported on Solaris hosts - the "Solaris Audio" 1020 <para>Since VirtualBox 5.0 only OSS is supported on Solaris hosts - the "Solaris Audio" 1021 1021 audio backend is no longer supported on Solaris hosts.</para> 1022 1022 </sect1> … … 1400 1400 <para>The "User Interface" section allows you to change certain aspects of 1401 1401 the user interface of this VM.</para> 1402 1402 1403 1403 <para><glosslist> 1404 1404 <glossentry> -
trunk/doc/manual/en_US/user_Introduction.xml
r66642 r68977 402 402 1.5. Support for Windows XP was removed with VirtualBox 5.0.</para> 403 403 </footnote> 404 404 405 405 <itemizedlist> 406 406 <listitem> -
trunk/doc/manual/en_US/user_Networking.xml
r68122 r68977 712 712 <para>As a security measure, by default, the Linux implementation of internal 713 713 networking only allows VMs running under the same user ID to establish an 714 internal network. However, it is possible to create a shared 714 internal network. However, it is possible to create a shared 715 715 internal networking interface, accessible by users with different UUIds.</para> 716 716 </sect1> … … 1010 1010 </listitem> 1011 1011 <listitem> 1012 <para>Perform a full, detailed analysis of network traffic on 1013 the VM's network adaptor using a 3rd party tool such as Wireshark. 1014 To do this, a promiscuous mode policy needs to be used on the 1015 VM's network adaptor. Use of this mode is only possible on 1012 <para>Perform a full, detailed analysis of network traffic on 1013 the VM's network adaptor using a 3rd party tool such as Wireshark. 1014 To do this, a promiscuous mode policy needs to be used on the 1015 VM's network adaptor. Use of this mode is only possible on 1016 1016 networks: NAT Network, Bridged Adapter, Internal Network and Host-only Adapter.</para> 1017 <para>To setup a promiscuous mode policy, either select from the drop down list 1017 <para>To setup a promiscuous mode policy, either select from the drop down list 1018 1018 located in the Network Settings dialog for the network adaptor 1019 1019 or use the command line tool <computeroutput>VBoxManage</computeroutput>; -
trunk/doc/manual/en_US/user_Storage.xml
r64233 r68977 418 418 419 419 <listitem> 420 <para><emphasis role="bold">copy</emphasis> a virtual hard disk, to 420 <para><emphasis role="bold">copy</emphasis> a virtual hard disk, to 421 421 another one - target type can be different, options are - VDI, VHD or VMDK.</para> 422 422 </listitem> 423 423 424 424 <listitem> 425 <para><emphasis role="bold">modify</emphasis> the attributes of the 425 <para><emphasis role="bold">modify</emphasis> the attributes of the 426 426 disk image file - available options are : Normal, Immutable, 427 427 Writethrough, Shareable, Multi-attach.</para> … … 429 429 430 430 <listitem> 431 <para><emphasis role="bold">refresh</emphasis> the values for the displayed 431 <para><emphasis role="bold">refresh</emphasis> the values for the displayed 432 432 attributes of the disk image currently selected in the window.</para> 433 433 </listitem> 434 434 435 435 </itemizedlist> 436 436 437 <para>These commands are accessible once a medium has been selected either by selecting 437 <para>These commands are accessible once a medium has been selected either by selecting 438 438 from the options shown at the top of the window, or by right-clicking the medium 439 439 and selecting from the options shown on the drop-down menu.</para> -
trunk/doc/manual/en_US/user_Technical.xml
r64726 r68977 40 40 on very old Windows versions which don't have this function 41 41 or where it unexpectedly returns an error, there is a fallback based 42 on environment variables: first 42 on environment variables: first 43 43 <computeroutput>%USERPROFILE%</computeroutput> is checked, if it 44 44 doesn't exist then an attempt with … … 57 57 <computeroutput>sudo</computeroutput> which by default doesn't reset 58 58 the environment variable <computeroutput>$HOME</computeroutput>). 59 Typical value on Linux and Solaris is 59 Typical value on Linux and Solaris is 60 60 <computeroutput>/home/username</computeroutput> and on Mac OS X 61 61 <computeroutput>/Users/username</computeroutput>.</para> … … 611 611 the benefits of communicating with the VirtualBox hypervisor.</para> 612 612 613 <para>Most modern mainstream guest operating systems, including 614 Windows and Linux, ship with support for one or more paravirtualization 615 interfaces. Hence, there is typically no need to install additional software 613 <para>Most modern mainstream guest operating systems, including 614 Windows and Linux, ship with support for one or more paravirtualization 615 interfaces. Hence, there is typically no need to install additional software 616 616 in the guest to take advantage of this feature. 617 617 </para> -
trunk/doc/manual/en_US/user_ThirdParty.xml
r68716 r68977 268 268 </para> 269 269 </listitem> 270 270 271 271 <listitem> 272 272 <para>VirtualBox contains portions of liblightdm-gobject which is governed by the -
trunk/doc/manual/en_US/user_Troubleshooting.xml
r62560 r68977 793 793 794 794 <para>Certain editions of Windows 2000 and 2003 servers support more 795 than 4 GB RAM on 32-bit systems. The AMD PCnet network driver shipped with 795 than 4 GB RAM on 32-bit systems. The AMD PCnet network driver shipped with 796 796 Windows Server 2003 fails to load if the 32-bit guest OS uses paging 797 797 extensions (which will occur with more than approximately 3.5 GB RAM … … 1121 1121 <title>Certain Solaris 10 releases may take long to boot with SMP</title> 1122 1122 1123 <para>When using more than one CPU, Solaris 10 releases 5/08 ("S10U5"), 1124 10/08 ("S10U6"), and 5/09 ("S10U7") may take a long time to boot and 1125 may print warnings on the system console regarding failures to read 1126 from disk. This is a bug in Solaris 10 which affects specific physical 1127 and virtual configurations. It is caused by trying to read microcode 1128 updates from the boot disk when the disk interrupt is reassigned to a 1129 not yet fully initialized secondary CPU. Disk reads will time out and 1123 <para>When using more than one CPU, Solaris 10 releases 5/08 ("S10U5"), 1124 10/08 ("S10U6"), and 5/09 ("S10U7") may take a long time to boot and 1125 may print warnings on the system console regarding failures to read 1126 from disk. This is a bug in Solaris 10 which affects specific physical 1127 and virtual configurations. It is caused by trying to read microcode 1128 updates from the boot disk when the disk interrupt is reassigned to a 1129 not yet fully initialized secondary CPU. Disk reads will time out and 1130 1130 fail, triggering delays (approx. 45 seconds) and warnings. 1131 1131 </para> 1132 1132 <para> 1133 The recommended solution is upgrading to at least Solaris 10 10/09 1134 ("S10U8") which includes a fix for this problem. Alternative solutions 1135 include restricting the number of virtual CPUs to one or possibly 1133 The recommended solution is upgrading to at least Solaris 10 10/09 1134 ("S10U8") which includes a fix for this problem. Alternative solutions 1135 include restricting the number of virtual CPUs to one or possibly 1136 1136 using a different storage controller. 1137 1137 </para> … … 1480 1480 <computeroutput>vboxusers</computeroutput> group. 1481 1481 Please keep in mind that group membership does not take effect immediately 1482 but rather at the next login. If available, the 1483 <computeroutput>newgrp</computeroutput> command may avoid the need for 1482 but rather at the next login. If available, the 1483 <computeroutput>newgrp</computeroutput> command may avoid the need for 1484 1484 logout/login.</para> 1485 1485 </sect2> -
trunk/doc/manual/en_US/user_VBoxManage.xml
r68515 r68977 251 251 <computeroutput>natnets</computeroutput> and 252 252 <computeroutput>dhcpservers</computeroutput>, respectively, list 253 bridged network interfaces, host-only network interfaces, 254 NAT network interfaces and DHCP servers currently available on the 253 bridged network interfaces, host-only network interfaces, 254 NAT network interfaces and DHCP servers currently available on the 255 255 host. Please see <xref 256 256 linkend="networkingdetails" /> for details on these.</para> … … 317 317 <listitem> 318 318 <para><computeroutput>groups</computeroutput> displays 319 details of the VM Groups; see <xref linkend="gui-vmgroups" /> 319 details of the VM Groups; see <xref linkend="gui-vmgroups" /> 320 320 for more information.</para> 321 321 </listitem> 322 322 323 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 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 327 to the VM using the 'webcam attach' command.</para> 328 328 </listitem> 329 329 330 330 <listitem> 331 <para><computeroutput>screenshotformats</computeroutput> displays a 331 <para><computeroutput>screenshotformats</computeroutput> displays a 332 332 list of available screenshot formats.</para> 333 333 </listitem> … … 367 367 ... 368 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 369 <para>Use the <computeroutput>--machinereadable</computeroutput> option 370 to produce the same output, but in machine readable format: property="value" on a 371 371 line by line basis, e.g.:</para> 372 372 <para><screen> … … 435 435 <computeroutput>.xml</computeroutput>) and the machine folder (a subfolder 436 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 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 440 is later renamed, the file and folder names will change automatically.</para> 441 441 … … 446 446 renamed.</para> 447 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 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 451 <computeroutput>/</computeroutput> and can be nested. By default, 452 VMs are always assigned membership of the group 452 VMs are always assigned membership of the group 453 453 <computeroutput>/</computeroutput>.</para> 454 454 455 455 <para>If the <computeroutput>--ostype <ostype></computeroutput>: 456 option is used, <ostype> specifies the guest operating system 456 option is used, <ostype> specifies the guest operating system 457 457 to run in the VM. To learn about the available OS options, 458 458 run <computeroutput>VBoxManage list ostypes</computeroutput> .</para> 459 459 460 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 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 464 within the appropriate namespace is automatically generated. 465 465 </para> … … 528 528 <listitem> 529 529 <para><computeroutput>--iconfile <filename></computeroutput>: 530 This specifies the absolute path on the host file system for the VirtualBox 530 This specifies the absolute path on the host file system for the VirtualBox 531 531 icon to be displayed in the VM.</para> 532 532 </listitem> … … 541 541 <listitem> 542 542 <para><computeroutput>--pagefusion on|off</computeroutput>: 543 Enables/disables (default) the Page Fusion feature. 544 The Page Fusion feature minimises memory duplication between VMs with similar 543 Enables/disables (default) the Page Fusion feature. 544 The Page Fusion feature minimises memory duplication between VMs with similar 545 545 configurations running on the same host. 546 546 See <xref linkend="guestadd-pagefusion" /> for details.</para> … … 667 667 <para><computeroutput>--x2apic on|off</computeroutput>: 668 668 This setting enables(default)/disables CPU x2APIC support. 669 CPU x2APIC support helps operating systems run more efficiently on high 669 CPU x2APIC support helps operating systems run more efficiently on high 670 670 core count configurations, and optimizes interrupt 671 671 distribution in virtualized environments. Disable when using host/guest … … 736 736 737 737 <listitem> 738 <para><computeroutput>--accelerate3d on|off</computeroutput>: 739 If the Guest Additions are installed, this setting enables or 738 <para><computeroutput>--accelerate3d on|off</computeroutput>: 739 If the Guest Additions are installed, this setting enables or 740 740 disables hardware 3D acceleration; see <xref 741 741 linkend="guestadd-3d" />.</para> … … 744 744 <listitem> 745 745 <para><computeroutput>--accelerate2dvideo on|off</computeroutput>: 746 If the Guest Additions are installed, this setting enables or 746 If the Guest Additions are installed, this setting enables or 747 747 disables 2D video acceleration; see <xref 748 748 linkend="guestadd-2d" />.</para> … … 794 794 disabled (no apic or x2apic) respectively.</para> 795 795 796 <para>Note that if x2apic is specified and x2apic is unsupported by the 797 VCPU, biosapic downgrades to apic, if supported - otherwise down to 'disabled'. 798 Similarly, if apic is specified, and apic is unsupported a 796 <para>Note that if x2apic is specified and x2apic is unsupported by the 797 VCPU, biosapic downgrades to apic, if supported - otherwise down to 'disabled'. 798 Similarly, if apic is specified, and apic is unsupported a 799 799 downgrade to 'disabled' results.</para> 800 800 </listitem> … … 803 803 <para><computeroutput>--biossystemtimeoffset <ms></computeroutput>: 804 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 805 the host time. If the offset is positive, the guest time runs ahead of the 806 806 host time.</para> 807 807 </listitem> … … 830 830 <listitem> 831 831 <para><computeroutput>--graphicscontroller none|vboxvga|vmsvga</computeroutput>: This 832 option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga. 832 option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga. 833 833 <xref linkend="settings-motherboard" />).</para> 834 834 </listitem> … … 836 836 <listitem> 837 837 <para><computeroutput>--snapshotfolder 838 default|<path></computeroutput>: This option specifies the folder in which 838 default|<path></computeroutput>: This option specifies the folder in which 839 839 snapshots will be kept for a virtual machine.</para> 840 840 </listitem> … … 842 842 <listitem> 843 843 <para><computeroutput>--firmware bios|efi|efi32|efi64</computeroutput>: 844 This option specifies which firmware to be used to boot the VM: 844 This option specifies which firmware to be used to boot the VM: 845 845 Available options are: BIOS, or one of the EFI options: efi, efi32 or efi64. 846 846 Use EFI options with care.</para> … … 898 898 <para><computeroutput>--nictype<1-N> 899 899 Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>: 900 This enables you to specify which networking hardware VirtualBox presents 900 This enables you to specify which networking hardware VirtualBox presents 901 901 to the guest for a specified VM virtual network card; 902 902 see <xref linkend="nichardware" />.</para> … … 940 940 <listitem> 941 941 <para><computeroutput>--nicspeed<1-N> <kbps></computeroutput>: 942 If generic networking has been enabled for a particular virtual network 942 If generic networking has been enabled for a particular virtual network 943 943 card (see the <computeroutput>--nic</computeroutput> option above - otherwise 944 this setting has no effect), this mode enables access to rarely used networking 945 sub-modes, such as VDE network or UDP Tunnel. This option specifies the 944 this setting has no effect), this mode enables access to rarely used networking 945 sub-modes, such as VDE network or UDP Tunnel. This option specifies the 946 946 throughput rate in KBytes/sec. 947 947 </para> … … 963 963 <para><computeroutput>--nicpromisc<1-N> 964 964 deny|allow-vms|allow-all</computeroutput>: 965 This ernables you to specify how the promiscuous mode is handled for 965 This ernables you to specify how the promiscuous mode is handled for 966 966 the specified VM virtual network card. 967 This setting is only relevant for bridged networking. 967 This setting is only relevant for bridged networking. 968 968 <computeroutput>deny</computeroutput> (default setting) hides 969 969 any traffic not intended for this VM. … … 977 977 <listitem> 978 978 <para><computeroutput>--nicbandwidthgroup<1-N> 979 none|<name></computeroutput>: This removes/adds an assignment 980 of a bandwidth group from/to the specified virtual network interface. 981 Specifying <computeroutput>none</computeroutput> removes any current 979 none|<name></computeroutput>: This removes/adds an assignment 980 of a bandwidth group from/to the specified virtual network interface. 981 Specifying <computeroutput>none</computeroutput> removes any current 982 982 bandwidth group assignment from the specified virtual network interface. 983 Specifying <computeroutput><name></computeroutput> adds an 984 assignment of a bandwidth group to the specified virtual network 983 Specifying <computeroutput><name></computeroutput> adds an 984 assignment of a bandwidth group to the specified virtual network 985 985 interface.</para> 986 986 <para>For details, please see <xref linkend="network_bandwidth_limit" />.</para> … … 1033 1033 <computeroutput>--nic</computeroutput> option above; otherwise 1034 1034 this setting has no effect), this mode allows you to access 1035 rarely used networking sub-modes, such as VDE network or UDP Tunnel. 1035 rarely used networking sub-modes, such as VDE network or UDP Tunnel. 1036 1036 </para> 1037 1037 </listitem> … … 1104 1104 <listitem> 1105 1105 <para><computeroutput>--nattbindip<1-N> 1106 <ip;></computeroutput>: VirtualBox's NAT engine normally routes 1107 TCP/IP packets through the default interface assigned by the host's 1108 TCP/IP stack. Use this setting to instruct the NAT engine to bind 1106 <ip;></computeroutput>: VirtualBox's NAT engine normally routes 1107 TCP/IP packets through the default interface assigned by the host's 1108 TCP/IP stack. Use this setting to instruct the NAT engine to bind 1109 1109 to a specified IP address instead. Please see <xref 1110 1110 linkend="nat-adv-settings" /> for details.</para> … … 1184 1184 connects a given virtual serial port (previously configured with 1185 1185 the <computeroutput>--uartX</computeroutput> setting, see above) 1186 to the host on which the virtual machine is running. As 1187 described in detail in <xref linkend="serialports" />, for each 1188 such port, you can specify <computeroutput><arg></computeroutput> 1186 to the host on which the virtual machine is running. As 1187 described in detail in <xref linkend="serialports" />, for each 1188 such port, you can specify <computeroutput><arg></computeroutput> 1189 1189 as one of the following options:<itemizedlist> 1190 1190 <listitem> … … 1234 1234 <listitem> 1235 1235 <para><computeroutput>file <file></computeroutput>: 1236 This redirects the serial port output to a raw file <file> 1236 This redirects the serial port output to a raw file <file> 1237 1237 specified by its absolute path on the host file system.</para> 1238 1238 </listitem> … … 1267 1267 <I/O base> <IRQ></computeroutput>: 1268 1268 Specifies the I/O address of the parallel port and the IRQ 1269 number that the Parallel Port feature will be using. Optional. Use this 1270 <emphasis>after</emphasis> <computeroutput>--lptmod</computeroutput>. 1271 I/O base address and IRQ are the values that guest sees i.e. the values 1269 number that the Parallel Port feature will be using. Optional. Use this 1270 <emphasis>after</emphasis> <computeroutput>--lptmod</computeroutput>. 1271 I/O base address and IRQ are the values that guest sees i.e. the values 1272 1272 avalable under guest Device Manager.</para> 1273 1273 </listitem> … … 1283 1283 <listitem> 1284 1284 <para><computeroutput>--audiocontroller ac97|hda|sb16</computeroutput>: With 1285 this setting, you can specify the audio controller to be used with this 1285 this setting, you can specify the audio controller to be used with this 1286 1286 VM. 1287 1287 </para> … … 1296 1296 <listitem> 1297 1297 <para><computeroutput>--audioin on</computeroutput>: With 1298 this setting, you can specify whether capturing audio from the 1298 this setting, you can specify whether capturing audio from the 1299 1299 host is enabled or disabled.</para> 1300 1300 </listitem> … … 1349 1349 1350 1350 <listitem> 1351 <para><computeroutput>--usbrename 1351 <para><computeroutput>--usbrename 1352 1352 <oldname> <newname></computeroutput>: This 1353 setting enables renaming of the VM's virtual USB controller from <oldname> 1353 setting enables renaming of the VM's virtual USB controller from <oldname> 1354 1354 to <newname>.</para> 1355 1355 </listitem> … … 1439 1439 <itemizedlist> 1440 1440 <listitem> 1441 <para>For TCP/Ports, <value> should be a port or a range of ports that the VRDE 1442 server can bind to; "default" or "0" means port 3389, the standard port for RDP. 1441 <para>For TCP/Ports, <value> should be a port or a range of ports that the VRDE 1442 server can bind to; "default" or "0" means port 3389, the standard port for RDP. 1443 1443 For details, see the description for the 1444 1444 <computeroutput>--vrdeport</computeroutput> option in <xref … … 1467 1467 1468 1468 <listitem> 1469 <para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive, 1470 representing a JPEG compression level on the VRDE server video channel. Lower values mean lower 1469 <para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive, 1470 representing a JPEG compression level on the VRDE server video channel. Lower values mean lower 1471 1471 quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para> 1472 1472 </listitem> 1473 1473 1474 1474 <listitem> 1475 <para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to 1476 enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer 1475 <para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to 1476 enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer 1477 1477 size, then it is regarded as a full screen video, and is displayed; but if its size is between fullscreen and the downscale 1478 1478 threshold - it is NOT displayed, as it could be an application window, which would be unreadable when downscaled. … … 1495 1495 For details, see <xref linkend="vrde-customization" />.</para> 1496 1496 </listitem> 1497 1497 1498 1498 <listitem> 1499 1499 <para><computeroutput>--vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para> … … 1526 1526 </listitem> 1527 1527 <listitem> 1528 <para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted. 1528 <para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted. 1529 1529 The client must support TLS.</para> 1530 1530 </listitem> … … 1630 1630 <listitem> 1631 1631 <para><computeroutput>--vrdeauthtype 1632 null|external|guest</computeroutput>: This enables you to indicate 1633 use of authorization, and specify how authorization will be performed; 1632 null|external|guest</computeroutput>: This enables you to indicate 1633 use of authorization, and specify how authorization will be performed; 1634 1634 see <xref linkend="vbox-auth" /> for details.</para> 1635 1635 </listitem> … … 1682 1682 introduction.<itemizedlist> 1683 1683 <listitem> 1684 <para><computeroutput>--teleporter on|off</computeroutput>: 1685 This setting enables/disables the teleporter feature whereby when the 1686 machine is started, it waits to receieve a teleporting request from the 1687 network instead of booting normally; teleporting requests are received on the 1684 <para><computeroutput>--teleporter on|off</computeroutput>: 1685 This setting enables/disables the teleporter feature whereby when the 1686 machine is started, it waits to receieve a teleporting request from the 1687 network instead of booting normally; teleporting requests are received on the 1688 1688 port and address specified using the following two parameters.</para> 1689 1689 </listitem> … … 1693 1693 <port></computeroutput>, <computeroutput>--teleporteraddress 1694 1694 <address></computeroutput>: these settings must be used with 1695 --teleporter and they specify the port and address the virtual machine should 1696 listen to to receive a teleporting request sent from another virtual machine. 1695 --teleporter and they specify the port and address the virtual machine should 1696 listen to to receive a teleporting request sent from another virtual machine. 1697 1697 <computeroutput><port></computeroutput> can 1698 1698 be any free TCP/IP port number (e.g. 6000); … … 1763 1763 1764 1764 <para>The following setting defines access to a USB Card Reader by the guest environment. 1765 USB card readers are typically used for accessing data on memory cards such as 1765 USB card readers are typically used for accessing data on memory cards such as 1766 1766 CompactFlash (CF), Secure Digital (SD) or MultiMediaCard (MMC).</para> 1767 1767 <itemizedlist> … … 1777 1777 1778 1778 <para>These settings configure the VM autostart feature, 1779 which automatically starts the VM at host system boot-up. 1780 Note that there are pre-requisites that need to be addressed before using this feature. 1779 which automatically starts the VM at host system boot-up. 1780 Note that there are pre-requisites that need to be addressed before using this feature. 1781 1781 See <xref lang="" linkend="autostart" /> for more details.</para> 1782 1782 <itemizedlist> … … 1826 1826 option defines that a linked clone should be created, which is 1827 1827 only possible for a machine cloned from a snapshot. The next two 1828 options enable specification of the handling of MAC addresses of 1828 options enable specification of the handling of MAC addresses of 1829 1829 every virtual network card. They can either be reinitialized 1830 1830 (the default), left unchanged … … 1991 1991 <para>For virtualization products which aren't fully compatible with the 1992 1992 OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the 1993 <computeroutput>--legacy09</computeroutput> option. Other options are 1993 <computeroutput>--legacy09</computeroutput> option. Other options are 1994 1994 --ovf09, --ovf10, --ovf20.</para> 1995 1995 … … 2130 2130 <listitem> 2131 2131 <para><computeroutput>VBoxManage controlvm <vm> 2132 acpipowerbutton</computeroutput> will send an ACPI shutdown signal to 2132 acpipowerbutton</computeroutput> will send an ACPI shutdown signal to 2133 2133 the VM, as if the power button on a real computer had been pressed. 2134 So long as the VM is running a fairly modern guest operating system 2135 providing ACPI support, this should trigger a proper shutdown mechanism 2134 So long as the VM is running a fairly modern guest operating system 2135 providing ACPI support, this should trigger a proper shutdown mechanism 2136 2136 from within the VM.</para> 2137 2137 </listitem> … … 2139 2139 <listitem> 2140 2140 <para><computeroutput>VBoxManage controlvm <vm> 2141 keyboardputscancode <hex> [<hex>...]</computeroutput> 2142 Sends commands using keycodes to the VM. Keycodes are documented in the 2141 keyboardputscancode <hex> [<hex>...]</computeroutput> 2142 Sends commands using keycodes to the VM. Keycodes are documented in the 2143 2143 public domain, e.g. http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html.</para> 2144 2144 </listitem> … … 2171 2171 <listitem> 2172 2172 <para><computeroutput>nic<1-N> 2173 null|nat|bridged|intnet|hostonly|generic|natnetwork[<devicename>]</computeroutput>: 2174 specifies the type of networking that should be made available on the specified VM 2175 virtual network card. 2173 null|nat|bridged|intnet|hostonly|generic|natnetwork[<devicename>]</computeroutput>: 2174 specifies the type of networking that should be made available on the specified VM 2175 virtual network card. 2176 2176 They can be: not connected to the host 2177 2177 (<computeroutput>null</computeroutput>), use network address … … 2183 2183 (<computeroutput>natnetwork</computeroutput>) or access to rarely used 2184 2184 sub-modes 2185 (<computeroutput>generic</computeroutput>). 2185 (<computeroutput>generic</computeroutput>). 2186 2186 These options correspond to the modes which are described in detail in <xref 2187 2187 linkend="networkingmodes" />.</para> … … 2189 2189 2190 2190 <listitem> 2191 <para>With the "nictrace" options, you can optionally trace network traffic by dumping 2191 <para>With the "nictrace" options, you can optionally trace network traffic by dumping 2192 2192 it to a file, for debugging purposes.</para> 2193 2193 2194 2194 <para>With <computeroutput>nictrace<1-N> 2195 on|off</computeroutput>, you can enable network tracing for a particular virtual 2195 on|off</computeroutput>, you can enable network tracing for a particular virtual 2196 2196 network card.</para> 2197 2197 … … 2205 2205 <para><computeroutput>nicpromisc<1-N> 2206 2206 deny|allow-vms|allow-all</computeroutput>: 2207 This specifies how the promiscious mode is handled for the specified VM 2207 This specifies how the promiscious mode is handled for the specified VM 2208 2208 virtual network card. This setting is only relevant for bridged networking. 2209 2209 <computeroutput>deny</computeroutput> (default setting) hides … … 2253 2253 2254 2254 <listitem> 2255 <para><computeroutput>usbattach<uuid|address> [--capturefile <filename>]</computeroutput></para> 2256 <para>and <computeroutput>usbdetach <uuid|address> [--capturefile <filename>]</computeroutput> 2255 <para><computeroutput>usbattach<uuid|address> [--capturefile <filename>]</computeroutput></para> 2256 <para>and <computeroutput>usbdetach <uuid|address> [--capturefile <filename>]</computeroutput> 2257 2257 make host USB devices visible/invisible to the virtual machine on the fly, without the need for 2258 2258 creating filters first. The USB devices can be specified by UUID 2259 (unique identifier) or by address on the host system. Use the --capturefile 2259 (unique identifier) or by address on the host system. Use the --capturefile 2260 2260 option to specify the absolute path of a file for writing activity logging data.</para> 2261 2261 … … 2266 2266 <listitem> 2267 2267 <para><computeroutput>audioin on</computeroutput>: With 2268 this setting, you can select whether capturing audio from the 2268 this setting, you can select whether capturing audio from the 2269 2269 host is enabled or disabled.</para> 2270 2270 </listitem> … … 2314 2314 <itemizedlist> 2315 2315 <listitem> 2316 <para>For TCP/Ports, <value> should be a port or a range of ports to which 2317 the VRDE server can bind; "default" or "0" means port 3389, the standard port for RDP. 2316 <para>For TCP/Ports, <value> should be a port or a range of ports to which 2317 the VRDE server can bind; "default" or "0" means port 3389, the standard port for RDP. 2318 2318 For details, see the description for the 2319 2319 <computeroutput>--vrdeport</computeroutput> option in <xref … … 2342 2342 2343 2343 <listitem> 2344 <para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive, 2345 representing a JPEG compression level on the VRDE server video channel. Lower values mean lower 2344 <para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive, 2345 representing a JPEG compression level on the VRDE server video channel. Lower values mean lower 2346 2346 quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para> 2347 2347 </listitem> 2348 2348 2349 2349 <listitem> 2350 <para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to enable the 2351 videochannel downscale protection feature. When enabled, if a video's size equals the shadow 2352 buffer size, then it is regarded as a full screen video, and is displayed; but if its size 2353 is between fullscreen and the downscale threshold - it is NOT displayed, as it could be an 2350 <para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to enable the 2351 videochannel downscale protection feature. When enabled, if a video's size equals the shadow 2352 buffer size, then it is regarded as a full screen video, and is displayed; but if its size 2353 is between fullscreen and the downscale threshold - it is NOT displayed, as it could be an 2354 2354 application window, which would be unreadable when downscaled. 2355 2355 When the downscale protection feature is disabled, an attempt is always made to display videos.</para> … … 2371 2371 For details, see <xref linkend="vrde-customization" />.</para> 2372 2372 </listitem> 2373 2373 2374 2374 <listitem> 2375 2375 <para><computeroutput>vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para> … … 2402 2402 </listitem> 2403 2403 <listitem> 2404 <para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted. 2404 <para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted. 2405 2405 The client must support TLS.</para> 2406 2406 </listitem> … … 2439 2439 <itemizedlist> 2440 2440 <listitem> 2441 <para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to 2441 <para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to 2442 2442 unset any Audio mode already set.</para> 2443 2443 </listitem> … … 2449 2449 </listitem> 2450 2450 <listitem> 2451 <para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent 2451 <para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent 2452 2452 under/overflow of the client queue.</para> 2453 2453 </listitem> … … 2460 2460 </itemizedlist></para> 2461 2461 </listitem> 2462 2462 2463 2463 <listitem> 2464 2464 <para><computeroutput>vrdevideochannelquality … … 2552 2552 2553 2553 <listitem> 2554 <para><computeroutput>teleport --host <name> --port <port></computeroutput> 2555 can be used to configure a VM as a target for teleporting. 2556 <name> specifies the virtual machine name. <port> specifies the port on the 2554 <para><computeroutput>teleport --host <name> --port <port></computeroutput> 2555 can be used to configure a VM as a target for teleporting. 2556 <name> specifies the virtual machine name. <port> specifies the port on the 2557 2557 virtual machine which should listen for teleporting requests from other 2558 2558 virtual machines. It can be any free TCP/IP port number (e.g. 6000); … … 2561 2561 <listitem> 2562 2562 <para><computeroutput>--maxdowntime <msec></computeroutput>: 2563 specifies the maximum downtime (milliseconds) for the 2563 specifies the maximum downtime (milliseconds) for the 2564 2564 teleporting target VM. Optional.</para> 2565 2565 </listitem> … … 2567 2567 <listitem> 2568 2568 <para><computeroutput>--password 2569 <password></computeroutput>: 2569 <password></computeroutput>: 2570 2570 indicates that the teleporting request will only succeed if the 2571 2571 source machine specifies the same password as the one given with … … 2575 2575 <listitem> 2576 2576 <para><computeroutput>--passwordfile 2577 <password file></computeroutput>: 2577 <password file></computeroutput>: 2578 2578 indicates that the teleporting request will only succeed if the 2579 2579 source machine specifies the same password as the one specified 2580 in the password file with the path specified with this command. 2581 Use <computeroutput>stdin</computeroutput> to read the password 2580 in the password file with the path specified with this command. 2581 Use <computeroutput>stdin</computeroutput> to read the password 2582 2582 from stdin. Optional.</para> 2583 2583 </listitem> … … 2602 2602 2603 2603 <listitem> 2604 <para><computeroutput>webcam 2605 attach <path|alias> [<key=value>[;<key=value>...]]</computeroutput>: This operation 2606 attaches a webcam to a running VM. Specify the absolute path of the 2607 webcam on the host operating system, or use its alias (obtained by using the command: VBoxManage 2604 <para><computeroutput>webcam 2605 attach <path|alias> [<key=value>[;<key=value>...]]</computeroutput>: This operation 2606 attaches a webcam to a running VM. Specify the absolute path of the 2607 webcam on the host operating system, or use its alias (obtained by using the command: VBoxManage 2608 2608 list webcams).</para> 2609 2609 2610 <para>Note that alias '.0' means default video input device on the host operating system, '.1', '.2', 2610 <para>Note that alias '.0' means default video input device on the host operating system, '.1', '.2', 2611 2611 etc. mean first, second, etc. video input device. The device order is host-specific.</para> 2612 2612 2613 <para>The optional settings parameter is a ';' delimited list of name/value pairs, enabling configuration 2613 <para>The optional settings parameter is a ';' delimited list of name/value pairs, enabling configuration 2614 2614 of the emulated webcam device.</para> 2615 2615 2616 2616 <para>The following settings are supported:</para> 2617 2617 2618 <para>MaxFramerate (default no maximum limit) - this specifies the highest rate (frames/sec) at which 2619 video frames are sent to the guest. Higher frame rates increase CPU load, so this setting can be useful 2620 when there is a need to reduce CPU load. Its default 'value' is 'no maximum limit', thus enabling the 2618 <para>MaxFramerate (default no maximum limit) - this specifies the highest rate (frames/sec) at which 2619 video frames are sent to the guest. Higher frame rates increase CPU load, so this setting can be useful 2620 when there is a need to reduce CPU load. Its default 'value' is 'no maximum limit', thus enabling the 2621 2621 guest to use all frame rates supported by the host webcam.</para> 2622 2622 2623 <para>MaxPayloadTransferSize (default 3060 bytes) - this specifies the maximum number of bytes the emulated 2624 webcam can send to the guest in one buffer. The default is used by some webcams. Higher values can 2625 slightly reduce CPU load, if the guest is able to use larger buffers. 2623 <para>MaxPayloadTransferSize (default 3060 bytes) - this specifies the maximum number of bytes the emulated 2624 webcam can send to the guest in one buffer. The default is used by some webcams. Higher values can 2625 slightly reduce CPU load, if the guest is able to use larger buffers. 2626 2626 Note that higher MaxPayloadTransferSize values may be not supported by some guest operating systems.</para> 2627 2627 </listitem> 2628 2628 2629 2629 <listitem> 2630 <para><computeroutput>webcam 2631 detach <path|alias></computeroutput>: This operation 2632 detaches a webcam from a running VM. Specify the absolute path of the 2630 <para><computeroutput>webcam 2631 detach <path|alias></computeroutput>: This operation 2632 detaches a webcam from a running VM. Specify the absolute path of the 2633 2633 webcam on the host, or use its alias (obtained from webcam list below).</para> 2634 2634 <para>Note the points below relating to specific Host Operating Systems:</para> … … 2636 2636 <para>Windows hosts</para> 2637 2637 2638 <para>When the webcam device is detached from the host, the emulated webcam device 2638 <para>When the webcam device is detached from the host, the emulated webcam device 2639 2639 is automatically detached from the guest.</para> 2640 2640 … … 2644 2644 2645 2645 <para>When the webcam device is detached from the host, the emulated webcam device remains 2646 attached to the guest and must be manually detached using the 2646 attached to the guest and must be manually detached using the 2647 2647 VBoxManage controlvm "VM name" webcam detach command.</para> 2648 2648 2649 2649 <para>Linux hosts</para> 2650 2650 2651 <para>When the webcam is detached from the host, the emulated webcam device is automatically detached 2652 from the guest only if the webcam is streaming video. If the emulated webcam is inactive, it 2651 <para>When the webcam is detached from the host, the emulated webcam device is automatically detached 2652 from the guest only if the webcam is streaming video. If the emulated webcam is inactive, it 2653 2653 should be manually detached using the VBoxManage controlvm "VM name" webcam detach command.</para> 2654 2654 </listitem> 2655 2655 2656 2656 <listitem> 2657 <para><computeroutput>webcam list</computeroutput>: This operation 2657 <para><computeroutput>webcam list</computeroutput>: This operation 2658 2658 lists webcams attached to the running VM. 2659 The output is a list of absolute paths or aliases that were used for attaching the webcams 2659 The output is a list of absolute paths or aliases that were used for attaching the webcams 2660 2660 to the VM using the 'webcam attach' command above. 2661 2661 </para> … … 2663 2663 2664 2664 <listitem> 2665 <para><computeroutput>addencpassword 2666 <id> <password file>|- [--removeonsuspend <yes|no>]</computeroutput>: This operation 2667 supplies an encrypted VM specified by <id> with the encryption password to enable a headless start. 2668 Either specify the absolute path of a password file on the host file system: <password file>, or 2665 <para><computeroutput>addencpassword 2666 <id> <password file>|- [--removeonsuspend <yes|no>]</computeroutput>: This operation 2667 supplies an encrypted VM specified by <id> with the encryption password to enable a headless start. 2668 Either specify the absolute path of a password file on the host file system: <password file>, or 2669 2669 use a '-' to instruct VBoxManage to prompt the user for the encryption password. </para> 2670 2670 2671 <para><computeroutput>--removeonsuspend <yes|no></computeroutput> specifies whether to remove/keep 2672 the password from/in VM memory when the VM is suspended. If the VM has been suspended and the password has 2673 been removed, the user needs to resupply the password before the VM can be resumed. This feature is useful 2674 in cases where the user doesn't want the password to be stored in VM memory, and the VM is suspended by a 2671 <para><computeroutput>--removeonsuspend <yes|no></computeroutput> specifies whether to remove/keep 2672 the password from/in VM memory when the VM is suspended. If the VM has been suspended and the password has 2673 been removed, the user needs to resupply the password before the VM can be resumed. This feature is useful 2674 in cases where the user doesn't want the password to be stored in VM memory, and the VM is suspended by a 2675 2675 host suspend event.</para> 2676 2676 2677 <para>Note: On VirtualBox versions 5.0 and later, data stored on hard disk images can be transparently 2678 encrypted for the guest. VirtualBox uses the AES algorithm in XTS mode and supports 128 or 256 2679 bit data encryption keys (DEK). The DEK is stored encrypted in the medium properties, and is 2677 <para>Note: On VirtualBox versions 5.0 and later, data stored on hard disk images can be transparently 2678 encrypted for the guest. VirtualBox uses the AES algorithm in XTS mode and supports 128 or 256 2679 bit data encryption keys (DEK). The DEK is stored encrypted in the medium properties, and is 2680 2680 decrypted during VM startup by supplying the encryption password.</para> 2681 2681 2682 <para>The "VBoxManage encryptmedium" operation is used to create a DEK encrypted medium. 2682 <para>The "VBoxManage encryptmedium" operation is used to create a DEK encrypted medium. 2683 2683 See <xref linkend="diskencryption-encryption" />" for details. 2684 When starting an encrypted VM from a VirtualBox GUI app, the user will be prompted for the 2684 When starting an encrypted VM from a VirtualBox GUI app, the user will be prompted for the 2685 2685 encryption password.</para> 2686 2686 2687 2687 <para>For a headless encrypted VM start, use:</para> 2688 2688 2689 2689 <para>VBoxManage startvm "vmname" --type headless</para> 2690 2690 … … 2698 2698 <listitem> 2699 2699 <para><computeroutput>removeencpassword <id></computeroutput>: This operation 2700 removes encryption password authorization for password <id> for all encrypted media 2700 removes encryption password authorization for password <id> for all encrypted media 2701 2701 attached to the VM.</para> 2702 2702 </listitem> … … 2704 2704 <listitem> 2705 2705 <para><computeroutput>removeallencpasswords</computeroutput>: This operation 2706 removes encryption password authorization for all passwords for all 2706 removes encryption password authorization for all passwords for all 2707 2707 encrypted media attached to the VM.</para> 2708 2708 </listitem> … … 2742 2742 hard disks can be quickly reset by simply dropping the pre-existing 2743 2743 differencing files.</para> 2744 2744 2745 2745 <screen>VBoxManage snapshot <uuid|vmname> 2746 2746 take <name> [--description <desc>] [--live] … … 3036 3036 <glossterm><computeroutput>--discard</computeroutput></glossterm> 3037 3037 <glossdef> 3038 <para>This switch enables the auto-discard feature for the virtual 3039 hard disks. This specifies that a VDI image will be shrunk in response 3038 <para>This switch enables the auto-discard feature for the virtual 3039 hard disks. This specifies that a VDI image will be shrunk in response 3040 3040 to the trim command from the guest OS. The following requirements 3041 3041 must be met: … … 3044 3044 <listitem> 3045 3045 <para>The disk format must be VDI.</para> 3046 </listitem> 3047 <listitem> 3046 </listitem> 3047 <listitem> 3048 3048 <para>The size of the cleared area must be at least 1MB.</para> 3049 3049 </listitem> 3050 3050 <listitem> 3051 <para>VirtualBox will only trim whole 1MB blocks. The VDIs themselves are organized 3052 into 1MB blocks, so this will only work if the space being TRIM-ed is at least 3051 <para>VirtualBox will only trim whole 1MB blocks. The VDIs themselves are organized 3052 into 1MB blocks, so this will only work if the space being TRIM-ed is at least 3053 3053 a 1MB contiguous block at a 1MB boundary. On Windows, occasional defrag (with "defrag.exe /D"), 3054 3054 or under Linux running "btrfs filesystem defrag" as a background cron job may be … … 3057 3057 </itemizedlist></para> 3058 3058 3059 <para>Notes: the Guest OS must be configured to issue trim command, and typically this 3060 means that the guest OS is made to 'see' the disk as an SSD. Ext4 supports -o discard mount flag; 3061 OSX probably requires additional settings. Windows ought to automatically detect and 3062 support SSDs - at least in versions 7, 8 and 10. Linux exFAT driver (courtesy of Samsung) 3059 <para>Notes: the Guest OS must be configured to issue trim command, and typically this 3060 means that the guest OS is made to 'see' the disk as an SSD. Ext4 supports -o discard mount flag; 3061 OSX probably requires additional settings. Windows ought to automatically detect and 3062 support SSDs - at least in versions 7, 8 and 10. Linux exFAT driver (courtesy of Samsung) 3063 3063 supports the trim command.</para> 3064 3064 <para>It is unclear whether Microsoft's implementation of exFAT supports this feature, even 3065 3065 though that file system was originally designed for flash.</para> 3066 3066 <para>Alternatively, there are ad hoc methods to issue trim, e.g. Linux fstrim command, 3067 part of util-linux package. Earlier solutions required a user to zero out unused areas, 3068 e.g. using zerofree, and explicitly compact the disk - only possible when the VM is 3067 part of util-linux package. Earlier solutions required a user to zero out unused areas, 3068 e.g. using zerofree, and explicitly compact the disk - only possible when the VM is 3069 3069 offline.</para> 3070 3070 </glossdef> … … 3162 3162 <para>iSCSI Initiator (optional). Note:</para> 3163 3163 3164 <para>Microsoft iSCSI Initiator is a system, such as a server that attaches to an IP network and initiates requests and receives responses 3165 from an iSCSI target. The SAN components in Microsoft iSCSI Initiator are largely analogous to Fibre Channel SAN components, and 3164 <para>Microsoft iSCSI Initiator is a system, such as a server that attaches to an IP network and initiates requests and receives responses 3165 from an iSCSI target. The SAN components in Microsoft iSCSI Initiator are largely analogous to Fibre Channel SAN components, and 3166 3166 they include the following:/</para> 3167 3167 3168 <para>To transport blocks of iSCSI commands over the IP network, an iSCSI driver must be installed on the iSCSI host. 3168 <para>To transport blocks of iSCSI commands over the IP network, an iSCSI driver must be installed on the iSCSI host. 3169 3169 An iSCSI driver is included with Microsoft iSCSI Initiator.</para> 3170 3170 3171 <para>A gigabit Ethernet adapter that transmits 1000 megabits per second (Mbps) is recommended for the connection to an iSCSI target. Like 3172 standard 10/100 adapters, most gigabit adapters use a pre-existing Category 5 or Category 6E cable. Each port on the adapter is 3171 <para>A gigabit Ethernet adapter that transmits 1000 megabits per second (Mbps) is recommended for the connection to an iSCSI target. Like 3172 standard 10/100 adapters, most gigabit adapters use a pre-existing Category 5 or Category 6E cable. Each port on the adapter is 3173 3173 identified by a unique IP address.</para> 3174 3174 3175 <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 3176 intermediate device, such as a network bridge between IP and Fibre Channel devices. Each port on the storage array controller or network 3175 <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 3176 intermediate device, such as a network bridge between IP and Fibre Channel devices. Each port on the storage array controller or network 3177 3177 bridge is identified by one or more IP addresses</para> 3178 3178 </glossdef> … … 3319 3319 <listitem> 3320 3320 <para><computeroutput>list</computeroutput>, shows all bandwidth groups 3321 defined for the given VM. Use the <computeroutput>--machinereadable</computeroutput> 3322 option to produce the same output, but in machine readable format. This is of the 3321 defined for the given VM. Use the <computeroutput>--machinereadable</computeroutput> 3322 option to produce the same output, but in machine readable format. This is of the 3323 3323 form: name="value" on a line by line basis.</para> 3324 3324 </listitem> … … 3362 3362 while the VM is running. The default unit is megabytes per 3363 3363 second. The unit can be changed by specifying one of the 3364 following suffixes: <computeroutput>k</computeroutput> for kilobits/s, 3364 following suffixes: <computeroutput>k</computeroutput> for kilobits/s, 3365 3365 <computeroutput>m</computeroutput> for megabits/s, 3366 3366 <computeroutput>g</computeroutput> for gigabits/s, … … 3397 3397 <para>The medium must be specified either by its UUID (if the medium 3398 3398 is registered) or by its filename. Registered images can be listed by 3399 <computeroutput>VBoxManage list hdds</computeroutput>, 3400 <computeroutput>VBoxManage list dvds</computeroutput>, 3399 <computeroutput>VBoxManage list hdds</computeroutput>, 3400 <computeroutput>VBoxManage list dvds</computeroutput>, 3401 3401 or <computeroutput>VBoxManage list floppies</computeroutput>, as appropriate. 3402 3402 (see <xref linkend="vboxmanage-list" /> … … 3438 3438 3439 3439 <glossdef> 3440 <para>Specifies the differencing image parent, either as a UUID or 3441 by the absolute pathname of the file on the host file system. 3440 <para>Specifies the differencing image parent, either as a UUID or 3441 by the absolute pathname of the file on the host file system. 3442 3442 Useful for sharing a base box disk image among several VMs.</para> 3443 3443 </glossdef> … … 3448 3448 3449 3449 <glossdef> 3450 <para>Specifies the file format for the output file. Available 3450 <para>Specifies the file format for the output file. Available 3451 3451 options are VDI, VMDK, VHD. Default is VDI. Optional. </para> 3452 3452 </glossdef> … … 3457 3457 3458 3458 <glossdef> 3459 <para>Specifies any required file format variant(s) for the output file. It is a 3460 comma-separated list of variant flags. Not all combinations are supported, and specifying 3459 <para>Specifies any required file format variant(s) for the output file. It is a 3460 comma-separated list of variant flags. Not all combinations are supported, and specifying 3461 3461 mutually incompatible flags results in an error message. Optional.</para> 3462 3462 </glossdef> 3463 3463 </glossentry> 3464 3464 </glosslist> <note> 3465 <para>For compatibility with earlier versions of VirtualBox, the "createvdi" and "createhd" commands 3465 <para>For compatibility with earlier versions of VirtualBox, the "createvdi" and "createhd" commands 3466 3466 are also supported and mapped internally to the "createmedium" command.</para> 3467 3467 </note></para> … … 3481 3481 [--resize <megabytes>|--resizebyte <bytes>] 3482 3482 [--move <path></screen><note> 3483 <para>For compatibility with earlier versions of VirtualBox, the "modifyvdi" and "modifyhd" 3483 <para>For compatibility with earlier versions of VirtualBox, the "modifyvdi" and "modifyhd" 3484 3484 commands are also supported and mapped internally to the "modifymedium" command.</para> 3485 3485 </note></para> … … 3632 3632 The syntax is as follows:</para> 3633 3633 3634 <screen>VBoxManage mediumproperty [disk|dvd|floppy] set <uuid|filename> 3634 <screen>VBoxManage mediumproperty [disk|dvd|floppy] set <uuid|filename> 3635 3635 <property> <value></screen> 3636 3636 … … 3643 3643 3644 3644 <listitem> 3645 <para>Use <computeroutput><uuid|filename></computeroutput> to supply either the uuid 3645 <para>Use <computeroutput><uuid|filename></computeroutput> to supply either the uuid 3646 3646 or absolute path of the medium/image to be encrypted.</para> 3647 3647 </listitem> 3648 3649 <listitem> 3650 <para>Use <computeroutput><property></computeroutput> to supply the name of the 3648 3649 <listitem> 3650 <para>Use <computeroutput><property></computeroutput> to supply the name of the 3651 3651 property.</para> 3652 3652 </listitem> … … 3657 3657 </itemizedlist></para> 3658 3658 3659 <screen>VBoxManage mediumproperty [disk|dvd|floppy] get <uuid|filename> 3659 <screen>VBoxManage mediumproperty [disk|dvd|floppy] get <uuid|filename> 3660 3660 <property></screen> 3661 3661 <para><itemizedlist> … … 3676 3676 </itemizedlist></para> 3677 3677 3678 <screen>VBoxManage mediumproperty [disk|dvd|floppy] delete <uuid|filename> 3678 <screen>VBoxManage mediumproperty [disk|dvd|floppy] delete <uuid|filename> 3679 3679 <property></screen> 3680 3680 3681 3681 3682 3682 <para><itemizedlist> 3683 3683 <listitem> … … 3706 3706 <para>The syntax is as follows:</para> 3707 3707 3708 <screen>VBoxManage encryptmedium <uuid|filename> 3708 <screen>VBoxManage encryptmedium <uuid|filename> 3709 3709 [--newpassword <file|->] 3710 3710 [--oldpassword <file|->] … … 3714 3714 <para><itemizedlist> 3715 3715 <listitem> 3716 <para>use <computeroutput><uuid|filename></computeroutput> to supply the 3716 <para>use <computeroutput><uuid|filename></computeroutput> to supply the 3717 3717 uuid or absolute path of the medium/image to be encrypted.</para> 3718 3718 </listitem> 3719 3719 3720 3720 <listitem> 3721 <para>Use <computeroutput>--newpassword <file|-></computeroutput> to supply a new 3721 <para>Use <computeroutput>--newpassword <file|-></computeroutput> to supply a new 3722 3722 encryption password; either specify the absolute pathname of a password file on the host operating system, 3723 or <computeroutput>-</computeroutput> to prompt you for the password on the command line. 3723 or <computeroutput>-</computeroutput> to prompt you for the password on the command line. 3724 3724 Always use the <computeroutput>--newpasswordid</computeroutput> option with this option.</para> 3725 3725 </listitem> … … 3730 3730 or <computeroutput>-</computeroutput> to prompt you for the old password on the command line.</para> 3731 3731 3732 <para>Use this option to gain access to an encrypted medium/image to change its password using 3732 <para>Use this option to gain access to an encrypted medium/image to change its password using 3733 3733 <computeroutput>--newpassword</computeroutput> and/or change its encryption using 3734 3734 <computeroutput>--cipher</computeroutput>.</para> … … 3736 3736 3737 3737 <listitem> 3738 <para>Use <computeroutput>--cipher <cipher></computeroutput> to specify the cipher to use for 3739 encryption; this can be either <computeroutput>AES-XTS128-PLAIN64</computeroutput> or 3738 <para>Use <computeroutput>--cipher <cipher></computeroutput> to specify the cipher to use for 3739 encryption; this can be either <computeroutput>AES-XTS128-PLAIN64</computeroutput> or 3740 3740 <computeroutput>AES-AXTS256-PLAIN64</computeroutput>.</para> 3741 3741 3742 <para>Use this option to change any existing encryption on the medium/image, or setup new encryption on 3742 <para>Use this option to change any existing encryption on the medium/image, or setup new encryption on 3743 3743 it for the 1st time.</para> 3744 3744 </listitem> … … 3746 3746 <listitem> 3747 3747 <para>Use <computeroutput>--newpasswordid <password id></computeroutput> to supply the new password identifier. 3748 This can be freely chosen by the user, and is used for correct identification when supplying multiple 3748 This can be freely chosen by the user, and is used for correct identification when supplying multiple 3749 3749 passwords during VM startup.</para> 3750 3750 3751 <para>If the user uses the same password when encrypting multiple images and also the same password identifier, the 3751 <para>If the user uses the same password when encrypting multiple images and also the same password identifier, the 3752 3752 user needs to supply the password only once during VM startup.</para> 3753 3753 </listitem> … … 3765 3765 <para>The syntax is as follows:</para> 3766 3766 3767 <screen>VBoxManage checkmediumpwd <uuid|filename> 3767 <screen>VBoxManage checkmediumpwd <uuid|filename> 3768 3768 <pwd file|-></screen> 3769 3769 <para><itemizedlist> 3770 3770 <listitem> 3771 <para>Use <computeroutput><uuid|filename></computeroutput> to supply the uuid or absolute path of the 3771 <para>Use <computeroutput><uuid|filename></computeroutput> to supply the uuid or absolute path of the 3772 3772 medium/image to be checked.</para> 3773 3773 </listitem> 3774 3774 3775 3775 <listitem> 3776 <para>Use <computeroutput><pwd file|-></computeroutput> to supply the password identifier to be checked. Either 3777 specify the absolute pathname of a password file on the host operating system, or <computeroutput>-</computeroutput> to 3776 <para>Use <computeroutput><pwd file|-></computeroutput> to supply the password identifier to be checked. Either 3777 specify the absolute pathname of a password file on the host operating system, or <computeroutput>-</computeroutput> to 3778 3778 prompt you for the password on the command line.</para> 3779 3779 </listitem> … … 3781 3781 3782 3782 </sect1> 3783 3783 3784 3784 <sect1> 3785 3785 <title>VBoxManage convertfromraw</title> … … 4056 4056 remove</computeroutput> and specify the index and the target.</para> 4057 4057 4058 <para>The following is a list of the additional 4059 <computeroutput>usbfilter add</computeroutput> and 4060 <computeroutput>usbfilter modify</computeroutput> options, with detailed 4058 <para>The following is a list of the additional 4059 <computeroutput>usbfilter add</computeroutput> and 4060 <computeroutput>usbfilter modify</computeroutput> options, with detailed 4061 4061 explanations on how to use them.</para> 4062 4062 4063 4063 <para><itemizedlist> 4064 4064 <listitem> 4065 <para><computeroutput>--action ignore|hold</computeroutput>Specifies 4066 whether devices that fit the filter description are allowed access by 4067 machines ("hold"), or have access denied ("ignore"). Applies to 4065 <para><computeroutput>--action ignore|hold</computeroutput>Specifies 4066 whether devices that fit the filter description are allowed access by 4067 machines ("hold"), or have access denied ("ignore"). Applies to 4068 4068 global filters only.</para> 4069 4069 </listitem> … … 4071 4071 <listitem> 4072 4072 <para><computeroutput>--active yes|no</computeroutput>Specifies whether 4073 the USB Filter is active or temporarily disabled. For 4073 the USB Filter is active or temporarily disabled. For 4074 4074 <computeroutput>usbfilter create</computeroutput> the default is 4075 4075 active.</para> … … 4077 4077 4078 4078 <listitem> 4079 <para><computeroutput>--vendorid <XXXX>|""</computeroutput>Specifies 4080 a vendor ID filter - the string representation for the exact matching 4079 <para><computeroutput>--vendorid <XXXX>|""</computeroutput>Specifies 4080 a vendor ID filter - the string representation for the exact matching 4081 4081 has the form XXXX, where X is the hex digit (including leading zeroes).</para> 4082 4082 </listitem> 4083 4083 4084 4084 <listitem> 4085 <para><computeroutput>--productid <XXXX>|""</computeroutput>Specifies 4086 a product ID filter - The string representation for the exact matching has 4085 <para><computeroutput>--productid <XXXX>|""</computeroutput>Specifies 4086 a product ID filter - The string representation for the exact matching has 4087 4087 the form XXXX, where X is the hex digit (including leading zeroes).</para> 4088 4088 </listitem> 4089 4089 4090 4090 <listitem> 4091 <para><computeroutput>--revision <IIFF>|""</computeroutput>Specifies 4091 <para><computeroutput>--revision <IIFF>|""</computeroutput>Specifies 4092 4092 a revision ID filter - the string representation for the exact matching has 4093 4093 the form IIFF, where I is the decimal digit of the integer part of the revision, … … 4099 4099 4100 4100 <listitem> 4101 <para><computeroutput>--manufacturer <string>|""</computeroutput>Specifies 4101 <para><computeroutput>--manufacturer <string>|""</computeroutput>Specifies 4102 4102 a manufacturer ID filter, as a string.</para> 4103 4103 </listitem> 4104 4104 4105 4105 <listitem> 4106 <para><computeroutput>--product <string>|""</computeroutput>Specifies 4106 <para><computeroutput>--product <string>|""</computeroutput>Specifies 4107 4107 a product ID filter, as a string.</para> 4108 4108 </listitem> 4109 4109 4110 4110 <listitem> 4111 <para><computeroutput>--remote yes|no""</computeroutput>Specifies 4112 a remote filter - indicating whether the device is physically connected to a 4111 <para><computeroutput>--remote yes|no""</computeroutput>Specifies 4112 a remote filter - indicating whether the device is physically connected to a 4113 4113 remote VRDE client or to a local host machine. Applies to VM filters only.</para> 4114 4114 </listitem> 4115 4115 4116 4116 <listitem> 4117 <para><computeroutput>--serialnumber <string>|""</computeroutput>Specifies 4117 <para><computeroutput>--serialnumber <string>|""</computeroutput>Specifies 4118 4118 a serial number filter, as a string.</para> 4119 4119 </listitem> 4120 4120 4121 4121 <listitem> 4122 <para><computeroutput>--maskedinterfaces <XXXXXXXX></computeroutput>Specifies 4123 a masked interface filter, for hiding one or more USB interfaces from the guest. 4124 The value is a bit mask where the set bits correspond to the USB interfaces that 4122 <para><computeroutput>--maskedinterfaces <XXXXXXXX></computeroutput>Specifies 4123 a masked interface filter, for hiding one or more USB interfaces from the guest. 4124 The value is a bit mask where the set bits correspond to the USB interfaces that 4125 4125 should be hidden, or masked off. This feature only works on Linux hosts.</para> 4126 4126 </listitem> … … 4147 4147 <listitem> 4148 4148 <para><computeroutput><uuid|vmname></computeroutput> 4149 Specifies the UUID or name of the VM whose guest operating system will be 4149 Specifies the UUID or name of the VM whose guest operating system will be 4150 4150 sharing folders with the host computer. Mandatory.</para> 4151 4151 </listitem> … … 4153 4153 <listitem> 4154 4154 <para><computeroutput>--name <name></computeroutput> 4155 Specifies the name of the share. Each share has a unique name within the 4155 Specifies the name of the share. Each share has a unique name within the 4156 4156 namespace of the host operating system. Mandatory.</para> 4157 4157 </listitem> … … 4159 4159 <listitem> 4160 4160 <para><computeroutput>-hostpath <hostpath></computeroutput> 4161 Specifies the absolute path on the host operating system of the 4161 Specifies the absolute path on the host operating system of the 4162 4162 folder/directory to be shared with the guest operating system. 4163 4163 Mandatory.</para> … … 4166 4166 <listitem> 4167 4167 <para><computeroutput>-transient</computeroutput> 4168 Specifies that the share is 'transient', meaning that it can be added 4169 and removed at runtime and does not persist after the VM has stopped. 4168 Specifies that the share is 'transient', meaning that it can be added 4169 and removed at runtime and does not persist after the VM has stopped. 4170 4170 Optional.</para> 4171 4171 </listitem> … … 4175 4175 Specifies that the share has only read-only access to files at the host path.</para> 4176 4176 4177 <para>By default, shared folders have read/write access to the files at the host 4178 path. More specifically, on Linux distros - shared folders are mounted with 4179 770 io permissions with root user and vboxsf as the group, and using this option 4177 <para>By default, shared folders have read/write access to the files at the host 4178 path. More specifically, on Linux distros - shared folders are mounted with 4179 770 io permissions with root user and vboxsf as the group, and using this option 4180 4180 the io permissions change to 700. Optional.</para> 4181 4181 </listitem> … … 4183 4183 <listitem> 4184 4184 <para><computeroutput>-automount</computeroutput> 4185 Specifies that the share will be automatically mounted. On Linux distros, this will 4185 Specifies that the share will be automatically mounted. On Linux distros, this will 4186 4186 be to either /media/USER/sf_<name> or /media/sf_<name> - depending on 4187 4187 your guest OS. Where <name> is the share name. Optional.</para> … … 4205 4205 <listitem> 4206 4206 <para><computeroutput><uuid|vmname></computeroutput> 4207 Specifies the UUID or name of the VM whose guest operating system is 4207 Specifies the UUID or name of the VM whose guest operating system is 4208 4208 sharing folders with the host computer. Mandatory.</para> 4209 4209 </listitem> … … 4211 4211 <listitem> 4212 4212 <para><computeroutput>--name <name></computeroutput> 4213 Specifies the name of the share to be removed. Each share has a unique name within the 4213 Specifies the name of the share to be removed. Each share has a unique name within the 4214 4214 namespace of the host operating system. Mandatory.</para> 4215 4215 </listitem> … … 4217 4217 <listitem> 4218 4218 <para><computeroutput>-transient</computeroutput> 4219 Specifies that the share is 'transient', meaning that it can be added 4220 and removed at runtime and does not persist after the VM has stopped. 4219 Specifies that the share is 'transient', meaning that it can be added 4220 and removed at runtime and does not persist after the VM has stopped. 4221 4221 Optional.</para> 4222 4222 </listitem> … … 4361 4361 [--passwordfile <file> | --password <password>] 4362 4362 [--domain <domain> ] 4363 [-v|--verbose] [-q|quiet] 4363 [-v|--verbose] [-q|quiet] 4364 4364 </screen> 4365 4365 … … 4373 4373 </glossdef> 4374 4374 </glossentry> 4375 4375 4376 4376 <glossentry> 4377 4377 <glossterm><computeroutput>--username <name></computeroutput></glossterm> … … 4383 4383 <glossentry> 4384 4384 <glossterm><computeroutput>--passwordfile <file>|--password</computeroutput></glossterm> 4385 <glossdef><para>Specifies the absolute path on guest file system of password file containing the 4386 password for the specified user account or password for the specified user account. Optional. 4385 <glossdef><para>Specifies the absolute path on guest file system of password file containing the 4386 password for the specified user account or password for the specified user account. Optional. 4387 4387 If both are omitted, empty password is assumed.</para></glossdef> 4388 4388 </glossentry> … … 4408 4408 <listitem> 4409 4409 <para><emphasis role="bold"><computeroutput>run</computeroutput></emphasis> 4410 Executes a guest program - forwarding stdout, stderr and stdin to/from the host 4410 Executes a guest program - forwarding stdout, stderr and stdin to/from the host 4411 4411 until it completes.</para> 4412 4412 <screen>VBoxManage guestcontrol <uuid|vmname> run [common-options] … … 4437 4437 <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm> 4438 4438 <glossdef> 4439 <para>Specifies the maximum time (microseconds) that the executable can run, 4440 during which VBoxManage receives its output. Optional. 4441 If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para> 4442 </glossdef> 4443 </glossentry> 4444 4445 <glossentry> 4446 <glossterm><computeroutput>-E|--putenv <NAME>=<VALUE> 4447 </computeroutput></glossterm> 4448 <glossdef> 4449 <para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para> 4450 <para>The guest process is created with the standard default guest OS environment. 4451 Use this option to modify that default environment. To set/modify a variable use: 4452 <computeroutput><NAME>=<VALUE></computeroutput>. 4453 To unset a variable use: 4454 <computeroutput><NAME>=</computeroutput></para> 4455 <para>Any spaces in names/values should be enclosed by quotes. </para> 4456 <para>To set/modify/unset multiple variables, use multiple instances of the 4457 <computeroutput>--E|--putenv</computeroutput> option. </para> 4458 </glossdef> 4459 </glossentry> 4460 4461 <glossentry> 4462 <glossterm><computeroutput>--unquoted-args</computeroutput></glossterm> 4463 <glossdef> 4464 <para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para> 4465 </glossdef> 4466 </glossentry> 4467 4468 <glossentry> 4469 <glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm> 4470 <glossdef> 4471 <para>Ignore orphaned processes. Not yet implemented. Optional.</para> 4472 </glossdef> 4473 </glossentry> 4474 4475 <glossentry> 4476 <glossterm><computeroutput>--profile</computeroutput></glossterm> 4477 <glossdef> 4478 <para>Use Profile. Not yet implemented. Optional.</para> 4479 </glossdef> 4480 </glossentry> 4481 4482 <glossentry> 4483 <glossterm><computeroutput>--no-wait-stdout|--wait-stdout</computeroutput></glossterm> 4484 <glossdef> 4485 <para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags. 4486 In the case of --wait-stdout - while the process runs, VBoxManage receives its stdout. Optional.</para> 4487 </glossdef> 4488 </glossentry> 4489 4490 <glossentry> 4491 <glossterm><computeroutput>--no-wait-stderr|--wait-stderr</computeroutput></glossterm> 4492 <glossdef> 4493 <para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags. 4494 In case of --wait-stderr - while the process runs, VBoxManage receives its stderr. Optional.</para> 4495 </glossdef> 4496 </glossentry> 4497 4498 <glossentry> 4499 <glossterm><computeroutput>--dos2unix</computeroutput></glossterm> 4500 <glossdef><para> 4501 Converts output from DOS/Windows guests to UNIX/Linux-compatible line endings 4502 (CR + LF → LF). Not yet implemented. Optional.</para> 4503 </glossdef> 4504 </glossentry> 4505 4506 <glossentry> 4507 <glossterm><computeroutput>--unix2dos</computeroutput></glossterm> 4508 <glossdef><para> 4509 Converts output from a UNIX/Linux guests to DOS/Windows-compatible 4510 line endings (LF → CR + LF). Not yet implemented. Optional.</para> 4511 </glossdef> 4512 </glossentry> 4513 4514 <glossentry> 4515 <glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm> 4516 <glossdef> 4517 <para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para> 4518 <para>Note: Any spaces in arguments should be enclosed by quotes.</para> 4519 </glossdef> 4520 </glossentry> 4521 </glosslist> 4522 4523 <para><note> 4524 <para>On Windows there are certain limitations for graphical 4525 applications; please see <xref linkend="KnownIssues" /> for more 4526 information.</para> 4527 </note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls" 4528 --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "c:\\windows\\system32\\ipconfig.exe" 4529 --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that 4530 the double backslashes in the second example are only required on 4531 Unix hosts.</para> 4532 4533 <para><note> 4534 <para>For certain commands a user name of an existing user account on the guest 4535 must be specified; anonymous executions are not supported for security reasons. A 4536 user account password, however, is optional and depends on the guest's OS security 4537 policy or rules. If no password is specified for a given user name, an empty password 4538 will be used. On certain OSes like Windows the security policy may needs to be adjusted 4539 in order to allow user accounts with an empty password set. Also, global domain rules might 4540 apply and therefore cannot be changed.</para> 4541 </note></para> 4542 4543 <para>Starting at VirtualBox 4.1.2 guest process execution by default is limited 4544 to serve up to 5 guest processes at a time. If a new guest process gets started 4545 which would exceed this limit, the oldest not running guest process will be discarded 4546 in order to be able to run that new process. Also, retrieving output from this 4547 old guest process will not be possible anymore then. If all 5 guest processes 4548 are still active and running, starting a new guest process will result in an 4549 appropriate error message.</para> 4550 4551 <para>To raise or lower the guest process execution limit, either the guest 4552 property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput> 4553 or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput> 4554 needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited 4555 guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para> 4556 </listitem> 4557 4558 <listitem> 4559 <para><emphasis role="bold"><computeroutput>start</computeroutput></emphasis> 4560 Executes a guest program until it completes.</para> 4561 <screen>VBoxManage guestcontrol <uuid|vmname> start [common-options] 4562 [--exe <path to executable>] [--timeout <msec>] 4563 [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] 4564 [--ignore-operhaned-processes] [--profile] 4565 -- <program/arg0> [argument1] ... [argumentN]] 4566 </screen> 4567 4568 <para>Where the options are: <glosslist> 4569 <glossentry> 4570 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 4571 <glossdef> 4572 <para>Specifies the VM UUID or VM name. Mandatory.</para> 4573 </glossdef> 4574 </glossentry> 4575 4576 <glossentry> 4577 <glossterm><computeroutput>--exe <path to executable></computeroutput></glossterm> 4578 <glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.: 4579 <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para> 4580 </glossdef> 4581 </glossentry> 4582 4583 <glossentry> 4584 <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm> 4585 <glossdef> 4586 <para>Specifies the maximum time (microseconds) that the executable can run. Optional. 4439 <para>Specifies the maximum time (microseconds) that the executable can run, 4440 during which VBoxManage receives its output. Optional. 4587 4441 If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para> 4588 4442 </glossdef> … … 4615 4469 <glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm> 4616 4470 <glossdef> 4471 <para>Ignore orphaned processes. Not yet implemented. Optional.</para> 4472 </glossdef> 4473 </glossentry> 4474 4475 <glossentry> 4476 <glossterm><computeroutput>--profile</computeroutput></glossterm> 4477 <glossdef> 4478 <para>Use Profile. Not yet implemented. Optional.</para> 4479 </glossdef> 4480 </glossentry> 4481 4482 <glossentry> 4483 <glossterm><computeroutput>--no-wait-stdout|--wait-stdout</computeroutput></glossterm> 4484 <glossdef> 4485 <para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags. 4486 In the case of --wait-stdout - while the process runs, VBoxManage receives its stdout. Optional.</para> 4487 </glossdef> 4488 </glossentry> 4489 4490 <glossentry> 4491 <glossterm><computeroutput>--no-wait-stderr|--wait-stderr</computeroutput></glossterm> 4492 <glossdef> 4493 <para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags. 4494 In case of --wait-stderr - while the process runs, VBoxManage receives its stderr. Optional.</para> 4495 </glossdef> 4496 </glossentry> 4497 4498 <glossentry> 4499 <glossterm><computeroutput>--dos2unix</computeroutput></glossterm> 4500 <glossdef><para> 4501 Converts output from DOS/Windows guests to UNIX/Linux-compatible line endings 4502 (CR + LF → LF). Not yet implemented. Optional.</para> 4503 </glossdef> 4504 </glossentry> 4505 4506 <glossentry> 4507 <glossterm><computeroutput>--unix2dos</computeroutput></glossterm> 4508 <glossdef><para> 4509 Converts output from a UNIX/Linux guests to DOS/Windows-compatible 4510 line endings (LF → CR + LF). Not yet implemented. Optional.</para> 4511 </glossdef> 4512 </glossentry> 4513 4514 <glossentry> 4515 <glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm> 4516 <glossdef> 4517 <para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para> 4518 <para>Note: Any spaces in arguments should be enclosed by quotes.</para> 4519 </glossdef> 4520 </glossentry> 4521 </glosslist> 4522 4523 <para><note> 4524 <para>On Windows there are certain limitations for graphical 4525 applications; please see <xref linkend="KnownIssues" /> for more 4526 information.</para> 4527 </note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls" 4528 --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "c:\\windows\\system32\\ipconfig.exe" 4529 --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that 4530 the double backslashes in the second example are only required on 4531 Unix hosts.</para> 4532 4533 <para><note> 4534 <para>For certain commands a user name of an existing user account on the guest 4535 must be specified; anonymous executions are not supported for security reasons. A 4536 user account password, however, is optional and depends on the guest's OS security 4537 policy or rules. If no password is specified for a given user name, an empty password 4538 will be used. On certain OSes like Windows the security policy may needs to be adjusted 4539 in order to allow user accounts with an empty password set. Also, global domain rules might 4540 apply and therefore cannot be changed.</para> 4541 </note></para> 4542 4543 <para>Starting at VirtualBox 4.1.2 guest process execution by default is limited 4544 to serve up to 5 guest processes at a time. If a new guest process gets started 4545 which would exceed this limit, the oldest not running guest process will be discarded 4546 in order to be able to run that new process. Also, retrieving output from this 4547 old guest process will not be possible anymore then. If all 5 guest processes 4548 are still active and running, starting a new guest process will result in an 4549 appropriate error message.</para> 4550 4551 <para>To raise or lower the guest process execution limit, either the guest 4552 property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput> 4553 or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput> 4554 needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited 4555 guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para> 4556 </listitem> 4557 4558 <listitem> 4559 <para><emphasis role="bold"><computeroutput>start</computeroutput></emphasis> 4560 Executes a guest program until it completes.</para> 4561 <screen>VBoxManage guestcontrol <uuid|vmname> start [common-options] 4562 [--exe <path to executable>] [--timeout <msec>] 4563 [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] 4564 [--ignore-operhaned-processes] [--profile] 4565 -- <program/arg0> [argument1] ... [argumentN]] 4566 </screen> 4567 4568 <para>Where the options are: <glosslist> 4569 <glossentry> 4570 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 4571 <glossdef> 4572 <para>Specifies the VM UUID or VM name. Mandatory.</para> 4573 </glossdef> 4574 </glossentry> 4575 4576 <glossentry> 4577 <glossterm><computeroutput>--exe <path to executable></computeroutput></glossterm> 4578 <glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.: 4579 <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para> 4580 </glossdef> 4581 </glossentry> 4582 4583 <glossentry> 4584 <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm> 4585 <glossdef> 4586 <para>Specifies the maximum time (microseconds) that the executable can run. Optional. 4587 If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para> 4588 </glossdef> 4589 </glossentry> 4590 4591 <glossentry> 4592 <glossterm><computeroutput>-E|--putenv <NAME>=<VALUE> 4593 </computeroutput></glossterm> 4594 <glossdef> 4595 <para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para> 4596 <para>The guest process is created with the standard default guest OS environment. 4597 Use this option to modify that default environment. To set/modify a variable use: 4598 <computeroutput><NAME>=<VALUE></computeroutput>. 4599 To unset a variable use: 4600 <computeroutput><NAME>=</computeroutput></para> 4601 <para>Any spaces in names/values should be enclosed by quotes. </para> 4602 <para>To set/modify/unset multiple variables, use multiple instances of the 4603 <computeroutput>--E|--putenv</computeroutput> option. </para> 4604 </glossdef> 4605 </glossentry> 4606 4607 <glossentry> 4608 <glossterm><computeroutput>--unquoted-args</computeroutput></glossterm> 4609 <glossdef> 4610 <para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para> 4611 </glossdef> 4612 </glossentry> 4613 4614 <glossentry> 4615 <glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm> 4616 <glossdef> 4617 4617 <para>Ignores orphaned processes. Not yet implemented. Optional.</para> 4618 4618 </glossdef> … … 4672 4672 <listitem> 4673 4673 <para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis> 4674 Copies files from the guest to the host file system. 4674 Copies files from the guest to the host file system. 4675 4675 (Note - only with Guest Additions 4.0 or later installed).</para> 4676 4676 … … 4691 4691 <glossterm><computeroutput>--dryrun</computeroutput></glossterm> 4692 4692 <glossdef> 4693 <para>Instructs VBoxManage to perform a dry run instead of an actual file copying 4693 <para>Instructs VBoxManage to perform a dry run instead of an actual file copying 4694 4694 operation. Optional. </para> 4695 4695 </glossdef> … … 4734 4734 <listitem> 4735 4735 <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis> 4736 Copies files from the host to the guest file system. 4736 Copies files from the host to the guest file system. 4737 4737 (Note - only with Guest Additions 4.0 or later installed).</para> 4738 4738 … … 4753 4753 <glossterm><computeroutput>--dryrun</computeroutput></glossterm> 4754 4754 <glossdef> 4755 <para>Instructs VBoxManage to perform a dry run instead of an actual file copying 4755 <para>Instructs VBoxManage to perform a dry run instead of an actual file copying 4756 4756 operation. Optional. </para> 4757 4757 </glossdef> … … 4796 4796 <listitem> 4797 4797 <para><emphasis role="bold"><computeroutput>md|mkdir|createdir|createdirectory</computeroutput></emphasis> 4798 Creates one or more directory(ies) on the guest file system. 4798 Creates one or more directory(ies) on the guest file system. 4799 4799 (Note - only with Guest Additions 4.0 or later installed).</para> 4800 4800 … … 4813 4813 <glossterm><computeroutput>--parents</computeroutput></glossterm> 4814 4814 <glossdef> 4815 <para>Creates any absent parent directory(ies) of the specified directory. Optional.</para> 4815 <para>Creates any absent parent directory(ies) of the specified directory. Optional.</para> 4816 4816 <para>e.g. If specified directory is <computeroutput>D:\Foo\Bar</computeroutput> 4817 and <computeroutput>D:\Foo</computeroutput> is absent, it will 4818 be created. In such a case, had the <computeroutput>--parents</computeroutput> 4817 and <computeroutput>D:\Foo</computeroutput> is absent, it will 4818 be created. In such a case, had the <computeroutput>--parents</computeroutput> 4819 4819 option not been used, this command would have failed.</para> 4820 4820 </glossdef> … … 4824 4824 <glossterm><computeroutput>--mode <mode></computeroutput></glossterm> 4825 4825 <glossdef> 4826 <para>Specifies the permission mode on the specified directory(ies) (and any parents, 4826 <para>Specifies the permission mode on the specified directory(ies) (and any parents, 4827 4827 where <computeroutput>--parents</computeroutput> option used). 4828 Currently octal modes (e.g. <computeroutput>0755</computeroutput>) only are 4828 Currently octal modes (e.g. <computeroutput>0755</computeroutput>) only are 4829 4829 supported.</para> 4830 4830 </glossdef> … … 4835 4835 <glossdef> 4836 4836 <para>Specifies list of absolute path(s) of directory(ies) to be created on 4837 guest file system. Mandatory. 4837 guest file system. Mandatory. 4838 4838 e.g. <computeroutput>D:\Foo\Bar</computeroutput>.</para> 4839 4839 <para>All parent directories must already exist 4840 unless switch <computeroutput>--parents</computeroutput> used. 4841 (e.g. in the above example <computeroutput>D:\Foo</computeroutput>). 4840 unless switch <computeroutput>--parents</computeroutput> used. 4841 (e.g. in the above example <computeroutput>D:\Foo</computeroutput>). 4842 4842 The specified user must have sufficient rights to create the 4843 specified directory(ies), and any parents that need 4843 specified directory(ies), and any parents that need 4844 4844 to be created.</para> 4845 4845 </glossdef> … … 4856 4856 [--recursive|-R] 4857 4857 <guest-dir0> [<guest-dir1> [...]] 4858 </screen> 4858 </screen> 4859 4859 4860 4860 <para>Where the parameters are: <glosslist> … … 4877 4877 <glossdef> 4878 4878 <para>Specifies list of the absolute path(s) of directory(ies) to be deleted on 4879 guest file system. Mandatory. Wildcards are allowed. e.g. <computeroutput>D:\Foo\*Bar</computeroutput>. 4879 guest file system. Mandatory. Wildcards are allowed. e.g. <computeroutput>D:\Foo\*Bar</computeroutput>. 4880 4880 The specified user must have sufficient rights to delete the 4881 4881 specified directory(ies).</para> … … 4913 4913 <glossdef> 4914 4914 <para>Specifies list of absolute path(s) of file(s) to be deleted on guest file system. Mandatory. 4915 Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar\text*.txt</computeroutput>. 4915 Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar\text*.txt</computeroutput>. 4916 4916 The specified user should have sufficient rights to delete the specified file(s).</para> 4917 4917 </glossdef> … … 4940 4940 <glossterm><computeroutput><guest-source0> [<guest-source1> [...]]</computeroutput></glossterm> 4941 4941 <glossdef> 4942 <para>Specifies absolute path(s) of file(s) and/or single directory to be moved/renamed on guest 4942 <para>Specifies absolute path(s) of file(s) and/or single directory to be moved/renamed on guest 4943 4943 file system. Mandatory. 4944 Wildcards are allowed in file names(s). The specified user should have sufficient rights to 4944 Wildcards are allowed in file names(s). The specified user should have sufficient rights to 4945 4945 access the specified file(s).</para> 4946 4946 </glossdef> … … 4951 4951 <glossdef> 4952 4952 <para>Specifies the absolute path of the destination file/directory to which the file(s) 4953 are to be moved. Mandatory. If only one file to be moved, <dest> can be file or directory, 4953 are to be moved. Mandatory. If only one file to be moved, <dest> can be file or directory, 4954 4954 else it must be a directory. 4955 4955 The specified user must have sufficient rights to access the destination file/directory.</para> … … 4962 4962 <para><emphasis role="bold"><computeroutput>mktemp|createtemp|createtemporary</computeroutput></emphasis> 4963 4963 Creates a temporary file/directory on the guest file system, to assist subsequent 4964 copying of files from the host to the guest file systems. By default, the file/directory 4964 copying of files from the host to the guest file systems. By default, the file/directory 4965 4965 is created in the guest's platform specific temp directory. Not currently supported. 4966 4966 (Only with installed Guest Additions 4.2 and later).</para> … … 4968 4968 <screen>VBoxManage guestcontrol <uuid|vmname> mktemp|createtemp|createtemporary [common-options] 4969 4969 [--directory] [--secure] [--mode <mode>] [--tmpdir <directory>] 4970 <template> 4970 <template> 4971 4971 </screen> 4972 4972 … … 4991 4991 <para> 4992 4992 Enforces secure file/directory creation. Optional. The permission mode is set to 4993 <computeroutput>0755</computeroutput>. Operation fails if it cannot be performed securely. 4993 <computeroutput>0755</computeroutput>. Operation fails if it cannot be performed securely. 4994 4994 </para> 4995 4995 </glossdef> … … 4999 4999 <glossterm><computeroutput>--mode <mode></computeroutput></glossterm> 5000 5000 <glossdef> 5001 <para>Specifies the permission mode of the specified directory. Optional. 5002 Currently only octal modes (e.g. <computeroutput>0755</computeroutput>) 5001 <para>Specifies the permission mode of the specified directory. Optional. 5002 Currently only octal modes (e.g. <computeroutput>0755</computeroutput>) 5003 5003 are supported.</para> 5004 5004 </glossdef> … … 5009 5009 <glossdef> 5010 5010 <para> 5011 Specifies the absolute path of the directory on the guest file system into which the 5011 Specifies the absolute path of the directory on the guest file system into which the 5012 5012 file/directory specified in will be created. Optional. 5013 If unspecified, the platform-specific temp directory is used. 5013 If unspecified, the platform-specific temp directory is used. 5014 5014 </para> 5015 5015 </glossdef> … … 5019 5019 <glossterm><computeroutput><template></computeroutput></glossterm> 5020 5020 <glossdef> 5021 <para>Specifies a file name without a directory path, containing at least one sequence comprising 5022 three consecutive 'X' characters, or ending in 'X'. Mandatory. 5021 <para>Specifies a file name without a directory path, containing at least one sequence comprising 5022 three consecutive 'X' characters, or ending in 'X'. Mandatory. 5023 5023 </para> 5024 5024 </glossdef> … … 5063 5063 <para>The "common-options" are:</para> 5064 5064 <screen> 5065 [-v|--verbose] [-q|--quiet] 5065 [-v|--verbose] [-q|--quiet] 5066 5066 </screen> 5067 5067 … … 5136 5136 <glossterm><computeroutput>--session-name <name or pattern></computeroutput></glossterm> 5137 5137 <glossdef> 5138 <para>Specifies the guest session by its name, or multiple sessions 5138 <para>Specifies the guest session by its name, or multiple sessions 5139 5139 using a pattern containing wildcards. Optional.</para> 5140 5140 </glossdef> … … 5192 5192 <listitem> 5193 5193 <para><emphasis role="bold"><computeroutput>updatega|updateadditions|updateguestadditions</computeroutput></emphasis> 5194 Ugrades Guest Additions already installed on the guest. 5194 Ugrades Guest Additions already installed on the guest. 5195 5195 (Only already installed Guest Additions 4.0 and later).</para> 5196 5196 5197 5197 <screen>VBoxManage guestcontrol <uuid|vmname> updatega|updateadditions|updateguestadditions [common-options] 5198 5198 [--source <New .ISO path>] 5199 [--wait-start] 5199 [--wait-start] 5200 5200 [-- <argument0> [<argument1> [...]]]</screen> 5201 5201 … … 5218 5218 <glossterm><computeroutput>--wait-start</computeroutput></glossterm> 5219 5219 <glossdef> 5220 <para>Indicates that VBoxManage starts the usual updating process on the guest and then waits 5220 <para>Indicates that VBoxManage starts the usual updating process on the guest and then waits 5221 5221 until the actual Guest Additions updating begins, at which point VBoxManage self-terminates. Optional.</para> 5222 <para>Default behavior is that VBoxManage waits for completion of the Guest Additions update before 5223 terminating. Use of this option is sometimes necessary, as a running VBoxManage 5222 <para>Default behavior is that VBoxManage waits for completion of the Guest Additions update before 5223 terminating. Use of this option is sometimes necessary, as a running VBoxManage 5224 5224 can affect the interaction between the installer and the guest OS.</para> 5225 5225 </glossdef> … … 5413 5413 <title>VBoxManage natnetwork</title> 5414 5414 5415 <para>NAT networks use the Network Address Translation (NAT) service - which works in a 5415 <para>NAT networks use the Network Address Translation (NAT) service - which works in a 5416 5416 similar way to a home router. It groups systems using it into a network and prevents 5417 outside systems from directly accessing those inside, while letting systems inside communicate 5417 outside systems from directly accessing those inside, while letting systems inside communicate 5418 5418 with each other and outside systems using TCP and UDP over IPv4 and IPv6.</para> 5419 5419 5420 <para>A NAT service is attached to an internal network. Virtual machines to make use of one 5421 should be attached to it. The name of an internal network is chosen when the NAT service is 5422 created, and the internal network will be created if it does not already exist. 5420 <para>A NAT service is attached to an internal network. Virtual machines to make use of one 5421 should be attached to it. The name of an internal network is chosen when the NAT service is 5422 created, and the internal network will be created if it does not already exist. 5423 5423 An example command to create a NAT network:</para> 5424 5424 … … 5426 5426 5427 5427 <para>Here, "natnet1" is the name of the internal network to be used and "192.168.15.0/24" is the 5428 network address and mask of the NAT service interface. By default, in this static configuration 5428 network address and mask of the NAT service interface. By default, in this static configuration 5429 5429 - the gateway will be assigned the address 192.168.15.1 (the address after the interface address), 5430 5430 though this is subject to change.</para> … … 5445 5445 [--port-forward-6 <rule>] 5446 5446 [--loopback-6 <rule>] 5447 </screen> 5448 5449 5450 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork add</computeroutput></emphasis> 5451 Creates a new internal network interface, and adds a NAT network service. This command is a 5447 </screen> 5448 5449 5450 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork add</computeroutput></emphasis> 5451 Creates a new internal network interface, and adds a NAT network service. This command is a 5452 5452 prerequisite for enabling attachment of VMs to the NAT network. Parameters:</para> 5453 5453 … … 5463 5463 <glossterm><computeroutput>--network <network></computeroutput></glossterm> 5464 5464 <glossdef> 5465 <para>Where <network> specifies the static(default)/DHCP network address and mask of 5465 <para>Where <network> specifies the static(default)/DHCP network address and mask of 5466 5466 the NAT service interface.</para> 5467 5467 </glossdef> … … 5476 5476 <glossterm><computeroutput>--dhcp on|off</computeroutput></glossterm> 5477 5477 <glossdef> 5478 <para>Enables/disables DHCP server specified by --netname; its use also indicates that it 5478 <para>Enables/disables DHCP server specified by --netname; its use also indicates that it 5479 5479 is a DHCP server.</para> 5480 5480 </glossdef> … … 5511 5511 </glossentry> 5512 5512 </glosslist> 5513 </para> 5513 </para> 5514 5514 5515 5515 <screen>VBoxManage natnetwork remove --netname <name> </screen> … … 5528 5528 </glossentry> 5529 5529 </glosslist> 5530 </para> 5530 </para> 5531 5531 5532 5532 <screen>VBoxManage natnetwork modify --netname <name> … … 5541 5541 </screen> 5542 5542 5543 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork modify</computeroutput></emphasis> 5543 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork modify</computeroutput></emphasis> 5544 5544 Modifies an existing NAT network service, parameters:</para> 5545 5545 … … 5555 5555 <glossterm><computeroutput>--network <network></computeroutput></glossterm> 5556 5556 <glossdef> 5557 <para>Where <network> specifies the new static(default)/DHCP network address and mask 5557 <para>Where <network> specifies the new static(default)/DHCP network address and mask 5558 5558 of the NAT service interface.</para> 5559 5559 </glossdef> … … 5602 5602 </glossentry> 5603 5603 </glosslist> 5604 </para> 5604 </para> 5605 5605 5606 5606 <screen>VBoxManage natnetwork start --netname <name> 5607 5607 </screen> 5608 5608 5609 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork start</computeroutput></emphasis> 5609 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork start</computeroutput></emphasis> 5610 5610 Starts specified NAT network service and any associated DHCP server, parameters:</para> 5611 5611 … … 5624 5624 </screen> 5625 5625 5626 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork stop</computeroutput></emphasis> 5626 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork stop</computeroutput></emphasis> 5627 5627 Stops specified NAT network service and any DHCP server, parameters:</para> 5628 5628 … … 5640 5640 <screen>VBoxManage natnetwork list [<pattern>] </screen> 5641 5641 5642 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork list</computeroutput></emphasis> 5642 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork list</computeroutput></emphasis> 5643 5643 Lists all NAT network services with optional filtering, parameters:</para> 5644 5644 … … 5766 5766 <computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use 5767 5767 <computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given 5768 network or host-only interface name. This has the same parameters as 5768 network or host-only interface name. This has the same parameters as 5769 5769 <computeroutput>VBoxManage dhcpserver add</computeroutput>.</para> 5770 5770 </sect1> … … 5773 5773 <title>VBoxManage usbdevsource</title> 5774 5774 5775 <para>The "usbdevsource" commands enables you to add and remove USB devices 5775 <para>The "usbdevsource" commands enables you to add and remove USB devices 5776 5776 globally.</para> 5777 5777 … … 5785 5785 <para>Where the command line options are:<itemizedlist> 5786 5786 <listitem> 5787 <para><source name> specifies the ID of the 'source' USB 5787 <para><source name> specifies the ID of the 'source' USB 5788 5788 device to be added. Mandatory.</para> 5789 5789 </listitem> 5790 5790 <listitem> 5791 <para>--backend <backend> specifies the USB proxy service 5791 <para>--backend <backend> specifies the USB proxy service 5792 5792 backend to use. Mandatory.</para> 5793 5793 </listitem> 5794 5794 <listitem> 5795 <para>--address <address> specifies the backend specific 5795 <para>--address <address> specifies the backend specific 5796 5796 address. Mandatory.</para> 5797 5797 </listitem> … … 5805 5805 <para>Where the command line options are:<itemizedlist> 5806 5806 <listitem> 5807 <para><source name> specifies the ID of the 'source' USB 5807 <para><source name> specifies the ID of the 'source' USB 5808 5808 device to be removed. Mandatory.</para> 5809 5809 </listitem>
Note:
See TracChangeset
for help on using the changeset viewer.