fog-xenserver 0.0.1.alpha

data/lib/fog/xenserver/examples/storage_repositories.md

@@ -0,0 +1,94 @@
+# Storage Repositories
+
+Official storage repository Citrix API documentation:
+
+http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/?c=SR
+
+Create the XenServer connection first, as usual:
+
+```ruby
+require 'fog'
+require 'net/scp'
+require 'pp'
+
+xenserver = Fog::Compute.new({
+  :provider => 'XenServer',
+  :xenserver_url => 'xenserver-test',
+  :xenserver_username => 'root',
+  :xenserver_password => 'secret',
+})
+```
+
+Listing the available storage repositories:
+
+```ruby
+xenserver.storage_repositories
+```
+
+
+Filter storage repositories by content type:
+
+```ruby
+xenserver.storage_repositories.select { |sr| sr.content_type == 'iso' }
+```
+
+Filter storage repositories by allowed operations:
+
+```ruby
+rw_srs = xenserver.storage_repositories.select do |sr|
+  # Are we allowed to create a VDI here?
+  sr.allowed_operations.include? 'vdi_create'
+end
+```
+
+Print some attributes of the first SR found:
+
+```ruby
+sr = rw_srs.first
+puts sr.name
+puts sr.description
+puts sr.type
+puts sr.tags
+# in bytes
+puts sr.physical_size
+puts sr.physical_utilisation
+# sum of virtual_sizes of all VDIs in this storage repository (in bytes)
+puts sr.virtual_allocation
+```
+
+List virtual disk images available and print some VDI's attributes:
+
+```ruby
+sr.vdis.each do |vdi|
+  # http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/?c=VDI
+  puts vdi.uuid
+  puts vdi.is_a_snapshot
+  puts vdi.name
+  # in bytes
+  puts vdi.physical_utilisation
+  puts vdi.virtual_size
+  puts vdi.read_only
+  # ["update", "resize", "destroy", "clone", "copy", "snapshot"],
+  puts vdi.allowed_operations
+end
+```
+
+Create a new VDI in this storage repository:
+
+```ruby
+vdi = xenserver.vdis.create :name => 'super-vdi',
+                            :storage_repository => sr,
+                            :description => 'my super-vdi',
+                            :virtual_size => '1073741824' # 1 GB
+```
+
+I have an ext3 storage repository and this creates a 1GB VHD file there:
+
+    [root@xenserver ~]# vhd-util query -v -n /var/run/sr-mount/6edd263a-2da1-7533-840c-768417b5be25/4050057d-a3a8-4c00-8f2e-cf5531232921.vhd
+    1024
+
+Destroy the VDI:
+
+```ruby
+vdi.destroy
+```

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

