vmrCreate {vmr} | R Documentation |
Create a vmr environment class
Description
Create a vmr object.
Usage
vmrCreate(
name,
provider = "virtualbox",
version = "latest",
provider.options = virtualboxOptions(FALSE)
)
Arguments
name |
a box name |
provider |
the box provider (default: "virtualbox") |
version |
the box version (default : "latest") |
provider.options |
provider options (call [ |
Details
Create a S3 vmr object (a simple list). The object contains all information needed to configure and manage a vmr environment (a vagrant environment).
A vmr environment need mostly a box name and a provider. The environment is attached to the current working directory.
vmr object main attributs:
-
path: working directory
-
org: Vagrant cloud user/organization name 'VMR'
-
box: the box name
-
version: the box version
-
provider: the provider
-
provider_options: the provider options (see [
getProviderOptions()
]) -
vagrantName: Vagrant environment name
-
ID <- Vagrant environment ID
-
synced_folder: a list with source and destination
-
ssh_user: the ssh user
-
ssh_pwd: the ssh user password
-
ssh_port: the ssh port
-
ssh_private_key_path: the private ssh key path
Value
a vmr object (see details)
Examples
## Not run:
# List boxes available
boxes <- vmrList()
# Create a vmr object
vmr <- vmrCreate(boxes$Name[1])
# to customize the guest machine for virtualbox
virtualboxOpts <- getProviderOptions(provider = "virtualbox")
virtualboxOpts$modifyvm <- list(cpus = 4, memory = 4096)
virtualboxOpts$name <- "My VM Cool Name"
# To specify a provider and version
vmr <- vmrCreate(
name = boxes$Name[1],
provider = "virtualbox",
version = boxes$Version[1],
provider.options = virtualboxOpts
)
## End(Not run)