module OpenStack module Compute class Server require 'openstack/compute/metadata' attr_reader :id attr_reader :name attr_reader :libvirt_id attr_reader :fault attr_reader :status attr_reader :state attr_reader :progress attr_reader :accessipv4 attr_reader :accessipv6 attr_reader :addresses attr_reader :hostId attr_reader :image attr_reader :flavor attr_reader :metadata attr_accessor :adminPass attr_reader :key_name attr_reader :created attr_reader :security_groups # 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) # => # # >> server.name # => "RenamedRubyTest" 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 # 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 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"] @state = data["OS-EXT-STS:task_state"] @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"] || []) true end alias :refresh :populate # 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 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 # 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 def reboot! self.reboot("HARD") end # Sends an API request to stop (suspend) the server. # # Returns true if the API call succeeds. # # >> server.stop() # => true 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 # Sends an API request to start (resume) the server. # # Returns true if the API call succeeds. # # >> server.start() # => true 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 # 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" 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 # 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 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 # 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 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 # 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") # => 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 # 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 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 # 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 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 # 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 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 # Changes the admin password. # Returns the password if it succeeds. def change_password!(password) json = JSON.generate(:changePassword => { :adminPass => password }) @compute.connection.req('POST', "/servers/#{@id}/action", :data => json) @adminPass = password end 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 novnc console URL #Return Hash with type and URL 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 #Return output string object 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 # Sends an API request to pause this server. # # Returns true if the API call succeeds. # # >> server.pause # => true 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 # Sends an API request to unpause this server. # # Returns true if the API call succeeds. # # >> server.unpause # => true 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 # Sends an API request to suspend this server. # # Returns true if the API call succeeds. # # >> server.suspend # => true 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 # Sends an API request to resume this server. # # Returns true if the API call succeeds. # # >> server.resume # => true 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 # Sends an API request to rescue this server. # # Returns true if the API call succeeds. # # >> server.rescue # => true 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 # Sends an API request to unrescue this server. # # Returns true if the API call succeeds. # # >> server.unrescue # => true 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 # Add a fixed ip from a specific network to the instance # # Returns true if the API call succeeds. # # >> server.add_fixed_ip # => true 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 # Remove a specific fixed ip from the instance # # Returns true if the API call succeeds. # # >> server.remove_fixed_ip # => true 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 # Lists all interfaces from this server. # # >> server.interface_list # => array 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 # Returns all details about the interface on this server. # # >> server.interface_details # => array 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 # Creates a new interface on this server. # # >> server.interface_create # => array 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 # Deleted a specific interface from this server. # # >> server.interface_delete # => true 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 # List volume attachments for an instance # # >> server.get_volume_attachments # => array 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 # Adds a specific security group to the server. # # >> server.add_security_group('default') # => true def add_security_group(security_group) data = JSON.generate(:addSecurityGroup => {:name => security_group}) 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 # Removes a specific security group from the server. # # >> server.delete_security_group('default') # => true def delete_security_group(security_group) data = JSON.generate(:removeSecurityGroup => {:name => security_group}) 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 end end end