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 54 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_controller end
Public Instance Methods
add_interface(attrs)
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 201 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 245 def cdrom(key) cdroms.get(key) end
cdroms(opts = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 241 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 127 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 170 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 254 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 104 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 212 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 226 def find_snapshot(snapshot_ref) snapshots.get(snapshot_ref) end
folder()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 262 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 249 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 197 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 193 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 189 def mac interfaces.first.mac unless interfaces.empty? end
memory()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 181 def memory memory_mb * 1024 * 1024 end
migrate(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 114 def migrate(options = {}) options = { :priority => 'defaultPriority' }.merge(options) requires :instance_uuid service.vm_migrate('instance_uuid' => instance_uuid, 'priority' => options[:priority]) end
new?()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 278 def new? id.nil? end
ready?()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 157 def ready? power_state == "poweredOn" end
reboot(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 98 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 290 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 282 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 230 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 267 def save requires :name, :cluster, :datacenter if persisted? raise "update is not supported yet" # service.update_vm(attributes) else self.id = service.create_vm(attributes) end reload end
scsi_controller()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 258 def scsi_controller self.attributes[:scsi_controller] ||= service.get_vm_first_scsi_controller(id) end
snapshots(opts = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 222 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 185 def sockets cpus / corespersocket end
start(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 87 def start(options = {}) requires :instance_uuid service.vm_power_on('instance_uuid' => instance_uuid) end
stop(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 92 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]) end
take_snapshot(options = {})
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 152 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 161 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 165 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 207 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 77 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 82 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
End Lazy Loaded Attributes
# File lib/fog/vsphere/models/compute/server.rb, line 72 def vm_reconfig_memory(options = {}) requires :instance_uuid, :memory service.vm_reconfig_memory('instance_uuid' => instance_uuid, 'memory' => memory_mb) end
vnc()
click to toggle source
returns a hash of VNC attributes required for service
# File lib/fog/vsphere/models/compute/server.rb, line 176 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 218 def volumes attributes[:volumes] ||= id.nil? ? [] : service.volumes(:server_id => self.id) end
Private Instance Methods
defaults()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 298 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 320 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 308 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_controller()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 326 def initialize_scsi_controller if attributes[:scsi_controller] and attributes[:scsi_controller].is_a?(Hash) Fog::Compute::Vsphere::SCSIController.new(self.attributes[:scsi_controller]) end end
initialize_volumes()
click to toggle source
# File lib/fog/vsphere/models/compute/server.rb, line 314 def initialize_volumes if attributes[:volumes] and attributes[:volumes].is_a?(Array) self.attributes[:volumes].map! { |vol| vol.is_a?(Hash) ? service.volumes.new(vol) : vol } end end