2.18. Locking Down the Oracle VM VirtualBox GUI

2.18.1. Customizing the VirtualBox Manager

There are several advanced customization settings for locking down the VirtualBox Manager. Locking down means removing some features that the user should not see.

VBoxManage setextradata global GUI/Customizations property[,property ...]

property is one of the following properties:

noSelector: Do not allow users to start the VirtualBox Manager. Trying to do so will show a window containing a proper error message.
noMenuBar: VM windows will not contain a menu bar.
noStatusBar: VM windows will not contain a status bar.

To disable any of these VirtualBox Manager customizations use the following command:

$ VBoxManage setextradata global GUI/Customizations

2.18.2. VM Selector Customization

The following per-machine VM extradata settings can be used to change the behavior of the VM selector window in respect of certain VMs:

$ VBoxManage setextradata VM-name property true

property can be any of the following:

GUI/HideDetails: Do not show the VM configuration of a certain VM. The details window will remain just empty if this VM is selected.
GUI/PreventReconfiguration: Do not allow the user to open the Settings dialog for a certain VM.
GUI/PreventSnapshotOperations: Prevent snapshot operations for a VM from the GUI, either at runtime or when the VM is powered off.
GUI/HideFromManager: Hide a certain VM in the VM selector window.
GUI/PreventApplicationUpdate: Disable the automatic update check and hide the corresponding menu item.

Note that these settings do not prevent the user from reconfiguring the VM by using the VBoxManage modifyvm command.

2.18.3. Configure VM Selector Menu Entries

You can disable, or blacklist, certain entries in the global settings page of the VM selector:

$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages property[,property...]

property is one of the following:

General: Do not show the General settings pane.
Input: Do not show the Input settings pane.
Update: Do not show the Update settings pane.
Language: Do not show the Language settings pane.
Display: Do not show the Display settings pane.
Network: Do not show the Network settings pane.
Extensions: Do not show the Extensions settings pane.
Proxy: Do not show the Proxy settings pane.

This is a global setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages

2.18.4. Configure VM Window Menu Entries

You can disable, or blacklist, certain menu actions in the VM window:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeMenus property[,property...]

property is one of the following:

All: Do not show any menu in the VM window.
Machine: Do not show the Machine menu in the VM window.
View: Do not show the View menu in the VM window.
Devices: Do not show the Devices menu in the VM window.
Help: Do not show the Help menu in the VM window.
Debug: Do not show the Debug menu in the VM window. The Debug menu is only visible if the GUI was started with special command line parameters or environment variable settings.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeMenus

You can also disable, or blacklist, certain menu actions of certain menus. Use the following command to disable certain actions of the Application menu. This is only available on Mac OS X hosts.

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeApplicationMenuActions property[,property...]

property is one of the following:

All: Do not show any menu item in this menu.
About: Do not show the About menu item in this menu.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeMenus

Use the following command to disable certain actions of the Machine menu:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeApplicationMenuActions property[,property ...]

property is one of the following:

All: Do not show any menu item in this menu.
SettingsDialog: Do not show the Settings menu item in this menu.
TakeSnapshot: Do not show the Take Snapshot menu item in this menu.
TakeScreenshot: Do not show the Take Screenshot menu item in this menu.
InformationDialog: Do not show the Session Information menu item in this menu.
MouseIntegration: Do not show the Disable Mouse Integration menu item in this menu.
TypeCAD: Do not show the Insert Ctrl+Alt+Del menu item in this menu.
TypeCABS: Do not show the Insert Ctrl+Alt+Backspace menu item in this menu. Available on X11 hosts only.
Pause: Do not show the Pause menu item in this menu.
Reset: Do not show the Reset menu item in this menu.
SaveState: Do not show the Save the machine state menu item in this menu.
Shutdown: Do not show the ACPI Shutdown menu item in this menu.
PowerOff: Do not show the Power Off the machine menu item in this menu.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeApplicationMenuActions

Use the following command to disable certain actions of the View menu:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeViewMenuActions property[,property...]

property is one of the following:

All: Do not show any menu item in this menu.
Fullscreen: Do not show the Switch to Fullscreen menu item in this menu.
Seamless: Do not show the Switch to Seamless Mode menu item in this menu.
Scale: Do not show the Switch to Scaled Mode menu item in this menu.
GuestAutoresize: Do not show the Auto-resize Guest Display menu item in this menu.
AdjustWindow: Do not show the Adjust Window Size menu item in this menu.
Multiscreen: Do not show the Multiscreen menu item in this menu. Only visible in full screen/seamless mode.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeViewMenuActions

Use the following command to disable certain actions of the View menu:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeDevicesMenuActions property[,property...]

property is one of the following properties to disable actions in the Devices menu:

