vagrant_utm 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e58e1f0313976a35281a3233fe67d4150f84c8ec51ed41c2ca55256ba9cae05e
-  data.tar.gz: b5b234e460ef8517720492d3b5695cf771cd52efdd0a60c172ec3d644931b535
+  metadata.gz: bc0499e6b39496b2bd9590d3683631bcc213f7b0f4f1a5fc259b9373e160da33
+  data.tar.gz: 36b2a3029c3d8ddb9d4e84865f657a989732495f59adf90e4f2eb19731780ae0
 SHA512:
-  metadata.gz: fb95231d43a7f9731d7b36823ff7e991b5e11c9113a60590120b21fcd0d6b420116fe7d39e3465e579e5c1548071d562b50b94142c5f4bb689d13c24a671271b
-  data.tar.gz: b3a7b1655c81f270c6aa8399668fcfd5862201f9d00e9532ba00b7e9609e2d6dc7b5a986b502fd447b39dd303bb92ce1b9f513b7c09e2fa2ccf4a801de5878c4
+  metadata.gz: adf69f5cc2fbb3d73e5453b761d374dfd29aded42d1581927a1bbfea2405a93817c11e4a79de57d1c144b6acd120e4d21dceb9140c38083436605f2f2f4a2889
+  data.tar.gz: c305e4949e66c6643646025c649dba12093e228dbbe298b0aada54be0974fa526bfdded85afbcf2b0c062d1982100f601bb77d290784b9d4b57e8fc4173644cf

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## [Unreleased]
+
+
+## [0.1.3] - 2025-04-20
+
+### Added 
+
+- Implements VirtFS synced folder in UTM using qemu additional args and vm registry (for permission)
+
+### Changed
+
+- Config: Makes `virtFS` as default directory_share_mode in UTM
+
+### Removed
+
+- Driver: Removed support for UTM versions < 4.6.5 
+
+## [0.1.2.beta] - 2024-12-05
+
+WARNING: This version of the plugin adds initial synced folder support. By default, Vagrant will pick the directory share method which it supports and prefers. e.g., SMB. However, SMB is not fully tested, so you need to force the plugin to pick the one that is simple and tested `rsync`
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.synced_folder ".", "/vagrant", type: "rsync"
+  config.vm.box = "utm/ubuntu-24.04"
+end
+```
+
+### Added
+
+- Initial Synced Folder support with sync
+- Warning: By default vagrant brings other sync methods eg: SMB, NFS but they are not ready to use.
+
 ## [0.1.1] - 2024-12-03 
 
 IMPORTANT: This version of the plugin only works with UTM version 4.5.1 and above, and is incompatible with 0.0.1 version of the plugin.

data/README.md

@@ -15,7 +15,7 @@ vagrant plugin install vagrant_utm
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.box = "utm/debian11"
+  config.vm.box = "utm/bookworm"
 end
 ```
 

data/docs/Gemfile.lock

@@ -261,8 +261,8 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
-    uri (0.13.0)
-    webrick (1.8.1)
+    uri (0.13.2)
+    webrick (1.8.2)
 
 PLATFORMS
   arm64-darwin

data/docs/_config.yml

@@ -28,8 +28,8 @@ nav_external_links:
     url: https://mac.getutm.app
   - title: Packer plugin for UTM
     url: https://github.com/naveenrajm7/packer-plugin-utm
-  # - title: GitHub
-  #   url: https://github.com/naveenrajm7/vagrant_utm
+  - title: UTM Gallery
+    url: https://naveenrajm7.github.io/utm-gallery/
 
 
 # Aux links for the upper right navigation

data/docs/boxes/creating_utm_box.md

