» Forwarded Ports

Vagrant forwarded ports allow you to access a port on your host machine and haveall data forwarded to a port on the guest machine, over either TCP or UDP.

For example: If the guest machine is running a web server listening on port 80,you can make a forwarded port mapping to port 8080 (or anything) on your hostmachine. You can then open your browser to localhost:8080 and browse thewebsite, while all actual network data is being sent to the guest.

The forwarded port configuration expects two parameters, the port on theguest and the port on the host. Example:

This will allow accessing port 80 on the guest via port 8080 on the host.

For most providers, forwarded ports by default bind to all interfaces. Thismeans that other devices on your network can access the forwarded ports.If you want to restrict access, see the guest_ip and host_ip settingsbelow.

• auto_correct (boolean) - If true, the host port will be changed automatically in case it collides with a port already in use. By default, this is false.

• (int) - The port on the guest that you want to be exposed onthe host. This can be any port.

• guest_ip (string) - The guest IP to bind the forwarded port to. Ifthis is not set, the port will go to every IP interface. By default,this is empty.

• (string) - The IP on the host you want to bind the forwardedport to. If not specified, it will be bound to every IP. By default,this is empty.

• id (string) - Name of the rule (can be visible in VirtualBox). By default this is "protocol""guest" (example : "tcp123").

By default, any defined port will only forward the TCP protocol. As an optionalthird parameter, you may specify protocol: 'udp' in order to pass UDPtraffic. If a given port needs to be able to listen to the same port on bothprotocols, you must define the port twice with each protocol specified, likeso:

It is common when running multiple Vagrant machines to unknowingly createforwarded port definitions that collide with each other (two separateVagrant projects forwarded to port 8080, for example). Vagrant includesbuilt-in mechanism to detect this and correct it, automatically.

Port collision detection is always done. Vagrant will not allow you todefine a forwarded port where the port on the host appears to be acceptingtraffic or connections.

Port collision auto-correction must be manually enabled for each forwardedport, since it is often surprising when it occurs and can lead the Vagrantuser to think that the port was not properly forwarded. Enabling auto correctis easy:

You can define allowed port range assignable by Vagrant when port collision isdetected via property.