fog-hyperv 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af18f5580ade8fe5abf47b387585468f91015c27629395924701e00b93d91c63
-  data.tar.gz: ed2a99e90fe6f3352900348c58a35a49a4c958faaa1171e14eba8f7bc2bfe266
+  metadata.gz: 967724a9fd59c0978858d86ff438fe64a8eefc884cdeb11d0e6c7e372c28b725
+  data.tar.gz: f845028078a57dd1aec509aa7357ac3c58e5aab5d301b833ac00ab01fc8ee726
 SHA512:
-  metadata.gz: 6b68ca5623d9bf6cac41b8c1225bb42d7cb64243914bc99b438dc0f77c39379eba129461161bdca8f31d5afd5338092210bcfa275e2eea238116576707b8f205
-  data.tar.gz: 30719e7bd1f874b8ce11ea283682af5f676d014a742ac04e5ea86c5ab68c01633e615db8a6fdb7b52be75ae0629d79408b9e24bd7c515bdf9ab0584041dd057f
+  metadata.gz: e4f71c7887ef726c2281be088d048fa56ceb71b4bd0b1684846bd1accd922a245ea2227e4f562b3acdbb9d57c90f72a930011f63c051b30937187cd1e13bc012
+  data.tar.gz: 2ea917dfb9a6fc294ea7ced844661dc3c5772e9775d2e01d77eb3eb2592d742b8a96e5a57ca4ecd9ca527bee1e467d40256cb218f897164e223a7de4b874e5e4

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