@@ -60,17 +60,18 @@ Check the [UTM Guide on Guest Support](https://docs.getutm.app/guest-support/gue
 
 By satisfying the [general guidance on creating vagrant boxes](https://developer.hashicorp.com/vagrant/docs/boxes/base) and the above [Virtual Machine](#virtual-machine) requirements you can use your VM with Vagrant UTM plugin.
 
-Apart from manually building the boxes, you can also use the semi-automated way of building these boxes using [packer plugin for UTM](https://github.com/naveenrajm7/packer-plugin-utm).
+Apart from manually building the boxes, you can also use the automated (almost) way of building these boxes using [packer plugin for UTM](https://github.com/naveenrajm7/packer-plugin-utm).
 The packer plugin has the following components:
 1. Builder
-  1. UTM - Use existing utm file 
-  2. ISO - Start from scratch using ISO files
+    1. UTM - Use existing utm file 
+    2. ISO - Start from scratch using ISO files  
+    3. CLOUD - Use existing qcow2 cloud images
 2. Post-processor
-  1. ZIP - Package UTM VM into zip file
-  2. Vagrant - Package UTM VM into vagrant box.
+    1. ZIP - Package UTM VM into zip file
+    2. Vagrant - Package UTM VM into vagrant box.
 
 
-Checkout [UTM Box Guide](https://github.com/naveenrajm7/utm-box/blob/main/HowToBuild/DebianUTM.md) to know how to build Box using packer.
+Checkout [UTM Box Packer recipe](https://github.com/naveenrajm7/utm-box?tab=readme-ov-file#building-boxes) to know how to build Box using packer.
 
 ## Using your own UTM VMs
 

data/docs/boxes/utm_box_gallery.md

@@ -10,22 +10,27 @@ nav_order: 1
 To work with Vagrant, a base VM (box) must have 
 [certain features](https://developer.hashicorp.com/vagrant/docs/boxes/base), like an ssh user for vagrant to connect.
 
-To help you get started with Vagrant UTM provider, a couple of pre-built VMs that work with Vagrant and are published in [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm).
+To help you get started with Vagrant UTM provider, some pre-built VMs that work with Vagrant are published in [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm).
 
 {: .important}
-All the VMs provided are built from [UTM Gallery VMs](https://mac.getutm.app/gallery/) or ISO in an (semi) automated way using [packer plugin for UTM][packer plugin for UTM]. Please see the [UTM Box Guide][UTM Box Guide] on how these UTM Vagrant boxes were built using packer.
+All the VMs provided are built from Cloud Images or ISO files in an (semi) automated way using [packer plugin for UTM][packer plugin for UTM]. Please see the [UTM Box Guide][UTM Box Guide] on how these UTM Vagrant boxes were built using packer.
 
-* Debian 11 (Xfce):   
+* Debian 12 - Built from cloud image:   
+```ruby
+config.vm.box = "utm/bookworm"
+```
+
+* Debian 11 (Xfce) - Built from UTM file of UTM gallery:   
 ```ruby
 config.vm.box = "utm/debian11"
 ```
 
-* Ubuntu 24.04 :
+* Ubuntu 24.04 - Built from ISO:
 ```ruby
 config.vm.box = "utm/ubuntu-24.04"
 ```
 
-* Help build more boxes using [packer plugin for UTM][packer plugin for UTM]
+* Build your own boxes using [packer plugin for UTM][packer plugin for UTM]
 <!-- * ArchLinux ARM -->
 
 

data/docs/features/synced_folders.md

@@ -7,22 +7,22 @@ nav_order: 1
 
 # Synced Folders
 
-UTM Vagrant plugin currently gives rudimentary support for syncing folders between host and guest machine.
-The plugin provides option to configure the Qemu directory share mode. 
-After which the the host directory can be selected from UTM UI, and the guest directory can be mounted in guest OS. Both of these steps are now manual until UTM exposes API to configure Host/Guest directory.
+UTM Vagrant plugin has support for syncing multiple folders between host and guest machine.
+The plugin implements [UTM QEMU VirtFS](https://docs.getutm.app/guest-support/linux/#virtfs) as the default synced folder implementation for UTM provider.
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.box = "utm/debian11"
-  config.vm.provider :utm do |u|
-    # QEMU Directoy Share mode for the VM. 
-    # Takes none, webDAV or virtFS
-    u.directory_share_mode = "webDAV"
-  end
+  config.vm.box = "utm/bookworm"
+  config.vm.synced_folder "../test", "/vagrant-test"
 end
 ```
 
-## Other Vagrant options
+Vagrant by default syncs the current folder where that Vagrantfile is, and you can access them at `/vagrant` in the guest.
 
 {: .important}
-Apart from the provider specific Sync options, Vagrant has components to provide sync folders feature using NFS and RSync. These features are not yet supported in UTM plugin.
+
+
+## Other Vagrant options
+
+Apart from the provider specific Sync options, Vagrant has components to provide sync folders feature using NFS and RSync. These features are also supported in UTM plugin.
+Check all Vagrant provided sync options at [Vagrant synced folders](https://developer.hashicorp.com/vagrant/docs/synced-folders).

data/docs/index.md

@@ -19,8 +19,8 @@ allowing Vagrant to control and provision machines via UTM's API.
 ---
 
 {: .new}
-> UTM Vagrant plugin now supports [Vagrant boxes](https://developer.hashicorp.com/vagrant/docs/boxes)!   
-> Find UTM boxes at [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm). 
+> Plugin now supports [Vagrant boxes](https://developer.hashicorp.com/vagrant/docs/boxes)!, find UTM boxes at [HCP Vagrant registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm)  
+> Plugin now supports multiple synced folders, check out [Synced Folder](features/synced_folders.md)
 
 [UTM] is a free, full-featured system emulator and virtual machine host for iOS and macOS.  
 The UTM provider currently supports UTM versions 
@@ -59,14 +59,14 @@ vagrant plugin install vagrant_utm
 Option 1: Create a Vagrantfile and initiate the box (OR)
 
 ```
-vagrant init utm/debian11
+vagrant init utm/bookworm
 ```
 
 Option 2: Open the Vagrantfile and replace the contents with the following
 
 ```ruby
 Vagrant.configure("2") do |config|
-  config.vm.box = "utm/debian11"
+  config.vm.box = "utm/bookworm"
 end
 ```
 
@@ -81,9 +81,9 @@ Now start using your machine!
 
 `vagrant ssh` to log into machine or forward ports to check your website or share folders and start developing.
 
-Check [Commands](commands.md) for all supported Vagrant commands.
-Check [Configuration](configuration.md) for more UTM provider config options.
-
+Check [Commands](commands.md) for all supported Vagrant commands.  
+Check [Configuration](configuration.md) for more UTM provider config options.  
+Discover UTM Vagrant boxes at [HCP Vagrant UTM Registry](https://portal.cloud.hashicorp.com/vagrant/discover/utm), which as boxes of popular OS including OpenBSD!  
 
 ## About the project
 

data/docs/internals/actions.md

@@ -17,4 +17,5 @@ The Table below maps the vagrant commands to the corresponding UTM commands that
 | `vagrant destroy`     | `utmctl delete` | 
 | `vagrant status`      | `utmctl status` | 
 | `vagrant disposable`  | `utmctl start --disposable` | 
-| `vagrant snapshot`    | `qemu-img snapshot`         |
+| `vagrant snapshot`    | `qemu-img snapshot`         |
+| `vagrant ip-address`  | `utmctl ip-address`         |

data/docs/known_issues.md

@@ -5,7 +5,7 @@ nav_order: 7
 
 # Known Issues
 
-This plugin was built built around the existing UTM API.
+This plugin is built around the existing UTM API.
 Hence there are things which are not ideal.
 
 1. ~~vagrant up : Loads new VM by downloading zip file every time, and manually asks the user to confirm the download completion.~~   
@@ -21,4 +21,4 @@ Draw back -  UTM does not expose export API. (UTM already has 'Share')~~
 
 5. vagrant snapshot: Even though UTM does not have snapshot feature, this plugin has a experimental support for offline VM snapshots using qemu-img. 
 The VM must be stopped, for any snapshot commands to work.
-The snapshot only works for **single** qcow2 based VM images
+The snapshot only works for **single** qcow2 based VM images

data/lib/vagrant_utm/action/prepare_nfs_settings.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action prepares the NFS settings for the machine.
+      class PrepareNFSSettings
+        include Vagrant::Action::Builtin::MixinSyncedFolders
+        include Vagrant::Util::Retryable
+
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+        end
+
+        def call(env)
+          @machine = env[:machine]
+
+          @app.call(env)
+
+          opts = {
+            cached: !env[:synced_folders_cached].nil?,
+            config: env[:synced_folders_config],
+            disable_usable_check: !env[:test].nil?
+          }
+          folders = synced_folders(env[:machine], **opts)
+
+          return unless folders.key?(:nfs)
+
+          @logger.info("Using NFS, preparing NFS settings by reading host IP and machine IP")
+          add_ips_to_env!(env)
+        end
+
+        # Extracts the proper host and guest IPs for NFS mounts and stores them
+        # in the environment for the SyncedFolder action to use them in
+        # mounting.
+        #
+        # The ! indicates that this method modifies its argument.
+        def add_ips_to_env!(env)
+          # Hardcoded IP for the host IP
+          host_ip = "10.0.2.2"
+          machine_ip = read_dynamic_machine_ip
+
+          raise Vagrant::Errors::NFSNoHostonlyNetwork if !host_ip || !machine_ip
+
+          env[:nfs_host_ip]    = host_ip
+          env[:nfs_machine_ip] = machine_ip
+        end
+
+        # Returns the IP address of the guest by looking at utm guest additions
+        # for the appropriate guest adapter.
+        #
+        # For DHCP interfaces, the guest property will not be present until the
+        # guest completes
+        #
+        # @param [Integer] adapter number to read IP for
+        # @return [String] ip address of adapter
+        def read_dynamic_machine_ip
+          # we need to wait for the guest's IP to show up as a guest property.
+          # retry thresholds are relatively high since we might need to wait
+          # for DHCP, but even static IPs can take a second or two to appear.
+          retryable(retry_options.merge(on: Vagrant::Errors::VirtualBoxGuestPropertyNotFound)) do
+            # Read the IP address from the list given by qemu-guest-agent
+            @machine.provider.driver.read_guest_ip[0]
+          end
+        rescue Vagrant::Errors::VirtualBoxGuestPropertyNotFound
+          # this error is more specific with a better error message directing
+          # the user towards the fact that it's probably a reportable bug
+          raise Vagrant::Errors::NFSNoGuestIP
+        end
+
+        # Separating these out so we can stub out the sleep in tests
+        def retry_options
+          { tries: 15, sleep: 1 }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action/prepare_nfs_valid_ids.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+module VagrantPlugins
+  module Utm
+    module Action
+      # This action prepares the NFS valid IDs for the VMs.
+      # The ids that are valid and should not be pruned by NFS
+      class PrepareNFSValidIds
+        def initialize(app, _env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+        end
+
+        def call(env)
+          env[:nfs_valid_ids] = env[:machine].provider.driver.read_vms.keys
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/action.rb

@@ -40,6 +40,8 @@ module VagrantPlugins
       autoload :PackageSetupFiles, action_root.join("package_setup_files")
       autoload :PackageSetupFolders, action_root.join("package_setup_folders")
       autoload :PackageVagrantfile, action_root.join("package_vagrantfile")
+      autoload :PrepareNFSSettings, action_root.join("prepare_nfs_settings")
+      autoload :PrepareNFSValidIds, action_root.join("prepare_nfs_valid_ids")
       autoload :PrepareForwardedPortCollisionParams, action_root.join("prepare_forwarded_port_collision_params")
       autoload :Resume, action_root.join("resume")
       autoload :SetId, action_root.join("set_id")
@@ -66,6 +68,10 @@ module VagrantPlugins
           b.use EnvSet, port_collision_repair: true
           b.use PrepareForwardedPortCollisionParams
           b.use HandleForwardedPortCollisions
+          b.use PrepareNFSValidIds
+          b.use SyncedFolderCleanup
+          b.use SyncedFolders
+          b.use PrepareNFSSettings
           b.use ForwardPorts
           b.use SetHostname
           b.use Customize, "pre-boot"
@@ -90,7 +96,7 @@ module VagrantPlugins
       # This is the action that is primarily responsible for completely
       # freeing the resources of the underlying virtual machine.
       # UTM equivalent of `utmctl delete <uuid>`
-      def self.action_destroy
+      def self.action_destroy # rubocop:disable Metrics/AbcSize
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckUtm
           b.use Call, Created do |env1, b2|
@@ -106,6 +112,8 @@ module VagrantPlugins
                 b3.use CheckAccessible
                 b3.use action_halt
                 b3.use Destroy
+                b3.use PrepareNFSValidIds
+                b3.use SyncedFolderCleanup
               else
                 b3.use MessageWillNotDestroy
               end
@@ -160,7 +168,7 @@ module VagrantPlugins
       end
 
       # This action packages the virtual machine into a single box file.
-      def self.action_package
+      def self.action_package # rubocop:disable Metrics/AbcSize
         Vagrant::Action::Builder.new.tap do |b|
           b.use CheckUtm
           b.use Call, Created do |env, b2|
@@ -174,6 +182,8 @@ module VagrantPlugins
             b2.use CheckAccessible
             b2.use action_halt
             b2.use ClearForwardedPorts
+            b2.use PrepareNFSValidIds
+            b2.use SyncedFolderCleanup
             b2.use Package
             b2.use Export
             b2.use PackageVagrantfile
@@ -405,6 +415,16 @@ module VagrantPlugins
         end
       end
 
+      # This is the action that is called to sync folders to a running
+      # machine without a reboot.
+      def self.action_sync_folders
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use PrepareNFSValidIds
+          b.use SyncedFolders
+          b.use PrepareNFSSettings
+        end
+      end
+
       # This action brings the machine up from nothing, including importing
       # the box, configuring metadata, and booting.
       def self.action_up

data/lib/vagrant_utm/cap/mount_options.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
+require_relative "../util/unix_mount_helpers"
+
+module VagrantPlugins
+  module Utm
+    module Cap
+      # Capability for mount options
+      module MountOptions
+        extend VagrantPlugins::SyncedFolder::UnixMountHelpers
+
+        # Mount type for VirtFS
+        UTM_MOUNT_TYPE = "9p"
+
+        # Returns mount options for a utm synced folder
+        #
+        # @param [Machine] machine
+        # @param [String] name of mount
+        # @param [String] path of mount on guest
+        # @param [Hash] hash of mount options
+        def self.mount_options(machine, _name, guest_path, options)
+          mount_options = options.fetch(:mount_options, [])
+          detected_ids = detect_owner_group_ids(machine, guest_path, mount_options, options)
+          mount_uid = detected_ids[:uid]
+          mount_gid = detected_ids[:gid]
+
+          # VirtFS mount options
+          mount_options << "trans=virtio"
+          mount_options << "version=9p2000.L"
+          mount_options << if mount_options.include?("ro")
+                             "ro"
+                           else
+                             "rw"
+                           end
+          mount_options << "_netdev"
+          mount_options << "nofail"
+
+          mount_options = mount_options.join(",")
+          [mount_options, mount_uid, mount_gid]
+        end
+
+        def self.mount_type(_machine)
+          UTM_MOUNT_TYPE
+        end
+
+        def self.mount_name(_machine, name, _data)
+          name.gsub(%r{[\s/\\]}, "_").sub(/^_/, "")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_utm/config.rb

@@ -7,11 +7,6 @@ module VagrantPlugins
   module Utm
     # This is the configuration class for the UTM provider.
     class Config < Vagrant.plugin("2", :config)
-      # This should be set to the name of the machine in the UTM GUI.
-      #
-      # @return [String]
-      attr_accessor :name
-
       # If true, will check if guest additions are installed and up to
       # date. By default, this is true.
       #
@@ -23,6 +18,19 @@ module VagrantPlugins
       # @return [Array]
       attr_reader :customizations
 
+      # Whether or not this VM has a functional VirtFS 9P filesystem module
+      # for VirtFS directory sharing to work.
+      # This defaults to true. If you set this to false, then the "utm"
+      # synced folder type won't be valid.
+      #
+      # @return [Boolean]
+      attr_accessor :functional_9pfs
+
+      # This should be set to the name of the machine in the UTM GUI.
+      #
+      # @return [String]
+      attr_accessor :name
+
       # The time to wait for the VM to be 'running' after 'started'.
       #
       # @return [Integer]
@@ -33,6 +41,7 @@ module VagrantPlugins
         super
         @check_guest_additions = UNSET_VALUE
         @customizations = []
+        @functional_9pfs = UNSET_VALUE
         @name = UNSET_VALUE
         @wait_time = UNSET_VALUE
       end
@@ -76,6 +85,8 @@ module VagrantPlugins
         customize("pre-boot", ["customize_vm.applescript", :id, "--notes", notes])
       end
 
+      # TODO: All warning if user sets directory_share_mode,
+      # because default implementation is 'virtFS'
       # Shortcut for setting the directory share mode of the virtual machine.
       # Calls #customize internally.
       #
@@ -101,8 +112,13 @@ module VagrantPlugins
       # This is the hook that is called to finalize the object before it
       # is put into use.
       def finalize!
+        # By default, we check for guest additions (qemu-ga)
         @check_guest_additions = true if @check_guest_additions == UNSET_VALUE
-
+        # Always set the directory share mode to 'virtFS'
+        # default share folder implementation in utm plugin
+        self.directory_share_mode = "virtFS"
+        # By default, we assume the VM supports virtio 9p filesystems
+        @functional_9pfs = true if @functional_9pfs == UNSET_VALUE
         # The default name is just nothing, and we default it
         @name = nil if @name == UNSET_VALUE
 
@@ -127,6 +143,10 @@ module VagrantPlugins
 
         { "UTM Provider" => errors }
       end
+
+      def to_s
+        "UTM"
+      end
     end
   end
 end

data/lib/vagrant_utm/driver/base.rb

@@ -86,6 +86,12 @@ module VagrantPlugins
         # @return [Array]
         def read_used_ports(active_only: true); end
 
+        # Returns a list of all UUIDs of virtual machines currently
+        # known by UTM.
+        #
+        # @return [Array<String>]
+        def read_vms; end
+
         # Returns the  IP addresses of the guest machine.
         # Only supported for VMs with qemu-guest-agent installed.
         #

data/lib/vagrant_utm/driver/meta.rb

@@ -58,9 +58,14 @@ module VagrantPlugins
             "4.6" => Version_4_6
           }
 
-          # UTM 4.6.0  doesn't have import support to work with Vagrant box,
-          # so show error
-          raise Errors::UtmInvalidVersion if @version.start_with?("4.6.0")
+          # UTM version < 4.6.5  doesn't have
+          # import support to work with Vagrant box (< 4.6.1)
+          # registry support to work with synced folders (< 4.6.5)
+          # Restrict to UTM versions >= 4.6.5
+          unless Gem::Version.new(@version) >= Gem::Version.new("4.6.5")
+            raise Errors::UtmInvalidVersion,
+                  supported_versions: "4.6.5 or earlier"
+          end
 
           driver_klass = nil
           driver_map.each do |key, klass|
@@ -88,6 +93,7 @@ module VagrantPlugins
         def_delegators :@driver,
                        :check_qemu_guest_agent,
                        :clear_forwarded_ports,
+                       :clear_shared_folders,
                        :create_snapshot,
                        :delete,
                        :delete_snapshot,
@@ -104,9 +110,11 @@ module VagrantPlugins
                        :read_network_interfaces,
                        :read_state,
                        :read_used_ports,
+                       :read_vms,
                        :restore_snapshot,
                        :set_mac_address,
                        :set_name,
+                       :share_folders,
                        :ssh_port,
                        :start,
                        :start_disposable,

data/lib/vagrant_utm/driver/version_4_5.rb

@@ -239,6 +239,16 @@ module VagrantPlugins
           ports
         end
 
+        def read_vms
+          results = {}
+          list.machines.each do |machine|
+            # Store UUID (Unique) as key and name as value
+            results[machine.uuid] = machine.name
+          end
+
+          results
+        end
+
         def set_name(name) # rubocop:disable Naming/AccessorMethodName
           command = ["customize_vm.applescript", @uuid, "--name", name.to_s]
           execute_osa_script(command)