All: Do not show any menu item in this menu.
OpticalDevices: Do not show the CD/DVD Devices menu item in this menu.
FloppyDevices: Do not show the Floppy Devices menu item in this menu.
USBDevices: Do not show the USB Devices menu item in this menu.
SharedClipboard: Do not show the Shared Clipboard menu item in this menu.
DragAndDrop: Do not show the Drag and Drop menu item in this menu.
NetworkSettings: Do not show the Network Settings... menu item in this menu.
SharedFoldersSettings: Do not show the Shared Folders Settings... menu item in this menu.
VRDEServer: Do not show the Remove Display menu item in this menu.
InstallGuestTools: Do not show the Insert Guest Additions CD image... menu item in this menu.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeDevicesMenuActions

Use the following command to disable certain actions of the View menu:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeDebuggerMenuActions property[,property...]

property is one of the following properties to disable actions in the Debug menu, which is completely disabled by default:

All: Do not show any menu item in this menu.
Statistics: Do not show the Statistics... menu item in this menu.
CommandLine: Do not show the Command Line... menu item in this menu.
Logging: Do not show the Logging... menu item in this menu.
LogDialog: Do not show the Show Log... menu item in this menu.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeDebuggerMenuActions

Use the following command to disable certain actions of the View menu:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeHelpMenuActions property[,property...]

property is one of the following properties to disable actions in the Help menu, which is completely disabled by default:

All: Do not show any menu item in this menu.
Contents: Do not show the Contents... menu item in this menu.
WebSite: Do not show the VirtualBox Web Site... menu item in this menu.
ResetWarnings: Do not show the Reset All Warnings menu item in this menu.
NetworkAccessManager: Do not show the Network Operations Manager menu item in this menu.
About: Do not show the About menu item in this menu. Only for non-Mac OS X hosts.
Contents: Do not show the Contents... menu item in this menu.
Contents: Do not show the Contents... menu item in this menu.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedRuntimeHelpMenuActions

2.18.5. Configure VM Window Status Bar Entries

You can disable, or blacklist, certain status bar items:

$ VBoxManage setextradata VM-name GUI/RestrictedStatusBarIndicators property[,property...]

property is one of the following:

HardDisks: Do not show the hard disk icon in the VM window status bar. By default the hard disk icon is only shown if the VM configuration contains one or more hard disks.
OpticalDisks: Do not show the CD icon in the VM window status bar. By default the CD icon is only shown if the VM configuration contains one or more CD drives.
FloppyDisks: Do not show the floppy icon in the VM window status bar. By default the floppy icon is only shown if the VM configuration contains one or more floppy drives.
Network: Do not show the network icon in the VM window status bar. By default the network icon is only shown if the VM configuration contains one or more active network adapters.
USB: Do not show the USB icon in the status bar.
SharedFolders: Do not show the shared folders icon in the status bar.
Capture: Do not show the capture icon in the status bar.
Features: Do not show the CPU features icon in the status bar.
Mouse: Do not show the mouse icon in the status bar.
Keyboard: Do not show the keyboard icon in the status bar.

This is a per-VM setting. You can specify any combination of properties. If all options are specified, no icons are shown in the status bar of the VM window. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedStatusBarIndicators

2.18.6. Configure VM Window Visual Modes

You can disable, or blacklist, certain VM visual modes:

$ VBoxManage setextradata VM-name GUI/RestrictedVisualStates property[,property...]

property is one of the following:

Fullscreen: Do not allow to switch the VM into full screen mode.
Seamless: Do not allow to switch the VM into seamless mode.
Scale: Do not allow to switch the VM into scale mode.

This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedVisualStates

2.18.7. Host Key Customization

To disable all Host key combinations, open the preferences and change the Host key to None. This might be useful when using Oracle VM VirtualBox in a kiosk mode.

To redefine or disable certain Host key actions, use the following command:

$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."

The following table shows the possible Host key actions, together with their default Host key shortcut. Setting an action to None will disable that Host key action.

Table 2.1 Host Key Customization

Action	Default Key	Action
`TakeSnapshot`	T	Take a snapshot
`TakeScreenshot`	E	Take a screenshot
`MouseIntegration`	I	Toggle mouse integration
`TypeCAD`	Del	Inject Ctrl+Alt+Del
`TypeCABS`	Backspace	Inject Ctrl+Alt+Backspace
`Pause`	P	Pause the VM
`Reset`	R	Hard reset the guest
`SaveState`		Save the VM state and terminate the VM
`Shutdown`	H	Press the virtual ACPI power button
`PowerOff`		Power off the VM without saving the state
`Close`	Q	Show the Close VM dialog
`FullscreenMode`	F	Switch the VM into full screen mode
`SeamlessMode`	L	Switch the VM into seamless mode
`ScaleMode`	C	Switch the VM into scaled mode
`GuestAutoResize`	G	Automatically resize the guest window
`WindowAdjust`	A	Immediately resize the guest window
`PopupMenu`	Home	Show the popup menu in full screen mode and seamless mode
`SettingsDialog`	S	Open the VM Settings dialog
`InformationDialog`	N	Show the VM Session Information window
`NetworkAdaptersDialog`		Show the VM Network Adapters dialog
`SharedFoldersDialog`		Show the VM Shared Folders dialog
`InstallGuestAdditions`	D	Mount the ISO containing the Guest Additions

