class SoftLayer::VirtualDiskImage

Each SoftLayer VirtualDiskImage instance provides information about software installed on a specific piece of hardware.

This class roughly corresponds to the entity SoftLayer_Virtual_Disk_Image in the API.

Attributes

capacity[R]

A disk image's size measured in gigabytes.

checksum[R]

A disk image's unique md5 checksum.

created[R]

The date a disk image was created. DEPRECATION WARNING: This attribute is deprecated in favor of #created_at and will be removed in the next major release.

created_at[R]

The date a disk image was created.

description[R]

A brief description of a virtual disk image.

modified[R]

The date a disk image was last modified. DEPRECATION WARNING: This attribute is deprecated in favor of #modified_at and will be removed in the next major release.

modified_at[R]

The date a disk image was last modified.

name[R]

A descriptive name used to identify a disk image to a user.

units[R]

The unit of storage in which the size of the image is measured. Defaults to “GB” for gigabytes.

uuid[R]

A disk image's unique ID on a virtualization platform.

Public Class Methods

image_with_id(image_id, options = {}) click to toggle source

Retrieve the virtual disk image with the given image ID from the API

The options parameter should contain:

:client - The client used to connect to the API

If no client is given, then the routine will try to use SoftLayer::Client.default_client If no client can be found the routine will raise an error.

The options may include the following keys

:object_mask (string) - A object mask of properties, in addition to the default properties, that you wish to retrieve for the image

# File lib/softlayer/VirtualDiskImage.rb, line 204
def self.image_with_id(image_id, options = {})
  softlayer_client = options[:client] || Client.default_client
  raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client

  vdi_service = softlayer_client[:Virtual_Disk_Image]
  vdi_service = vdi_service.object_mask(default_object_mask.to_sl_object_mask)

  if options.has_key?(:object_mask)
    vdi_service = vdi_service.object_mask(options[:object_mask])
  end

  image_data = vdi_service.object_with_id(image_id).getObject()

  return VirtualDiskImage.new(softlayer_client, image_data)
end

Protected Class Methods

default_object_mask() click to toggle source

# File lib/softlayer/VirtualDiskImage.rb, line 222
def self.default_object_mask
  {
    "mask(SoftLayer_Virtual_Disk_Image)" => [
                                             'capacity',
                                             'checksum',
                                             'createDate',
                                             'description',
                                             'id',
                                             'modifyDate',
                                             'name',
                                             'units',
                                             'uuid'
                                            ]
  }.to_sl_object_mask
end

Public Instance Methods

coalesced_disk_images(force_update=false) click to toggle source

Retrieve coalesced disk images associated with this virtual disk image

# File lib/softlayer/VirtualDiskImage.rb, line 77
sl_dynamic_attr :coalesced_disk_images do |resource|
  resource.should_update? do
    #only retrieved once per instance
    @coalesced_disk_images == nil
  end

  resource.to_update do
    coalesced_disk_images = self.service.getCoalescedDiskImages
    coalesced_disk_images.collect { |coalesced_disk_image| VirtualDiskImage.new(softlayer_client, coalesced_disk_image) }
  end
end

local_disk(force_update=false) click to toggle source

Retrieve local disk flag associated with virtual disk image

# File lib/softlayer/VirtualDiskImage.rb, line 93
sl_dynamic_attr :local_disk do |resource|
  resource.should_update? do
    #only retrieved once per instance
    @local_disk == nil
  end

  resource.to_update do
    self.service.getLocalDiskFlag
  end
end

metadata(force_update=false) click to toggle source

Retrieve metadata as to whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order.

# File lib/softlayer/VirtualDiskImage.rb, line 109
sl_dynamic_attr :metadata do |resource|
  resource.should_update? do
    #only retrieved once per instance
    @metadata == nil
  end

  resource.to_update do
    self.service.getMetadataFlag
  end
end

service() click to toggle source

Returns the service for interacting with this virtual disk image through the network API

# File lib/softlayer/VirtualDiskImage.rb, line 187
def service
  softlayer_client[:Virtual_Disk_Image].object_with_id(self.id)
end

software(force_update=false) click to toggle source

Retrieve the references to the software that resides on a disk image.

# File lib/softlayer/VirtualDiskImage.rb, line 124
sl_dynamic_attr :software do |resource|
  resource.should_update? do
    #only retrieved once per instance
    @software == nil
  end

  resource.to_update do
    software_references = self.service.object_mask(VirtualDiskImageSoftware.default_object_mask).getSoftwareReferences
    software_references.collect { |software| VirtualDiskImageSoftware.new(softlayer_client, software) unless software.empty? }.compact
  end
end

source_disk_image(force_update=false) click to toggle source

Retrieve the original disk image that the current disk image was cloned from.

# File lib/softlayer/VirtualDiskImage.rb, line 140
sl_dynamic_attr :source_disk_image do |resource|
  resource.should_update? do
    #only retrieved once per instance
    @source_disk_image == nil
  end

  resource.to_update do
    source_disk_image = self.service.object_mask(VirtualDiskImage.default_object_mask).getSourceDiskImage
    VirtualDiskImage.new(softlayer_client, source_disk_image) unless source_disk_image.empty?
  end
end

type_description(force_update=false) click to toggle source

Retrieve a brief description of a virtual disk image type's function.

# File lib/softlayer/VirtualDiskImage.rb, line 156
sl_dynamic_attr :type_description do |resource|
  resource.should_update? do
    #only retrieved once per instance
    @type_description == nil
  end

  resource.to_update do
    type = self.service.getType
    type['description']
  end
end

type_name(force_update=false) click to toggle source

Retrieve a virtual disk image type's name.

# File lib/softlayer/VirtualDiskImage.rb, line 172
sl_dynamic_attr :type_name do |resource|
  resource.should_update? do
    #only retrieved once per instance
    @type_name == nil
  end

  resource.to_update do
    type = self.service.getType
    type['name']
  end
end