class Fog::Compute::Vsphere::Server
Public Class Methods
new(attributes={} )
click to toggle source
Calls superclass method
# File lib/fog/vsphere/models/compute/server.rb, line 55 def initialize(attributes={} ) super defaults.merge(attributes) self.instance_uuid ||= id # TODO: remvoe instance_uuid as it can be replaced with simple id initialize_interfaces initialize_volumes initialize_customvalues initialize_scsi_controllers end
Public Instance Methods
acquire_ticket(type = nil)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 327 def acquire_ticket(type = nil) service.tickets(:server => self).create end
add_interface(attrs)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 225 def add_interface attrs Fog::Logger.deprecation("<server>.add_interface is deprecated. Call <server>.interfaces.create instead.") interfaces.create(attrs) end
cdrom(key)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 269 def cdrom(key) cdroms.get(key) end
cdroms(opts = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 265 def cdroms(opts = {}) service.cdroms(:instance_uuid => self.id).all(opts) end
clone(options = {})
click to toggle source
Clone from a server object
Parameters¶ ↑
*<~Hash>:
* 'name'<~String> - *REQUIRED* Name of the _new_ VirtualMachine * See more options in vm_clone request/compute/vm_clone.rb
# File lib/fog/vsphere/models/compute/server.rb, line 151 def clone(options = {}) requires :name, :datacenter, :path # Convert symbols to strings req_options = options.reduce({}) { |hsh, (k,v)| hsh[k.to_s] = v; hsh } # Give our path to the request req_options['template_path'] ="#{relative_path}/#{name}" req_options['datacenter'] = "#{datacenter}" # Perform the actual clone clone_results = service.vm_clone(req_options) # We need to assign the service, otherwise we can't reload the model # Create the new VM model. TODO This only works when "wait=true" new_vm = self.class.new(clone_results['new_vm'].merge(:service => self.service)) # We need to assign the collection otherwise we # cannot reload the model. new_vm.collection = self.collection # Return the new VM model. new_vm end
config_vnc(options = {})
click to toggle source
defines VNC attributes on the hypervisor
# File lib/fog/vsphere/models/compute/server.rb, line 194 def config_vnc(options = {}) requires :instance_uuid service.vm_config_vnc(options.merge('instance_uuid' => instance_uuid)) end
customvalues()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 278 def customvalues attributes[:customvalues] ||= id.nil? ? [] : service.customvalues( :vm => self ) end
destroy(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 121 def destroy(options = {}) requires :instance_uuid if ready? # need to turn it off before destroying stop(options) wait_for { !ready? } end service.vm_destroy('instance_uuid' => instance_uuid) end
destroy_interface(attrs)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 236 def destroy_interface attrs Fog::Logger.deprecation("<server>.destroy_vm_interface is deprecated. Call <server>.interfaces.get(:key => <nic_key>).destroy instead.") interfaces.get(attrs[:key] || attrs['key']).destroy end
find_snapshot(snapshot_ref)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 250 def find_snapshot(snapshot_ref) snapshots.get(snapshot_ref) end
folder()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 290 def folder return nil unless datacenter and path attributes[:folder] ||= service.folders(:datacenter => datacenter, :type => :vm).get(path) end
guest_processes(opts = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 273 def guest_processes(opts = {}) fail 'VM tools must be running' unless tools_running? service.list_processes(self.id, opts) end
interface_ready?(attrs)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 221 def interface_ready? attrs (attrs.is_a? Hash and attrs[:blocking]) or attrs.is_a? Fog::Compute::Vsphere::Interface end
interfaces()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 217 def interfaces attributes[:interfaces] ||= id.nil? ? [] : service.interfaces( :server_id => self.id ) end
mac()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 213 def mac interfaces.first.mac unless interfaces.empty? end
memory()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 205 def memory memory_mb * 1024 * 1024 end
migrate(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 131 def migrate(options = {}) options = { :priority => 'defaultPriority' }.merge(options) requires :instance_uuid # Convert symbols to strings req_options = options.reduce({}) { |hsh, (k,v)| hsh[k.to_s] = v; hsh } req_options['cluster'] ||= cluster req_options['datacenter'] = "#{datacenter}" req_options['instance_uuid'] = instance_uuid service.vm_migrate(req_options) end
new?()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 309 def new? id.nil? end
ready?()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 181 def ready? power_state == "poweredOn" end
reboot(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 115 def reboot(options = {}) options = { :force => false }.merge(options) requires :instance_uuid service.vm_reboot('instance_uuid' => instance_uuid, 'force' => options[:force]) end
relative_path()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 321 def relative_path requires :path, :datacenter (path.split('/').reject {|e| e.empty?} - ["Datacenters", datacenter, "vm"]).join("/") end
reload()
click to toggle source
Calls superclass method
# File lib/fog/vsphere/models/compute/server.rb, line 313 def reload # reload does not re-read assoiciated attributes, so we clear it manually [:interfaces, :volumes].each do |attr| self.attributes.delete(attr) end super end
revert_snapshot(snapshot)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 254 def revert_snapshot(snapshot) case snapshot when Snapshot service.revert_to_snapshot(snapshot) when String service.revert_to_snapshot(find_snapshot(snapshot)) else fail ArgumentError, "snapshot has to be kind of Snapshot or String class" end end
save()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 295 def save requires :name, :cluster, :datacenter if persisted? vm_rename if attribute_changed?(:name) vm_reconfig_cpus if attribute_changed?(:cpus) || attribute_changed?(:corespersocket) vm_reconfig_memory if attribute_changed?(:memory_mb) vm_reconfig_volumes if attribute_changed?(:volumes) else self.id = service.create_vm(attributes) end @old = nil reload end
scsi_controller()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 286 def scsi_controller scsi_controllers.first end
scsi_controllers()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 282 def scsi_controllers self.attributes[:scsi_controllers] ||= service.list_vm_scsi_controllers(id) end
snapshots(opts = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 246 def snapshots(opts = {}) service.snapshots(:server_id => self.id).all(opts) end
sockets()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 209 def sockets cpus / corespersocket end
start(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 98 def start(options = {}) requires :instance_uuid service.vm_power_on('instance_uuid' => instance_uuid) unless ready? end
stop(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 103 def stop(options = {}) options = { :force => !tools_installed? || !tools_running? }.merge(options) requires :instance_uuid service.vm_power_off('instance_uuid' => instance_uuid, 'force' => options[:force]) unless power_state == 'poweredOff' end
suspend(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 109 def suspend(options = {}) options = { :force => !tools_installed? || !tools_running? }.merge(options) requires :instance_uuid service.vm_suspend('instance_uuid' => instance_uuid, 'force' => options[:force]) end
take_snapshot(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 176 def take_snapshot(options = {}) requires :instance_uuid service.vm_take_snapshot(options.merge('instance_uuid' => instance_uuid)) end
tools_installed?()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 185 def tools_installed? !(tools_state == 'toolsNotInstalled' || tools_version == 'guestToolsNotInstalled') end
tools_running?()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 189 def tools_running? ["toolsOk","toolsOld"].include? tools_state end
update_interface(attrs)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 231 def update_interface attrs wait_for { not ready? } if interface_ready? attrs service.update_vm_interface(id, attrs) end
vm_reconfig_cpus(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 83 def vm_reconfig_cpus(options = {}) requires :instance_uuid, :cpus, :corespersocket service.vm_reconfig_cpus('instance_uuid' => instance_uuid, 'cpus' => cpus, 'corespersocket' => corespersocket) end
vm_reconfig_hardware(hardware_spec, options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 93 def vm_reconfig_hardware(hardware_spec, options = {}) requires :instance_uuid service.vm_reconfig_hardware('instance_uuid' => instance_uuid, 'hardware_spec' => hardware_spec) end
vm_reconfig_memory(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 78 def vm_reconfig_memory(options = {}) requires :instance_uuid, :memory service.vm_reconfig_memory('instance_uuid' => instance_uuid, 'memory' => memory_mb) end
vm_reconfig_volumes(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 88 def vm_reconfig_volumes(options = {}) requires :instance_uuid, :volumes service.vm_reconfig_volumes('instance_uuid' => instance_uuid, 'volumes' => volumes) end
vm_rename()
click to toggle source
End Lazy Loaded Attributes
# File lib/fog/vsphere/models/compute/server.rb, line 73 def vm_rename requires :instance_uuid, :name service.vm_rename('instance_uuid' => instance_uuid, 'name' => name) end
vnc()
click to toggle source
returns a hash of VNC attributes required for service
# File lib/fog/vsphere/models/compute/server.rb, line 200 def vnc requires :instance_uuid service.vm_get_vnc(instance_uuid) end
volumes()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 242 def volumes attributes[:volumes] ||= id.nil? ? [] : service.volumes(:server_id => self.id) end
Private Instance Methods
attribute_changed?(attr)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 378 def attribute_changed?(attr) self.attributes.select { |k, v| old.attributes[k] != v }.key?(attr) end
defaults()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 333 def defaults { :cpus => 1, # :corespersocket => 1, :memory_mb => 512, :guest_id => 'otherGuest', :path => '/' } end
initialize_customvalues()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 355 def initialize_customvalues if attributes[:customvalues] and attributes[:customvalues].is_a?(Array) self.attributes[:customvalues].map { |cfield| cfield.is_a?(Hash) ? service.customvalue.new(cfield) : cfield} end end
initialize_interfaces()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 343 def initialize_interfaces if attributes[:interfaces] and attributes[:interfaces].is_a?(Array) self.attributes[:interfaces].map! { |nic| nic.is_a?(Hash) ? service.interfaces.new(nic) : nic } end end
initialize_scsi_controllers()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 361 def initialize_scsi_controllers if attributes[:scsi_controllers] && attributes[:scsi_controllers].is_a?(Array) self.attributes[:scsi_controllers].map! do |controller| controller.is_a?(Hash) ? Fog::Compute::Vsphere::SCSIController.new(controller) : controller end elsif attributes[:scsi_controller] && attributes[:scsi_controller].is_a?(Hash) self.attributes[:scsi_controllers] = [ Fog::Compute::Vsphere::SCSIController.new(self.attributes[:scsi_controller]) ] elsif attributes[:volumes] && attributes[:volumes].is_a?(Array) && !attributes[:volumes].empty? # Create a default scsi controller if there are any disks but no controller defined self.attributes[:scsi_controllers] = [ Fog::Compute::Vsphere::SCSIController.new ] end end
initialize_volumes()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 349 def initialize_volumes if attributes[:volumes] and attributes[:volumes].is_a?(Array) self.attributes[:volumes].map! { |vol| vol.is_a?(Hash) ? service.volumes.new({:server => self}.merge(vol)) : vol } end end
old()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 382 def old @old ||= self.dup.reload end