@@ -0,0 +1,22 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class Blob < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=blob
+
+        identity :reference
+
+        attribute :last_updated
+        attribute :mime_type
+        attribute :description,         :aliases => :name_description
+        attribute :name,                :aliases => :name_label
+        attribute :public
+        attribute :size
+        attribute :uuid
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class Bond < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=Bond
+
+        identity :reference
+
+        attribute :links_up
+        attribute :__master,            :aliases => :master
+        attribute :mode
+        attribute :other_config
+        attribute :__primary_slave,     :aliases => :primary_slave
+        attribute :properties
+        attribute :__slaves,            :aliases => :slaves
+        attribute :uuid
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class Console < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=console
+
+        identity :reference
+
+        attribute :location
+        attribute :other_config
+        attribute :protocol
+        attribute :uuid
+        attribute :__vm, aliases: :VM
+
+        def vm
+          begin
+            vm = service.servers.get __vm
+          rescue Fog::XenServer::RequestFailed => e
+            vm = nil
+          end
+          vm
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,19 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class CrashDump < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=crashdump
+
+        identity :reference
+
+        attribute :other_config
+        attribute :__vdi,           :aliases => :VDI
+        attribute :__vm,            :aliases => :VM
+        attribute :uuid
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class DrTask < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=DR_task
+
+        identity :reference
+
+        attribute :__introduced_srs,        :aliases => :introduced_SRs
+        attribute :uuid
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,22 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class GpuGroup < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=GPU_group
+
+        identity :reference
+
+        attribute :gpu_types,           :aliases => :GPU_types
+        attribute :description,         :aliases => :name_description
+        attribute :name,                :aliases => :name_label
+        attribute :other_config
+        attribute :__pgpus,             :aliases => :PGPUs
+        attribute :__vgpus,             :aliases => :VGPUs
+        attribute :uuid
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class GuestMetrics < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=VM_guest_metrics
+
+        identity :reference
+
+        attribute :uuid
+        attribute :disk
+        attribute :last_updated
+        attribute :live
+        attribute :memory
+        attribute :networks
+        attribute :os_version
+        attribute :other
+        attribute :other_config
+        attribute :pv_drivers_up_to_date,    :aliases => :PV_drivers_up_to_date
+        attribute :pv_drivers_version,       :aliases => :PV_drivers_version
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class Host < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=host
+
+        identity :reference
+
+        attribute :name,                                :aliases => :name_label
+        attribute :uuid
+        attribute :address
+        attribute :allowed_operations
+        attribute :api_version_major,                   :aliases => :API_version_major
+        attribute :api_version_minor,                   :aliases => :API_version_minor
+        attribute :api_version_vendor,                  :aliases => :API_version_vendor
+        attribute :api_version_vendor_implementation,   :aliases => :API_version_vendor_implementation
+        attribute :bios_strings
+        attribute :blobs
+        attribute :capabilities
+        attribute :chipset_info
+        attribute :cpu_configuration
+        attribute :cpu_info
+        attribute :__crash_dump_sr,                     :aliases => :crash_dump_sr
+        attribute :__crashdumps,                        :aliases => :crashdumps
+        attribute :current_operations
+        attribute :enabled
+        attribute :external_auth_configuration
+        attribute :external_auth_service_name
+        attribute :external_auth_type
+        attribute :guest_vcpus_params,                  :aliases => :guest_VCPUs_params
+        attribute :ha_network_peers
+        attribute :ha_statefiles
+        attribute :hostname
+        attribute :license_params
+        attribute :license_server
+        attribute :__local_cache_sr,                    :aliases => :local_cache_sr
+        attribute :logging
+        attribute :memory_overhead
+        attribute :__metrics,                           :aliases => :metrics
+        attribute :description,                         :aliases => :name_description
+        attribute :other_config
+        attribute :patches
+        attribute :__pbds,                              :aliases => :PBDs
+        attribute :__pcis,                              :aliases => :PCIs
+        attribute :__pgpus,                             :aliases => :PGPUs
+        attribute :__pifs,                              :aliases => :PIFs
+        attribute :power_on_config
+        attribute :power_on_mode
+        attribute :__resident_vms,                      :aliases => :resident_VMs
+        attribute :sched_policy
+        attribute :supported_bootloaders
+        attribute :suspend_image_sr
+        attribute :tags
+        attribute :__host_cpus,                         :aliases => :host_CPUs
+        attribute :edition
+        attribute :software_version
+
+        def pifs
+          __pifs.collect { |pif| service.pifs.get pif }
+        end
+
+        def pbds
+          __pbds.collect { |pbd| service.pbds.get pbd }
+        end
+
+        def resident_servers
+          __resident_vms.collect { |ref| service.servers.get ref }
+        end
+
+        def resident_vms
+          resident_servers
+        end
+
+        def host_cpus
+          cpus = []
+          (__host_cpus || []).each do |ref|
+            cpu_ref = service.get_record(ref, 'host_cpu' )
+            cpu_ref[:service] = service
+            cpus << Fog::Compute::XenServer::HostCpu.new(cpu_ref)
+          end
+          cpus
+        end
+
+        def metrics
+          return nil unless __metrics
+          rec = service.get_record(__metrics, 'host_metrics' )
+          Fog::Compute::XenServer::HostMetrics.new(rec)
+        end
+
+        #
+        # Reboot the host disabling it first unless auto_disable is
+        # set to false
+        #
+        # This function can only be called if there are no currently running
+        # VMs on the host and it is disabled. If there are running VMs, it will
+        # raise an exception.
+        #
+        # @param [Boolean] auto_disable disable the host first
+        #
+        # @see http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/?c=host
+        #
+        def reboot(auto_disable = true)
+          disable if auto_disable
+          service.reboot_host(reference)
+        end
+
+        #
+        # Puts the host into a state in which no new VMs can be started.
+        # Currently active VMs on the host continue to execute.
+        #
+        # @see http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/?c=host
+        #
+        def disable
+          service.disable_host(reference)
+        end
+
+        #
+        # Puts the host into a state in which new VMs can be started.
+        #
+        # @see http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/?c=host
+        #
+        def enable
+          service.enable_host(reference)
+        end
+
+        #
+        # Shutdown the host disabling it first unless auto_disable is
+        # set to false.
+        #
+        # This function can only be called if there are no currently running
+        # VMs on the host and it is disabled. If there are running VMs, it will
+        # raise an exception.
+        #
+        # @param [Boolean] auto_disable disable the host first
+        #
+        # @see http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/?c=host
+        #
+        def shutdown(auto_disable = true)
+          disable if auto_disable
+          service.shutdown_host(reference)
+        end
+
+        def set_attribute(name, *val)
+          data = service.set_attribute( 'host', 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