fog-hyperv 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366c601e6615f5b716341d88c28d02fe80360121f7e5570bee5e414b9a4b6e5e
-  data.tar.gz: 80e37578e713ff575a3044ecc5e0cd93d86a2ddbf9ff19cd18036ee40496e5fa
+  metadata.gz: af18f5580ade8fe5abf47b387585468f91015c27629395924701e00b93d91c63
+  data.tar.gz: ed2a99e90fe6f3352900348c58a35a49a4c958faaa1171e14eba8f7bc2bfe266
 SHA512:
-  metadata.gz: 735d793469f62b025edd6adf35e8f57120769eaa71d36c6fea8e25e25c27515c8d9fd338e0c66e5b1645a2863175ee4356008e7438bdeadd70ec5d0be9de222a
-  data.tar.gz: 05356cabc6caa6eef04872f2afb1ad795f12acd1cfdc0b4662bf2910ff2864f3601e1e184b90928369e744982874239f077ac957e7de82d2c0f139d0fbc0eb4f
+  metadata.gz: 6b68ca5623d9bf6cac41b8c1225bb42d7cb64243914bc99b438dc0f77c39379eba129461161bdca8f31d5afd5338092210bcfa275e2eea238116576707b8f205
+  data.tar.gz: 30719e7bd1f874b8ce11ea283682af5f676d014a742ac04e5ea86c5ab68c01633e615db8a6fdb7b52be75ae0629d79408b9e24bd7c515bdf9ab0584041dd057f

data/README.md

@@ -1,6 +1,6 @@
 # Fog Hyper-V
 
