class OpenStack::Compute::Server

Attributes

accessipv4[R]
accessipv6[R]
addresses[R]
adminPass[RW]
flavor[R]
hostId[R]
id[R]
image[R]
key_name[R]
metadata[R]
name[R]
progress[R]
security_groups[R]
status[R]

Public Class Methods

new(compute,id) click to toggle source

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"
# File lib/openstack/compute/server.rb, line 31
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

Public Instance Methods

change_password!(password) click to toggle source

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

# File lib/openstack/compute/server.rb, line 232
def change_password!(password)
  json = JSON.generate(:changePassword => { :adminPass => password })
  @compute.connection.req('POST', "/servers/#{@id}/action", :data => json)
  @adminPass = password
end
confirm_resize!() click to toggle source

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
# File lib/openstack/compute/server.rb, line 205
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(%r^20.$/)
  self.populate
  true
end
create_image(options) click to toggle source

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")
=>
# File lib/openstack/compute/server.rb, line 176
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(%r^20.$/)
  image_id = response["Location"].scan(%r.*\/(.*)/).flatten
  OpenStack::Compute::Image.new(@compute, image_id)
end
delete!() click to toggle source

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
# File lib/openstack/compute/server.rb, line 121
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(%r^20.$/)
  true
end
get_addresses(address_info) click to toggle source
# File lib/openstack/compute/server.rb, line 238
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
populate(data=nil) click to toggle source

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
# File lib/openstack/compute/server.rb, line 50
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(%r^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
  @security_groups = (data["security_groups"] || []).inject([]){|res, c| res << c["id"]  ; res}
  true
end
Also aliased as: refresh
reboot(type="SOFT") click to toggle source

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
# File lib/openstack/compute/server.rb, line 79
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(%r^20.$/)
  true
end
reboot!() click to toggle source

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
# File lib/openstack/compute/server.rb, line 92
def reboot!
  self.reboot("HARD")
end
rebuild!(options) click to toggle source

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
# File lib/openstack/compute/server.rb, line 154
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(%r^20.$/)
  data = JSON.parse(response.body)['server']
  self.populate(data)
  self.adminPass = data['adminPass']
  true
end
refresh(data=nil) click to toggle source
Alias for: populate
resize!(flavorRef) click to toggle source

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
# File lib/openstack/compute/server.rb, line 191
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(%r^20.$/)
  self.populate
  true
end
revert_resize!() click to toggle source

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
# File lib/openstack/compute/server.rb, line 221
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(%r^20.$/)
  self.populate
  true
end
update(options) click to toggle source

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"
# File lib/openstack/compute/server.rb, line 106
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(%r^20.$/)
  # If we rename the instance, repopulate the object
  self.populate if options[:name]
  true
end