Class: Fog::Compute::Vsphere::Server

Inherits:
Server
  • Object
show all
Extended by:
Deprecation
Defined in:
lib/fog/vsphere/models/compute/server.rb

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Server

Returns a new instance of Server.



53
54
55
56
57
58
59
60
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 53

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

Instance Method Details

#add_interface(attrs) ⇒ Object 



200
201
202
203
204
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 200

def add_interface attrs
  Fog::Logger.deprecation("<server>.add_interface is deprecated. Call <server>.interfaces.create instead.")

  interfaces.create(attrs)
end

#clone(options = {}) ⇒ Object

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 126

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 = {}) ⇒ Object

defines VNC attributes on the hypervisor



169
170
171
172
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 169

def config_vnc(options = {})
  requires :instance_uuid
  service.vm_config_vnc(options.merge('instance_uuid' => instance_uuid))
end

#customvalues ⇒ Object 



245
246
247
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 245

def customvalues
  attributes[:customvalues] ||= id.nil? ? [] : service.customvalues( :vm => self )
end

#destroy(options = {}) ⇒ Object 



103
104
105
106
107
108
109
110
111
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 103

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) ⇒ Object 



211
212
213
214
215
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 211

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) ⇒ Object 



225
226
227
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 225

def find_snapshot(snapshot_ref)
  snapshots.get(snapshot_ref)
end

#folder ⇒ Object 



253
254
255
256
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 253

def folder
  return nil unless datacenter and path
  attributes[:folder] ||= service.folders(:datacenter => datacenter, :type => :vm).get(path)
end

#guest_processes(opts = {}) ⇒ Object 



240
241
242
243
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 240

def guest_processes(opts = {})
  fail 'VM tools must be running' unless tools_running?
  service.list_processes(self.id, opts)
end

#interface_ready?(attrs) ⇒ Boolean

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 196

def interface_ready? attrs
  (attrs.is_a? Hash and attrs[:blocking]) or attrs.is_a? Fog::Compute::Vsphere::Interface
end

#interfaces ⇒ Object 



192
193
194
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 192

def interfaces
  attributes[:interfaces] ||= id.nil? ? [] : service.interfaces( :server_id => self.id )
end

#mac ⇒ Object 



188
189
190
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 188

def mac
  interfaces.first.mac unless interfaces.empty?
end

#memory ⇒ Object 



180
181
182
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 180

def memory
  memory_mb * 1024 * 1024
end

#migrate(options = {}) ⇒ Object 



113
114
115
116
117
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 113

def migrate(options = {})
  options = { :priority => 'defaultPriority' }.merge(options)
  requires :instance_uuid
  service.vm_migrate('instance_uuid' => instance_uuid, 'priority' => options[:priority])
end

#new? ⇒ Boolean

Returns:

  • (Boolean) 


269
270
271
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 269

def new?
  id.nil?
end

#ready? ⇒ Boolean

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 156

def ready?
  power_state == "poweredOn"
end

#reboot(options = {}) ⇒ Object 



97
98
99
100
101
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 97

def reboot(options = {})
  options = { :force => false }.merge(options)
  requires :instance_uuid
  service.vm_reboot('instance_uuid' => instance_uuid, 'force' => options[:force])
end

#relative_path ⇒ Object 



281
282
283
284
285
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 281

def relative_path
  requires :path, :datacenter

  (path.split('/').reject {|e| e.empty?} - ["Datacenters", datacenter, "vm"]).join("/")
end

#reload ⇒ Object 



273
274
275
276
277
278
279
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 273

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) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 229

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 ⇒ Object 



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 258

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 ⇒ Object 



249
250
251
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 249

def scsi_controller
  self.attributes[:scsi_controller] ||= service.get_vm_first_scsi_controller(id)
end

#snapshots(opts = {}) ⇒ Object 



221
222
223
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 221

def snapshots(opts = {})
  service.snapshots(server_id: self.id).all(opts)
end

#sockets ⇒ Object 



184
185
186
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 184

def sockets
  cpus / corespersocket
end

#start(options = {}) ⇒ Object 



86
87
88
89
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 86

def start(options = {})
  requires :instance_uuid
  service.vm_power_on('instance_uuid' => instance_uuid)
end

#stop(options = {}) ⇒ Object 



91
92
93
94
95
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 91

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 = {}) ⇒ Object 



151
152
153
154
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 151

def take_snapshot(options = {})
  requires :instance_uuid
  service.vm_take_snapshot(options.merge('instance_uuid' => instance_uuid))
end

#tools_installed? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 160

def tools_installed?
  tools_state != "toolsNotInstalled"
end

#tools_running? ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 164

def tools_running?
  ["toolsOk","toolsOld"].include? tools_state
end

#update_interface(attrs) ⇒ Object 



206
207
208
209
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 206

def update_interface attrs
  wait_for { not ready? } if interface_ready? attrs
  service.update_vm_interface(id, attrs)
end

#vm_reconfig_cpus(options = {}) ⇒ Object 



76
77
78
79
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 76

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 = {}) ⇒ Object 



81
82
83
84
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 81

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 = {}) ⇒ Object

End Lazy Loaded Attributes



71
72
73
74
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 71

def vm_reconfig_memory(options = {})
  requires :instance_uuid, :memory
  service.vm_reconfig_memory('instance_uuid' => instance_uuid, 'memory' => memory_mb)
end

#vnc ⇒ Object

returns a hash of VNC attributes required for service



175
176
177
178
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 175

def vnc
  requires :instance_uuid
  service.vm_get_vnc(instance_uuid)
end

#volumes ⇒ Object 



217
218
219
 
# File 'lib/fog/vsphere/models/compute/server.rb', line 217

def volumes
  attributes[:volumes] ||= id.nil? ? [] : service.volumes(:server_id => self.id)
end