vagrant/plugins/providers/virtualbox/config.rb

87 lines
2.6 KiB
Ruby

module VagrantPlugins
module ProviderVirtualBox
class Config < Vagrant.plugin("2", :config)
# Vagrant by default will make "smart" decisions to enable/disable
# the NAT DNS proxy. If this is set to `true`, then the DNS proxy
# will not be enabled, and it is up to the end user to do it.
#
# @return [Boolean]
attr_accessor :auto_nat_dns_proxy
# An array of customizations to make on the VM prior to booting it.
#
# @return [Array]
attr_reader :customizations
# If set to `true`, then VirtualBox will be launched with a GUI.
#
# @return [Boolean]
attr_accessor :gui
# This should be set to the name of the machine in the VirtualBox
# GUI.
#
# @return [String]
attr_accessor :name
# The defined network adapters.
#
# @return [Hash]
attr_reader :network_adapters
def initialize
@auto_nat_dns_proxy = UNSET_VALUE
@customizations = []
@name = UNSET_VALUE
@network_adapters = {}
@gui = UNSET_VALUE
# We require that network adapter 1 is a NAT device.
network_adapter(1, :nat)
end
# Customize the VM by calling `VBoxManage` with the given
# arguments.
#
# When called multiple times, the customizations will be applied
# in the order given.
#
# The special `:name` parameter in the command will be replaced with
# the unique ID or name of the virtual machine. This is useful for
# parameters to `modifyvm` and the like.
#
# @param [Array] command An array of arguments to pass to
# VBoxManage.
def customize(command)
@customizations << command
end
# This defines a network adapter that will be added to the VirtualBox
# virtual machine in the given slot.
#
# @param [Integer] slot The slot for this network adapter.
# @param [Symbol] type The type of adapter.
def network_adapter(slot, type, *args)
@network_adapters[slot] = [type, args]
end
# This is the hook that is called to finalize the object before it
# is put into use.
def finalize!
# Default is to auto the DNS proxy
@auto_nat_dns_proxy = true if @auto_nat_dns_proxy == UNSET_VALUE
# Default is to not show a GUI
@gui = false if @gui == UNSET_VALUE
# The default name is just nothing, and we default it
@name = nil if @name == UNSET_VALUE
end
def to_s
"VirtualBox"
end
end
end
end