@@ -41,8 +41,8 @@ class Fog::Hyperv::Compute
       return self unless changes.any?
 
       data = service.set_vm_bios(
-        computer_name:,
-        vm_id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
 
         **changes,
 
@@ -57,8 +57,8 @@ class Fog::Hyperv::Compute
       requires :vm_id
 
       data = service.get_vm_bios(
-        computer_name:,
-        vm_id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
 
         _return_fields: self.class.attributes
       )

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

@@ -31,11 +31,7 @@ class Fog::Hyperv::Compute
     def reload
       requires :id
 
-      data = service.get_cluster(
-        id:,
-
-        _return_fields: self.class.attributes
-      )
+      data = service.get_cluster id: id, _return_fields: self.class.attributes
       return unless data
 
       merge_attributes(data.attributes)
@@ -48,13 +44,7 @@ class Fog::Hyperv::Compute
 
       requires :id
 
-      [
-        service.get_cluster_node(
-          id:,
-
-          _return_fields: %i[name]
-        )
-      ].flatten
+      [service.get_cluster_node(id: id, _return_fields: %i[name])].flatten
     end
   end
 end

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

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

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

@@ -39,9 +39,9 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.set_vm_com_port(
-          computer_name:,
-          vm_id:,
-          id:,
+          computer_name: computer_name,
+          vm_id: vm_id,
+          id: id,
 
           **changes,
 
@@ -56,9 +56,9 @@ class Fog::Hyperv::Compute
       requires :vm_id, :id
 
       data = service.get_vm_com_port(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
 
         _return_fields: self.class.attributes
       )

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

@@ -53,13 +53,13 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.add_vm_dvd_drive(
-          computer_name:,
-          vm_id:,
+          computer_name: computer_name,
+          vm_id: vm_id,
 
-          allow_unverified_paths:,
-          controller_number:,
-          controller_location:,
-          path:,
+          allow_unverified_paths: allow_unverified_paths,
+          controller_number: controller_numbere,
+          controller_location: controller_location,
+          path: path,
           resource_pool_name: pool_name,
 
           _return_fields: self.class.attributes
@@ -86,7 +86,7 @@ class Fog::Hyperv::Compute
           vm_id: old.vm_id,
           id: old.id,
 
-          allow_unverified_paths:,
+          allow_unverified_paths: allow_unverified_paths,
           **changes,
 
           _always_include: changes.keys,
@@ -100,9 +100,9 @@ class Fog::Hyperv::Compute
       requires :id, :vm_id
 
       service.remove_vm_dvd_drive(
-        computer_name:,
-        vm_id:,
-        id:
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id
       )
       true
     end
@@ -112,9 +112,9 @@ class Fog::Hyperv::Compute
       requires :id, :vm_id
 
       data = service.get_vm_dvd_drive(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
 
         _return_fields: self.class.attributes
       )

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

@@ -52,8 +52,10 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.set_vm_firmware(
-          computer_name:,
-          vm_id:,
+          computer_name: computer_name,
+          vm_id: vm_id,
+
+          **changes,
 
           _return_fields: self.class.attributes
         )
@@ -65,8 +67,8 @@ class Fog::Hyperv::Compute
       requires :vm_id
 
       data = service.get_vm_firmware(
-        computer_name:,
-        vm_id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
 
         _return_fields: self.class.attributes
       )

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

@@ -34,9 +34,9 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.set_vm_floppy_disk_drive(
-          computer_name:,
-          vm_id:,
-          id:,
+          computer_name: computer_name,
+          vm_id: vm_id,
+          id: id,
 
           **changes,
 
@@ -50,9 +50,9 @@ class Fog::Hyperv::Compute
       requires :vm_id, :id
 
       data = service.get_vm_floppy_disk_drive(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
 
         _return_fields: self.class.attributes
       )

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

@@ -67,7 +67,7 @@ class Fog::Hyperv::Compute
       return associations[:vhd] if associations[:vhd]
       return unless path
 
-      associations[:vhd] = service.vhds.get(path, computer_name:)
+      associations[:vhd] = (vm || service).vhds.get(path, computer_name: computer_name)
     end
 
     def vhd=(new_vhd)
@@ -99,17 +99,17 @@ class Fog::Hyperv::Compute
 
       merge_attributes(
         service.add_vm_hard_disk_drive(
-          computer_name:,
-          vm_id:,
-
-          allow_unverified_paths:,
-          controller_location:,
-          controller_number:,
-          controller_type:,
-          # disk_number: disk&.number,
-          maximum_iops:,
-          minimum_iops:,
-          path:,
+          **attributes.slice(
+            :computer_name,
+            :vm_id,
+            :allow_unverified_paths,
+            :controller_location,
+            :controller_number,
+            :controller_type,
+            :maximum_iops,
+            :minimum_iops,
+            :path
+          ),
           resource_pool_name: pool_name,
 
           _return_fields: self.class.attributes - %i[allow_unverified_paths vhd]
@@ -139,7 +139,7 @@ class Fog::Hyperv::Compute
             id: old.id,
 
             **changes,
-            allow_unverified_paths:,
+            allow_unverified_paths: allow_unverified_paths,
 
             _always_include: changes.keys,
             _return_fields: self.class.attributes - %i[allow_unverified_paths vhd]
@@ -159,9 +159,9 @@ class Fog::Hyperv::Compute
       requires :id, :vm_id
 
       data = service.get_vm_hard_disk_drive(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
 
         _return_fields: self.class.attributes - %i[allow_unverified_paths vhd]
       )
@@ -175,11 +175,7 @@ class Fog::Hyperv::Compute
 
       requires :id, :vm_id
 
-      service.remove_vm_hard_disk_drive(
-        computer_name:,
-        vm_id:,
-        id:
-      )
+      service.remove_vm_hard_disk_drive computer_name: computer_name, vm_id: vm_id, id: id
       vhd.destroy if underlying && vhd?
       true
     end

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

@@ -54,10 +54,7 @@ class Fog::Hyperv::Compute
     def reload
       requires :name
 
-      data = service.get_vm_host(
-        computer_name:,
-        name:
-      )
+      data = service.get_vm_host computer_name: computer_name, name: name
       return unless data
 
       merge_attributes(data)

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  class IntegrationService < Fog::Hyperv::Model
+    # rubocop:disable Layout/HashAlignment
+
+    # Integration service statuses
+    # @note Defined by Microsoft.HyperV.PowerShell.VMIntegrationComponentOperationalStatus
+    INTEGRATION_SERVICE_STATUS_ENUM_VALUES = {
+      Ok:                    2,
+      Degraded:              3,
+      Error:                 6,
+      NonRecoverableError:   7,
+      NoContact:             12,
+      LostCommunication:     13,
+      Disabled:              32_896,
+      ProtocolMismatch:      32_775,
+      ApplicationCritical:   32_782,
+      CommunicationTimedOut: 32_783,
+      CommunicationFailed:   32_784
+    }.freeze
+    # rubocop:enable Layout/HashAlignment
+
+    # @!attribute [r] name
+    #   @return [String] the name of the integration service
+    identity :name
+
+    # @!attribute [r] computer_name
+    #   @return [String] the name of the computer running the VM that this integration service is attached to
+    attribute :computer_name
+    # @!attribute [r] vm_id
+    #   @return [String] the GUID of the VM this integration service is attached to
+    attribute :vm_id
+
+    # @!attribute enabled
+    #   @return [Boolean] if the integration service is enabled or not
+    attribute :enabled, type: :boolean
+    # @!attribute [r] operational_status
+    #   @return [Symbol] the statuses of the integration service
+    #   @see INTEGRATION_SERVICE_STATUS_ENUM_VALUES
+    attribute :operational_status, type: :hypervenumarray, values: INTEGRATION_SERVICE_STATUS_ENUM_VALUES
+
+    def update
+      requires :name, :vm_id
+
+      return self unless changed? :enabled
+
+      method = enabled ? :enable : :disable
+      service.send(:"#{method}_vm_integration_service", computer_name: computer_name, vm_id: vm_id, name: name)
+
+      old.enabled = attributes[:enabled]
+      self
+    end
+
+    def reload
+      requires :name, :vm_id
+
+      data = service.get_vm_integration_service computer_name: computer_name, vm_id: vm_id, name: name
+      return unless data
+
+      merge_attributes(data)
+    end
+
+    protected
+
+    def merge_attributes(new_attributes = {})
+      new_attributes[:operational_status] = [] if new_attributes[:operational_status] == ''
+
+      super
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # A collection of integration services available for a VM
+  #
+  # @note Requires a vm_id to be specified, as integration services are not retrievable as loose objects
+  class IntegrationServices < Fog::Hyperv::Collection
+    model Fog::Hyperv::Compute::IntegrationService
+
+    get_method :get_vm_integration_service
+
+    # @!attribute vm_id
+    #   @return [String] the GUID of the VM containing the COM ports
+    attribute :vm_id
+    # @!attribute computer_name
+    #   @return [String] the name of the computer running the VM that these COM ports are attached to
+    attribute :computer_name
+
+    requires :vm_id
+
+    # Get an integration service by name
+    # @param id [String] the name of the integration service to retrieve
+    def get(name, **filters)
+      raise ArgumentError, 'Must provide a name' if name.nil? || name.empty?
+
+      super(name: name, **filters)
+    end
+  end
+end

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

@@ -118,10 +118,10 @@ class Fog::Hyperv::Compute
 
         associations[:vlan_setting] = Fog::Hyperv::Compute::NetworkAdapterVlan.new(
           **service.get_vm_network_adapter_vlan(
-            computer_name:,
+            computer_name: computer_name,
             management_os: is_management_os,
-            vm_id:,
-            id:,
+            vm_id: vm_id,
+            id: id,
 
             _return_fields: Fog::Hyperv::Compute::NetworkAdapterVlan.attributes
           ),
@@ -147,9 +147,9 @@ class Fog::Hyperv::Compute
       options[:management_os] = true if is_management_os
 
       service.connect_vm_network_adapter(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
 
         switch_id: new_switch_id,
         switch_name: new_switch_name,
@@ -168,9 +168,9 @@ class Fog::Hyperv::Compute
 
       options[:management_os] = true if is_management_os
       service.disconnect_vm_network_adapter(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
 
         **options
       )
@@ -185,7 +185,13 @@ class Fog::Hyperv::Compute
     # @see connect
     # @see disconnect
     def switch
-      service.switches.get(switch_id:, switch_name:, computer_name:) if switch_name.any? || switch_id.any?
+      return unless switch_name.any? || switch_id.any?
+
+      service.switches.get(
+        switch_id: switch_id,
+        switch_name: switch_name,
+        computer_name: computer_name
+      )
     end
 
     def switch=(new_switch)
@@ -212,7 +218,7 @@ class Fog::Hyperv::Compute
         selector[:vm_id] = vm_id
       end
 
-      args = { name:, switch_name: }
+      args = attributes.slice(:name, :switch_name)
       args[:is_legacy] = true if is_legacy
       if !dynamic_mac_address_enabled && mac_address != NIC_FALLBACK_MAC
         args[:static_mac_address] = mac_address
@@ -221,7 +227,7 @@ class Fog::Hyperv::Compute
       end
       data = service.add_vm_network_adapter(
         **selector,
-        computer_name:,
+        computer_name: computer_name,
 
         **args,
 
@@ -293,9 +299,9 @@ class Fog::Hyperv::Compute
       requires :vm_id unless is_management_os
 
       service.remove_vm_network_adapter(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
         management_os: is_management_os
       )
       true
@@ -306,9 +312,9 @@ class Fog::Hyperv::Compute
       requires :vm_id unless is_management_os
 
       data = service.get_vm_network_adapter(
-        computer_name:,
-        vm_id:,
-        id:,
+        computer_name: computer_name,
+        vm_id: vm_id,
+        id: id,
         management_os: is_management_os,
 
         _return_fields: self.class.attributes
@@ -348,11 +354,11 @@ class Fog::Hyperv::Compute
     end
 
     def save_switch
-      selector = { computer_name:, vm_id:, id: }.compact
+      selector = attributes.slice(:computer_name, :vm_id, :id).compact
       selector[:management_os] = true if is_management_os
 
       if switch_name || switch_id
-        service.connect_vm_network_adapter(**selector, switch_name:, switch_id:)
+        service.connect_vm_network_adapter(**selector, switch_name: switch_name, switch_id: switch_id)
       else
         service.disconnect_vm_network_adapter(**selector)
       end

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

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

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

@@ -36,10 +36,14 @@ class Fog::Hyperv::Compute
     def key_protector
       requires :vm
 
-      @key_protector ||= service.get_vm_key_protector(
-        computer_name: vm.computer_name,
-        vm_id: vm.id
-      )[:value]
+      @key_protector ||= begin
+        value = service.get_vm_key_protector(
+          computer_name: vm.computer_name,
+          vm_id: vm.id
+        )[:value]
+        value = nil if value == [0, 0, 0, 4]
+        value
+      end
     end
 
     # Change the key protector for a VM