virtualboxOptions: List 'VirtualBox' options available

In vmr: Virtual Machines for R

List 'VirtualBox' options available

Description

List available options for 'VirtualBox' provider

Usage

virtualboxOptions(details = TRUE)

Arguments

details

if TRUE print options (default), otherwise only return default options

Details

Get the 'VirtualBox' default options. It return a list as follow:

list(
gui = TRUE,
name = NULL,
nic_type = NULL,
linked_clone = FALSE,
check_guest_additions = TRUE,
modifyvm = list(cpus = "2", memory = "4096")
)

• gui: if TRUE show the GUI, otherwise headless mode is actived

• name: the 'VirtualBox' instance name

• nic_type: the NIC type for the network interface to use, by default use the default one. see VirtualBox Networking

• linked_clone: if TRUE, linked clones are based on a master VM, which is generated by importing the base box only once the first time it is required. For the linked clones only differencing disk images are created where the parent disk image belongs to the master VM. (Be careful, master VM can't be remove until linked_clone still exists)

• check_guest_additions: If TRUE (default) check if guest have guest additions installed.

• modifyvm: list of 'VirtualBox' properties for the guest VM (such as number of cpus, memory size,...). see 'VirtualBox' modifyvm

Value

A default list of options

list(
gui = TRUE,
name = NULL,
nic_type = NULL,
linked_clone = FALSE,
check_guest_additions = TRUE,
modifyvm = list(cpus = "2", memory = "4096")
)

Examples

## Not run: 
vb.opts <- virtualboxOptions(details = FALSE)
vb.opts$modifyvm$cpus <- "4"
vb.opts$modifyvm$memory <- "8192"
vb.opts

## End(Not run)

vmr documentation built on March 31, 2023, 8:31 p.m.