Class: OpenNebula::Image

Inherits:
PoolElement show all
Defined in:
lib/opennebula/image.rb

Constant Summary collapse

IMAGE_METHODS =

Constants and Class Methods

{
    :info       => "image.info",
    :allocate   => "image.allocate",
    :update     => "image.update",
    :enable     => "image.enable",
    :persistent => "image.persistent",
    :delete     => "image.delete",
    :chown      => "image.chown",
    :chmod      => "image.chmod",
    :chtype     => "image.chtype",
    :clone      => "image.clone",
    :rename     => "image.rename",
    :snapshotdelete  => "image.snapshotdelete",
    :snapshotrevert  => "image.snapshotrevert",
    :snapshotflatten => "image.snapshotflatten",
    :restore    => "image.restore",
    :lock       => "image.lock",
    :unlock     => "image.unlock"
}
IMAGE_STATES = 
%w{INIT READY USED DISABLED LOCKED ERROR CLONE DELETE
USED_PERS LOCKED_USED LOCKED_USED_PERS}
SHORT_IMAGE_STATES = 
{
    "INIT"      => "init",
    "READY"     => "rdy",
    "USED"      => "used",
    "DISABLED"  => "disa",
    "LOCKED"    => "lock",
    "ERROR"     => "err",
    "CLONE"     => "clon",
    "DELETE"    => "dele",
    "USED_PERS" => "used",
    "LOCKED_USED" => "lock",
    "LOCKED_USED_PERS" => "lock"
}
IMAGE_TYPES = 
%w{OS CDROM DATABLOCK KERNEL RAMDISK CONTEXT BACKUP}
SHORT_IMAGE_TYPES = 
{
    "OS"        => "OS",
    "CDROM"     => "CD",
    "DATABLOCK" => "DB",
    "KERNEL"    => "KL",
    "RAMDISK"   => "RD",
    "CONTEXT"   => "CX",
    "BACKUP"    => "BK"
}
DISK_TYPES = 
%w{FILE CD_ROM BLOCK RBD}

Instance Attribute Summary

Attributes inherited from PoolElement

#name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PoolElement

#id, new_with_id, #replace, #to_str

Methods inherited from XMLElement

#[], #add_element, #attr, #delete_element, #each, #each_xpath, #element_xml, #has_elements?, #initialize_xml, #name, #retrieve_elements, #retrieve_xmlelements, #set_content, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml, #xml_nil?

Constructor Details

#initialize(xml, client) ⇒ Image

Class constructor



97
98
99
100
101
 
# File 'lib/opennebula/image.rb', line 97

def initialize(xml, client)
    LockableExt.make_lockable(self, IMAGE_METHODS)

    super(xml,client)
end

Class Method Details

.build_xml(pe_id = nil) ⇒ Object

Creates an Image description with just its identifier this method should be used to create plain Image objects. id the id of the image

Example:

image = Image.new(Image.build_xml(3),rpc_client)



86
87
88
89
90
91
92
93
94
 
# File 'lib/opennebula/image.rb', line 86

def Image.build_xml(pe_id=nil)
    if pe_id
        image_xml = "<IMAGE><ID>#{pe_id}</ID></IMAGE>"
    else
        image_xml = "<IMAGE></IMAGE>"
    end

    XMLElement.build_xml(image_xml,'IMAGE')
end

Instance Method Details

#allocate(description, ds_id, check_capacity = true) ⇒ nil, OpenNebula::Error

Allocates a new Image in OpenNebula

Parameters:

  • description (String) —

    A string containing the template of the Image.

  • ds_id (Integer) —

    the target datastore ID

Returns:



121
122
123
 
# File 'lib/opennebula/image.rb', line 121

def allocate(description, ds_id, check_capacity=true)
    super(IMAGE_METHODS[:allocate],description, ds_id, check_capacity)
end

#chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u, other_m, other_a) ⇒ nil, OpenNebula::Error

