vi_api_lib 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,19 @@
+=== 0.1.2 / 2009-06-07
+
+* 1 bug fix:
+  * Fix powerOff for VitualMachibe
+
+* 2 minor enhancements:
+  * Add find_entities method to Session
+  * Added shortcut to managed object wrapper in session
+
+* 5 additional entity methods:
+  * Add markAsVirtualMachine function to VirtualMachine
+  * Add migrate function to VirtualMachine
+  * Added rename methods to folder and virtual machine
+  * Added destroy methods to folder and virtual machine
+  * Added clone methods to virtual machine
+
 === 0.1.1 / 2009-04-21
 
 * 3 bug fixes:

data/lib/vmware/objects/folder.rb

@@ -14,5 +14,13 @@ class VMware::Folder < VMware::ManagedEntity
     
     result
   end
+  def rename_Task name
+    rt = RenameRequestType.new self.object_reference
+    rt.newName = name
+    @session.rename_Task rt
+  end
+  def destroy_Task
+    @session.destroy_Task DestroyRequestType.new self.object_reference
+  end
   
-end
+end

data/lib/vmware/objects/managed_entity.rb

@@ -25,25 +25,9 @@ class VMware::ManagedEntity
       return @cached_properties
     end
     
-    #  Object at which filter starts.
-    object_spec = ObjectSpec.new
-    object_spec.obj = @object_reference
-    object_spec.skip = false
-
-    # Which properties to return.
-    prop_spec = PropertySpec.new
-    prop_spec.type = @managed_type || self.class.to_s.gsub(/^.*::/, "")
-    prop_spec.pathSet = prop_list
-    prop_spec.all = prop_list.empty?
-
-    # Create the filter.
-    prop_filter_spec = PropertyFilterSpec.new
-    prop_filter_spec.objectSet = [object_spec]
-    prop_filter_spec.propSet = prop_spec
-
     # Create the request.
-    request = RetrievePropertiesRequestType.new(@session.sic.propertyCollector)
-    request.specSet = prop_filter_spec
+    type = @managed_type || self.class.to_s.gsub(/^.*::/, "")
+    request = @session.create_prop_request type, prop_list, @object_reference
 
     prop_hash = {}
     begin
@@ -85,4 +69,4 @@ class VMware::ManagedEntity
     return p[key.to_s]
   end
   
-end
+end

data/lib/vmware/objects/virtual_machine.rb

@@ -18,11 +18,13 @@ class VMware::VirtualMachine < VMware::ManagedEntity
     @session.managed_object_wrapper_factory("ResourcePool", self["resourcePool"])
   end
   
-  def powerOnVM_Task
-    @session.powerOnVM_Task PowerOnVMRequestType.new self.object_reference
+  def powerOnVM_Task host=nil
+    rt = PowerOnVMRequestType.new self.object_reference
+    rt.host = host
+    @session.powerOnVM_Task rt
   end
   def powerOffVM
-    @session.powerOffVM PowerOffVMRequestType.new self.object_reference
+    @session.powerOffVM_Task PowerOffVMRequestType.new self.object_reference
   end
   def shutdownGuest
     @session.shutdownGuest ShutdownGuestRequestType.new self.object_reference
@@ -39,4 +41,46 @@ class VMware::VirtualMachine < VMware::ManagedEntity
   def rebootGuest
     @session.rebootGuest RebootGuestRequestType.new self.object_reference
   end
