Class: OpenNebula::VirtualMachine
- Inherits:
-
PoolElement
- Object
- XMLElement
- PoolElement
- OpenNebula::VirtualMachine
- Defined in:
- lib/opennebula/virtual_machine.rb
Defined Under Namespace
Modules: Driver
Constant Summary collapse
- VM_METHODS =
Constants and Class Methods
{ :info => "vm.info", :allocate => "vm.allocate", :action => "vm.action", :migrate => "vm.migrate", :deploy => "vm.deploy", :chown => "vm.chown", :chmod => "vm.chmod", :monitoring => "vm.monitoring", :attach => "vm.attach", :detach => "vm.detach", :rename => "vm.rename", :update => "vm.update", :resize => "vm.resize", :snapshotcreate => "vm.snapshotcreate", :snapshotrevert => "vm.snapshotrevert", :snapshotdelete => "vm.snapshotdelete", :attachnic => "vm.attachnic", :detachnic => "vm.detachnic", :recover => "vm.recover", :disksaveas => "vm.disksaveas", :disksnapshotcreate => "vm.disksnapshotcreate", :disksnapshotrevert => "vm.disksnapshotrevert", :disksnapshotdelete => "vm.disksnapshotdelete", :disksnapshotrename => "vm.disksnapshotrename", :diskresize => "vm.diskresize", :updateconf => "vm.updateconf", :lock => "vm.lock", :unlock => "vm.unlock", :schedadd => "vm.schedadd", :scheddelete => "vm.scheddelete", :schedupdate => "vm.schedupdate", :attachsg => "vm.attachsg", :detachsg => "vm.detachsg" }
- VM_STATE =
%w{INIT PENDING HOLD ACTIVE STOPPED SUSPENDED DONE FAILED POWEROFF UNDEPLOYED CLONING CLONING_FAILURE}
- LCM_STATE =
%w{ LCM_INIT PROLOG BOOT RUNNING MIGRATE SAVE_STOP SAVE_SUSPEND SAVE_MIGRATE PROLOG_MIGRATE PROLOG_RESUME EPILOG_STOP EPILOG SHUTDOWN CANCEL FAILURE CLEANUP_RESUBMIT UNKNOWN HOTPLUG SHUTDOWN_POWEROFF BOOT_UNKNOWN BOOT_POWEROFF BOOT_SUSPENDED BOOT_STOPPED CLEANUP_DELETE HOTPLUG_SNAPSHOT HOTPLUG_NIC HOTPLUG_SAVEAS HOTPLUG_SAVEAS_POWEROFF HOTPLUG_SAVEAS_SUSPENDED SHUTDOWN_UNDEPLOY EPILOG_UNDEPLOY PROLOG_UNDEPLOY BOOT_UNDEPLOY HOTPLUG_PROLOG_POWEROFF HOTPLUG_EPILOG_POWEROFF BOOT_MIGRATE BOOT_FAILURE BOOT_MIGRATE_FAILURE PROLOG_MIGRATE_FAILURE PROLOG_FAILURE EPILOG_FAILURE EPILOG_STOP_FAILURE EPILOG_UNDEPLOY_FAILURE PROLOG_MIGRATE_POWEROFF PROLOG_MIGRATE_POWEROFF_FAILURE PROLOG_MIGRATE_SUSPEND PROLOG_MIGRATE_SUSPEND_FAILURE BOOT_UNDEPLOY_FAILURE BOOT_STOPPED_FAILURE PROLOG_RESUME_FAILURE PROLOG_UNDEPLOY_FAILURE DISK_SNAPSHOT_POWEROFF DISK_SNAPSHOT_REVERT_POWEROFF DISK_SNAPSHOT_DELETE_POWEROFF DISK_SNAPSHOT_SUSPENDED DISK_SNAPSHOT_REVERT_SUSPENDED DISK_SNAPSHOT_DELETE_SUSPENDED DISK_SNAPSHOT DISK_SNAPSHOT_REVERT DISK_SNAPSHOT_DELETE PROLOG_MIGRATE_UNKNOWN PROLOG_MIGRATE_UNKNOWN_FAILURE DISK_RESIZE DISK_RESIZE_POWEROFF DISK_RESIZE_UNDEPLOYED HOTPLUG_NIC_POWEROFF HOTPLUG_RESIZE HOTPLUG_SAVEAS_UNDEPLOYED HOTPLUG_SAVEAS_STOPPED }
- SHORT_VM_STATES =
{ "INIT" => "init", "PENDING" => "pend", "HOLD" => "hold", "ACTIVE" => "actv", "STOPPED" => "stop", "SUSPENDED" => "susp", "DONE" => "done", "FAILED" => "fail", "POWEROFF" => "poff", "UNDEPLOYED" => "unde", "CLONING" => "clon", "CLONING_FAILURE" => "fail" }
- SHORT_LCM_STATES =
{ "PROLOG" => "prol", "BOOT" => "boot", "RUNNING" => "runn", "MIGRATE" => "migr", "SAVE_STOP" => "save", "SAVE_SUSPEND" => "save", "SAVE_MIGRATE" => "save", "PROLOG_MIGRATE" => "migr", "PROLOG_RESUME" => "prol", "EPILOG_STOP" => "epil", "EPILOG" => "epil", "SHUTDOWN" => "shut", "CANCEL" => "shut", "FAILURE" => "fail", "CLEANUP_RESUBMIT" => "clea", "UNKNOWN" => "unkn", "HOTPLUG" => "hotp", "SHUTDOWN_POWEROFF" => "shut", "BOOT_UNKNOWN" => "boot", "BOOT_POWEROFF" => "boot", "BOOT_SUSPENDED" => "boot", "BOOT_STOPPED" => "boot", "CLEANUP_DELETE" => "clea", "HOTPLUG_SNAPSHOT" => "snap", "HOTPLUG_NIC" => "hotp", "HOTPLUG_SAVEAS" => "hotp", "HOTPLUG_SAVEAS_POWEROFF" => "hotp", "HOTPLUG_SAVEAS_SUSPENDED" => "hotp", "SHUTDOWN_UNDEPLOY" => "shut", "EPILOG_UNDEPLOY" => "epil", "PROLOG_UNDEPLOY" => "prol", "BOOT_UNDEPLOY" => "boot", "HOTPLUG_PROLOG_POWEROFF" => "hotp", "HOTPLUG_EPILOG_POWEROFF" => "hotp", "BOOT_MIGRATE" => "boot", "BOOT_FAILURE" => "fail", "BOOT_MIGRATE_FAILURE" => "fail", "PROLOG_MIGRATE_FAILURE" => "fail", "PROLOG_FAILURE" => "fail", "EPILOG_FAILURE" => "fail", "EPILOG_STOP_FAILURE" => "fail", "EPILOG_UNDEPLOY_FAILURE" => "fail", "PROLOG_MIGRATE_POWEROFF" => "migr", "PROLOG_MIGRATE_POWEROFF_FAILURE" => "fail", "PROLOG_MIGRATE_SUSPEND" => "migr", "PROLOG_MIGRATE_SUSPEND_FAILURE" => "fail", "BOOT_UNDEPLOY_FAILURE" => "fail", "BOOT_STOPPED_FAILURE" => "fail", "PROLOG_RESUME_FAILURE" => "fail", "PROLOG_UNDEPLOY_FAILURE" => "fail", "DISK_SNAPSHOT_POWEROFF" => "snap", "DISK_SNAPSHOT_REVERT_POWEROFF" => "snap", "DISK_SNAPSHOT_DELETE_POWEROFF" => "snap", "DISK_SNAPSHOT_SUSPENDED" => "snap", "DISK_SNAPSHOT_REVERT_SUSPENDED"=> "snap", "DISK_SNAPSHOT_DELETE_SUSPENDED"=> "snap", "DISK_SNAPSHOT" => "snap", "DISK_SNAPSHOT_DELETE" => "snap", "PROLOG_MIGRATE_UNKNOWN" => "migr", "PROLOG_MIGRATE_UNKNOWN_FAILURE" => "fail", "DISK_RESIZE" => "drsz", "DISK_RESIZE_POWEROFF" => "drsz", "DISK_RESIZE_UNDEPLOYED" => "drsz", "HOTPLUG_NIC_POWEROFF" => "hotp", "HOTPLUG_RESIZE" => "hotp", "HOTPLUG_SAVEAS_UNDEPLOYED" => "hotp", "HOTPLUG_SAVEAS_STOPPED" => "hotp" }
- HISTORY_ACTION =
%w{none migrate live-migrate shutdown shutdown-hard undeploy undeploy-hard hold release stop suspend resume boot delete delete-recreate reboot reboot-hard resched unresched poweroff poweroff-hard disk-attach disk-detach nic-attach nic-detach disk-snapshot-create disk-snapshot-delete terminate terminate-hard disk-resize deploy chown chmod updateconf rename resize update snapshot-resize snapshot-delete snapshot-revert disk-saveas disk-snapshot-revert recover retry monitor disk-snapshot-rename alias-attach alias-detach poweroff-migrate poweroff-hard-migrate }
- EXTERNAL_IP_ATTRS =
[ 'GUEST_IP', 'AWS_IP_ADDRESS', 'AWS_PUBLIC_IP_ADDRESS', 'AWS_PRIVATE_IP_ADDRESS', 'AZ_IPADDRESS', 'SL_PRIMARYIPADDRESS' ]
Class Method Summary collapse
-
.build_xml(pe_id = nil) ⇒ Object
Creates a VirtualMachine description with just its identifier this method should be used to create plain VirtualMachine objects.
- .get_history_action(action) ⇒ Object
Instance Method Summary collapse
-
#allocate(description, hold = false) ⇒ nil, OpenNebula::Error
Allocates a new VirtualMachine 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 permissions.
-
#chmod_octet(octet) ⇒ nil, OpenNebula::Error
Changes the permissions.
-
#chown(uid, gid) ⇒ Object
- Changes the owner/group uid
-
Integer the new owner id.
-
#delete(recreate = false) ⇒ Object
Deletes a VM from the pool.
-
#deploy(host_id, enforce = false, ds_id = -1,, extra_template = "") ⇒ nil, OpenNebula::Error
Initiates the instance of the VM on the target host.
-
#deploy_id ⇒ Object
Returns the deploy_id of the VirtualMachine (numeric value).
-
#disk_attach(disk_template) ⇒ nil, OpenNebula::Error
(also: #attachdisk)
Attaches a disk to a running VM.
-
#disk_detach(disk_id) ⇒ nil, OpenNebula::Error
(also: #detachdisk)
Detaches a disk from a running VM.
-
#disk_resize(disk_id, size) ⇒ nil, OpenNebula::Error
Changes the size of a disk.
-
#disk_saveas(disk_id, image_name, image_type = "", snap_id = -1)) ⇒ Integer, OpenNebula::Error
Set the specified vm’s disk to be saved as a new image.
-
#disk_snapshot_create(disk_id, name) ⇒ Integer, OpenNebula::Error
Takes a new snapshot of a disk.
-
#disk_snapshot_delete(disk_id, snap_id) ⇒ nil, OpenNebula::Error
Deletes a disk snapshot.
-
#disk_snapshot_rename(disk_id, snap_id, new_name) ⇒ nil, OpenNebula::Error
Renames a disk snapshot.
-
#disk_snapshot_revert(disk_id, snap_id) ⇒ nil, OpenNebula::Error
Reverts disk state to a previously taken snapshot.
- #get_history_record(seq) ⇒ Object
-
#gid ⇒ Object
Returns the group identifier [return] Integer the element’s group ID.
-
#hold ⇒ Object
Sets a VM to hold state, scheduler will not deploy it.
-
#info(decrypt = false) ⇒ Object
(also: #info!)
Retrieves the information of the given VirtualMachine.
-
#initialize(xml, client) ⇒ VirtualMachine
constructor
Class constructor.
-
#lcm_state ⇒ Object
Returns the LCM state of the VirtualMachine (numeric value).
-
#lcm_state_str ⇒ Object
Returns the LCM state of the VirtualMachine (string value).
-
#live_migrate(host_id, enforce = false) ⇒ Object
deprecated
Deprecated.
use #migrate instead
-
#migrate(host_id, live = false, enforce = false, ds_id = -1,, mtype = 0) ⇒ nil, OpenNebula::Error
Moves a running VM to the specified host.
-
#monitoring(xpath_expressions) ⇒ Hash<String, Array<Array<int>>>, OpenNebula::Error
Retrieves this VM’s monitoring data from OpenNebula.
-
#monitoring_xml ⇒ String
Retrieves this VM’s monitoring data from OpenNebula, in XML.
-
#nic_attach(nic_template) ⇒ nil, OpenNebula::Error
Attaches a NIC to a running VM.
-
#nic_detach(nic_id) ⇒ nil, OpenNebula::Error
Detaches a NIC from a running VM.
-
#poweroff(hard = false) ⇒ Object
Powers off a running VM.
-
#reboot(hard = false) ⇒ Object
Reboots an already deployed VM.
-
#recover(result) ⇒ nil, OpenNebula::Error
Recovers an ACTIVE VM.
-
#release ⇒ Object
Releases a VM from hold state.
-
#rename(name) ⇒ nil, OpenNebula::Error
Renames this VM.
- #replace(opts = {}) ⇒ Object
-
#resched ⇒ Object
Sets the re-scheduling flag for the VM.
-
#resize(capacity_template, enforce) ⇒ nil, OpenNebula::Error
Resize the VM.
-
#resume ⇒ Object
Resumes the execution of a saved VM.
-
#sched_action_add(sched_template) ⇒ nil, OpenNebula::Error
Add sched actions.
-
#sched_action_delete(sched_id) ⇒ nil, OpenNebula::Error
Delete sched action.
-
#sched_action_update(sched_id, sched_template) ⇒ nil, OpenNebula::Error
Update sched_action.
-
#sg_attach(nic_id, sg_id) ⇒ nil, OpenNebula::Error
Attaches a Security Groupt to a running VM.
-
#sg_detach(nic_id, sg_id) ⇒ nil, OpenNebula::Error
Detaches a Security Group from a running VM.
-
#snapshot_create(name = "") ⇒ Integer, OpenNebula::Error
Creates a new VM snapshot.
-
#snapshot_delete(snap_id) ⇒ nil, OpenNebula::Error
Deletes a VM snapshot.
-
#snapshot_revert(snap_id) ⇒ nil, OpenNebula::Error
Reverts to a snapshot.
-
#state ⇒ Object
Returns the VM state of the VirtualMachine (numeric value).
-
#state_str ⇒ Object
Returns the VM state of the VirtualMachine (string value).
-
#status ⇒ Object
Returns the short status string for the VirtualMachine.
-
#stop ⇒ Object
Stops a running VM.
-
#suspend ⇒ Object
Saves a running VM.
-
#terminate(hard = false) ⇒ Object
(also: #shutdown)
Shutdowns an already deployed VM.
-
#undeploy(hard = false) ⇒ Object
Shuts down an already deployed VM, saving its state in the system DS.
-
#unresched ⇒ Object
Unsets the re-scheduling flag for the VM.
-
#update(new_template = nil, append = false) ⇒ nil, OpenNebula::Error
Replaces the template contents.
-
#updateconf(new_conf, append = false) ⇒ nil, OpenNebula::Error
Changes the attributes of a VM in power off, failure and undeploy states.
-
#user_template_str(indent = true) ⇒ String
Returns the <USER_TEMPLATE> element in text form.
-
#user_template_xml ⇒ String
Returns the <USER_TEMPLATE> element in XML form.
- #wait_state(state, timeout = 120) ⇒ Object
- #wait_state2(state, lcm_state, timeout = 120) ⇒ Object
Methods inherited from PoolElement
#id, #name, new_with_id, #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) ⇒ VirtualMachine
Class constructor
285 286 287 288 289 |
# File 'lib/opennebula/virtual_machine.rb', line 285 def initialize(xml, client) LockableExt.make_lockable(self, VM_METHODS) super(xml,client) end |
Class Method Details
.build_xml(pe_id = nil) ⇒ Object
Creates a VirtualMachine description with just its identifier this method should be used to create plain VirtualMachine objects. id
the id of the vm
Example:
vm = VirtualMachine.new(VirtualMachine.build_xml(3),rpc_client)
270 271 272 273 274 275 276 277 278 |
# File 'lib/opennebula/virtual_machine.rb', line 270 def VirtualMachine.build_xml(pe_id=nil) if pe_id vm_xml = "<VM><ID>#{pe_id}</ID></VM>" else vm_xml = "<VM></VM>" end XMLElement.build_xml(vm_xml, 'VM') end |
.get_history_action(action) ⇒ Object
280 281 282 |
# File 'lib/opennebula/virtual_machine.rb', line 280 def VirtualMachine.get_history_action(action) return HISTORY_ACTION[action.to_i] end |
Instance Method Details
#allocate(description, hold = false) ⇒ nil, OpenNebula::Error
Allocates a new VirtualMachine in OpenNebula
311 312 313 |
# File 'lib/opennebula/virtual_machine.rb', line 311 def allocate(description, hold=false) super(VM_METHODS[:allocate], description, hold) 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 permissions. Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
584 585 586 587 588 |
# File 'lib/opennebula/virtual_machine.rb', line 584 def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u, other_m, other_a) super(VM_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 permissions.
575 576 577 |
# File 'lib/opennebula/virtual_machine.rb', line 575 def chmod_octet(octet) super(VM_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
566 567 568 |
# File 'lib/opennebula/virtual_machine.rb', line 566 def chown(uid, gid) super(VM_METHODS[:chown], uid, gid) end |
#delete(recreate = false) ⇒ Object
Deletes a VM from the pool
729 730 731 732 733 734 735 |
# File 'lib/opennebula/virtual_machine.rb', line 729 def delete(recreate=false) if recreate recover(4) else recover(3) end end |
#deploy(host_id, enforce = false, ds_id = -1,, extra_template = "") ⇒ nil, OpenNebula::Error
Initiates the instance of the VM on the target host.
363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'lib/opennebula/virtual_machine.rb', line 363 def deploy(host_id, enforce=false, ds_id=-1, extra_template="") enforce ||= false ds_id ||= -1 extra_template ||= "" self.info return call(VM_METHODS[:deploy], @pe_id, host_id.to_i, enforce, ds_id.to_i, extra_template) end |
#deploy_id ⇒ Object
Returns the deploy_id of the VirtualMachine (numeric value)
824 825 826 |
# File 'lib/opennebula/virtual_machine.rb', line 824 def deploy_id self['DEPLOY_ID'] end |
#disk_attach(disk_template) ⇒ nil, OpenNebula::Error Also known as: attachdisk
Attaches a disk to a running VM
430 431 432 |
# File 'lib/opennebula/virtual_machine.rb', line 430 def disk_attach(disk_template) return call(VM_METHODS[:attach], @pe_id, disk_template) end |
#disk_detach(disk_id) ⇒ nil, OpenNebula::Error Also known as: detachdisk
Detaches a disk from a running VM
441 442 443 |
# File 'lib/opennebula/virtual_machine.rb', line 441 def disk_detach(disk_id) return call(VM_METHODS[:detach], @pe_id, disk_id) end |
#disk_resize(disk_id, size) ⇒ nil, OpenNebula::Error
Changes the size of a disk
713 714 715 |
# File 'lib/opennebula/virtual_machine.rb', line 713 def disk_resize(disk_id, size) return call(VM_METHODS[:diskresize], @pe_id, disk_id, size.to_s) end |
#disk_saveas(disk_id, image_name, image_type = "", snap_id = -1)) ⇒ Integer, OpenNebula::Error
Set the specified vm’s disk to be saved as a new image
current disk image state
535 536 537 538 539 540 541 542 543 544 545 |
# File 'lib/opennebula/virtual_machine.rb', line 535 def disk_saveas(disk_id, image_name, image_type="", snap_id=-1) return Error.new('ID not defined') if !@pe_id rc = @client.call(VM_METHODS[:disksaveas], @pe_id, disk_id, image_name, image_type, snap_id) return rc end |
#disk_snapshot_create(disk_id, name) ⇒ Integer, OpenNebula::Error
Takes a new snapshot of a disk
669 670 671 |
# File 'lib/opennebula/virtual_machine.rb', line 669 def disk_snapshot_create(disk_id, name) return call(VM_METHODS[:disksnapshotcreate], @pe_id, disk_id, name) end |
#disk_snapshot_delete(disk_id, snap_id) ⇒ nil, OpenNebula::Error
Deletes a disk snapshot
691 692 693 |
# File 'lib/opennebula/virtual_machine.rb', line 691 def disk_snapshot_delete(disk_id, snap_id) return call(VM_METHODS[:disksnapshotdelete], @pe_id, disk_id, snap_id) end |
#disk_snapshot_rename(disk_id, snap_id, new_name) ⇒ nil, OpenNebula::Error
Renames a disk snapshot
703 704 705 |
# File 'lib/opennebula/virtual_machine.rb', line 703 def disk_snapshot_rename(disk_id, snap_id, new_name) return call(VM_METHODS[:disksnapshotrename], @pe_id, disk_id, snap_id, new_name) end |
#disk_snapshot_revert(disk_id, snap_id) ⇒ nil, OpenNebula::Error
Reverts disk state to a previously taken snapshot
680 681 682 |
# File 'lib/opennebula/virtual_machine.rb', line 680 def disk_snapshot_revert(disk_id, snap_id) return call(VM_METHODS[:disksnapshotrevert], @pe_id, disk_id, snap_id) end |
#get_history_record(seq) ⇒ Object
828 829 830 |
# File 'lib/opennebula/virtual_machine.rb', line 828 def get_history_record(seq) retrieve_xmlelements('//HISTORY')[seq].to_xml end |
#gid ⇒ Object
Returns the group identifier
- return
-
Integer the element’s group ID
819 820 821 |
# File 'lib/opennebula/virtual_machine.rb', line 819 def gid self['GID'].to_i end |
#hold ⇒ Object
Sets a VM to hold state, scheduler will not deploy it
401 402 403 |
# File 'lib/opennebula/virtual_machine.rb', line 401 def hold action('hold') end |
#info(decrypt = false) ⇒ Object Also known as: info!
Retrieves the information of the given VirtualMachine.
296 297 298 |
# File 'lib/opennebula/virtual_machine.rb', line 296 def info(decrypt = false) super(VM_METHODS[:info], 'VM', decrypt) end |
#lcm_state ⇒ Object
Returns the LCM state of the VirtualMachine (numeric value)
797 798 799 |
# File 'lib/opennebula/virtual_machine.rb', line 797 def lcm_state self['LCM_STATE'].to_i end |
#lcm_state_str ⇒ Object
Returns the LCM state of the VirtualMachine (string value)
802 803 804 |
# File 'lib/opennebula/virtual_machine.rb', line 802 def lcm_state_str LCM_STATE[lcm_state] end |
#live_migrate(host_id, enforce = false) ⇒ Object
use #migrate instead
519 520 521 |
# File 'lib/opennebula/virtual_machine.rb', line 519 def live_migrate(host_id, enforce=false) migrate(host_id, true, enforce) end |
#migrate(host_id, live = false, enforce = false, ds_id = -1,, mtype = 0) ⇒ nil, OpenNebula::Error
Moves a running VM to the specified host. With live=true the migration is done withdout downtime.
513 514 515 516 |
# File 'lib/opennebula/virtual_machine.rb', line 513 def migrate(host_id, live=false, enforce=false, ds_id=-1, mtype=0) call(VM_METHODS[:migrate], @pe_id, host_id.to_i, live==true, enforce, ds_id.to_i, mtype) end |
#monitoring(xpath_expressions) ⇒ Hash<String, Array<Array<int>>>, OpenNebula::Error
Retrieves this VM’s monitoring data from OpenNebula
607 608 609 |
# File 'lib/opennebula/virtual_machine.rb', line 607 def monitoring(xpath_expressions) return super(VM_METHODS[:monitoring], xpath_expressions) end |
#monitoring_xml ⇒ String
Retrieves this VM’s monitoring data from OpenNebula, in XML
614 615 616 617 618 |
# File 'lib/opennebula/virtual_machine.rb', line 614 def monitoring_xml() return Error.new('ID not defined') if !@pe_id return @client.call(VM_METHODS[:monitoring], @pe_id) end |
#nic_attach(nic_template) ⇒ nil, OpenNebula::Error
Attaches a NIC to a running VM
452 453 454 |
# File 'lib/opennebula/virtual_machine.rb', line 452 def nic_attach(nic_template) return call(VM_METHODS[:attachnic], @pe_id, nic_template) end |
#nic_detach(nic_id) ⇒ nil, OpenNebula::Error
Detaches a NIC from a running VM
461 462 463 |
# File 'lib/opennebula/virtual_machine.rb', line 461 def nic_detach(nic_id) return call(VM_METHODS[:detachnic], @pe_id, nic_id) end |
#poweroff(hard = false) ⇒ Object
Powers off a running VM
391 392 393 |
# File 'lib/opennebula/virtual_machine.rb', line 391 def poweroff(hard=false) action(hard ? 'poweroff-hard' : 'poweroff') end |
#reboot(hard = false) ⇒ Object
Reboots an already deployed VM
396 397 398 |
# File 'lib/opennebula/virtual_machine.rb', line 396 def reboot(hard=false) action(hard ? 'reboot-hard' : 'reboot') end |
#recover(result) ⇒ nil, OpenNebula::Error
Recovers an ACTIVE VM
retry (2), delete (3), delete-recreate (4), delete-db (5)
724 725 726 |
# File 'lib/opennebula/virtual_machine.rb', line 724 def recover(result) return call(VM_METHODS[:recover], @pe_id, result) end |
#release ⇒ Object
Releases a VM from hold state
406 407 408 |
# File 'lib/opennebula/virtual_machine.rb', line 406 def release action('release') end |
#rename(name) ⇒ nil, OpenNebula::Error
Renames this VM
626 627 628 |
# File 'lib/opennebula/virtual_machine.rb', line 626 def rename(name) return call(VM_METHODS[:rename], @pe_id, name) end |
#replace(opts = {}) ⇒ Object
347 348 349 |
# File 'lib/opennebula/virtual_machine.rb', line 347 def replace(opts = {}) super(opts, "USER_TEMPLATE") end |
#resched ⇒ Object
Sets the re-scheduling flag for the VM
485 486 487 |
# File 'lib/opennebula/virtual_machine.rb', line 485 def resched action('resched') end |
#resize(capacity_template, enforce) ⇒ nil, OpenNebula::Error
Resize the VM
558 559 560 |
# File 'lib/opennebula/virtual_machine.rb', line 558 def resize(capacity_template, enforce) return call(VM_METHODS[:resize], @pe_id, capacity_template, enforce) end |
#resume ⇒ Object
Resumes the execution of a saved VM
421 422 423 |
# File 'lib/opennebula/virtual_machine.rb', line 421 def resume action('resume') end |
#sched_action_add(sched_template) ⇒ nil, OpenNebula::Error
Add sched actions
758 759 760 |
# File 'lib/opennebula/virtual_machine.rb', line 758 def sched_action_add(sched_template) return call(VM_METHODS[:schedadd], @pe_id, sched_template) end |
#sched_action_delete(sched_id) ⇒ nil, OpenNebula::Error
Delete sched action
767 768 769 |
# File 'lib/opennebula/virtual_machine.rb', line 767 def sched_action_delete(sched_id) return call(VM_METHODS[:scheddelete], @pe_id, sched_id.to_i) end |
#sched_action_update(sched_id, sched_template) ⇒ nil, OpenNebula::Error
Update sched_action
777 778 779 780 |
# File 'lib/opennebula/virtual_machine.rb', line 777 def sched_action_update(sched_id, sched_template) return call(VM_METHODS[:schedupdate], @pe_id, sched_id.to_i, sched_template) end |
#sg_attach(nic_id, sg_id) ⇒ nil, OpenNebula::Error
Attaches a Security Groupt to a running VM
471 472 473 |
# File 'lib/opennebula/virtual_machine.rb', line 471 def sg_attach(nic_id, sg_id) return call(VM_METHODS[:attachsg], @pe_id, nic_id, sg_id) end |
#sg_detach(nic_id, sg_id) ⇒ nil, OpenNebula::Error
Detaches a Security Group from a running VM
480 481 482 |
# File 'lib/opennebula/virtual_machine.rb', line 480 def sg_detach(nic_id, sg_id) return call(VM_METHODS[:detachsg], @pe_id, nic_id, sg_id) end |
#snapshot_create(name = "") ⇒ Integer, OpenNebula::Error
Creates a new VM snapshot
636 637 638 639 640 641 |
# File 'lib/opennebula/virtual_machine.rb', line 636 def snapshot_create(name="") return Error.new('ID not defined') if !@pe_id name ||= "" return @client.call(VM_METHODS[:snapshotcreate], @pe_id, name) end |
#snapshot_delete(snap_id) ⇒ nil, OpenNebula::Error
Deletes a VM snapshot
659 660 661 |
# File 'lib/opennebula/virtual_machine.rb', line 659 def snapshot_delete(snap_id) return call(VM_METHODS[:snapshotdelete], @pe_id, snap_id) end |
#snapshot_revert(snap_id) ⇒ nil, OpenNebula::Error
Reverts to a snapshot
649 650 651 |
# File 'lib/opennebula/virtual_machine.rb', line 649 def snapshot_revert(snap_id) return call(VM_METHODS[:snapshotrevert], @pe_id, snap_id) end |
#state ⇒ Object
Returns the VM state of the VirtualMachine (numeric value)
787 788 789 |
# File 'lib/opennebula/virtual_machine.rb', line 787 def state self['STATE'].to_i end |
#state_str ⇒ Object
Returns the VM state of the VirtualMachine (string value)
792 793 794 |
# File 'lib/opennebula/virtual_machine.rb', line 792 def state_str VM_STATE[state] end |
#status ⇒ Object
Returns the short status string for the VirtualMachine
807 808 809 810 811 812 813 814 815 |
# File 'lib/opennebula/virtual_machine.rb', line 807 def status short_state_str=SHORT_VM_STATES[state_str] if short_state_str=="actv" short_state_str=SHORT_LCM_STATES[lcm_state_str] end short_state_str end |
#stop ⇒ Object
Stops a running VM
411 412 413 |
# File 'lib/opennebula/virtual_machine.rb', line 411 def stop action('stop') end |
#suspend ⇒ Object
Saves a running VM
416 417 418 |
# File 'lib/opennebula/virtual_machine.rb', line 416 def suspend action('suspend') end |
#terminate(hard = false) ⇒ Object Also known as: shutdown
Shutdowns an already deployed VM
379 380 381 |
# File 'lib/opennebula/virtual_machine.rb', line 379 def terminate(hard=false) action(hard ? 'terminate-hard' : 'terminate') end |
#undeploy(hard = false) ⇒ Object
Shuts down an already deployed VM, saving its state in the system DS
386 387 388 |
# File 'lib/opennebula/virtual_machine.rb', line 386 def undeploy(hard=false) action(hard ? 'undeploy-hard' : 'undeploy') end |
#unresched ⇒ Object
Unsets the re-scheduling flag for the VM
490 491 492 |
# File 'lib/opennebula/virtual_machine.rb', line 490 def unresched action('unresched') end |
#update(new_template = nil, append = false) ⇒ nil, OpenNebula::Error
Replaces the template contents
323 324 325 |
# File 'lib/opennebula/virtual_machine.rb', line 323 def update(new_template=nil, append=false) super(VM_METHODS[:update], new_template, append ? 1 : 0) end |
#updateconf(new_conf, append = false) ⇒ nil, OpenNebula::Error
Changes the attributes of a VM in power off, failure and undeploy
states
749 750 751 |
# File 'lib/opennebula/virtual_machine.rb', line 749 def updateconf(new_conf, append = false) return call(VM_METHODS[:updateconf], @pe_id, new_conf, append ? 1 : 0) end |
#user_template_str(indent = true) ⇒ String
Returns the <USER_TEMPLATE> element in text form
332 333 334 |
# File 'lib/opennebula/virtual_machine.rb', line 332 def user_template_str(indent=true) template_like_str('USER_TEMPLATE', indent) end |
#user_template_xml ⇒ String
Returns the <USER_TEMPLATE> element in XML form
339 340 341 342 343 344 345 |
# File 'lib/opennebula/virtual_machine.rb', line 339 def user_template_xml if NOKOGIRI @xml.xpath('USER_TEMPLATE').to_s else @xml.elements['USER_TEMPLATE'].to_s end end |
#wait_state(state, timeout = 120) ⇒ Object
832 833 834 835 836 837 838 839 840 841 842 |
# File 'lib/opennebula/virtual_machine.rb', line 832 def wait_state(state, timeout=120) require 'opennebula/wait_ext' extend OpenNebula::WaitExt rc = wait2(state, 'LCM_INIT', timeout) return Error.new("Timeout expired for state #{state}.") unless rc true end |
#wait_state2(state, lcm_state, timeout = 120) ⇒ Object
844 845 846 847 848 849 850 851 852 |
# File 'lib/opennebula/virtual_machine.rb', line 844 def wait_state2(state, lcm_state, timeout=120) extend OpenNebula::WaitExt rc = wait2(state, lcm_state, timeout) return Error.new("Timeout expired for state #{state}.") unless rc true end |