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"



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

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

#accessipv4 ⇒ Object (readonly)

Returns the value of attribute accessipv4.



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

def accessipv4
  @accessipv4
end

#accessipv6 ⇒ Object (readonly)

Returns the value of attribute accessipv6.



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

def accessipv6
  @accessipv6
end

#addresses ⇒ Object (readonly)

Returns the value of attribute addresses.



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

def addresses
  @addresses
end

#adminPass ⇒ Object

Returns the value of attribute adminPass.



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

def adminPass
  @adminPass
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



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

def created
  @created
end

#flavor ⇒ Object (readonly)

Returns the value of attribute flavor.



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

def flavor
  @flavor
end

#hostId ⇒ Object (readonly)

Returns the value of attribute hostId.



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

def hostId
  @hostId
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#image ⇒ Object (readonly)

Returns the value of attribute image.



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

def image
  @image
end

#key_name ⇒ Object (readonly)

Returns the value of attribute key_name.



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

def key_name
  @key_name
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#progress ⇒ Object (readonly)

Returns the value of attribute progress.



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

def progress
  @progress
end

#security_groups ⇒ Object (readonly)

Returns the value of attribute security_groups.



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

def security_groups
  @security_groups
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



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

def status
  @status
end

Instance Method Details

#change_password!(password) ⇒ Object

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



262
263
264
265
266
 
# File 'lib/openstack/compute/server.rb', line 262

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



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

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")
=>



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

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



151
152
153
154
155
 
# File 'lib/openstack/compute/server.rb', line 151

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 



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

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

Get novnc console URL Return Hash with type and URL



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

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



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

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

#pause ⇒ Object

Sends an API request to pause this server.

Returns true if the API call succeeds.

>> server.pause
=> true



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

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



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

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"]
  @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



81
82
83
84
85
86
 
# File 'lib/openstack/compute/server.rb', line 81

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



94
95
96
 
# File 'lib/openstack/compute/server.rb', line 94

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



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

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']
  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



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

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

#resume ⇒ Object

Sends an API request to resume this server.

Returns true if the API call succeeds.

>> server.resume
=> true



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

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



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

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

#start ⇒ Object

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

Returns true if the API call succeeds.

>> server.start()
=> true



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

def start()
  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

#stop ⇒ Object

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

Returns true if the API call succeeds.

>> server.stop()
=> true



104
105
106
107
108
109
110
111
 
# File 'lib/openstack/compute/server.rb', line 104

def stop()
  data = JSON.generate(:suspend => nil)
  puts data
  pp "About to post ACTION"
  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

#suspend ⇒ Object

Sends an API request to suspend this server.

Returns true if the API call succeeds.

>> server.suspend
=> true



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

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

#unpause ⇒ Object

Sends an API request to unpause this server.

Returns true if the API call succeeds.

>> server.unpause
=> true



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

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

#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"



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

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