Changes the Image permissions. Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change

Returns:



194
195
196
197
198
 
# File 'lib/opennebula/image.rb', line 194

def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
        other_m, other_a)
    super(IMAGE_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
        group_m, group_a, other_u, other_m, other_a)
end

#chmod_octet(octet) ⇒ nil, OpenNebula::Error

Changes the Image permissions.

Parameters:

  • octet (String) —

    Permissions octed , e.g. 640

Returns:



185
186
187
 
# File 'lib/opennebula/image.rb', line 185

def chmod_octet(octet)
    super(IMAGE_METHODS[:chmod], octet)
end

#chown(uid, gid) ⇒ Object

Changes the owner/group

uid

Integer the new owner id. Set to -1 to leave the current one

gid

Integer the new group id. Set to -1 to leave the current one

return

nil in case of success or an Error object



176
177
178
 
# File 'lib/opennebula/image.rb', line 176

def chown(uid, gid)
    super(IMAGE_METHODS[:chown], uid, gid)
end

#chtype(type) ⇒ nil, OpenNebula::Error

Changes the Image type

Parameters:

  • type (String) —

    new Image type

Returns:



204
205
206
207
208
209
210
211
 
# File 'lib/opennebula/image.rb', line 204

def chtype(type)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(IMAGE_METHODS[:chtype], @pe_id, type)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#clone(name, target_ds = -1)) ⇒ Integer, OpenNebula::Error

Clones this Image into a new one

Parameters:

  • name (String) —

    for the new Image.

Returns:

  • (Integer, OpenNebula::Error) —

    The new Image ID in case of success, Error otherwise



219
220
221
222
223
224
225
 
# File 'lib/opennebula/image.rb', line 219

def clone(name, target_ds=-1)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(IMAGE_METHODS[:clone], @pe_id, name, target_ds)

    return rc
end

#delete(force = false) ⇒ Object

Deletes the Image



168
169
170
 
# File 'lib/opennebula/image.rb', line 168

def delete(force=false)
    call(IMAGE_METHODS[:delete], @pe_id, force)
end

#disable ⇒ Object

Disables an Image



143
144
145
 
# File 'lib/opennebula/image.rb', line 143

def disable
    set_enabled(false)
end

#enable ⇒ Object

Enables an Image



138
139
140
 
# File 'lib/opennebula/image.rb', line 138

def enable
    set_enabled(true)
end

#gid ⇒ Object

Returns the group identifier

return

Integer the element’s group ID



308
309
310
 
# File 'lib/opennebula/image.rb', line 308

def gid
    self['GID'].to_i
end

#info(decrypt = false) ⇒ Object Also known as: info!

Retrieves the information of the given Image.



108
109
110
 
# File 'lib/opennebula/image.rb', line 108

def info(decrypt = false)
    super(IMAGE_METHODS[:info], 'IMAGE', decrypt)
end

#nonpersistent ⇒ Object

Makes the Image non persistent



163
164
165
 
# File 'lib/opennebula/image.rb', line 163

def nonpersistent
    set_persistent(false)
end

#persistent ⇒ Object

Makes the Image persistent



158
159
160
 
# File 'lib/opennebula/image.rb', line 158

def persistent
    set_persistent(true)
end

#public? ⇒ Boolean

Returns:

  • (Boolean) 


312
313
314
315
316
317
318
 
# File 'lib/opennebula/image.rb', line 312

def public?
    if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
        true
    else
        false
    end
end

#publish ⇒ Object

Publishes the Image, to be used by other users



148
149
150
 
# File 'lib/opennebula/image.rb', line 148

def publish
    set_publish(true)
end

#rename(name) ⇒ nil, OpenNebula::Error

Renames this Image

Parameters:

  • name (String) —

    New name for the Image.

Returns:



233
234
235
 
# File 'lib/opennebula/image.rb', line 233

