fog-hyperv 0.1.0 → 0.2.0

data/lib/fog/hyperv/compute/models/server.rb

@@ -141,6 +141,9 @@ class Fog::Hyperv::Compute
     # @!attribute notes
     #   @return [String] user-specified notes for the VM
     attribute :notes, type: :string
+    # @!attribute path
+    #   @return [String] the path on disk where the VM configuration is stored
+    attribute :path, type: :string
     # @!attribute processor_count
     #   @return [Integer] the number of processors in the VM
     attribute :processor_count, type: :integer, default: 1
@@ -161,6 +164,9 @@ class Fog::Hyperv::Compute
     # @!attribute hard_drives
     #   @return [Array<HardDrive>] the hard drives on the VM
     collection :hard_drives
+    # @!attribute integration_services
+    #   @return [Array<IntegrationService>] the integration services on the VM
+    collection :integration_services
     # @!attribute network_adapters
     #   @return [Array<NetworkAdapter>] the network adapters on the VM
     collection :network_adapters
@@ -194,8 +200,8 @@ class Fog::Hyperv::Compute
         klass.new(
           **service.public_send(
             method,
-            computer_name:,
-            vm_id:,
+            computer_name: computer_name,
+            vm_id: vm_id,
 
             _return_fields: klass.attributes
           ),
@@ -212,16 +218,21 @@ class Fog::Hyperv::Compute
     # @!attribute [r] security
     # @return [Security] UEFI security configuration, if #generation is +:UEFI+
     def security
-      requires :generation, :id
-      return nil unless generation == :UEFI
+      return unless persisted?
 
-      associations[:security] ||= Fog::Hyperv::Compute::Security.new(
-        **service.get_vm_security(
-          computer_name:,
-          vm_id:,
+      requires :generation
+      return unless generation == :UEFI
+
+      security = service.get_vm_security(
+        computer_name: computer_name,
+        vm_id: vm_id,
 
-          _return_fields: Fog::Hyperv::Compute::Security.attributes
-        ),
+        _return_fields: Fog::Hyperv::Compute::Security.attributes
+      )
+      return unless security.is_a? Hash
+
+      associations[:security] ||= Fog::Hyperv::Compute::Security.new(
+        **security,
 
         vm: self,
         service: @service,
@@ -249,7 +260,7 @@ class Fog::Hyperv::Compute
     def start
       requires :id
 
-      service.start_vm(computer_name:, id:)
+      service.start_vm(computer_name: computer_name, id: id)
       true
     end
 
@@ -258,7 +269,7 @@ class Fog::Hyperv::Compute
     def stop(turn_off: false)
       requires :id
 
-      service.stop_vm(computer_name:, id:, turn_off:)
+      service.stop_vm(computer_name: computer_name, id: id, turn_off: turn_off)
       true
     end
 
@@ -266,7 +277,7 @@ class Fog::Hyperv::Compute
     def suspend
       requires :id
 
-      service.suspend_vm(computer_name:, id:)
+      service.suspend_vm(computer_name: computer_name, id: id)
       true
     end
 
@@ -274,7 +285,7 @@ class Fog::Hyperv::Compute
     def resume
       requires :id
 
-      service.resume_vm(computer_name:, id:)
+      service.resume_vm(computer_name: computer_name, id: id)
       true
     end
 
@@ -282,7 +293,7 @@ class Fog::Hyperv::Compute
     def hibernate
       requires :id
 
-      service.save_vm(computer_name:, id:)
+      service.save_vm(computer_name: computer_name, id: id)
       true
     end
 
@@ -291,7 +302,7 @@ class Fog::Hyperv::Compute
     def restart
       requires :id
 
-      service.restart_vm(computer_name:, id:, force:)
+      service.restart_vm(computer_name: computer_name, id: id)
       true
     end
     alias reboot :restart
@@ -300,26 +311,36 @@ class Fog::Hyperv::Compute
     def update_version
       requires :id
 
-      service.update_vm(computer_name:, id:)
+      service.update_vm(computer_name: computer_name, id: id)
       true
     end
 
     # Remove the VM object from Hyper-V
+    # @param [Boolean] underlying remove the underlying configuration directory from disk on the Hyper-V host
     #
     # @note if the VM has VHDs, make sure to remove them first to not leave the VM data remaining on disk
-    def destroy
+    # @note underlying will remove the +full+ path of the VM, make sure this is what you want before using it
+    def destroy(underlying = nil)
+      underlying = true if underlying.nil? && attributes[:path]&.end_with?(attributes[:name])
+
       requires :id
+      requires :path if underlying
       stop turn_off: true if ready?
 
-      service.remove_vm(computer_name:, id:)
+      service.remove_vm(computer_name: computer_name, id: id)
+      service.remove_item(path: path, computer_name: computer_name, recurse: true) if underlying
       true
     end
 
     # Create the VM object if it doesn't exist
     # @param [Symbol] boot_device the default boot device to configure the VM with, one of BOOT_DEVICE
     # @param [String] switch_name the name of a Switch to connect the VM to on creation
+    # @option attrs [String] :path
+    #   a custom path to store the VM configuration under - will use a subdir under the default config path if relative
     def create(boot_device: nil, switch_name: nil, **attrs)
       attrs[:no_vhd] = true unless attrs[:new_vhd_path]
+      attrs[:path] = [computer.virtual_machine_path, attrs[:path]].join('\\') \
+        if attrs[:path] && attrs[:path] !~ %r{^(\w:[\\/]|[\\/]{2}\w+[\\/])}i
 
       # Attributes that can't be set as part of the New-VM call
       post_create_attributes = {
@@ -337,13 +358,13 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.new_vm(
-          computer_name:,
-          name:,
+          computer_name: computer_name,
+          name: name,
 
           generation: generation_num,
           memory_startup_bytes: memory_startup,
-          boot_device:,
-          switch_name:,
+          boot_device: boot_device,
+          switch_name: switch_name,
 
           **attrs,
 
@@ -411,7 +432,7 @@ class Fog::Hyperv::Compute
     def reload
       requires :id
 
-      data = service.get_vm computer_name:, id:, _return_fields: self.class.attributes
+      data = service.get_vm computer_name: computer_name, id: id, _return_fields: self.class.attributes
       return unless data
 
       merge_attributes(data)
@@ -422,10 +443,18 @@ class Fog::Hyperv::Compute
 
     # Build a path for where to store a VHD of a given name
     # @return [String] the absolute path for the VHD
-    def build_vhd_path(filename)
+    def build_vhd_path(filename = nil)
+      requires :name
+
+      [computer.virtual_hard_disk_path, name, filename].compact.join('\\')
+    end
+
+    # Build a path for where to store configuration files
+    # @return [String] the absolute path for the configuration store
+    def build_config_path(subdir = nil)
       requires :name
 
-      [computer.virtual_hard_disk_path, '\\', name, '\\', filename].join
+      [computer.virtual_machine_path, name, subdir].compact.join('\\')
     end
 
     # Get the username of the main system account

data/lib/fog/hyperv/compute/models/servers.rb

@@ -12,7 +12,7 @@ class Fog::Hyperv::Compute
 
       raise ArgumentError, 'Must provide a name or GUID' if (id.nil? || id.empty?) && (name.nil? || name.empty?)
 
-      super(name:, id:, **filters)
+      super(name: name, id: id, **filters)
     end
   end
 end

data/lib/fog/hyperv/compute/models/switch.rb

@@ -44,13 +44,13 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.new_vm_switch(
-          computer_name:,
-          name:,
+          computer_name: computer_name,
+          name: name,
 
-          allow_management_os:,
-          net_adapter_interface_description:,
-          net_adapter_name:,
-          notes:,
+          allow_management_os: allow_management_os,
+          net_adapter_interface_description: net_adapter_interface_description,
+          net_adapter_name: net_adapter_name,
+          notes: notes,
           switch_type: !net_adapter_interface_description && switch_type,
 
           _return_fields: self.class.attributes
@@ -96,8 +96,8 @@ class Fog::Hyperv::Compute
       requires :id
 
       service.remove_vm_switch(
-        computer_name:,
-        id:
+        computer_name: computer_name,
+        id: id
       )
       true
     end
@@ -106,8 +106,8 @@ class Fog::Hyperv::Compute
       requires :id
 
       data = service.get_vm_switch(
-        computer_name:,
-        id:
+        computer_name: computer_name,
+        id: id
       )
       return unless data
 

data/lib/fog/hyperv/compute/models/switches.rb

@@ -14,7 +14,7 @@ class Fog::Hyperv::Compute
 
       raise ArgumentError, 'Must provide a name or GUID' if (id.nil? || id.empty?) && (name.nil? || name.empty?)
 
-      super(name:, id:, **filter)
+      super(name: name, id: id, **filter)
     end
   end
 end

data/lib/fog/hyperv/compute/models/vhd.rb

@@ -121,9 +121,9 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.new_vhd(
-          computer_name:,
+          computer_name: computer_name,
 
-          path:,
+          path: path,
           block_size_bytes: block_size,
           size_bytes: size,
           **attrs,
@@ -154,9 +154,9 @@ class Fog::Hyperv::Compute
       requires_one :path, :disk_number
 
       data = service.get_vhd(
-        computer_name:,
-        path:,
-        disk_number:,
+        computer_name: computer_name,
+        path: path,
+        disk_number: disk_number,
 
         _return_fields: self.class.attributes - %i[basename]
       )
@@ -170,9 +170,22 @@ class Fog::Hyperv::Compute
       requires :path
 
       service.remove_item(
-        computer_name:,
-        path:
+        computer_name: computer_name,
+        path: [path, "#{path}.*"],
       )
+      components = path.split('\\')
+      if components[-2] == vm.name
+        # if (!Test-Path -Path ...\*) { Remove-Item -Path ... -Recurse -Force }
+        vmpath = components[0..-2].join '\\'
+        service.run_cmdlist(
+          [
+            ["$anyFiles = Test-Path", { path: [vmpath, '*'].join('\\') }],
+            ['if (-not $anyFiles) { Remove-Item @Args }', { path: vmpath, recurse: true, force: true }]
+          ],
+          skip_json: true,
+          target_computer: computer_name,
+        )
+      end
       true
     end
 
@@ -184,9 +197,9 @@ class Fog::Hyperv::Compute
       requires :path
 
       service.optimize_vhd(
-        computer_name:,
-        path:,
-        mode:
+        computer_name: computer_name,
+        path: path,
+        mode: mode
       )
       true
     end

data/lib/fog/hyperv/compute/models/vhds.rb

@@ -14,7 +14,7 @@ class Fog::Hyperv::Compute
 
       raise ArgumentError, 'Must provide a path or GUID' if (id.nil? || id.empty?) && (path.nil? || path.empty?)
 
-      super(disk_identifier: id, path:, **filters)
+      super(disk_identifier: id, path: path, **filters)
     end
 
     protected

data/lib/fog/hyperv/compute/requests/connect_vm_network_adapter.rb

@@ -28,7 +28,7 @@ class Fog::Hyperv::Compute
       else
         switch_name = options.delete :switch_name
         options.delete :switch_id
-        cmdlist << ['$NIC | Connect-VMNetworkAdapter', { switch_name:, **options }]
+        cmdlist << ['$NIC | Connect-VMNetworkAdapter', { switch_name: switch_name, **options }]
       end
 
       run_cmdlist(cmdlist, skip_json: true, target_computer: computer_name)

data/lib/fog/hyperv/compute/requests/disable_vm_integration_service.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class Real
+    def disable_vm_integration_service(name:, vm_id:, computer_name: nil, **options)
+      run_cmdlist(
+        [
+          ['$VM = Get-VM', { id: vm_id }],
+          ['$VM | Disable-VMIntegrationService', { name: name, **options }]
+        ],
+        skip_json: true,
+        target_computer: computer_name
+      )
+    end
+  end
+end

data/lib/fog/hyperv/compute/requests/enable_vm_integration_service.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class Real
+    def enable_vm_integration_service(name:, vm_id:, computer_name: nil, **options)
+      run_cmdlist(
+        [
+          ['$VM = Get-VM', { id: vm_id }],
+          ['$VM | Enable-VMIntegrationService', { name: name, **options }]
+        ],
+        skip_json: true,
+        target_computer: computer_name
+      )
+    end
+  end
+end

data/lib/fog/hyperv/compute/requests/get_cluster.rb

@@ -3,9 +3,9 @@
 class Fog::Hyperv::Compute
   class Real
     def get_cluster(**options)
-      _by_id = options.delete(:id)
+      by_id = options.delete(:id)
 
-      run_cmd 'Get-Cluster', _by_id:, **options
+      run_cmd 'Get-Cluster', _by_id: by_id, **options
     end
   end
 end

data/lib/fog/hyperv/compute/requests/get_vhd.rb

@@ -4,6 +4,8 @@ class Fog::Hyperv::Compute
   class Real
     def get_vhd(computer_name: nil, **options)
       requires_one options, :path, :disk_number unless options[:vm_id]
+      options.delete :vm_id if options[:path] || options[:disk_number]
+
       run_cmd 'Get-VHD', _target_computer: computer_name, **options
     end
   end

data/lib/fog/hyperv/compute/requests/get_vm_com_port.rb

@@ -3,12 +3,12 @@
 class Fog::Hyperv::Compute
   class Real
     def get_vm_com_port(vm_id:, computer_name: nil, **options)
-      _by_id = options.delete :id
+      by_id = options.delete :id
 
       run_cmdlist(
         [
           ['$VM = Get-VM', { id: vm_id }],
-          ['$VM | Get-VMComPort', { _by_id:, **options }]
+          ['$VM | Get-VMComPort', { _by_id: by_id, **options }]
         ],
         target_computer: computer_name
       )

data/lib/fog/hyperv/compute/requests/get_vm_dvd_drive.rb

@@ -3,12 +3,12 @@
 class Fog::Hyperv::Compute
   class Real
     def get_vm_dvd_drive(vm_id:, computer_name: nil, **options)
-      _by_id = options.delete :id
+      by_id = options.delete :id
 
       run_cmdlist(
         [
           ['$VM = Get-VM', { id: vm_id }],
-          ['$VM | Get-VMDvdDrive', { _by_id:, **options }]
+          ['$VM | Get-VMDvdDrive', { _by_id: by_id, **options }]
         ],
         target_computer: computer_name
       )

data/lib/fog/hyperv/compute/requests/get_vm_floppy_disk_drive.rb

@@ -3,11 +3,11 @@
 class Fog::Hyperv::Compute
   class Real
     def get_vm_floppy_disk_drive(vm_id:, computer_name: nil, **options)
-      _by_id = options.delete :id
+      by_id = options.delete :id
       run_cmdlist(
         [
           ['$VM = Get-VM', { id: vm_id }],
-          ['$VM | Get-VMFloppyDiskDrive', { _by_id:, **options }]
+          ['$VM | Get-VMFloppyDiskDrive', { _by_id: by_id, **options }]
         ],
         target_computer: computer_name
       )

data/lib/fog/hyperv/compute/requests/get_vm_hard_disk_drive.rb

@@ -3,11 +3,11 @@
 class Fog::Hyperv::Compute
   class Real
     def get_vm_hard_disk_drive(vm_id:, computer_name: nil, **options)
-      _by_id = options.delete :id
+      by_id = options.delete :id
       run_cmdlist(
         [
           ['$VM = Get-VM', { id: vm_id }],
-          ['$VM | Get-VMHardDiskDrive', { _by_id:, **options }]
+          ['$VM | Get-VMHardDiskDrive', { _by_id: by_id, **options }]
         ],
         target_computer: computer_name
       )

data/lib/fog/hyperv/compute/requests/get_vm_host_cluster.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def get_vm_host_cluster(cluster_name:, computer_name: nil, **options)
       requires_version '10.0'
 
-      run_cmd 'Get-VMHostCluster', _target_computer: computer_name, cluster_name:, **options
+      run_cmd 'Get-VMHostCluster', _target_computer: computer_name, cluster_name: cluster_name, **options
     end
   end
 

data/lib/fog/hyperv/compute/requests/get_vm_integration_service.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class Real
+    def get_vm_integration_service(vm_id:, computer_name: nil, **options)
+      run_cmdlist(
+        [
+          ['$VM = Get-VM', { id: vm_id }],
+          ['$VM | Get-VMIntegrationService', options]
+        ],
+        target_computer: computer_name
+      )
+    end
+  end
+end

data/lib/fog/hyperv/compute/requests/new_vhd.rb

@@ -3,7 +3,7 @@
 class Fog::Hyperv::Compute
   class Real
     def new_vhd(path:, size_bytes:, computer_name: nil, **options)
-      run_cmd 'New-VHD', _target_computer: computer_name, path:, size_bytes:, **options
+      run_cmd 'New-VHD', _target_computer: computer_name, path: path, size_bytes: size_bytes, **options
     end
   end
 end

data/lib/fog/hyperv/compute/requests/new_vm_switch.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def new_vm_switch(name:, computer_name: nil, **options)
       requires_one options, :net_adapter_name, :net_adapter_interface_description
 
-      run_cmd 'New-VMSwitch', _target_computer: computer_name, name:, **options
+      run_cmd 'New-VMSwitch', _target_computer: computer_name, name: name, **options
     end
   end
 end

data/lib/fog/hyperv/compute/requests/optimize_vhd.rb

@@ -3,7 +3,7 @@
 class Fog::Hyperv::Compute
   class Real
     def optimize_vhd(path:, computer_name: nil, **options)
-      run_cmd 'Optimize-VHD', _target_computer: computer_name, _skip_json: true, path:, **options
+      run_cmd 'Optimize-VHD', _target_computer: computer_name, _skip_json: true, path: path, **options
     end
   end
 end

data/lib/fog/hyperv/compute/requests/remove_item.rb

@@ -4,7 +4,7 @@ class Fog::Hyperv::Compute
   class Real
     def remove_item(path:, computer_name: nil, **options)
       # TODO: Really lock this method down, validation is good.
-      run_cmd 'Remove-Item', _target_computer: computer_name, _skip_json: true, path:, force: true, **options
+      run_cmd 'Remove-Item', _target_computer: computer_name, _skip_json: true, path: path, force: true, **options
     end
   end
 end

data/lib/fog/hyperv/compute/requests/remove_vm.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def remove_vm(id:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
+          ['$VM = Get-VM', { id: id }],
           ['$VM | Remove-VM', { force: true, **options }]
         ],
         skip_json: true,

data/lib/fog/hyperv/compute/requests/rename_vm.rb

@@ -5,8 +5,8 @@ class Fog::Hyperv::Compute
     def rename_vm(id:, new_name:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
-          ['$VM | Rename-VM', { new_name:, **options }]
+          ['$VM = Get-VM', { id: id }],
+          ['$VM | Rename-VM', { new_name: new_name, **options }]
         ],
         target_computer: computer_name,
         skip_json: true

data/lib/fog/hyperv/compute/requests/rename_vm_network_adapter.rb

@@ -17,7 +17,7 @@ class Fog::Hyperv::Compute
         options.delete :vm_id
         cmdlist << ['$NIC = Get-VMNetworkAdapter', { _by_id: id, management_os: true }]
       end
-      cmdlist << ['$NIC | Rename-VMNetworkAdapter', { new_name:, **options }]
+      cmdlist << ['$NIC | Rename-VMNetworkAdapter', { new_name: new_name, **options }]
 
       run_cmdlist(cmdlist, target_computer: computer_name, skip_json: true)
     end

data/lib/fog/hyperv/compute/requests/rename_vm_switch.rb

@@ -3,7 +3,14 @@
 class Fog::Hyperv::Compute
   class Real
     def rename_vm_switch(id:, new_name:, computer_name: nil, **options)
-      run_cmd 'Rename-VMSwitch', new_name:, _target_computer: computer_name, _by_id: id, _skip_json: true, **options
+      run_cmd(
+        'Rename-VMSwitch',
+        new_name: new_name,
+        _target_computer: computer_name,
+        _by_id: id,
+        _skip_json: true,
+        **options
+      )
     end
   end
 end

data/lib/fog/hyperv/compute/requests/resize_vhd.rb

@@ -3,7 +3,14 @@
 class Fog::Hyperv::Compute
   class Real
     def resize_vhd(path:, size_bytes:, computer_name: nil, **options)
-      run_cmd 'Resize-VHD', _target_computer: computer_name, _skip_json: true, path:, size_bytes:, **options
+      run_cmd(
+        'Resize-VHD',
+        _target_computer: computer_name,
+        _skip_json: true,
+        path: path,
+        size_bytes: size_bytes,
+        **options
+      )
     end
   end
 end

data/lib/fog/hyperv/compute/requests/restart_vm.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def restart_vm(id:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
+          ['$VM = Get-VM', { id: id }],
           ['$VM | Restart-VM', { force: true, **options }]
         ],
         skip_json: true,

data/lib/fog/hyperv/compute/requests/resume_vm.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def resume_vm(id:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
+          ['$VM = Get-VM', { id: id }],
           ['$VM | Resume-VM', options]
         ],
         skip_json: true,

data/lib/fog/hyperv/compute/requests/save_vm.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def save_vm(id:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
+          ['$VM = Get-VM', { id: id }],
           ['$VM | Save-VM', options]
         ],
         skip_json: true,

data/lib/fog/hyperv/compute/requests/set_vm.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def set_vm(id:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
+          ['$VM = Get-VM', { id: id }],
           ['$VM | Set-VM', { passthru: true, **options }]
         ],
         target_computer: computer_name

data/lib/fog/hyperv/compute/requests/start_vm.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def start_vm(id:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
+          ['$VM = Get-VM', { id: id }],
           ['$VM | Start-VM', options]
         ],
         skip_json: true,

data/lib/fog/hyperv/compute/requests/stop_vm.rb

@@ -5,7 +5,7 @@ class Fog::Hyperv::Compute
     def stop_vm(id:, computer_name: nil, **options)
       run_cmdlist(
         [
-          ['$VM = Get-VM', { id: }],
+          ['$VM = Get-VM', { id: id }],
           ['$VM | Stop-VM', { force: true, **options }]
         ],
         skip_json: true,