-[![Build Status](https://travis-ci.org/ananace/fog-hyperv.svg?branch=master)](https://travis-ci.org/ananace/fog-hyperv) [![Gem Version](https://badge.fury.io/rb/fog-hyperv.svg)](https://badge.fury.io/rb/fog-hyperv)
+[![Gem Version](https://badge.fury.io/rb/fog-hyperv.svg)](https://badge.fury.io/rb/fog-hyperv)
 
 Manage your Hyper-V instance with the help of the Fog cloud service abstractions.
 
@@ -43,11 +43,21 @@ compute.servers.all
 #=>   ...
 ```
 
+## Troubleshooting
+
+If you're getting `WinRM::AuthorizationErrors` from the negotiate transport
+even when using a valid user, make sure that the WinRM service is configured
+for Negotiate auth.
+
+If you're using a local (non-domain) user, you may also need to set the DWORD
+registry value `LocalAccountTokenFilterPolicy` at `HKLM\software\Microsoft\Windows\CurrentVersion\Policies\system`
+to `1`.
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `bundle exec irb` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/fog-hyperv.
+Bug reports and pull requests are welcome on the LiU GitLab at https://gitlab.liu.se/ITI/fog-hyperv or GitHub at https://github.com/ananace/fog-hyperv
 

data/lib/fog/bin/hyperv.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 class Hyperv < Fog::Bin
   class << self
     def class_for(key)
       case key
       when :compute
-        Fog::Compute::Hyperv
+        Fog::Hyperv::Compute
       else
         raise ArgumentError, "Unsupported #{self} service: #{key}"
       end
     end
 
     def [](service)
-      @@connections ||= Hash.new do |h, k|
+      @connections ||= Hash.new do |h, k|
         h[k] = case key
                when :compute
-                 Fog::Compute.new(provider: 'Hyperv')
+                 Fog::Hyperv::Compute.new
                else
                  raise ArgumentError, "Unrecognized service: #{key.inspect}"
                end
       end
-      @@connections[service]
+      @connections[service]
     end
 
     def services

data/lib/fog/hyperv/collection.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Fog::Hyperv
+  # Expanded Fog::Collection with Hyper-V specific configuration
+  class Collection < Fog::Collection
+    # Define the service request that is used to retrieve data for this collection
+    def self.get_method(method = nil)
+      @get_method ||= method
+    end
+
+    # Add required attributes for retrieving data for this collection
+    def self.requires(*attr)
+      @requires ||= []
+      @requires += attr if attr.any?
+      @requires
+    end
+
+    # Check if the collection requires a specific attribute
+    def self.requires?(req)
+      requires.include? req
+    end
+
+    def initialize(attributes = {})
+      @vm = attributes.delete(:vm)
+      @computer = attributes.delete(:computer)
+      @network_adapter = attributes.delete(:network_adapter)
+      @cluster = attributes.delete(:cluster)
+
+      super
+    end
+
+    # Retrieve all instances for the collection
+    def all(filters = {})
+      requires(*self.class.requires)
+
+      data = service.send(method, **search_attributes, **filters)
+      data ||= []
+      # Hyper-V will either return an array or a single value depending on the number of entries found
+      data = [data].flatten
+      return clone.load(data) if filters.any?
+
+      load data
+      @loaded = true
+      self
+    end
+
+    # Get a specific instance in the collection
+    def get(**filters)
+      new [service.send(method, **search_attributes, **filters)].flatten.first
+    rescue Fog::Hyperv::Errors::PSError => e
+      raise Fog::Errors::NotFound, e if e.message =~ /Hyper-V was unable to find|^No .* is found/
+
+      raise
+    end
+
+    # Create a new instance in the collection
+    def new(attributes = {})
+      requires(*self.class.requires)
+
+      attributes = attributes.attributes if attributes.is_a? Fog::Model
+      super(creation_attributes.merge(attributes))
+    end
+
+    protected
+
+    def search_attributes
+      attributes.merge(
+        _return_fields: model.attributes
+      )
+    end
+
+    def creation_attributes
+      attributes.merge(
+        {
+          vm: @vm,
+          computer: @computer,
+          network_adapter: @network_adapter,
+          cluster: @cluster
+        }.compact
+      )
+    end
+
+    private
+
+    def method
+      self.class.get_method
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # Configuration for the BIOS settings of a VM
+  #
+  # @see https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmbios for set-request
+  class Bios < Fog::Hyperv::Model
+    # @!attribute [r] vm_id
+    #   @return [String] the GUID of the VM this BIOS configuration is attached to
+    identity :vm_id, type: :string
+
+    # @!attribute [r] computer_name
+    #   @return [String] the name of the computer running the VM that this BIOS configuration is attached to
+    attribute :computer_name, type: :string
+
+    # attribute :is_deleted, type: :boolean
+    # @!attribute num_lock_enabled
+    #   @return [Boolean] if num-lock should be enabled on boot
+    attribute :num_lock_enabled, type: :boolean
+    # @!attribute startup_order
+    #   @note Hyper-V only really allows reordering these entries, not adding/removing from the list
+    #   @return [Array<Symbol>] the boot order of the VM
+    #   @see Fog::Hyperv::BOOT_DEVICE_ENUM_VALUES
+    #   @example Set legacy net boot as default - if possible
+    #     netboot = bios.startup_order.delete :LegacyNetworkAdapter
+    #     bios.startup_order.unshift netboot if netboot
+    #     bios.save
+    attribute :startup_order, type: :hypervenumarray, values: Fog::Hyperv::BOOT_DEVICE_ENUM_VALUES
+
+    # Save any modifications to Hyper-V
+    def update
+      requires :vm_id
+
+      # raise ArgumentError, 'Startup order can only be rearranged, not modified' \
+      #   if changed?(:startup_order) && startup_order.sort != old.startup_order.sort
+
+      changes = {
+        startup_order: changed!(:startup_order)
+      }.compact
+      changes[num_lock_enabled ? :enable_num_lock : :disable_num_lock] = true if changed?(:num_lock_enabled)
+      return self unless changes.any?
+
+      data = service.set_vm_bios(
+        computer_name:,
+        vm_id:,
+
+        **changes,
+
+        _return_fields: self.class.attributes
+      )
+
+      merge_attributes(data)
+    end
+
+    # Reload attributes from Hyper-V
+    def reload
+      requires :vm_id
+
+      data = service.get_vm_bios(
+        computer_name:,
+        vm_id:,
+
+        _return_fields: self.class.attributes
+      )
+      return unless data
+
+      merge_attributes(data)
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # A cluster known to Hyper-V
+  #
+  # This model is read-only and strictly informative
+  class Cluster < Fog::Hyperv::Model
+    # @!attribute [r] id
+    #   @return [String] the GUID of the cluster
+    identity :id, type: :string
+
+    # @!attribute [r] description
+    #   @return [String] the description of the cluster
+    attribute :description, type: :string
+    # @!attribute [r] domain
+    #   @return [String] the domain of the cluster
+    attribute :domain, type: :string
+    # @!attribute [r] name
+    #   @return [String] the name of the cluster
+    attribute :name, type: :string
+
+    # @!attribute [r] hosts
+    #   @return [Array<Host>] the list of hosts in the cluster
+    def hosts
+      return [] unless persisted?
+
+      cluster_nodes.map { |n| service.hosts.get(n[:name]) }
+    end
+
+    # Reload the cluster information from Hyper-V
+    def reload
+      requires :id
+
+      data = service.get_cluster(
+        id:,
+
+        _return_fields: self.class.attributes
+      )
+      return unless data
+
+      merge_attributes(data.attributes)
+    end
+
+    private
+
+    def cluster_nodes
+      return [] unless persisted?
+
+      requires :id
+
+      [
+        service.get_cluster_node(
+          id:,
+
+          _return_fields: %i[name]
+        )
+      ].flatten
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # A collection of clusters known by Hyper-V
+  class Clusters < Fog::Hyperv::Collection
+    model Fog::Hyperv::Compute::Cluster
+
+    get_method :get_cluster
+
+    # Get an instance of a cluster by name or id
+    # @param identifier [String] the name or GUID of the cluster
+    def get(identifier, **filters)
+      id = identifier if identifier =~ /\A#{Fog::Hyperv::GUID}\z/i
+      name = identifier unless id
+
+      raise ArgumentError, 'Must provide a name or GUID' if (id.nil? || id.empty?) && (name.nil? || name.empty?)
+
+      super(name:, _by_id: id, **filters)
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # The configuration of a virtual COM port on a VM
+  #
+  # @see https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmcomport for set-request
+  class ComPort < Fog::Hyperv::Model
+    # @!attribute [r] id
+    #   @return [String] the combined GUID of this COM port
+    identity :id, type: :string
+
+    # @!attribute [r] vm_id
+    #   @return [String] the GUID of the VM this COM port is attached to
+    attribute :vm_id, type: :string
+    # @!attribute [r] computer_name
+    #   @return [String] the name of the computer running the VM that this COM port is attached to
+    attribute :computer_name, type: :string
+
+    # @!attribute debugger_mode
+    #   @return [:On,:Off] if a debugger enabled on this COM port
+    attribute :debugger_mode, type: :hypervenum, values: Fog::Hyperv::ON_OFF_STATE_ENUM_VALUES
+    # @!attribute [r] name
+    #   @return [String] the name of this COM port
+    attribute :name, type: :string
+    # @!attribute path
+    #   @return [String] the path of the file/socket this COM port is attached to
+    attribute :path
+
+    # Save any modifications to Hyper-V
+    def update
+      requires :vm_id, :id
+
+      changes = {
+        debugger_mode: changed!(:debugger_mode)
+      }.compact
+      # Ensure path: nil is sent
+      changes[:path] = path if changed? :path
+      return self unless changes.any?
+
+      merge_attributes(
+        service.set_vm_com_port(
+          computer_name:,
+          vm_id:,
+          id:,
+
+          **changes,
+
+          _always_include: changes.keys,
+          _return_fields: self.class.attributes
+        )
+      )
+    end
+
+    # Reload attributes from Hyper-V
+    def reload
+      requires :vm_id, :id
+
+      data = service.get_vm_com_port(
+        computer_name:,
+        vm_id:,
+        id:,
+
+        _return_fields: self.class.attributes
+      )
+      return unless data
+
+      merge_attributes(data)
+    end
+
+    private
+
+    def merge_attributes(new_attributes = {})
+      new_attributes[:path] = nil if new_attributes[:path] == ''
+
+      super
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # A collection of COM ports attached to a VM
+  #
+  # @note Requires a vm_id to be specified, as COM ports are not retrievable as loose objects
+  class ComPorts < Fog::Hyperv::Collection
+    model Fog::Hyperv::Compute::ComPort
+
+    get_method :get_vm_com_port
+
+    # @!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 a COM port by ID
+    # @param id [String] the combined GUID of the COM port to retrieve
+    def get(id, **filters)
+      raise ArgumentError, 'Must provide a combined GUID' if id.nil? || id.empty?
+
+      super(_by_id: id, **filters)
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # A virtual DVD drive attached to a VM
+  #
+  # @see https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmdvddrive for set-request
+  class DvdDrive < Fog::Hyperv::Model
+    # @!attribute [r] id
+    #   @return [String] the GUID of this DVD drive
+    identity :id
+
+    # @!attribute [r] computer_name
+    #   @return [String] the name of the computer running the VM that this DVD drive is attached to
+    attribute :computer_name
+    # @!attribute [r] vm_id
+    #   @return [String] the GUID of the VM this DVD drive is attached to
+    attribute :vm_id
+
+    # @!attribute [r] name
+    #   @return [String] the name of this DVD drive
+    attribute :name
+    # @!attribute path
+    #   @return [String] the path of the underlying image inserted into this DVD drive
+    attribute :path
+    # @!attribute pool_name
+    #   @return [String] the pool storing this DVD drive's image
+    attribute :pool_name
+    # @!attribute controller_location
+    #   @return [String] the controller location this DVD drive is attached to
+    attribute :controller_location
+    # @!attribute controller_number
+    #   @return [Integer] the controller number this DVD drive is attached to
+    attribute :controller_number, type: :integer
+    # @!attribute [r] controller_type
+    #   @return [:IDE, :SCSI] the controller type this DVD drive is attached to
+    attribute :controller_type, type: :hypervenum, values: %i[IDE SCSI]
+    # @!attribute [r] dvd_media_type
+    #   @return [:None, :ISO, :Passthrough] the current type of media in the DVD drive
+    attribute :dvd_media_type, type: :hypervenum, values: %i[None ISO Passthrough]
+    # TODO? VM Snapshots?
+    #
+
+    # Should non-verifiable paths be allowed to be set
+    attr_accessor :allow_unverified_paths
+
+    # Create a new instance of a DVD drive
+    #
+    # @note Requires vm_id, as well as either controller settings or a path
+    # @see https://learn.microsoft.com/en-us/powershell/module/hyper-v/add-vmdvddrive for the add-request
+    def create
+      requires :vm_id
+      requires_one :controller_location, :controller_number, :controller_type, :path
+
+      merge_attributes(
+        service.add_vm_dvd_drive(
+          computer_name:,
+          vm_id:,
+
+          allow_unverified_paths:,
+          controller_number:,
+          controller_location:,
+          path:,
+          resource_pool_name: pool_name,
+
+          _return_fields: self.class.attributes
+        )
+      )
+    end
+
+    # Save any modifications to Hyper-V
+    def update
+      requires :id, :vm_id
+
+      changes = {
+        resource_pool_name: changed!(:pool_name),
+        to_controller_number: changed!(:controller_number),
+        to_controller_location: changed!(:controller_location)
+      }.compact
+      # Ensure path: nil is sent
+      changes[:path] = path if changed? :path
+      return self unless changes.any?
+
+      merge_attributes(
+        service.set_vm_dvd_drive(
+          computer_name: old.computer_name,
+          vm_id: old.vm_id,
+          id: old.id,
+
+          allow_unverified_paths:,
+          **changes,
+
+          _always_include: changes.keys,
+          _return_fields: self.class.attributes
+        )
+      )
+    end
+
+    # Remove the DVD drive from Hyper-V
+    def destroy
+      requires :id, :vm_id
+
+      service.remove_vm_dvd_drive(
+        computer_name:,
+        vm_id:,
+        id:
+      )
+      true
+    end
+
+    # Reload attributes from Hyper-V
+    def reload
+      requires :id, :vm_id
+
+      data = service.get_vm_dvd_drive(
+        computer_name:,
+        vm_id:,
+        id:,
+
+        _return_fields: self.class.attributes
+      )
+      return unless data
+
+      merge_attributes(data)
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # A collection of DVD drives attached to a VM
+  #
+  # @note Requires a vm_id to be specified, as DVD drives are not retrievable as loose objects
+  class DvdDrives < Fog::Hyperv::Collection
+    model Fog::Hyperv::Compute::DvdDrive
+
+    get_method :get_vm_dvd_drive
+
+    # @!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 a DVD drive by ID
+    # @param id [String] the GUID of the DVD drive to retrieve
+    def get(id, **filters)
+      raise ArgumentError, 'Must provide a GUID' if id.nil? || id.empty?
+
+      super(_by_id: id, **filters)
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class Fog::Hyperv::Compute
+  # UEFI firmware settings for a VM
+  #
+  # @see https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmfirmware for set-request
+  class Firmware < Fog::Hyperv::Model
+    # @!attribute [r] vm_id
+    #   @return [String] the GUID of the VM this UEFI configuration is attached to
+    identity :vm_id
+    # @!attribute [r] computer_name
+    #   @return [String] the name of the computer running the VM that this UEFI configuration is attached to
+    attribute :computer_name
+
+    # @!attribute [r] boot_order
+    #   @todo should be mapped to VM models; HDD/NIC/DVD, needs additional work
+    #   @return [Array<String>] the boot order of the VM
+    attribute :boot_order
+    # @!attribute console_mode
+    #   @return [:Default, :COM1, :COM2, :None] where the console output should be directed
+    attribute :console_mode, type: :hypervenum, values: %i[Default COM1 COM2 None]
+    # @!attribute preferred_network_boot_protocol
+    #   @return [:IPv4, :IPv6] the preferred IP protocol for PXE
+    attribute :preferred_network_boot_protocol, type: :hypervenum, values: %i[IPv4 IPv6]
+    # @!attribute secure_boot
+    #   @return [:On, :Off] if secure boot should be enabled
+    attribute :secure_boot, type: :hypervenum, values: Fog::Hyperv::ON_OFF_STATE_ENUM_VALUES
+    # @!attribute secure_boot_template
+    #   @return [String] the template to use for the secure boot configuration
+    #   @see Host#secure_boot_templates
+    attribute :secure_boot_template
+    # @!attribute [r] secure_boot_template_id
+    #   @return [String] the template id to use for the secure boot configuration
+    #   @see Host#secure_boot_templates
+    attribute :secure_boot_template_id
+    # @!attribute pause_after_boot_failure
+    #   @return [:On, :Off] if the VM should pause after failing boot
+    attribute :pause_after_boot_failure, type: :hypervenum, values: Fog::Hyperv::ON_OFF_STATE_ENUM_VALUES
+
+    # Save any modifications to Hyper-V
+    def update
+      requires :vm_id
+
+      changes = {
+        enable_secure_boot: changed!(:secure_boot),
+        secure_boot_template: changed!(:secure_boot_template),
+        preferred_network_boot_protocol: changed!(:preferred_network_boot_protocol),
+        console_mode: changed!(:console_mode),
+        pause_after_boot_failure: changed!(:pause_after_boot_failure)
+      }.compact
+      return self unless changes.any?
+
+      merge_attributes(
+        service.set_vm_firmware(
+          computer_name:,
+          vm_id:,
+
+          _return_fields: self.class.attributes
+        )
+      )
+    end
+
+    # Reload attributes from Hyper-V
+    def reload
+      requires :vm_id
+
+      data = service.get_vm_firmware(
+        computer_name:,
+        vm_id:,
+
+        _return_fields: self.class.attributes
+      )
+      return unless data
+
+      merge_attributes(data)
+    end
+  end
+end