Class/Module Index [+]

Quicksearch

Fog::Compute::OpenStack::Server

Attributes

flavor_ref[W]
image_ref[W]
nics[W]
os_scheduler_hints[W]
password[R]

Public Class Methods

new(attributes={}) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 46
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)

  super
end

Public Instance Methods

all_addresses() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 90
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.
  @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/models/compute/server.rb, line 219
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/models/compute/server.rb, line 258
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/models/compute/server.rb, line 147
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/models/compute/server.rb, line 171
def confirm_resize
  requires :id
  service.confirm_resize_server(id)
  true
end
console(log_length = nil) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 204
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/models/compute/server.rb, line 199
def create_image(name, metadata={})
  requires :id
  service.create_image(id, name, metadata)
end
destroy() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 79
def destroy
  requires :id
  service.delete_server(id)
  true
end
detach_volume(volume_id) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 264
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/models/compute/server.rb, line 224
def disassociate_address(floating_ip)
  requires :id
  service.disassociate_address id, floating_ip
end
flavor_ref() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 135
def flavor_ref
  @flavor_ref
end
floating_ip_address() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 113
def floating_ip_address
  floating_ip_addresses.first
end
Also aliased as: public_ip_address
floating_ip_addresses() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 107
def floating_ip_addresses
  all_addresses.map{|addr| addr["ip"]}
end
Also aliased as: public_ip_addresses
image_ref() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 127
def image_ref
  @image_ref
end
images() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 85
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/models/compute/server.rb, line 103
def ip_addresses
  addresses.values.flatten.map{|x| x['addr']}
end
live_migrate(host, block_migration, disk_over_commit) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 214
def live_migrate(host, block_migration, disk_over_commit)
  requires :id
  service.live_migrate_server(id, host, block_migration, disk_over_commit)
end
max_count=(new_max_count) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 238
def max_count=(new_max_count)
  @max_count = new_max_count
end
metadata() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 59
def metadata
  @metadata ||= begin
    Fog::Compute::OpenStack::Metadata.new({
      :service => service,
      :parent => self
    })
  end
end
metadata=(new_metadata={}) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 68
def metadata=(new_metadata={})
  return unless new_metadata
  metas = []
  new_metadata.each_pair {|k,v| metas << {"key" => k, "value" => v} }
  @metadata = metadata.load(metas)
end
migrate() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 209
def migrate
  requires :id
  service.migrate_server(id)
end
min_count=(new_min_count) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 234
def min_count=(new_min_count)
  @min_count = new_min_count
end
networks() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 242
def networks
  service.networks(:server => self)
end
private_ip_address() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 123
def private_ip_address
  private_ip_addresses.first
end
private_ip_addresses() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 119
def private_ip_addresses
  ip_addresses - floating_ip_addresses
end
public_ip_address() click to toggle source
Alias for: floating_ip_address
public_ip_addresses() click to toggle source
ready?() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 143
def ready?
  self.state == 'ACTIVE'
end
reboot(type = 'SOFT') click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 193
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/models/compute/server.rb, line 153
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
# File lib/fog/openstack/models/compute/server.rb, line 96
def reload
  @all_addresses = nil
  super
end
reset_vm_state(vm_state) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 229
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/models/compute/server.rb, line 159
def resize(flavor_ref)
  requires :id
  service.resize_server(id, flavor_ref)
  true
end
revert_resize() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 165
def revert_resize
  requires :id
  service.revert_resize_server(id)
  true
end
save() click to toggle source

TODO: Implement /os-volumes-boot support with 'block_device_mapping'

# File lib/fog/openstack/models/compute/server.rb, line 271
def save
  raise Fog::Errors::Error.new('Resaving an existing object may create a duplicate') if persisted?
  requires :flavor_ref, :image_ref, :name
  options = {
    'personality' => personality,
    'accessIPv4' => accessIPv4,
    'accessIPv6' => accessIPv6,
    'availability_zone' => availability_zone,
    'user_data' => user_data_encoded,
    'key_name'    => key_name,
    'security_groups' => @security_groups,
    'min_count'   => @min_count,
    'max_count'   => @max_count,
    'nics' => @nics,
    'os:scheduler_hints' => @os_scheduler_hints,
  }
  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/models/compute/server.rb, line 177
def security_groups
  requires :id

  groups = service.list_security_groups(id).body['security_groups']

  groups.map do |group|
    sg = Fog::Compute::OpenStack::SecurityGroup.new group
    sg.connection = service
    sg
  end
end
security_groups=(new_security_groups) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 189
def security_groups=(new_security_groups)
  @security_groups = new_security_groups
end
setup(credentials = {}) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 294
def setup(credentials = {})
  requires :public_ip_address, :identity, :public_key, :username
  Fog::SSH.new(public_ip_address, username, credentials).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
user_data=(ascii_userdata) click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 75
def user_data=(ascii_userdata)
  self.user_data_encoded = [ascii_userdata].pack('m')
end
volume_attachments() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 253
def volume_attachments
  requires :id
  service.get_server_volumes(id).body['volumeAttachments']
end
volumes() click to toggle source
# File lib/fog/openstack/models/compute/server.rb, line 246
def volumes
  requires :id
  service.volumes.find_all do |vol|
    vol.attachments.find { |attachment| attachment["serverId"] == id }
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.