fog-xenserver 0.0.1.alpha

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

@@ -0,0 +1,20 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class Pgpu < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=PGPU
+
+        identity :reference
+
+        attribute :__gpu_group,         :aliases => :GPU_group
+        attribute :__host,              :aliases => :host
+        attribute :other_config
+        attribute :__pci,               :aliases => :PCI
+        attribute :uuid
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,57 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class PIF < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=PIF
+
+        identity :reference
+
+        attribute :uuid
+        attribute :__bond_master_of,            :aliases => :bond_master_of
+        attribute :__bond_slave_of,             :aliases => :bond_slave_of
+        attribute :disallow_unplug
+        attribute :physical
+        attribute :mac,                         :aliases => :MAC
+        attribute :currently_attached
+        attribute :device
+        attribute :device_name
+        attribute :metrics
+        attribute :dns,                         :aliases => :DNS
+        attribute :gateway
+        attribute :ip,                          :aliases => :IP
+        attribute :ip_configuration_mode
+        attribute :ipv6,                        :aliases => :IPv6
+        attribute :ipv6_configuration_mode
+        attribute :ipv6_gateway
+        attribute :mtu,                         :aliases => :MTU
+        attribute :__network,                   :aliases => :network
+        attribute :netmask
+        attribute :status_code
+        attribute :status_detail
+        attribute :management
+        attribute :primary_address_type
+        attribute :__tunnel_access_pif_of,      :aliases => :tunnel_access_PIF_of
+        attribute :__tunnel_transport_pif_of,   :aliases => :tunnel_transport_PIF_of
+        attribute :vlan,                        :aliases => :VLAN
+        attribute :vlan_master_of,              :aliases => :VLAN_master_of
+        attribute :vlan_slave_of,               :aliases => :VLAN_slave_of
+        attribute :other_config
+        attribute :__host,                      :aliases => :host
+
+        def network
+          service.networks.get __network
+        end
+
+        def host
+          service.hosts.get __host
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class PifMetrics < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=PIF_metrics
+
+        identity :reference
+
+        attribute :carrier
+        attribute :device_id
+        attribute :device_name
+        attribute :duplex
+        attribute :io_read_kbs
+        attribute :io_write_kbs
+        attribute :last_updated
+        attribute :other_config
+        attribute :pci_bus_path
+        attribute :speed
+        attribute :uuid
+        attribute :vendor_id
+        attribute :vendor_name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'fog/core/collection'
+require 'fog/xenserver/models/compute/pif'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class Pifs < Fog::Collection
+
+        model Fog::Compute::XenServer::PIF
+
+        def initialize(attributes)
+          super
+        end
+
+        def all(options = {})
+          data = service.get_records 'PIF'
+          load(data)
+        end
+
+        def get( ref )
+          if ref && obj = service.get_record( ref, 'PIF' )
+            new(obj)
+          end
+        rescue Fog::XenServer::NotFound
+          nil
+        end
+
+      end
+
+    end
+  end
+end

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

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

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