To disable full screen mode and seamless mode, use the following command:

$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"

2.18.8. Action when Terminating the VM

You can disallow, or blacklist, certain actions when terminating a VM. To disallow specific actions, use the following command:

$ VBoxManage setextradata VM-name GUI/RestrictedCloseActions property[,property...]

property is one of the following:

SaveState: Do not allow the user to save the VM state when terminating the VM.
Shutdown: Do not allow the user to shutdown the VM by sending the ACPI power-off event to the guest.
PowerOff: Do not allow the user to power off the VM.
PowerOffRestoringSnapshot: Do not allow the user to return to the last snapshot when powering off the VM.
Detach: Do not allow the user to detach from the VM process if the VM was started in separate mode.

This is a per-VM setting. You can specify any combination of properties. If all properties are specified, the VM cannot be shut down.

2.18.9. Default Action when Terminating the VM

You can define a specific action for terminating a VM. In contrast to the setting decribed in the previous section, this setting allows only one action when the user terminates the VM. No exit menu is shown. Use the following command:

$ VBoxManage setextradata VM-name GUI/DefaultCloseAction action

action is one of the following:

SaveState: Save the VM state before terminating the VM process.
Shutdown: The VM is shut down by sending the ACPI power-off event to the guest.
PowerOff: The VM is powered off.
PowerOffRestoringSnapshot: The VM is powered off and the saved state returns to the last snapshot.
Detach: Terminate the frontend but leave the VM process running.

This is a per-VM setting. You can specify any combination of properties. If all properties are specified, the VM cannot be shut down.

2.18.10. Action for Handling a Guru Meditation

A VM runs into a Guru Meditation if there is a problem which cannot be fixed by other means than terminating the process. The default is to show a message window which instructs the user to open a bug report.

This behavior can be configured as follows:

$ VBoxManage setextradata VM-name GUI/GuruMeditationHandler mode

mode is one of the following:

Default: A message window is shown. After the user confirmed, the VM is terminated.
PowerOff: The VM is immediately powered-off without showing any message window. The VM logfile will show information about what happened.
Ignore: The VM is left in stuck mode. Execution is stopped but no message window is shown. The VM has to be powered off manually.

This is a per-VM setting.

2.18.11. Configuring Automatic Mouse Capturing

By default, the mouse is captured if the user clicks on the guest window and the guest expects relative mouse coordinates at this time. This happens if the pointing device is configured as PS/2 mouse and the guest has not yet started the Oracle VM VirtualBox Guest Additions. For instance, the guest is booting or the Guest Additions are not installed, or if the pointing device is configured as a USB tablet but the guest has no USB driver loaded yet. Once the Guest Additions become active or the USB guest driver is started, the mouse capture is automatically released.

The default behavior is sometimes not desired. Therefore it can be configured as follows:

VBoxManage setextradata VM-name GUI/MouseCapturePolicy mode

mode is one of the following:

Default: The default behavior as described above.
HostComboOnly: The mouse is only captured if the Host Key is toggled.
Disabled: The mouse is never captured, also not by toggling the Host Key

This is a per-VM setting.

2.18.12. Requesting Legacy Full-Screen Mode

Oracle VM VirtualBox uses special window manager facilities to switch a multi-screen machine to full-screen on a multi-monitor host system. However, not all window managers provide these facilities correctly. Oracle VM VirtualBox can be configured to use a legacy method of switching to full-screen mode instead, by using the command:

VBoxManage setextradata global GUI/Fullscreen/LegacyMode true

You can go back to the default method by using the following command:

VBoxManage setextradata global GUI/Fullscreen/LegacyMode

This is a global setting.

2.18.13. Removing Certain Modes of Networking From the GUI

It is possible to remove networking modes from Oracle VM VirtualBox GUI. To do this, use the following command:

VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes property[,property...]

property is one of the following:

NAT: Remove the NAT option from the GUI.
NATNetwork: Remove the NAT network option from the GUI.
BridgedAdapter: Remove the Bridged networking option from the GUI.
InternalNetwork: Remove the Internal networking option from the GUI.
HostOnlyAdapter: Remove the Host Only networking option from the GUI.
GenericDriver: Remove the Generic networking option from the GUI.

This is a global setting. You can specify any combination of properties. To restore the default behavior, use the following command:

VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes