class Fog::OpenStack::Compute::Server
Attributes
block_device_mapping[RW]
block_device_mapping_v2[RW]
flavor_ref[RW]
image_ref[RW]
max_count[W]
min_count[W]
nics[W]
os_scheduler_hints[W]
password[R]
project[RW]
In some cases it's handy to be able to store the project for the record, e.g. swift doesn't contain project info in the result, so we can track it in this attribute based on what project was used in the request
security_groups[W]
Public Class Methods
new(attributes = {})
click to toggle source
Calls superclass method
# File lib/fog/openstack/compute/models/server.rb, line 60 def initialize(attributes = {}) # Old 'connection' is renamed as service and should be used instead prepare_service_value(attributes) self.security_groups = attributes.delete(:security_groups) self.min_count = attributes.delete(:min_count) self.max_count = attributes.delete(:max_count) self.nics = attributes.delete(:nics) self.os_scheduler_hints = attributes.delete(:os_scheduler_hints) self.block_device_mapping = attributes.delete(:block_device_mapping) self.block_device_mapping_v2 = attributes.delete(:block_device_mapping_v2) super end
Public Instance Methods
all_addresses()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 104 def all_addresses # currently openstack API does not tell us what is a floating ip vs a fixed ip for the vm listing, # we fall back to get all addresses and filter sadly. # Only includes manually-assigned addresses, not auto-assigned @all_addresses ||= service.list_all_addresses.body["floating_ips"].select { |data| data['instance_id'] == id } end
associate_address(floating_ip)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 319 def associate_address(floating_ip) requires :id service.associate_address id, floating_ip end
attach_volume(volume_id, device_name)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 354 def attach_volume(volume_id, device_name) requires :id service.attach_volume(volume_id, id, device_name) true end
change_password(admin_password)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 199 def change_password(admin_password) requires :id service.change_server_password(id, admin_password) true end
confirm_resize()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 223 def confirm_resize requires :id service.confirm_resize_server(id) true end
console(log_length = nil)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 299 def console(log_length = nil) requires :id service.get_console_output(id, log_length) end
create_image(name, metadata = {})
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 294 def create_image(name, metadata = {}) requires :id service.create_image(id, name, metadata) end
destroy()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 93 def destroy requires :id service.delete_server(id) true end
detach_volume(volume_id)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 360 def detach_volume(volume_id) requires :id service.detach_volume(id, volume_id) true end
disassociate_address(floating_ip)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 324 def disassociate_address(floating_ip) requires :id service.disassociate_address id, floating_ip end
evacuate(host = nil, on_shared_storage = nil, admin_password = nil)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 314 def evacuate(host = nil, on_shared_storage = nil, admin_password = nil) requires :id service.evacuate_server(id, host, on_shared_storage, admin_password) end
failed?()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 195 def failed? state == 'ERROR' end
floating_ip_address()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 165 def floating_ip_address floating_ip_addresses.first end
floating_ip_addresses()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 127 def floating_ip_addresses all_floating = if addresses flattened_values = addresses.values.flatten flattened_values.select { |d| d["OS-EXT-IPS:type"] == "floating" }.collect { |a| a["addr"] } else [] end # Return them all, leading with manually assigned addresses manual = all_addresses.collect { |addr| addr["ip"] } all_floating.sort do |a, b| a_manual = manual.include? a b_manual = manual.include? b if a_manual && !b_manual -1 elsif !a_manual && b_manual 1 else 0 end end all_floating.empty? ? manual : all_floating end
images()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 99 def images requires :id service.images(:server => self) end
ip_addresses()
click to toggle source
returns all ip_addresses
for a given instance this includes both the fixed ip(s) and the floating ip(s)
# File lib/fog/openstack/compute/models/server.rb, line 123 def ip_addresses addresses ? addresses.values.flatten.collect { |x| x['addr'] } : [] end
live_migrate(host, block_migration, disk_over_commit)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 309 def live_migrate(host, block_migration, disk_over_commit) requires :id service.live_migrate_server(id, host, block_migration, disk_over_commit) end
metadata()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 75 def metadata @metadata ||= begin Fog::OpenStack::Compute::Metadata.new(:service => service, :parent => self) end end
metadata=(new_metadata = {})
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 82 def metadata=(new_metadata = {}) return unless new_metadata metas = [] new_metadata.each { |k, v| metas << {"key" => k, "value" => v} } @metadata = metadata.load(metas) end
migrate()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 304 def migrate requires :id service.migrate_server(id) end
networks()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 338 def networks service.networks(:server => self) end
os_interfaces()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 111 def os_interfaces requires :id service.os_interfaces(:server => self) end
pause()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 256 def pause requires :id service.pause_server(id) end
private_ip_address()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 179 def private_ip_address private_ip_addresses.first end
private_ip_addresses()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 173 def private_ip_addresses rfc1918_regexp = /(^10\.|^172\.1[6-9]\.|^172\.2[0-9]\.|^172.3[0-1]\.|^192\.168\.)/ almost_private = ip_addresses - public_ip_addresses - floating_ip_addresses almost_private.select { |ip| rfc1918_regexp.match ip } end
public_ip_address()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 169 def public_ip_address public_ip_addresses.first end
public_ip_addresses()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 153 def public_ip_addresses if floating_ip_addresses.empty? if addresses addresses.select { |s| s[0] =~ /public/i }.collect { |a| a[1][0]['addr'] } else [] end else floating_ip_addresses end end
ready?()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 191 def ready? state == 'ACTIVE' end
reboot(type = 'SOFT')
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 245 def reboot(type = 'SOFT') requires :id service.reboot_server(id, type) true end
rebuild(image_ref, name, admin_pass = nil, metadata = nil, personality = nil)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 205 def rebuild(image_ref, name, admin_pass = nil, metadata = nil, personality = nil) requires :id service.rebuild_server(id, image_ref, name, admin_pass, metadata, personality) true end
reload()
click to toggle source
Calls superclass method
# File lib/fog/openstack/compute/models/server.rb, line 116 def reload @all_addresses = nil super end
reset_vm_state(vm_state)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 329 def reset_vm_state(vm_state) requires :id service.reset_server_state id, vm_state end
resize(flavor_ref)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 211 def resize(flavor_ref) requires :id service.resize_server(id, flavor_ref) true end
revert_resize()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 217 def revert_resize requires :id service.revert_resize_server(id) true end
save()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 366 def save raise Fog::Errors::Error, 'Resaving an existing object may create a duplicate' if persisted? requires :flavor_ref, :name requires_one :image_ref, :block_device_mapping, :block_device_mapping_v2 options = { 'personality' => personality, 'accessIPv4' => accessIPv4, 'accessIPv6' => accessIPv6, 'availability_zone' => availability_zone, 'user_data' => user_data_encoded, 'key_name' => key_name, 'config_drive' => config_drive, 'security_groups' => @security_groups, 'min_count' => @min_count, 'max_count' => @max_count, 'nics' => @nics, 'os:scheduler_hints' => @os_scheduler_hints, 'block_device_mapping' => @block_device_mapping, 'block_device_mapping_v2' => @block_device_mapping_v2, } options['metadata'] = metadata.to_hash unless @metadata.nil? options = options.reject { |_key, value| value.nil? } data = service.create_server(name, image_ref, flavor_ref, options) merge_attributes(data.body['server']) true end
security_groups()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 229 def security_groups if id requires :id groups = service.list_security_groups(:server_id => id).body['security_groups'] groups.map do |group| Fog::OpenStack::Compute::SecurityGroup.new group.merge(:service => service) end else service.security_groups.all end end
setup(credentials = {})
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 393 def setup(credentials = {}) requires :ssh_ip_address, :identity, :public_key, :username ssh = Fog::SSH.new(ssh_ip_address, username, credentials) ssh.run([ %(mkdir .ssh), %(echo "#{public_key}" >> ~/.ssh/authorized_keys), %(passwd -l #{username}), %(echo "#{Fog::JSON.encode(attributes)}" >> ~/attributes.json), %(echo "#{Fog::JSON.encode(metadata)}" >> ~/metadata.json) ]) rescue Errno::ECONNREFUSED sleep(1) retry end
shelve()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 279 def shelve requires :id service.shelve_server(id) end
shelve_offload()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 289 def shelve_offload requires :id service.shelve_offload_server(id) end
start()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 266 def start requires :id case state.downcase when 'paused' service.unpause_server(id) when 'suspended' service.resume_server(id) else service.start_server(id) end end
stop()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 251 def stop requires :id service.stop_server(id) end
suspend()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 261 def suspend requires :id service.suspend_server(id) end
unshelve()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 284 def unshelve requires :id service.unshelve_server(id) end
user_data=(ascii_userdata)
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 89 def user_data=(ascii_userdata) self.user_data_encoded = [ascii_userdata].pack('m0') if ascii_userdata end
volume_attachments()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 349 def volume_attachments requires :id service.get_server_volumes(id).body['volumeAttachments'] end
volumes()
click to toggle source
# File lib/fog/openstack/compute/models/server.rb, line 342 def volumes requires :id service.volumes.select do |vol| vol.attachments.find { |attachment| attachment["serverId"] == id } end end