@@ -0,0 +1,79 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class Pool < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=pool
+
+        identity :reference
+
+        attribute :uuid
+        attribute :blobs
+        attribute :__crash_dump_sr,        :aliases => :crash_dump_SR
+        attribute :name,                   :aliases => :name_label
+        attribute :description,            :aliases => :name_description
+        attribute :__default_sr,           :aliases => :default_SR
+        attribute :gui_config
+        attribute :ha_allow_overcommit
+        attribute :ha_configuration
+        attribute :__master,               :aliases => :master
+        attribute :tags
+        attribute :restrictions
+        attribute :ha_enabled
+        attribute :ha_host_failures_to_tolerate
+        attribute :ha_overcommitted
+        attribute :ha_plan_exists_for
+        attribute :ha_statefiles
+        attribute :__metadata_vdis,        :aliases => :metadata_VDIs
+        attribute :other_config
+        attribute :redo_log_enabled
+        attribute :redo_log_vdi
+        attribute :vswitch_controller
+        attribute :__suspend_image_sr,     :aliases => :suspend_image_SR
+        attribute :wlb_enabled
+        attribute :wlb_url
+        attribute :wlb_username
+        attribute :wlb_verify_cert
+
+
+        def default_sr
+          service.storage_repositories.get __default_sr
+        end
+
+        def default_sr=(sr)
+          service.set_attribute( 'pool', reference, 'default_SR', sr.reference )
+        end
+        alias :default_storage_repository= :default_sr=
+
+        def default_storage_repository
+          default_sr
+        end
+
+        def suspend_image_sr=(sr)
+          service.set_attribute( 'pool', reference, 'suspend_image_SR', sr.reference )
+        end
+
+        def suspend_image_sr
+          service.storage_repositories.get __suspend_image_sr
+        end
+
+        def master
+          service.hosts.get __master
+        end
+
+        def set_attribute(name, *val)
+          data = service.set_attribute( 'pool', 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/pool_patch.rb

@@ -0,0 +1,24 @@
+require 'fog/core/model'
+
+module Fog
+  module Compute
+    class XenServer
+      class PoolPatch < Fog::Model
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=pool_patch
+
+        identity :reference
+
+        attribute :after_apply_guidance
+        attribute :__host_patches,          :aliases => :host_patches
+        attribute :description,             :aliases => :name_description
+        attribute :name,                    :aliases => :name_label
+        attribute :other_config
+        attribute :pool_applied
+        attribute :size
+        attribute :uuid
+        attribute :version
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,33 @@
+require 'fog/core/collection'
+require 'fog/xenserver/models/compute/pool'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class Pools < Fog::Collection
+
+        model Fog::Compute::XenServer::Pool
+
+        def initialize(attributes)
+          super
+        end
+
+        def all(options = {})
+          data = service.get_records 'pool'
+          load(data)
+        end
+
+        def get( pool_ref )
+          if pool_ref && pool = service.get_record( pool_ref, 'pool' )
+            new(pool)
+          else
+            nil
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,250 @@
+require 'fog/compute/models/server'
+
+module Fog
+  module Compute
+    class XenServer
+
+      class Server < Fog::Compute::Server
+        # API Reference here:
+        # http://docs.vmd.citrix.com/XenServer/6.2.0/1.0/en_gb/api/?c=VM
+
+        identity :reference
+
+        attribute :uuid
+        attribute :name,                        :aliases => :name_label
+        attribute :description,                 :aliases => :name_description
+        attribute :__affinity,                  :aliases => :affinity
+        attribute :actions_after_crash
+        attribute :actions_after_reboot
+        attribute :actions_after_shutdown
+        attribute :allowed_operations
+        attribute :__consoles,                  :aliases => :consoles
+        attribute :__attached_pcis,             :aliases => :attached_PCIs
+        attribute :bios_strings
+        attribute :blobs
+        attribute :blocked_operations
+        attribute :__children,                  :aliases => :children
+        attribute :__crash_dumps,               :aliases => :crash_dumps
+        attribute :current_operations
+        attribute :domarch
+        attribute :domid
+        attribute :generation_id
+        attribute :tags
+        attribute :__guest_metrics,             :aliases => :guest_metrics
+        attribute :ha_always_run
+        attribute :ha_restart_priority
+        attribute :is_a_snapshot
+        attribute :is_a_template
+        attribute :is_control_domain
+        attribute :is_snapshot_from_vmpp
+        attribute :last_boot_cpu_flags,         :aliases => :last_boot_CPU_flags
+        attribute :last_booted_record
+        attribute :memory_dynamic_max
+        attribute :memory_dynamic_min
+        attribute :memory_overhead
+        attribute :memory_static_max
+        attribute :memory_static_min
+        attribute :memory_target
+        attribute :__metrics,                   :aliases => :metrics
+        attribute :order
+        attribute :other_config
+        attribute :__parent,                    :aliases => :parent
+        attribute :platform
+        attribute :power_state
+        attribute :protection_policy
+        attribute :pv_args,                     :aliases => :PV_args
+        attribute :pv_bootloader,               :aliases => :PV_bootloader
+        attribute :pv_bootloader_args,          :aliases => :PV_bootloader_args
+        attribute :pv_kernel,                   :aliases => :PV_kernel
+        attribute :pv_ramdisk,                  :aliases => :PV_ramdisk
+        attribute :pv_legacy_args,              :aliases => :PV_legacy_args
+        attribute :recommendations
+        attribute :__resident_on,               :aliases => :resident_on
+        attribute :shutdown_delay
+        attribute :snapshot_info
+        attribute :snapshot_metadata
+        attribute :__snapshot_of,               :aliases => :snapshot_of
+        attribute :snapshot_time
+        attribute :start_delay
+        attribute :__suspend_sr,                :aliases => :suspend_sr
+        attribute :__suspend_vdi,               :aliases => :suspend_VDI
+        attribute :transportable_snapshot_id
+        attribute :user_version
+        attribute :version
+        attribute :__vgpus,                     :aliases => :VGPUs
+        attribute :__vtpms,                     :aliases => :VTPMs
+        attribute :xenstore_data
+        # Virtual Block Devices
+        attribute :__vbds,                      :aliases => :VBDs
+        # Virtual CPUs
+        attribute :vcpus_at_startup,            :aliases => :VCPUs_at_startup
+        attribute :vcpus_max,                   :aliases => :VCPUs_max
+        attribute :vcpus_params,                :aliases => :VCPUs_params
+        # Virtual Interfaces (NIC)
+        attribute :__vifs,                      :aliases => :VIFs
+        attribute :template_name
+        attribute :hvm_boot_policy,             :aliases => :HVM_boot_policy
+        attribute :hvm_boot_params,             :aliases => :HVM_boot_params
+        attribute :hvm_shadow_multiplier,       :aliases => :HVM_shadow_multiplier
+        attribute :pci_bus,                     :aliases => :PCI_bus
+        attribute :snapshots
+
+        def vbds
+          __vbds.collect {|vbd| service.vbds.get vbd }
+        end
+
+        def affinity
+          service.hosts.get __affinity
+        end
+
+        def consoles
+          __consoles.collect {|console| service.consoles.get console }
+        end
+
+        def destroy
+          # Make sure it's halted
+          stop('hard')
+          vbds.each do |vbd|
+            if vbd.type == "Disk"
+              vbd.unplug \
+                if vbd.allowed_operations.include?("unplug")
+              vbd.vdi.destroy \
+                if vbd.vdi.allowed_operations.include?("destroy")
+            end
+          end
+          service.destroy_server( reference )
+          true
+        end
+
+        def set_attribute(name, *val)
+          data = service.set_attribute( 'VM', 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
+
+        def refresh
+          data = service.get_record( reference, 'VM' )
+          merge_attributes( data )
+          true
+        end
+
+        def vifs
+          __vifs.collect { |vif| service.vifs.get vif }
+        end
+
+        # associations
+        def networks
+          vifs.collect { |v| v.network }
+        end
+
+        def resident_on
+          service.hosts.get __resident_on
+        end
+
+        #
+        # This is not always present in XenServer VMs
+        # Guest needs XenTools installed to report this AFAIK
+        def guest_metrics
+          return nil unless __guest_metrics
+          rec = service.get_record( __guest_metrics, 'VM_guest_metrics' )
+          Fog::Compute::XenServer::GuestMetrics.new(rec)
+        end
+
+        def tools_installed?
+          !guest_metrics.nil?
+        end
+
+        def home_hypervisor
+          service.hosts.first
+        end
+
+        def mac_address
+          networks.first.MAC
+        end
+
+        def running?
+          reload
+          power_state == "Running"
+        end
+
+        def halted?
+          reload
+          power_state == "Halted"
+        end
+
+        # operations
+        def start
+          return false if running?
+          service.start_server( reference )
+          true
+        end
+
+        def save(params = {})
+          requires :name
+          nets = attributes[:networks] || []
+          if params[:auto_start].nil?
+            auto_start = true
+          else
+            auto_start = params[:auto_start]
+          end
+          if template_name
+            attr = service.get_record(
+              service.create_server( name, template_name, nets, :auto_start => auto_start),
+              'VM'
+            )
+          else
+            attr = service.get_record(
+              service.create_server_raw(attributes),
+              'VM'
+            )
+          end
+          merge_attributes attr
+          true
+        end
+
+        def reboot(stype = 'clean')
+          service.reboot_server(reference, stype)
+          true
+        end
+
+        def hard_reboot
+          reboot 'hard'
+        end
+
+        def clean_reboot
+          reboot 'clean'
+        end
+
+        def stop(stype = 'clean')
+          return false if !running?
+          service.shutdown_server( reference, stype )
+          wait_for { power_state == 'Halted' }
+          true
+        end
+
+        def hard_shutdown
+          stop 'hard'
+        end
+
+        def clean_shutdown
+          stop 'clean'
+        end
+
+        def provision
+          service.provision_server reference
+        end
+
+        def snapshot(name)
+          service.snapshot_server(reference, name)
+        end
+
+        def revert(snapshot_ref)
+          service.snapshot_revert(snapshot_ref)
+        end
+      end
+
+    end
+  end
+end