def rename(name)
    call(IMAGE_METHODS[:rename], @pe_id, name)
end

#restore(dst_id, restore_opts) ⇒ Object

Restore the VM backup stored by the image

Parameters:

  • dst_id (Integer) —

    Datastore destination ID

  • restore_opts (String) —

    Template with additional restore options



268
269
270
 
# File 'lib/opennebula/image.rb', line 268

def restore(dst_id, restore_opts)
    @client.call(IMAGE_METHODS[:restore], @pe_id, dst_id, restore_opts)
end

#short_state_str ⇒ Object

Returns the state of the Image (string value)



287
288
289
 
# File 'lib/opennebula/image.rb', line 287

def short_state_str
    SHORT_IMAGE_STATES[state_str]
end

#short_type_str ⇒ Object

Returns the state of the Image (string value)



302
303
304
 
# File 'lib/opennebula/image.rb', line 302

def short_type_str
    SHORT_IMAGE_TYPES[type_str]
end

#snapshot_delete(snap_id) ⇒ nil, OpenNebula::Error

Deletes Image from snapshot

Parameters:

  • snap_id (Integer) —

    ID of the snapshot to delete

Returns:



242
243
244
 
# File 'lib/opennebula/image.rb', line 242

def snapshot_delete(snap_id)
    call(IMAGE_METHODS[:snapshotdelete], @pe_id, snap_id)
end

#snapshot_flatten(snap_id) ⇒ nil, OpenNebula::Error

Flattens an image snapshot

Parameters:

  • snap_id (Integer) —

    ID of the snapshot to flatten

Returns:



260
261
262
 
# File 'lib/opennebula/image.rb', line 260

def snapshot_flatten(snap_id)
    call(IMAGE_METHODS[:snapshotflatten], @pe_id, snap_id)
end

#snapshot_revert(snap_id) ⇒ nil, OpenNebula::Error

Reverts Image state to a previous snapshot

Parameters:

  • snap_id (Integer) —

    ID of the snapshot to revert to

Returns:



251
252
253
 
# File 'lib/opennebula/image.rb', line 251

def snapshot_revert(snap_id)
    call(IMAGE_METHODS[:snapshotrevert], @pe_id, snap_id)
end

#state ⇒ Object

Returns the state of the Image (numeric value)



277
278
279
 
# File 'lib/opennebula/image.rb', line 277

def state
    self['STATE'].to_i
end

#state_str ⇒ Object

Returns the state of the Image (string value)



282
283
284
 
# File 'lib/opennebula/image.rb', line 282

def state_str
    IMAGE_STATES[state]
end

#type ⇒ Object

Returns the type of the Image (numeric value)



292
293
294
 
# File 'lib/opennebula/image.rb', line 292

def type
    self['TYPE'].to_i
end

#type_str ⇒ Object

Returns the type of the Image (string value)



297
298
299
 
# File 'lib/opennebula/image.rb', line 297

def type_str
    IMAGE_TYPES[type]
end

#unpublish ⇒ Object

Unplubishes the Image



153
154
155
 
# File 'lib/opennebula/image.rb', line 153

def unpublish
    set_publish(false)
end

#update(new_template = nil, append = false) ⇒ nil, OpenNebula::Error

Replaces the template contents

Parameters:

  • new_template (String) (defaults to: nil) —

    New template contents

  • append (true, false) (defaults to: false) —

    True to append new attributes instead of replace the whole template

Returns:



133
134
135
 
# File 'lib/opennebula/image.rb', line 133

def update(new_template=nil, append=false)
    super(IMAGE_METHODS[:update], new_template, append ? 1 : 0)
end

#wait_state(state, timeout = 120) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/opennebula/image.rb', line 320

def wait_state(state, timeout=120)
    require 'opennebula/wait_ext'

    extend OpenNebula::WaitExt

    rc = wait(state, timeout)

    return Error.new("Timeout expired for state #{state}.") unless rc

    true
end