class Fog::Compute::Vsphere::Volume

Constants

DISK_SIZE_TO_GB

Public Class Methods

new(attributes={}) click to toggle source
Calls superclass method
# File lib/fog/vsphere/models/compute/volume.rb, line 22
def initialize(attributes={})
  super defaults.merge(attributes)
end

Public Instance Methods

destroy() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 47
def destroy
  requires :server_id, :key, :unit_number

  service.destroy_vm_volume(self)
  true
end
detach() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 39
def detach
  requires :server_id, :key, :unit_number

  service.remove_vm_volume(self)
  server.volumes -= [self]
  true
end
save() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 54
def save
  raise Fog::Errors::Error.new('Resaving an existing object may create a duplicate') if persisted?
  requires :server_id, :size, :datastore

  set_unit_number

  data = service.add_vm_volume(self)

  if data['task_state'] == 'success'
    if self.unit_number >= 7
      self.unit_number += 1
    end

    # We have to query vSphere to get the volume attributes since the task handle doesn't include that info.
    created = server.volumes.all.find { |volume| volume.unit_number == self.unit_number }

    # example of "created" =>
    #   <Fog::Compute::Vsphere::Volume
    #     id="6000C295-576f-0e2d-5b70-c778cd108b3a",
    #     datastore="datastore1",
    #     storage_pod=nil,
    #     mode="persistent",
    #     size=10485760,
    #     thin=true,
    #     eager_zero=nil,
    #     name="Hard disk 2",
    #     filename="[datastore1] testvm/testvm_2.vmdk",
    #     size_gb=10,
    #     key=2004,
    #     unit_number=2,
    #     controller_key=1000
    #   >
    self.id = created.id
    self.key = created.key
    self.controller_key = created.controller_key
    self.filename = created.filename

    true
  else
    false
  end
end
server_id() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 97
def server_id
  requires :server
  server.id
end
set_key() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 115
def set_key
  requires :controller_key, :unit_number

  return unless key.nil?

  # controller key is based on 1000 + controller bus
  # disk key is based on 2000 + the SCSI ID + the controller bus * 16
  controller_bus = controller_key - 1000
  self.key = 2000 + (controller_bus * 16) + unit_number
end
set_unit_number() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 102
def set_unit_number
  # When adding volumes to vsphere, if our unit_number is 7 or higher, vsphere will increment the unit_number
  # This is due to SCSI ID 7 being reserved for the pvscsi controller
  # When referring to a volume that already added using a unit_id of 7 or higher, we must refer to the actual SCSI ID
  if unit_number.nil?
    self.unit_number = calculate_free_unit_number
  else
    if server.volumes.select { |vol| vol.controller_key == controller_key }.any? { |volume| volume.unit_number == self.unit_number && volume.id != self.id }
      raise "A volume already exists with that unit_number, so we can't save the new volume"
    end
  end
end
size_gb() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 26
def size_gb
  attributes[:size_gb] ||= attributes[:size].to_i / DISK_SIZE_TO_GB if attributes[:size]
end
size_gb=(s) click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 30
def size_gb= s
  attributes[:size] = s.to_i * DISK_SIZE_TO_GB if s
  attributes[:size_gb] = s.to_i if s
end
to_s() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 35
def to_s
  name
end

Private Instance Methods

calculate_free_unit_number() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 137
def calculate_free_unit_number
  requires :controller_key

  # Vsphere maps unit_numbers 7 and greater to a higher SCSI ID since the pvscsi driver reserves SCSI ID 7
  used_unit_numbers = server.volumes
    .select { |vol| vol.unit_number && vol.controller_key == controller_key }.map(&:unit_number) + [7]
  free_unit_numbers = (0..15).to_a - used_unit_numbers

  free_unit_numbers.first
end
defaults() click to toggle source
# File lib/fog/vsphere/models/compute/volume.rb, line 128
def defaults
  {
    :thin => true,
    :name => "Hard disk",
    :mode => "persistent",
    :controller_key => 1000
  }
end