Class: OpenNebula::Image
- Inherits:
-
PoolElement
- Object
- XMLElement
- PoolElement
- OpenNebula::Image
- 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", :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}
- SHORT_IMAGE_TYPES =
{ "OS" => "OS", "CDROM" => "CD", "DATABLOCK" => "DB", "KERNEL" => "KL", "RAMDISK" => "RD", "CONTEXT" => "CX" }
- DISK_TYPES =
%w{FILE CD_ROM BLOCK RBD}
Class Method Summary collapse
-
.build_xml(pe_id = nil) ⇒ Object
Creates an Image description with just its identifier this method should be used to create plain Image objects.
Instance Method Summary collapse
-
#allocate(description, ds_id, check_capacity = true) ⇒ nil, OpenNebula::Error
Allocates a new Image in OpenNebula.
-
#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.
-
#chmod_octet(octet) ⇒ nil, OpenNebula::Error
Changes the Image permissions.
-
#chown(uid, gid) ⇒ Object
- Changes the owner/group uid
-
Integer the new owner id.
-
#chtype(type) ⇒ nil, OpenNebula::Error
Changes the Image type.
-
#clone(name, target_ds = -1)) ⇒ Integer, OpenNebula::Error
Clones this Image into a new one.
-
#delete ⇒ Object
Deletes the Image.
-
#disable ⇒ Object
Disables an Image.
-
#enable ⇒ Object
Enables an Image.
-
#gid ⇒ Object
Returns the group identifier [return] Integer the element’s group ID.
-
#info ⇒ Object
(also: #info!)
Retrieves the information of the given Image.
-
#initialize(xml, client) ⇒ Image
constructor
Class constructor.
- #lock(level) ⇒ Object
-
#nonpersistent ⇒ Object
Makes the Image non persistent.
-
#persistent ⇒ Object
Makes the Image persistent.
- #public? ⇒ Boolean
-
#publish ⇒ Object
Publishes the Image, to be used by other users.
-
#rename(name) ⇒ nil, OpenNebula::Error
Renames this Image.
-
#short_state_str ⇒ Object
Returns the state of the Image (string value).
-
#short_type_str ⇒ Object
Returns the state of the Image (string value).
-
#snapshot_delete(snap_id) ⇒ nil, OpenNebula::Error
Deletes Image from snapshot.
-
#snapshot_flatten(snap_id) ⇒ nil, OpenNebula::Error
Flattens an image snapshot.
-
#snapshot_revert(snap_id) ⇒ nil, OpenNebula::Error
Reverts Image state to a previous snapshot.
-
#state ⇒ Object
Returns the state of the Image (numeric value).
-
#state_str ⇒ Object
Returns the state of the Image (string value).
-
#type ⇒ Object
Returns the type of the Image (numeric value).
-
#type_str ⇒ Object
Returns the type of the Image (string value).
- #unlock ⇒ Object
-
#unpublish ⇒ Object
Unplubishes the Image.
-
#update(new_template = nil, append = false) ⇒ nil, OpenNebula::Error
Replaces the template contents.
Methods inherited from PoolElement
#id, #name, 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
94 95 96 97 98 |
# File 'lib/opennebula/image.rb', line 94 def initialize(xml, client) super(xml,client) @client = client end |
Class Method Details
.build_xml(pe_id = nil) ⇒ Object
83 84 85 86 87 88 89 90 91 |
# File 'lib/opennebula/image.rb', line 83 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
118 119 120 |
# File 'lib/opennebula/image.rb', line 118 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
191 192 193 194 195 |
# File 'lib/opennebula/image.rb', line 191 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.
182 183 184 |
# File 'lib/opennebula/image.rb', line 182 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
173 174 175 |
# File 'lib/opennebula/image.rb', line 173 def chown(uid, gid) super(IMAGE_METHODS[:chown], uid, gid) end |
#chtype(type) ⇒ nil, OpenNebula::Error
Changes the Image type
201 202 203 204 205 206 207 208 |
# File 'lib/opennebula/image.rb', line 201 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
216 217 218 219 220 221 222 |
# File 'lib/opennebula/image.rb', line 216 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 ⇒ Object
Deletes the Image
165 166 167 |
# File 'lib/opennebula/image.rb', line 165 def delete() super(IMAGE_METHODS[:delete]) end |
#disable ⇒ Object
Disables an Image
140 141 142 |
# File 'lib/opennebula/image.rb', line 140 def disable set_enabled(false) end |
#enable ⇒ Object
Enables an Image
135 136 137 |
# File 'lib/opennebula/image.rb', line 135 def enable set_enabled(true) end |
#gid ⇒ Object
Returns the group identifier
- return
-
Integer the element’s group ID
297 298 299 |
# File 'lib/opennebula/image.rb', line 297 def gid self['GID'].to_i end |
#info ⇒ Object Also known as: info!
Retrieves the information of the given Image.
105 106 107 |
# File 'lib/opennebula/image.rb', line 105 def info() super(IMAGE_METHODS[:info], 'IMAGE') end |
#lock(level) ⇒ Object
301 302 303 |
# File 'lib/opennebula/image.rb', line 301 def lock(level) return call(IMAGE_METHODS[:lock], @pe_id, level) end |
#nonpersistent ⇒ Object
Makes the Image non persistent
160 161 162 |
# File 'lib/opennebula/image.rb', line 160 def nonpersistent set_persistent(false) end |
#persistent ⇒ Object
Makes the Image persistent
155 156 157 |
# File 'lib/opennebula/image.rb', line 155 def persistent set_persistent(true) end |
#public? ⇒ Boolean
309 310 311 312 313 314 315 |
# File 'lib/opennebula/image.rb', line 309 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
145 146 147 |
# File 'lib/opennebula/image.rb', line 145 def publish set_publish(true) end |
#rename(name) ⇒ nil, OpenNebula::Error
Renames this Image
230 231 232 |
# File 'lib/opennebula/image.rb', line 230 def rename(name) return call(IMAGE_METHODS[:rename], @pe_id, name) end |
#short_state_str ⇒ Object
Returns the state of the Image (string value)
276 277 278 |
# File 'lib/opennebula/image.rb', line 276 def short_state_str SHORT_IMAGE_STATES[state_str] end |
#short_type_str ⇒ Object
Returns the state of the Image (string value)
291 292 293 |
# File 'lib/opennebula/image.rb', line 291 def short_type_str SHORT_IMAGE_TYPES[type_str] end |
#snapshot_delete(snap_id) ⇒ nil, OpenNebula::Error
Deletes Image from snapshot
239 240 241 |
# File 'lib/opennebula/image.rb', line 239 def snapshot_delete(snap_id) return call(IMAGE_METHODS[:snapshotdelete], @pe_id, snap_id) end |
#snapshot_flatten(snap_id) ⇒ nil, OpenNebula::Error
Flattens an image snapshot
257 258 259 |
# File 'lib/opennebula/image.rb', line 257 def snapshot_flatten(snap_id) return call(IMAGE_METHODS[:snapshotflatten], @pe_id, snap_id) end |
#snapshot_revert(snap_id) ⇒ nil, OpenNebula::Error
Reverts Image state to a previous snapshot
248 249 250 |
# File 'lib/opennebula/image.rb', line 248 def snapshot_revert(snap_id) return call(IMAGE_METHODS[:snapshotrevert], @pe_id, snap_id) end |
#state ⇒ Object
Returns the state of the Image (numeric value)
266 267 268 |
# File 'lib/opennebula/image.rb', line 266 def state self['STATE'].to_i end |
#state_str ⇒ Object
Returns the state of the Image (string value)
271 272 273 |
# File 'lib/opennebula/image.rb', line 271 def state_str IMAGE_STATES[state] end |
#type ⇒ Object
Returns the type of the Image (numeric value)
281 282 283 |
# File 'lib/opennebula/image.rb', line 281 def type self['TYPE'].to_i end |
#type_str ⇒ Object
Returns the type of the Image (string value)
286 287 288 |
# File 'lib/opennebula/image.rb', line 286 def type_str IMAGE_TYPES[type] end |
#unlock ⇒ Object
305 306 307 |
# File 'lib/opennebula/image.rb', line 305 def unlock() return call(IMAGE_METHODS[:unlock], @pe_id) end |
#unpublish ⇒ Object
Unplubishes the Image
150 151 152 |
# File 'lib/opennebula/image.rb', line 150 def unpublish set_publish(false) end |
#update(new_template = nil, append = false) ⇒ nil, OpenNebula::Error
Replaces the template contents
130 131 132 |
# File 'lib/opennebula/image.rb', line 130 def update(new_template=nil, append=false) super(IMAGE_METHODS[:update], new_template, append ? 1 : 0) end |