fog-xenserver 0.0.1.alpha

data/lib/fog/xenserver/models/compute/server_appliance.rb

@@ -0,0 +1,21 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class ServerAppliance < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=VM_appliance
+
+        identity :reference
+
+        attribute :allowed_operations
+        attribute :current_operations
+        attribute :description,             :aliases => :name_description
+        attribute :name,                    :aliases => :name_label
+        attribute :uuid
+        attribute :__vms,                   :aliases => :VMs
+      end
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/server_appliances.rb

@@ -0,0 +1,25 @@
+require 'fog/core/collection'
+require 'fog/xenserver/models/compute/server_appliance'
+
+module Fog
+  module Compute
+    class XenServer
+      class ServerAppliances < Fog::Collection
+        model Fog::Compute::XenServer::ServerAppliance
+
+        def all(options={})
+          data = service.get_records 'VM_appliance'
+          load(data)
+        end
+
+        def get( server_appliance_ref )
+          if server_appliance_ref && server_appliance = service.get_record( server_appliance_ref, 'VM_appliance' )
+            new(server_appliance)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require 'fog/core/collection'
+require 'fog/xenserver/models/compute/server'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class Servers < Fog::Collection
+
+        model Fog::Compute::XenServer::Server
+
+        def templates
+          data = service.get_records 'VM'
+          data.delete_if do |vm|
+            !vm[:is_a_template]
+          end
+          load(data)
+        end
+
+        def custom_templates
+          data = service.get_records 'VM'
+          data.delete_if do |vm|
+            !vm[:is_a_template] or !vm[:other_config]['default_template'].nil?
+          end
+          load(data)
+        end
+
+        def builtin_templates
+          data = service.get_records 'VM'
+          data.delete_if do |vm|
+            !vm[:is_a_template] or vm[:other_config]['default_template'].nil?
+          end
+          load(data)
+        end
+
+        def all(options = {})
+          data = service.get_records 'VM'
+          # Exclude templates
+          data.delete_if { |vm| vm[:is_control_domain] or vm[:is_a_template] }
+          data.delete_if { |vm| vm[:is_a_snapshot] and !options[:include_snapshots] }
+          data.delete_if { |vm| options[:name_matches] and (vm[:name_label] !~ /#{Regexp.escape(options[:name_matches])}/i ) }
+          data.delete_if { |vm| options[:name_equals] and (vm[:name_label] != options[:name_equals] ) }
+          load(data)
+        end
+
+        def get_by_name( name )
+          ref = service.get_vm_by_name( name )
+          get ref
+        end
+
+        def get_by_uuid( uuid )
+          ref = service.get_vm_by_uuid( uuid )
+          get ref
+        end
+
+        def get( vm_ref )
+          if vm_ref && vm = service.get_record( vm_ref, 'VM' )
+            new(vm)
+          end
+        rescue Fog::XenServer::NotFound
+          nil
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/storage_manager.rb

@@ -0,0 +1,28 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class StorageManager < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=SM
+
+        identity :reference
+
+        attribute :capabilities
+        attribute :configuration
+        attribute :copyright
+        attribute :driver_filename
+        attribute :features
+        attribute :description,               :aliases => :name_description
+        attribute :name,                      :aliases => :name_label
+        attribute :other_config
+        attribute :required_api_version
+        attribute :type
+        attribute :uuid
+        attribute :vendor
+        attribute :version
+      end
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/storage_managers.rb

@@ -0,0 +1,25 @@
+require 'fog/core/collection'
+require 'fog/xenserver/models/compute/storage_manager'
+
+module Fog
+  module Compute
+    class XenServer
+      class StorageManagers < Fog::Collection
+        model Fog::Compute::XenServer::StorageManager
+
+        def all(options={})
+          data = service.get_records 'SM'
+          load(data)
+        end
+
+        def get( sm_ref )
+          if sm_ref && sm = service.get_record( sm_ref, 'SM' )
+            new(sm)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/storage_repositories.rb

@@ -0,0 +1,31 @@
+require 'fog/core/collection'
+require 'fog/xenserver/models/compute/storage_repository'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class StorageRepositories < Fog::Collection
+
+        model Fog::Compute::XenServer::StorageRepository
+
+        def all
+          data = service.get_records 'SR'
+          #data.delete_if {|sr| sr[:shared].eql?(false)}
+          #data.delete_if {|sr| sr[:content_type].eql?('iso')}
+          load(data)
+        end
+
+        def get( sr_ref )
+          if sr_ref && sr = service.get_record( sr_ref, 'SR' )
+            new(sr)
+          else
+            nil
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/storage_repository.rb

@@ -0,0 +1,93 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class StorageRepository < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=SR
+
+        identity :reference
+
+        attribute :name,                 :aliases => :name_label
+        attribute :description,          :aliases => :name_description
+        attribute :uuid
+        attribute :blobs
+        attribute :allowed_operations
+        attribute :current_operations
+        attribute :introduced_by
+        attribute :local_cache_enabled
+        attribute :content_type
+        attribute :other_config
+        attribute :__pbds,               :aliases => :PBDs
+        attribute :shared
+        attribute :type
+        attribute :tags
+        attribute :__vdis,               :aliases => :VDIs
+        attribute :physical_size
+        attribute :physical_utilisation
+        attribute :sm_config
+        attribute :virtual_allocation
+
+        def vdis
+          __vdis.collect { |vdi| service.vdis.get vdi }
+        end
+
+        def pbds
+          __pbds.collect { |pbd| service.pbds.get pbd }
+        end
+
+        def scan
+          service.scan_sr reference
+          reload
+        end
+
+        def destroy
+          service.destroy_sr reference
+        end
+
+        def save
+          requires :name
+          requires :type
+
+          # host is not a model attribute (not in XAPI at least),
+          # but we need it here
+          host = attributes[:host]
+          raise ArgumentError.new('host is required for this operation') unless
+            host
+
+          # Not sure if this is always required, so not raising exception if nil
+          device_config = attributes[:device_config]
+
+          # create_sr request provides sane defaults if some attributes are
+          # missing
+          attr = service.get_record(
+            service.create_sr( host.reference,
+                                  name,
+                                  type,
+                                  description || '',
+                                  device_config || {},
+                                  physical_size || '0',
+                                  content_type || 'user',
+                                  shared || false,
+                                  sm_config || {}),
+            'SR'
+          )
+          merge_attributes attr
+          true
+        end
+
+        def set_attribute(name, *val)
+          data = service.set_attribute( 'SR', reference, name, *val )
+          # Do not reload automatically for performance reasons
+          # We can set multiple attributes at the same time and
+          # then reload manually
+          #reload
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/tunnel.rb

@@ -0,0 +1,20 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class Tunnel < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=tunnel
+
+        identity :reference
+
+        attribute :access_pif,          :aliases => :access_PIF
+        attribute :other_config
+        attribute :status
+        attribute :transport_pif,       :aliases => :transport_PIF
+        attribute :uuid
+      end
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/tunnels.rb

@@ -0,0 +1,25 @@
+require 'fog/core/collection'
+require 'fog/xenserver/models/compute/tunnel'
+
+module Fog
+  module Compute
+    class XenServer
+      class Tunnels < Fog::Collection
+        model Fog::Compute::XenServer::Tunnel
+
+        def all(options={})
+          data = service.get_records 'tunnel'
+          load(data)
+        end
+
+        def get( tunnel_ref )
+          if tunnel_ref && tunnel = service.get_record( tunnel_ref, 'tunnel' )
+            new(tunnel)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/vbd.rb

@@ -0,0 +1,91 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class VBD < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=VBD
+
+        identity :reference
+
+        attribute :uuid
+        attribute :currently_attached
+        attribute :allowed_operations
+        attribute :current_operations
+        attribute :__vdi,               :aliases => :VDI
+        attribute :__vm,                :aliases => :VM
+        attribute :device
+        attribute :status_detail
+        attribute :status_code
+        attribute :type
+        attribute :userdevice
+        attribute :empty
+        attribute :mode
+        attribute :other_config
+        attribute :storage_lock
+        attribute :runtime_properties
+        attribute :unpluggable
+        attribute :bootable
+        attribute :qos_supported_algorithms
+        attribute :qos_algorithm_params
+        attribute :qos_algorithm_type
+        attribute :qos_supported_algorithms
+        attribute :empty
+        attribute :__metrics,           :aliases => :metrics
+
+        #
+        # May return nil
+        #
+        def vdi
+          service.vdis.get __vdi
+        end
+
+        #
+        # TODO: May it return nil?
+        #
+        def server
+          service.servers.get __vm
+        end
+
+        def save
+          requires :vdi, :server
+          ref = service.create_vbd attributes[:server], attributes[:vdi], attributes
+          merge_attributes service.vbds.get(ref).attributes
+        end
+
+        def unplug
+          service.unplug_vbd reference
+        end
+
+        def unplug_force
+          service.unplug_force_vbd reference
+        end
+
+        def eject
+          service.eject_vbd reference
+        end
+
+        def insert(vdi)
+          service.insert_vbd reference, vdi.reference
+        end
+
+        #
+        # return nil if the VBD is not attached
+        #
+        # TODO: Confirm that the VBD_metrics handle is invalid
+        # when the VBD is NOT attached. I get a HANDLE_INVALID
+        # exception in that case.
+        #
+        def metrics
+          return nil unless currently_attached
+          rec = service.get_record( __metrics, 'VBD_metrics' )
+          Fog::Compute::XenServer::VbdMetrics.new(rec)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/xenserver/models/compute/vbd_metrics.rb

@@ -0,0 +1,27 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class VbdMetrics < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=VBD_metrics
+
+        identity :reference
+
+        attribute :uuid
+        attribute :last_updated
+        attribute :other_config
+        attribute :io_read_kbs
+        attribute :io_write_kbs
+
+        def initialize(attributes = {})
+          super
+          self.last_updated = attributes[:last_updated].to_time
+        end
+      end
+
+    end
+  end
+end