» Machine Settings

Config namespace: config.vm

The settings within config.vm modify the configuration of themachine that Vagrant manages.

» Available Settings

  • config.vm.base_mac (string) - The MAC address to be assigned to the defaultNAT interface on the guest. Support for this option is provider dependent.

  • config.vm.base_address (string) - The IP address to be assigned to the defaultNAT interface on the guest. Support for this option is provider dependent.

  • config.vm.boot_timeout (integer) - The time in seconds that Vagrant will waitfor the machine to boot and be accessible. By default this is 300 seconds.

  • config.vm.box (string) - This configures what box themachine will be brought up against. The value here should be the nameof an installed box or a shorthand name of a box inHashiCorp's Vagrant Cloud.

  • config.vm.box_check_update (boolean) - If true, Vagrant will check for updates tothe configured box on every vagrant up. If an update is found, Vagrantwill tell the user. By default this is true. Updates will only be checkedfor boxes that properly support updates (boxes fromHashiCorp's Vagrant Cloudor some other versioned box).

  • config.vm.box_download_checksum (string) - The checksum of the box specified byconfig.vm.box_url. If not specified, no checksum comparison will be done.If specified, Vagrant will compare the checksum of the downloaded box tothis value and error if they do not match. Checksum checking is only donewhen Vagrant must download the box. If this is specified, thenconfig.vm.box_download_checksum_type must also be specified.

  • config.vm.box_download_checksum_type (string) - The type of checksum specifiedby config.vm.box_download_checksum (if any). Supported values arecurrently "md5", "sha1", and "sha256".

  • config.vm.box_download_client_cert (string) - Path to a client certificate touse when downloading the box, if it is necessary. By default, no clientcertificate is used to download the box.

  • config.vm.box_download_ca_cert (string) - Path to a CA cert bundle to use whendownloading a box directly. By default, Vagrant will use the Mozilla CA certbundle.

  • config.vm.box_download_ca_path (string) - Path to a directory containingCA certificates for downloading a box directly. By default, Vagrant willuse the Mozilla CA cert bundle.

  • config.vm.box_download_insecure (boolean) - If true, then SSL certificatesfrom the server will not be verified. By default, if the URL is an HTTPSURL, then SSL certs will be verified.

  • config.vm.box_download_location_trusted (boolean) - If true, then all HTTP redirects will betreated as trusted. That means credentials used for initial URL will be used forall subsequent redirects. By default, redirect locations are untrusted so credentials(if specified) used only for initial HTTP request.

  • config.vm.box_url (string, array of strings) - The URL that the configured box can be found at.If config.vm.box is a shorthand to a box in HashiCorp's Vagrant Cloudthen this value does not need to be specified. Otherwise, it shouldpoint to the proper place where the box can be found if it is notinstalled. This can also be an array of multiple URLs. The URLs will be tried inorder.

Note that any client certificates, insecure download settings, andso on will apply to all URLs in this list. The URLs can also be local filesby using the file:// scheme. For example: "file:///tmp/test.box".

  • config.vm.box_version (string) - The version of the box to use. This defaults to">= 0" (the latest version available). This can contain an arbitrary listof constraints, separated by commas, such as: >= 1.0, < 1.5. When constraintsare given, Vagrant will use the latest available box satisfying theseconstraints.

  • config.vm.communicator (string) - The communicator type to use to connect to theguest box. By default this is "ssh", but should be changed to "winrm" forWindows guests.

  • config.vm.graceful_halt_timeout (integer) - The time in seconds that Vagrant willwait for the machine to gracefully halt when vagrant halt is called.Defaults to 60 seconds.

  • config.vm.guest (string, symbol) - The guest OS that will be running within thismachine. This defaults to :linux, and Vagrant will auto-detect theproper distro. However, this should be changed to :windows for Windows guests.Vagrant needs to know this information to perform some guest OS-specific thingssuch as mounting folders and configuring networks.

  • config.vm.hostname (string) - The hostname the machine should have. Defaultsto nil. If nil, Vagrant will not manage the hostname. If set to a string,the hostname will be set on boot. If set, Vagrant will update /etc/hostson the guest with the configured hostname.

  • config.vm.ignore_box_vagrantfile (boolean) - If true, Vagrant will not load the thesettings found inside a boxes Vagrantfile, if present. Defaults to false.

  • config.vm.network - Configures networks onthe machine. Please see the networking page for more information.

  • config.vm.post_up_message (string) - A message to show after vagrant up. Thiswill be shown to the user and is useful for containing instructionssuch as how to access various components of the development environment.

  • config.vm.provider - Configures provider-specific configuration,which is used to modify settings which are specific to a certainprovider. If the provider you are configuringdoes not exist or is not setup on the system of the person who runsvagrant up, Vagrant will ignore this configuration block. This allowsa Vagrantfile that is configured for many providers to be shared amonga group of people who may not have all the same providers installed.

  • config.vm.provision - Configures provisionerson the machine, so that software can be automatically installed and configuredwhen the machine is created. Please see the page on provisioners for moreinformation on how this setting works.

  • config.vm.synced_folder - Configures synced folderson the machine, so that folders on your host machine can be synced toand from the guest machine. Please see the page on synced folders formore information on how this setting works.

  • config.vm.usable_port_range (range) - A range of ports Vagrant can use forhandling port collisions and such. Defaults to 2200..2250.