-end
+  def migrateVM_Task host
+    rt = MigrateVMRequestType.new self.object_reference
+    rt.priority = VirtualMachineMovePriority.new("defaultPriority")
+    rt.host = host
+    @session.migrateVM_Task rt
+  end
+  def markAsVirtualMachine pool
+    rt = MarkAsVirtualMachineRequestType.new self.object_reference
+    rt.pool = pool
+    @session.markAsVirtualMachine rt
+  end
+  def rename_Task name
+    rt = RenameRequestType.new self.object_reference
+    rt.newName = name
+    @session.rename_Task rt
+  end
+  def destroy_Task
+    @session.destroy_Task DestroyRequestType.new self.object_reference
+  end
+  def cloneVMToTemplate folder, name, pool
+    location = VirtualMachineRelocateSpec.new
+    location.pool = pool
+    spec = VirtualMachineCloneSpec.new
+    spec.template = true
+    spec.powerOn = false
+    spec.location = location
+    cloneVM_Task folder, name, spec
+  end
+  def cloneVM folder, name, power_on=false
+    spec = VirtualMachineCloneSpec.new
+    spec.template = false
+    spec.powerOn = power_on
+    spec.location = VirtualMachineRelocateSpec.new
+    cloneVM_Task folder, name, spec
+  end
+  def cloneVM_Task folder, name, spec
+    rt = CloneVMRequestType.new self.object_reference
+    rt.folder = folder
+    rt.name = name
+    rt.spec = spec
+    @session.cloneVM_Task rt
+  end
+end

data/lib/vmware/session.rb

@@ -34,6 +34,63 @@ class VMware::Session
   def task_manager
     managed_object_wrapper_factory("TaskManager", @sic.taskManager)
   end
+  def find_entities type, begin_entity=nil
+    begin_entity ||= @sic.rootFolder
+    request = create_prop_request type, [], begin_entity, traversal_specs
+    begin
+      retrieveProperties(request).collect { |obj| obj.obj }
+    rescue SOAP::FaultError => e
+      puts e.inspect
+      []
+    end
+  end
+
+  def traversal_specs
+    specs = []
+    spec = selection_spec ['folder_spec','host_folder_spec','vm_folder_spec','host_spec','resource_spec','cr_spec','hosts_spec']
+    specs.push(traversal_spec 'folder_spec', 'Folder', 'childEntity', spec)
+    spec = selection_spec ['folder_spec']
+    specs.push(traversal_spec 'host_folder_spec', 'Datacenter', 'hostFolder', spec)
+    specs.push(traversal_spec 'vm_folder_spec', 'Datacenter', 'vmFolder', spec)
+    specs.push(traversal_spec 'host_spec', 'HostSystem', 'vm', spec)
+    spec = selection_spec ['resource_spec']
+    specs.push(traversal_spec 'resource_spec', 'ResourcePool', 'resourcePool', spec)
+    specs.push(traversal_spec 'cr_spec', 'ComputeResource', 'resourcePool', spec)
+    spec = selection_spec ['host_spec']
+    specs.push(traversal_spec 'hosts_spec', 'ComputeResource', 'host', spec)
+    specs
+  end
+  def traversal_spec name, type, path, select_set
+    TraversalSpec.new nil, [], name, type, path, false, select_set
+  end
+  def selection_spec names
+    names.collect do |name|
+      spec = SelectionSpec.new
+      spec.name = name
+      spec
+    end
+  end
+  def create_prop_request type, path_set, begin_entity, select_set=nil
+    # Which properties to return.
+    prop_spec = PropertySpec.new
+    prop_spec.type = type
+    prop_spec.pathSet = path_set
+    prop_spec.all = path_set.empty?
+
+    #  Object at which filter starts.
+    object_spec = ObjectSpec.new
+    object_spec.obj = begin_entity
+    object_spec.skip = false
+    object_spec.selectSet = select_set unless select_set.nil?
+
+    # Create the filter.
+    prop_filter_spec = PropertyFilterSpec.new
+    prop_filter_spec.propSet = prop_spec
+    prop_filter_spec.objectSet = [object_spec]
+
+    # Create the request.
+    RetrievePropertiesRequestType.new @sic.propertyCollector, prop_filter_spec
+  end
   
   #
   # Login to the server.
@@ -56,10 +113,13 @@ class VMware::Session
     begin
       eval("VMware::#{type}.new(self, reference)")
     rescue
-      puts "WARNING: Unknown managed object type: #{type}"
+      STDERR.puts "WARNING: Unknown managed object type: #{type}"
       VMware::ManagedEntity.new(self, reference, type)
     end
   end
+  def wrap ref
+    managed_object_wrapper_factory ref.xmlattr_type, ref
+  end
   
   #
   # Catch any function call and send it over the soap connection.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vi_api_lib
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Chris Waters
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 +02:00
+date: 2009-06-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency