Class: OpenStack::Compute::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/openstack/compute/server.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(compute, id) ⇒ Server

This class is the representation of a single Server object. The constructor finds the server identified by the specified ID number, accesses the API via the populate method to get information about that server, and returns the object.

Will be called via the get_server or create_server methods on the OpenStack::Compute::Connection object, and will likely not be called directly.

>> server = cs.get_server(110917)
=> #<OpenStack::Compute::Server:0x1014e5438 ....>
>> server.name
=> "RenamedRubyTest"


34
35
36
37
38
39
40
41
42
43
# File 'lib/openstack/compute/server.rb', line 34

def initialize(compute,id)
  @compute    = compute
  @id            = id
  @svrmgmthost   = @compute.connection.service_host
  @svrmgmtpath   = @compute.connection.service_path
  @svrmgmtport   = @compute.connection.service_port
  @svrmgmtscheme = @compute.connection.service_scheme
  populate
  return self
end

Instance Attribute Details

#accessipv4Object (readonly)

Returns the value of attribute accessipv4.



13
14
15
# File 'lib/openstack/compute/server.rb', line 13

def accessipv4
  @accessipv4
end

#accessipv6Object (readonly)

Returns the value of attribute accessipv6.



14
15
16
# File 'lib/openstack/compute/server.rb', line 14

def accessipv6
  @accessipv6
end

#addressesObject (readonly)

Returns the value of attribute addresses.



15
16
17
# File 'lib/openstack/compute/server.rb', line 15

def addresses
  @addresses
end

#adminPassObject

Returns the value of attribute adminPass.



20
21
22
# File 'lib/openstack/compute/server.rb', line 20

def adminPass
  @adminPass
end

#createdObject (readonly)

Returns the value of attribute created.



22
23
24
# File 'lib/openstack/compute/server.rb', line 22

def created
  @created
end

#faultObject (readonly)

Returns the value of attribute fault.



10
11
12
# File 'lib/openstack/compute/server.rb', line 10

def fault
  @fault
end

#flavorObject (readonly)

Returns the value of attribute flavor.



18
19
20
# File 'lib/openstack/compute/server.rb', line 18

def flavor
  @flavor
end

#hostIdObject (readonly)

Returns the value of attribute hostId.



16
17
18
# File 'lib/openstack/compute/server.rb', line 16

def hostId
  @hostId
end

#idObject (readonly)

Returns the value of attribute id.



7
8
9
# File 'lib/openstack/compute/server.rb', line 7

def id
  @id
end

#imageObject (readonly)

Returns the value of attribute image.



17
18
19
# File 'lib/openstack/compute/server.rb', line 17

def image
  @image
end

#key_nameObject (readonly)

Returns the value of attribute key_name.



21
22
23
# File 'lib/openstack/compute/server.rb', line 21

def key_name
  @key_name
end

#libvirt_idObject (readonly)

Returns the value of attribute libvirt_id.



9
10
11
# File 'lib/openstack/compute/server.rb', line 9

def libvirt_id
  @libvirt_id
end

#metadataObject (readonly)

Returns the value of attribute metadata.



19
20
21
# File 'lib/openstack/compute/server.rb', line 19

def 
  @metadata
end

#nameObject (readonly)

Returns the value of attribute name.



8
9
10
# File 'lib/openstack/compute/server.rb', line 8

def name
  @name
end

#progressObject (readonly)

Returns the value of attribute progress.



12
13
14
# File 'lib/openstack/compute/server.rb', line 12

def progress
  @progress
end

#security_groupsObject (readonly)

Returns the value of attribute security_groups.



23
24
25
# File 'lib/openstack/compute/server.rb', line 23

def security_groups
  @security_groups
end

#statusObject (readonly)

Returns the value of attribute status.



11
12
13
# File 'lib/openstack/compute/server.rb', line 11

def status
  @status
end

Instance Method Details

#add_fixed_ip(network_id) ⇒ Object

Add a fixed ip from a specific network to the instance

Returns true if the API call succeeds.

>> server.add_fixed_ip
=> true


386
387
388
389
390
391
392
393
# File 'lib/openstack/compute/server.rb', line 386

def add_fixed_ip(network_id)
  data = JSON.generate(:addFixedIp => {
      :networkId => network_id
  })
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#change_password!(password) ⇒ Object

Changes the admin password. Returns the password if it succeeds.



