@@ -72,9 +72,20 @@ The `virtio-net` option adds a network interface to a virtual machine.
7272
7373#### Arguments
7474
75+ Legacy arguments to create a virtio-net device that uses gvproxy in vfkit mode:
7576- ` unixSocketPath ` : Path to a UNIX socket to attach to the guest network interface.
7677- ` mac ` : MAC address of a virtual machine.
7778
79+ Arguments to create an independent device with a unixgram-based backend:
80+ - ` unixgram ` : Path to a UNIX datagram socket to attach to the guest network interface.
81+ - ` mac ` : MAC address of a virtual machine.
82+ - ` offloading ` : Whether or not to enable network offloading between the guest and host.
83+ - ` vfkitMagic ` : (Optional) Whether to send the vfkit magic value after establishing a network connection.
84+ Default value is ` false ` .
85+
86+ > [ !NOTE]
87+ > The ` unixSocketPath ` and ` unixgram ` arguments are mutually exclusive and cannot be used together.
88+
7889#### Example
7990
8091This adds a virtio-net device to a virtual machine and redirects all guest network traffic to the corresponding
@@ -84,6 +95,14 @@ socket at `/Users/user/vm-network.sock` with a MAC address of `ff:ff:ff:ff:ff:ff
8495--device virtio-net,unixSocketPath=/Users/user/vm-network.sock,mac=ff:ff:ff:ff:ff:ff
8596```
8697
98+ This adds a virtio-net device and redirects all guest network traffic like the example above. However, this
99+ will use the ` unixgram ` argument and enable offloading. By enabling offloading alongside tools like
100+ ` vmnet-helper ` , it may increase host-to-vm throughput performance.
101+
102+ ```
103+ --device virtio-net,unixgram=/Users/user/vmnetwork.sock,mac=ff:ff:ff:ff:ff:ff,offloading=true
104+ ```
105+
87106### Serial Port
88107
89108The ` virtio-serial ` option adds a serial device to a virtual machine. This allows for redirection of virtual
0 commit comments