Class: OpenNebula::VirtualMachinePool
- Inherits:
-
Pool
- Object
- XMLElement
- XMLPool
- Pool
- OpenNebula::VirtualMachinePool
- Defined in:
- lib/opennebula/virtual_machine_pool.rb
Constant Summary collapse
- VM_POOL_METHODS =
{ :info => "vmpool.info", :info_extended => "vmpool.infoextended", :monitoring => "vmpool.monitoring", :accounting => "vmpool.accounting", :showback => "vmpool.showback", :calculate_showback => "vmpool.calculateshowback" }
- INFO_NOT_DONE =
Constants for info queries (include/RequestManagerPoolInfoFilter.h)
-1
- INFO_ALL_VM =
-2
Constants inherited from Pool
Pool::INFO_ALL, Pool::INFO_GROUP, Pool::INFO_MINE, Pool::INFO_PRIMARY_GROUP, Pool::PAGINATED_POOLS
Instance Attribute Summary
Attributes inherited from Pool
Instance Method Summary collapse
-
#accounting(filter_flag = INFO_ALL, options = {}) ⇒ Hash, OpenNebula::Error
Retrieves the accounting data for all the VMs in the pool.
-
#accounting_xml(filter_flag = INFO_ALL, options = {}) ⇒ String
Retrieves the accounting data for all the VMs in the pool in xml.
-
#calculate_showback(start_month, start_year, end_month, end_year) ⇒ Object
Processes all the history records, and stores the monthly cost for each VM.
-
#factory(element_xml) ⇒ Object
Default Factory Method for the Pools.
-
#get_hash_extended ⇒ Object
Get info extended VM.
- #info(*args) ⇒ Object
-
#info! ⇒ Object
Retrieves all or part of the VirtualMachines in the pool.
- #info_search(args = {}) ⇒ Object
-
#initialize(client, user_id = 0) ⇒ VirtualMachinePool
constructor
client
a Client object that represents a XML-RPC connectionuser_id
is to refer to a Pool with VirtualMachines from that user. -
#monitoring(xpath_expressions, filter_flag = INFO_ALL) ⇒ Hash<String, <Hash<String, Array<Array<int>>>>>, OpenNebula::Error
Retrieves the monitoring data for all the VMs in the pool.
-
#monitoring_xml(filter_flag = INFO_ALL) ⇒ String
Retrieves the monitoring data for all the VMs in the pool, in XML.
-
#showback(filter_flag = INFO_ALL, options = {}) ⇒ Hash, OpenNebula::Error
Retrieves the showback data for all the VMs in the pool.
-
#showback_xml(filter_flag = INFO_ALL, options = {}) ⇒ String
Retrieves the showback data for all the VMs in the pool, in xml.
Methods inherited from Pool
#each, #each_page, #each_with_xpath, #get_hash, #get_page, #info_paginated, #is_paginated?, #to_str
Methods inherited from XMLPool
Methods inherited from XMLElement
#[], #add_element, #attr, build_xml, #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(client, user_id = 0) ⇒ VirtualMachinePool
client
a Client object that represents a XML-RPC connection user_id
is to refer to a Pool with VirtualMachines from that user
47 48 49 50 51 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 47 def initialize(client, user_id=0) super('VM_POOL','VM',client) @user_id = user_id end |
Instance Method Details
#accounting(filter_flag = INFO_ALL, options = {}) ⇒ Hash, OpenNebula::Error
Retrieves the accounting data for all the VMs in the pool
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 291 def accounting(filter_flag=INFO_ALL, ={}) acct_hash = Hash.new rc = build_accounting(filter_flag, ) do |history| hash = acct_hash if [:order_by_1] id_1 = history[[:order_by_1]] acct_hash[id_1] ||= Hash.new if [:order_by_2] id_2 = history[[:order_by_2]] acct_hash[id_1][id_2] ||= Hash.new hash = acct_hash[id_1][id_2] else hash = acct_hash[id_1] end end hash["HISTORY_RECORDS"] ||= Hash.new hash["HISTORY_RECORDS"]["HISTORY"] ||= Array.new hash["HISTORY_RECORDS"]["HISTORY"] << history.to_hash['HISTORY'] end return rc if OpenNebula.is_error?(rc) acct_hash end |
#accounting_xml(filter_flag = INFO_ALL, options = {}) ⇒ String
Retrieves the accounting data for all the VMs in the pool in xml
337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 337 def accounting_xml(filter_flag=INFO_ALL, ={}) acct_hash = Hash.new xml_str = "<HISTORY_RECORDS>\n" rc = build_accounting(filter_flag, ) do |history| xml_str << history.to_xml end return rc if OpenNebula.is_error?(rc) xml_str << "\n</HISTORY_RECORDS>" xml_str end |
#calculate_showback(start_month, start_year, end_month, end_year) ⇒ Object
Processes all the history records, and stores the monthly cost for each VM
@param [Integer] start_month First month (+year) to process. January is 1.
Use -1 to unset
@param [Integer] start_year First year (+month) to process. e.g. 2014.
Use -1 to unset
@param [Integer] end_month Last month (+year) to process. January is 1.
Use -1 to unset
@param [Integer] end_year Last year (+month) to process. e.g. 2014.
Use -1 to unset
220 221 222 223 224 225 226 227 228 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 220 def calculate_showback(start_month, start_year, end_month, end_year) start_month ||= -1 start_year ||= -1 end_month ||= -1 end_year ||= -1 return @client.call(VM_POOL_METHODS[:calculate_showback], start_month, start_year, end_month, end_year) end |
#factory(element_xml) ⇒ Object
Default Factory Method for the Pools
61 62 63 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 61 def factory(element_xml) OpenNebula::VirtualMachine.new(element_xml,@client) end |
#get_hash_extended ⇒ Object
Get info extended VM
54 55 56 57 58 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 54 def get_hash_extended rc = info_search(:extended => true) return rc if OpenNebula.is_error?(rc) to_hash end |
#info(*args) ⇒ Object
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 75 def info(*args) case args.size when 0 info_filter(VM_POOL_METHODS[:info], @user_id, -1, -1, INFO_NOT_DONE) when 1 info_filter(VM_POOL_METHODS[:info], args[0], -1, -1, INFO_NOT_DONE) when 3 info_filter(VM_POOL_METHODS[:info], args[0], args[1], args[2], INFO_NOT_DONE) when 4 info_filter(VM_POOL_METHODS[:info], args[0], args[1], args[2], args[3]) end end |
#info! ⇒ Object
Retrieves all or part of the VirtualMachines in the pool. No arguments, returns the not-in-done VMs for the user
- user_id, start_id, end_id
- user_id, start_id, end_id, state
73 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 73 alias_method :info!, :info |
#info_search(args = {}) ⇒ Object
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 139 def info_search(args = {}) default_args = { :who => INFO_ALL, :start_id => -1, :end_id => -1, :state => INFO_NOT_DONE, :query => "", :extended => false }.merge!(args) if args[:extended] method = VM_POOL_METHODS[:info_extended] else method = VM_POOL_METHODS[:info] end info_filter(method, default_args[:who], default_args[:start_id], default_args[:end_id], default_args[:state], default_args[:query]) end |
#monitoring(xpath_expressions, filter_flag = INFO_ALL) ⇒ Hash<String, <Hash<String, Array<Array<int>>>>>, OpenNebula::Error
Retrieves the monitoring data for all the VMs in the pool
194 195 196 197 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 194 def monitoring(xpath_expressions, filter_flag=INFO_ALL) return super(VM_POOL_METHODS[:monitoring], 'VM', 'LAST_POLL', xpath_expressions, filter_flag) end |
#monitoring_xml(filter_flag = INFO_ALL) ⇒ String
Retrieves the monitoring data for all the VMs in the pool, in XML
205 206 207 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 205 def monitoring_xml(filter_flag=INFO_ALL) return @client.call(VM_POOL_METHODS[:monitoring], filter_flag) end |
#showback(filter_flag = INFO_ALL, options = {}) ⇒ Hash, OpenNebula::Error
Retrieves the showback data for all the VMs in the pool
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 375 def showback(filter_flag=INFO_ALL, ={}) data_hash = Hash.new rc = build_showback(filter_flag, ) do |record| hash = data_hash if [:order_by_1] id_1 = record[[:order_by_1]] data_hash[id_1] ||= Hash.new if [:order_by_2] id_2 = record[[:order_by_2]] data_hash[id_1][id_2] ||= Hash.new hash = data_hash[id_1][id_2] else hash = data_hash[id_1] end end hash["SHOWBACK_RECORDS"] ||= Hash.new hash["SHOWBACK_RECORDS"]["SHOWBACK"] ||= Array.new hash["SHOWBACK_RECORDS"]["SHOWBACK"] << record.to_hash['SHOWBACK'] end return rc if OpenNebula.is_error?(rc) data_hash end |
#showback_xml(filter_flag = INFO_ALL, options = {}) ⇒ String
Retrieves the showback data for all the VMs in the pool, in xml
424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/opennebula/virtual_machine_pool.rb', line 424 def showback_xml(filter_flag=INFO_ALL, ={}) xml_str = "<SHOWBACK_RECORDS>\n" rc = build_showback(filter_flag, ) do |showback| xml_str << showback.to_xml end return rc if OpenNebula.is_error?(rc) xml_str << "\n</SHOWBACK_RECORDS>" xml_str end |