class Fog::Compute::Libvirt::Server
Attributes
iso_dir[RW]
The following attributes are only needed when creating a new vm
TODO: Add depreciation warning
iso_file[RW]
The following attributes are only needed when creating a new vm
TODO: Add depreciation warning
network_bridge_name[RW]
network_interface_type[RW]
network_nat_network[RW]
password[RW]
volume_allocation[RW]
volume_capacity[RW]
volume_format_type[RW]
volume_name[RW]
volume_path[RW]
volume_pool_name[RW]
volume_template_name[RW]
volumes_path[RW]
xml[R]
Public Class Methods
new(attributes={} )
click to toggle source
Can be created by passing in :xml => “<xml to create domain/server>” or by providing :template_options => {
:name => "", :cpus => 1, :memory_size => 256 , :volume_template }
Calls superclass method
# File lib/fog/libvirt/models/compute/server.rb, line 45 def initialize(attributes={} ) @xml = attributes.delete(:xml) verify_boot_order(attributes[:boot_order]) super defaults.merge(attributes) initialize_nics initialize_volumes end
Public Instance Methods
destroy(options={ :destroy_volumes => false})
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 82 def destroy(options={ :destroy_volumes => false}) poweroff unless stopped? service.vm_action(uuid, :undefine) volumes.each { |vol| vol.destroy } if options[:destroy_volumes] true end
disk_path()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 78 def disk_path volumes.first.path if volumes and volumes.first end
mac()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 74 def mac nics.first.mac if nics && nics.first end
new?()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 53 def new? uuid.nil? end
poweroff()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 95 def poweroff action_status = service.vm_action(uuid, :destroy) reload action_status end
Also aliased as: halt
private_ip_address()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 137 def private_ip_address ip_address(:private) end
public_ip_address()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 141 def public_ip_address ip_address(:public) end
ready?()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 123 def ready? state == "running" end
reboot()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 89 def reboot action_status = service.vm_action(uuid, :reboot) reload action_status end
resume()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 107 def resume action_status = service.vm_action(uuid, :resume) reload action_status end
save()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 57 def save raise Fog::Errors::Error.new('Saving an existing server may create a duplicate') unless new? create_or_clone_volume unless xml or @volumes @xml ||= to_xml self.id = (persistent ? service.define_domain(xml) : service.create_domain(xml)).uuid reload rescue => e raise Fog::Errors::Error.new("Error saving the server: #{e}") end
scp(local_path, remote_path, upload_options = {})
click to toggle source
Transfers a file
# File lib/fog/libvirt/models/compute/server.rb, line 163 def scp(local_path, remote_path, upload_options = {}) requires :ssh_ip_address, :username scp_options = {} scp_options[:password] = password unless self.password.nil? scp_options[:key_data] = [private_key] if self.private_key scp_options[:proxy]= ssh_proxy unless self.ssh_proxy.nil? Fog::SCP.new(ssh_ip_address, username, scp_options).upload(local_path, remote_path, upload_options) end
setup(credentials = {})
click to toggle source
Sets up a new key
# File lib/fog/libvirt/models/compute/server.rb, line 175 def setup(credentials = {}) requires :public_key, :ssh_ip_address, :username credentials[:proxy]= ssh_proxy unless ssh_proxy.nil? credentials[:password] = password unless self.password.nil? credentails[:key_data] = [private_key] if self.private_key commands = [ %{mkdir .ssh}, # %{passwd -l #{username}}, #Not sure if we need this here # %{echo "#{Fog::JSON.encode(attributes)}" >> ~/attributes.json} ] if public_key commands << %{echo "#{public_key}" >> ~/.ssh/authorized_keys} end # wait for domain to be ready Timeout::timeout(360) do begin Timeout::timeout(8) do Fog::SSH.new(ssh_ip_address, username, credentials.merge(:timeout => 4)).run('pwd') end rescue Errno::ECONNREFUSED sleep(2) retry rescue Net::SSH::AuthenticationFailed, Timeout::Error retry end end Fog::SSH.new(ssh_ip_address, username, credentials).run(commands) end
shutdown()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 101 def shutdown action_status = service.vm_action(uuid, :shutdown) reload action_status end
Also aliased as: stop
ssh(commands)
click to toggle source
Calls superclass method
# File lib/fog/libvirt/models/compute/server.rb, line 145 def ssh(commands) requires :ssh_ip_address, :username ssh_options={} ssh_options[:password] = password unless password.nil? ssh_options[:proxy]= ssh_proxy unless ssh_proxy.nil? super(commands, ssh_options) end
ssh_proxy()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 155 def ssh_proxy # if this is a direct connection, we don't need a proxy to be set. return nil unless connection.uri.ssh_enabled? user_string= service.uri.user ? "-l #{service.uri.user}" : "" Net::SSH::Proxy::Command.new("ssh #{user_string} #{service.uri.host} nc %h %p") end
start()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 67 def start return true if active? action_status = service.vm_action(uuid, :create) reload action_status end
stopped?()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 119 def stopped? state == "shutoff" end
suspend()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 113 def suspend action_status = service.vm_action(uuid, :suspend) reload action_status end
update_display(attrs = {})
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 207 def update_display attrs = {} service.update_display attrs.merge(:uuid => uuid) reload end
vnc_port()
click to toggle source
can’t use deprecate method, as the value is part of the display hash
# File lib/fog/libvirt/models/compute/server.rb, line 213 def vnc_port Fog::Logger.deprecation("#{self.class} => #vnc_port is deprecated, use #display[:port] instead [light_black](#{caller.first})[/]") display[:port] end
volumes()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 132 def volumes # lazy loading of volumes @volumes ||= (@volumes_path || []).map{|path| service.volumes.all(:path => path).first } end
Private Instance Methods
addresses(service=service, options={})
click to toggle source
This retrieves the ip address of the mac address It returns an array of public and private ip addresses Currently only one ip address is returned, but in the future this could be multiple if the server has multiple network interface
# File lib/fog/libvirt/models/compute/server.rb, line 225 def addresses(service=service, options={}) mac=self.mac # Aug 24 17:34:41 juno arpwatch: new station 10.247.4.137 52:54:00:88:5a:0a eth0.4 # Aug 24 17:37:19 juno arpwatch: changed ethernet address 10.247.4.137 52:54:00:27:33:00 (52:54:00:88:5a:0a) eth0.4 # Check if another ip_command string was provided ip_command_global=service.ip_command.nil? ? 'grep $mac /var/log/arpwatch.log|sed -e "s/new station//"|sed -e "s/changed ethernet address//g" |sed -e "s/reused old ethernet //" |tail -1 |cut -d ":" -f 4-| cut -d " " -f 3' : service.ip_command ip_command_local=options[:ip_command].nil? ? ip_command_global : options[:ip_command] ip_command="mac=#{mac}; server_name=#{name}; "+ip_command_local ip_address=nil if service.uri.ssh_enabled? # Retrieve the parts we need from the service to setup our ssh options user=service.uri.user #could be nil host=service.uri.host keyfile=service.uri.keyfile port=service.uri.port # Setup the options ssh_options={} ssh_options[:keys]=[ keyfile ] unless keyfile.nil? ssh_options[:port]=port unless keyfile.nil? ssh_options[:paranoid]=true if service.uri.no_verify? begin result=Fog::SSH.new(host, user, ssh_options).run(ip_command) rescue Errno::ECONNREFUSED raise Fog::Errors::Error.new("Connection was refused to host #{host} to retrieve the ip_address for #{mac}") rescue Net::SSH::AuthenticationFailed raise Fog::Errors::Error.new("Error authenticating over ssh to host #{host} and user #{user}") end # Check for a clean exit code if result.first.status == 0 ip_address=result.first.stdout.strip else # We got a failure executing the command raise Fog::Errors::Error.new("The command #{ip_command} failed to execute with a clean exit code") end else # It's not ssh enabled, so we assume it is if service.uri.transport=="tls" raise Fog::Errors::Error.new("TlS remote transport is not currently supported, only ssh") end # Execute the ip_command locally # Initialize empty ip_address string ip_address="" IO.popen("#{ip_command}") do |p| p.each_line do |l| ip_address+=l end status=Process.waitpid2(p.pid)[1].exitstatus if status!=0 raise Fog::Errors::Error.new("The command #{ip_command} failed to execute with a clean exit code") end end #Strip any new lines from the string ip_address=ip_address.chomp end # The Ip-address command has been run either local or remote now if ip_address=="" #The grep didn't find an ip address result" ip_address=nil else # To be sure that the command didn't return another random string # We check if the result is an actual ip-address # otherwise we return nil unless ip_address=~/^(\d{1,3}\.){3}\d{1,3}$/ raise Fog::Errors::Error.new( "The result of #{ip_command} does not have valid ip-address format\n"+ "Result was: #{ip_address}\n" ) end end return { :public => [ip_address], :private => [ip_address]} end
create_or_clone_volume()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 330 def create_or_clone_volume options = {:name => volume_name || default_volume_name} # Check if a disk template was specified if volume_template_name template_volume = service.volumes.all(:name => volume_template_name).first raise Fog::Errors::Error.new("Template #{volume_template_name} not found") unless template_volume begin volume = template_volume.clone("#{options[:name]}") rescue => e raise Fog::Errors::Error.new("Error creating the volume : #{e}") end else # If no template volume was given, let's create our own volume options[:pool_name] = volume_pool_name if volume_pool_name options[:format_type] = volume_format_type if volume_format_type options[:capacity] = volume_capacity if volume_capacity options[:allocation] = volume_allocation if volume_allocation begin volume = service.volumes.create(options) rescue => e raise Fog::Errors::Error.new("Error creating the volume : #{e}") end end @volumes.nil? ? @volumes = [volume] : @volumes << volume end
default_boot_order()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 383 def default_boot_order %w[hd cdrom network] end
default_display()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 395 def default_display {:port => '-1', :listen => '127.0.0.1', :type => 'vnc', :password => '' } end
default_iso_dir()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 357 def default_iso_dir "/var/lib/libvirt/images" end
default_volume_name()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 361 def default_volume_name "#{name}.#{volume_format_type || 'img'}" end
defaults()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 365 def defaults { :persistent => true, :cpus => 1, :memory_size => 256 *1024, :name => randomized_name, :os_type => "hvm", :arch => "x86_64", :domain_type => "kvm", :iso_dir => default_iso_dir, :network_interface_type => "network", :network_nat_network => "default", :network_bridge_name => "br0", :boot_order => default_boot_order, :display => default_display } end
initialize_nics()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 316 def initialize_nics if nics nics.map! { |nic| nic.is_a?(Hash) ? service.nics.new(nic) : nic } else self.nics = [service.nics.new({:type => network_interface_type, :bridge => network_bridge_name, :network => network_nat_network})] end end
initialize_volumes()
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 324 def initialize_volumes if attributes[:volumes] && !attributes[:volumes].empty? @volumes = attributes[:volumes].map { |vol| vol.is_a?(Hash) ? service.volumes.new(vol) : vol } end end
ip_address(key)
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 312 def ip_address(key) addresses[key].nil? ? nil : addresses[key].first end
verify_boot_order(order = [])
click to toggle source
# File lib/fog/libvirt/models/compute/server.rb, line 387 def verify_boot_order order = [] if order order.each do |b| raise "invalid boot order, possible values are: hd, network and/or cdrom" unless default_boot_order.include?(b) end end end