264
265
266
267
268
# File 'lib/openstack/compute/server.rb', line 264

def change_password!(password)
  json = JSON.generate(:changePassword => { :adminPass => password })
  @compute.connection.req('POST', "/servers/#{@id}/action", :data => json)
  @adminPass = password
end

#confirm_resize!Object

After a server resize is complete, calling this method will confirm the resize with the OpenStack API, and discard the fallback/original image.

Returns true if the API call succeeds.

>> server.confirm_resize!
=> true


237
238
239
240
241
242
243
244
# File 'lib/openstack/compute/server.rb', line 237

def confirm_resize!
  # If the resize bug gets figured out, should put a check here to make sure that it's in the proper state for this.
  data = JSON.generate(:confirmResize => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  self.populate
  true
end

#create_image(options) ⇒ Object

Takes a snapshot of the server and creates a server image from it. That image can then be used to build new servers. The snapshot is saved asynchronously. Check the image status to make sure that it is ACTIVE before attempting to perform operations on it.

A name string for the saved image must be provided. A new OpenStack::Compute::Image object for the saved image is returned.

The image is saved as a backup, of which there are only three available slots. If there are no backup slots available, A OpenStack::Exception::OpenStackComputeFault will be raised.

>> image = server.create_image(:name => "My Rails Server")
=>


208
209
210
211
212
213
214
# File 'lib/openstack/compute/server.rb', line 208

def create_image(options)
  data = JSON.generate(:createImage => options)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  image_id = response["Location"].split("/images/").last
  OpenStack::Compute::Image.new(@compute, image_id)
end

#delete!Object

Deletes the server from OpenStack Compute. The server will be shut down, data deleted, and billing stopped.

Returns true if the API call succeeds.

>> server.delete!
=> true


153
154
155
156
157
# File 'lib/openstack/compute/server.rb', line 153

def delete!
  response = @compute.connection.csreq("DELETE",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}",@svrmgmtport,@svrmgmtscheme)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#get_addresses(address_info) ⇒ Object



270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/openstack/compute/server.rb', line 270

def get_addresses(address_info)
  address_info = OpenStack::Compute::Address.fix_labels(address_info)
  address_list = OpenStack::Compute::AddressList.new
  address_info.each do |label, addr|
    addr.each do |address|
      address_list << OpenStack::Compute::Address.new(label,address)
      if address_list.last.version == 4 && (!@accessipv4 || accessipv4 == "") then
        @accessipv4 = address_list.last.address
      end
    end
  end
  address_list
end

#get_consoleObject

Get novnc console URL Return Hash with type and URL



286
287
288
289
290
291
# File 'lib/openstack/compute/server.rb', line 286

def get_console
  data = JSON.generate("os-getVNCConsole" => {:type => "novnc"})
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  JSON::parse(response.body)["console"]
end

#get_console_output(length = 50) ⇒ Object

Get console output Return output string object



295
296
297
298
299
300
# File 'lib/openstack/compute/server.rb', line 295

def get_console_output(length=50)
  data = JSON.generate("os-getConsoleOutput" => {:length => length})
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  JSON::parse(response.body)["output"]
end

#get_volume_attachmentsObject

List volume attachments for an instance

>> server.get_volume_attachments
=> array


455
456
457
458
459
# File 'lib/openstack/compute/server.rb', line 455

def get_volume_attachments
  response = @compute.connection.req('GET', "/servers/#{@id}/os-volume_attachments")
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  JSON.parse(response.body)['volumeAttachments']
end

#interface_create(options) ⇒ Object

Creates a new interface on this server.

>> server.interface_create
=> array


434
435
436
437
438
439
# File 'lib/openstack/compute/server.rb', line 434

def interface_create(options)
  data = JSON.generate(:interfaceAttachment => options)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/os-interface",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  JSON::parse(response.body)["interfaceAttachment"]
end

#interface_delete(id) ⇒ Object

Deleted a specific interface from this server.

>> server.interface_delete
=> true


445
446
447
448
449
# File 'lib/openstack/compute/server.rb', line 445

def interface_delete(id)
  response = @compute.connection.csreq("DELETE",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/os-interface/#{id}",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'})
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#interface_details(id) ⇒ Object

Returns all details about the interface on this server.

>> server.interface_details
=> array


424
425
426
427
428
# File 'lib/openstack/compute/server.rb', line 424

def interface_details(id)
  response = @compute.connection.csreq("GET",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/os-interface/#{id}",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'})
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  JSON::parse(response.body)["interfaceAttachment"]
end

#interface_listObject

Lists all interfaces from this server.

>> server.interface_list
=> array


414
415
416
417
418
# File 'lib/openstack/compute/server.rb', line 414

def interface_list
  response = @compute.connection.csreq("GET",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/os-interface",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'})
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  JSON::parse(response.body)["interfaceAttachments"]
end

#pauseObject

Sends an API request to pause this server.

Returns true if the API call succeeds.

>> server.pause
=> true


308
309
310
311
312
313
# File 'lib/openstack/compute/server.rb', line 308

def pause
  data = JSON.generate(:pause => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#populate(data = nil) ⇒ Object Also known as: refresh

Makes the actual API call to get information about the given server object. If you are attempting to track the status or project of a server object (for example, when rebuilding, creating, or resizing a server), you will likely call this method within a loop until the status becomes “ACTIVE” or other conditions are met.

Returns true if the API call succeeds.

>> server.refresh
=> true


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/openstack/compute/server.rb', line 53

def populate(data=nil)
  path = "/servers/#{URI.encode(@id.to_s)}"
  if data.nil? then
      response = @compute.connection.req("GET", path)
      OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
      data = JSON.parse(response.body)["server"]
  end
  @id        = data["id"] || data["uuid"]
  @name      = data["name"]
  @libvirt_id = data["OS-EXT-SRV-ATTR:instance_name"]
  @fault = data["fault"]
  @status    = data["status"]
  @progress  = data["progress"]
  @addresses = get_addresses(data["addresses"])
  @metadata  = OpenStack::Compute::Metadata.new(@compute, path, data["metadata"])
  @hostId    = data["hostId"]
  @image   = data["image"] || data["imageId"]
  @flavor  = data["flavor"] || data["flavorId"]
  @key_name = data["key_name"] # if provider uses the keys API extension for accessing servers
  @created = data["created"]
  @security_groups = (data["security_groups"] || []).inject([]){|res, c| res << c["id"]  ; res}
  true
end

#reboot(type = "SOFT") ⇒ Object

Sends an API request to reboot this server. Takes an optional argument for the type of reboot, which can be “SOFT” (graceful shutdown) or “HARD” (power cycle). The hard reboot is also triggered by server.reboot!, so that may be a better way to call it.

Returns true if the API call succeeds.

>> server.reboot
=> true


85
86
87
88
89
90
# File 'lib/openstack/compute/server.rb', line 85

def reboot(type="SOFT")
  data = JSON.generate(:reboot => {:type => type})
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#reboot!Object

Sends an API request to hard-reboot (power cycle) the server. See the reboot method for more information.

Returns true if the API call succeeds.

>> server.reboot!
=> true


98
99
100
# File 'lib/openstack/compute/server.rb', line 98

def reboot!
  self.reboot("HARD")
end

#rebuild!(options) ⇒ Object

The rebuild function removes all data on the server and replaces it with the specified image. The serverRef and all IP addresses will remain the same. If name and metadata are specified, they will replace existing values, otherwise they will not change. A rebuild operation always removes data injected into the file system via server personality. You may reinsert data into the filesystem during the rebuild.

This method expects a hash of the form: {

:imageRef => "https://foo.com/v1.1/images/2",
:name => "newName",
:metadata => { :values => { :foo : "bar" } },
:personality => [
  {
    :path => "/etc/banner.txt",
    :contents => : "ICAgpY2hhcmQgQmFjaA=="
  }
]

}

This will wipe and rebuild the server, but keep the server ID number, name, and IP addresses the same.

Returns true if the API call succeeds.

>> server.rebuild!
=> true


186
187
188
189
190
191
192
193
194
195
# File 'lib/openstack/compute/server.rb', line 186

def rebuild!(options)
  options[:personality] = Personalities.get_personality(options[:personality])
  json = JSON.generate(:rebuild => options)
  response = @compute.connection.req('POST', "/servers/#{@id}/action", :data => json)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  data = JSON.parse(response.body)['server']
  self.populate(data)
  self.adminPass = data['adminPass'] if data['adminPass']
  true
end

#remove_fixed_ip(ip) ⇒ Object

Remove a specific fixed ip from the instance

Returns true if the API call succeeds.

>> server.remove_fixed_ip
=> true


401
402
403
404
405
406
407
408
# File 'lib/openstack/compute/server.rb', line 401

def remove_fixed_ip(ip)
  data = JSON.generate(:removeFixedIp => {
      :address => ip
  })
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#rescue(options = nil) ⇒ Object

Sends an API request to rescue this server.

Returns true if the API call succeeds.

>> server.rescue
=> true


360
361
362
363
364
365
# File 'lib/openstack/compute/server.rb', line 360

def rescue(options = nil)
  data = JSON.generate(:rescue => options)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#resize!(flavorRef) ⇒ Object

Resizes the server to the size contained in the server flavor found at ID flavorRef. The server name, ID number, and IP addresses will remain the same. After the resize is done, the server.status will be set to “VERIFY_RESIZE” until the resize is confirmed or reverted.

Refreshes the OpenStack::Compute::Server object, and returns true if the API call succeeds.

>> server.resize!(1)
=> true


223
224
225
226
227
228
229
# File 'lib/openstack/compute/server.rb', line 223

def resize!(flavorRef)
  data = JSON.generate(:resize => {:flavorRef => flavorRef})
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  self.populate
  true
end

#resumeObject

Sends an API request to resume this server.

Returns true if the API call succeeds.

>> server.resume
=> true


347
348
349
350
351
352
# File 'lib/openstack/compute/server.rb', line 347

def resume
  data = JSON.generate(:resume => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#revert_resize!Object

After a server resize is complete, calling this method will reject the resized server with the OpenStack API, destroying the new image and replacing it with the pre-resize fallback image.

Returns true if the API call succeeds.

>> server.confirm_resize!
=> true


253
254
255
256
257
258
259
260
# File 'lib/openstack/compute/server.rb', line 253

def revert_resize!
  # If the resize bug gets figured out, should put a check here to make sure that it's in the proper state for this.
  data = JSON.generate(:revertResize => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  self.populate
  true
end

#startObject

Sends an API request to start (resume) the server.

Returns true if the API call succeeds.

>> server.start()
=> true


121
122
123
124
125
126
# File 'lib/openstack/compute/server.rb', line 121

def start
  data = JSON.generate('os-start' => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#stopObject

Sends an API request to stop (suspend) the server.

Returns true if the API call succeeds.

>> server.stop()
=> true


108
109
110
111
112
113
# File 'lib/openstack/compute/server.rb', line 108

def stop()
  data = JSON.generate('os-stop' => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#suspendObject

Sends an API request to suspend this server.

Returns true if the API call succeeds.

>> server.suspend
=> true


334
335
336
337
338
339
# File 'lib/openstack/compute/server.rb', line 334

def suspend
  data = JSON.generate(:suspend => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#unpauseObject

Sends an API request to unpause this server.

Returns true if the API call succeeds.

>> server.unpause
=> true


321
322
323
324
325
326
# File 'lib/openstack/compute/server.rb', line 321

def unpause
  data = JSON.generate(:unpause => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#unrescueObject

Sends an API request to unrescue this server.

Returns true if the API call succeeds.

>> server.unrescue
=> true


373
374
375
376
377
378
# File 'lib/openstack/compute/server.rb', line 373

def unrescue
  data = JSON.generate(:unrescue => nil)
  response = @compute.connection.csreq("POST",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}/action",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  true
end

#update(options) ⇒ Object

Updates various parameters about the server. Currently, the only operations supported are changing the server name (not the actual hostname on the server, but simply the label in the Servers API) and the administrator password (note: changing the admin password will trigger a reboot of the server). Other options are ignored. One or both key/value pairs may be provided. Keys are case-sensitive.

Input hash key values are :name and :adminPass. Returns true if the API call succeeds.

>> server.update(:name => "MyServer", :adminPass => "12345")
=> true
>> server.name
=> "MyServer"


138
139
140
141
142
143
144
145
# File 'lib/openstack/compute/server.rb', line 138

def update(options)
  data = JSON.generate(:server => options)
  response = @compute.connection.csreq("PUT",@svrmgmthost,"#{@svrmgmtpath}/servers/#{URI.encode(self.id.to_s)}",@svrmgmtport,@svrmgmtscheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  # If we rename the instance, repopulate the object
  self.populate if options[:name]
  true
end