opennebula-cli 6.0.2 → 6.2.0

data/lib/one_helper/onevm_helper.rb

@@ -124,7 +124,8 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
         :name => 'weekly',
         :large => '--weekly days',
         :description => 'Repeats the schedule action the days of the week ' \
-        'specified, it can be a number between 0,6 separated with commas.' \
+        'specified, it can be a number between 0 (Sunday) to 6 (Saturday) ' \
+        'separated with commas. ' \
         'For example: onevm resume 0 --schedule "09/23 14:15" --weekly 0,2,4',
         :format => String
     }
@@ -133,8 +134,8 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
         :name => 'monthly',
         :large => '--monthly days',
         :description => 'Repeats the schedule action the days of the month ' \
-        'specified, it can be a number between 0,31 separated with commas.' \
-        'For example: onevm resume 0 --schedule "09/23 14:15" --monthly 0,14',
+        'specified, it can be a number between 1,31 separated with commas. ' \
+        'For example: onevm resume 0 --schedule "09/23 14:15" --monthly 1,14',
         :format => String
     }
 
@@ -142,7 +143,7 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
         :name => 'yearly',
         :large => '--yearly days',
         :description => 'Repeats the schedule action the days of the year ' \
-        'specified, it can be a number between 0,365 separated with commas.' \
+        'specified, it can be a number between 0,365 separated with commas. ' \
         'For example: onevm resume 0 --schedule "09/23 14:15" --yearly 30,60',
         :format => String
     }
@@ -151,7 +152,7 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
         :name => 'hourly',
         :large => '--hourly hour',
         :description => 'Repeats the schedule action each hours specified,' \
-        'it can be a number between 0,168 separated with commas.' \
+        'it can be a number between 0,168 separated with commas. ' \
         'For example: onevm resume 0 --schedule "09/23 14:15" --hourly 1,5',
         :format => Numeric
     }
@@ -439,21 +440,6 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
                 str_periodic << ', END_TYPE = 0'
             end
 
-            rc = vm.info
-
-            if OpenNebula.is_error?(rc)
-                puts rc.message
-                exit(-1)
-            end
-
-            ids = vm.retrieve_elements('USER_TEMPLATE/SCHED_ACTION/ID')
-
-            id = 0
-            if !ids.nil? && !ids.empty?
-                ids.map! {|e| e.to_i }
-                id = ids.max + 1
-            end
-
             sched = options[:schedule]
 
             # If the action is set to be executed from VM start to an specific
@@ -463,16 +449,14 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
                 sched = sched.to_i
             end
 
-            tmp_str = vm.user_template_str
-
-            tmp_str << "\nSCHED_ACTION = "
-            tmp_str << "[ID = #{id}, ACTION = #{action}, "
+            tmp_str = "SCHED_ACTION = ["
+            tmp_str << "ACTION = #{action}, "
             tmp_str << "WARNING = #{warning}," if warning
             tmp_str << "ARGS = \"#{options[:args]}\"," if options[:args]
             tmp_str << "TIME = #{sched}"
             tmp_str << str_periodic << ']'
 
-            vm.update(tmp_str)
+            vm.sched_action_add(tmp_str)
         end
     end
 
@@ -490,7 +474,7 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
                 exit(-1)
             end
 
-            xpath = "USER_TEMPLATE/SCHED_ACTION[ID=#{action_id}]"
+            xpath = "TEMPLATE/SCHED_ACTION[ID=#{action_id}]"
 
             unless vm.retrieve_elements(xpath)
                 STDERR.puts "Sched action #{action_id} not found"
@@ -508,12 +492,11 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
             vm.delete_element(xpath)
 
             # Add the modified sched action
-            tmp_str = vm.user_template_str
-            tmp_str << "\nSCHED_ACTION = ["
+            tmp_str = "\nSCHED_ACTION = ["
             tmp_str << str.split("\n").join(',')
             tmp_str << ']'
 
-            rc = vm.update(tmp_str)
+            rc = vm.sched_action_update(action_id, tmp_str)
 
             if OpenNebula.is_error?(rc)
                 STDERR.puts "Error updating: #{rc.message}"
@@ -669,6 +652,78 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
         YAML.load_file(self.class.table_conf)[:charters]
     end
 
+    # SSH into a VM
+    #
+    # @param args    [Array] CLI arguments
+    # @param options [Hash]  CLI parameters
+    def ssh(args, options)
+        perform_action(args[0], options, 'SSH') do |vm|
+            rc = vm.info
+
+            if OpenNebula.is_error?(rc)
+                STDERR.puts rc.message
+                exit(-1)
+            end
+
+            if vm.lcm_state_str != 'RUNNING'
+                STDERR.puts 'VM is not RUNNING, cannot SSH to it'
+                exit(-1)
+            end
+
+            # Get user to login
+            username = vm.retrieve_xmlelements('//TEMPLATE/CONTEXT/USERNAME')[0]
+
+            if !username.nil?
+                login = username.text
+            elsif !args[1].nil?
+                login = args[1]
+            else
+                login = 'root'
+            end
+
+            # Get CMD to run
+            options[:cmd].nil? ? cmd = '' : cmd = options[:cmd]
+
+            # Get NIC to connect
+            if options[:nic_id]
+                nic = vm.retrieve_xmlelements(
+                    "//TEMPLATE/NIC[NIC_ID=\"#{options[:nic_id]}\"]"
+                )[0]
+            else
+                nic = vm.retrieve_xmlelements('//TEMPLATE/NIC[SSH="YES"]')[0]
+            end
+
+            nic = vm.retrieve_xmlelements('//TEMPLATE/NIC[1]')[0] if nic.nil?
+
+            if nic.nil?
+                STDERR.puts 'No NIC found'
+                exit(-1)
+            end
+
+            # If there is node port
+            if nic['EXTERNAL_PORT_RANGE']
+                ip   = vm.to_hash['VM']['HISTORY_RECORDS']['HISTORY']
+                ip   = [ip].flatten[-1]['HOSTNAME']
+                port = Integer(nic['EXTERNAL_PORT_RANGE'].split(':')[0]) + 21
+            else
+                ip   = nic['IP']
+                port = 22
+            end
+
+            options[:ssh_opts].nil? ? opts = '' : opts = options[:ssh_opts]
+
+            if opts.empty?
+                exec(*%W[ssh #{login}@#{ip} -p #{port} #{cmd}])
+            else
+                exec('ssh', *opts.split, *%W[#{login}@#{ip} -p #{port} #{cmd}])
+            end
+        end
+
+        # rubocop:disable Style/SpecialGlobalVars
+        $?.exitstatus
+        # rubocop:enable Style/SpecialGlobalVars
+    end
+
     private
 
     def factory(id = nil)
@@ -1227,7 +1282,7 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
             format_history(vm)
         end
 
-        if vm.has_elements?('/VM/USER_TEMPLATE/SCHED_ACTION')
+        if vm.has_elements?('/VM/TEMPLATE/SCHED_ACTION')
             puts
             CLIHelper.print_header(str_h1 % 'SCHEDULED ACTIONS', false)
 
@@ -1245,7 +1300,10 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
                 end
 
                 column :SCHEDULED, '', :adjust => true do |d|
-                    OpenNebulaHelper.time_to_str(d['TIME'], false) \
+                    t2 = d['TIME'].to_i
+                    t2 += vm['STIME'].to_i unless d['TIME'] =~ /^[0-9].*/
+
+                    OpenNebulaHelper.time_to_str(t2, false) \
                         unless d.nil?
                 end
 
@@ -1296,7 +1354,10 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
 
                 column :CHARTER, '', :left, :adjust, :size => 15 do |d|
                     t1 = Time.now
-                    t2 = Time.at(vm['STIME'].to_i + d['TIME'].to_i)
+                    t2 = d['TIME'].to_i
+                    t2 += vm['STIME'].to_i unless d['TIME'] =~ /^[0-9].*/
+
+                    t2 = Time.at(t2)
 
                     days    = ((t2 - t1) / (24 * 3600)).round(2)
                     hours   = ((t2 - t1) / 3600).round(2)
@@ -1304,7 +1365,7 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
 
                     if days > 1
                         show = "In #{days} days"
-                    elsif days < 1 && hours > 1
+                    elsif days <= 1 && hours > 1
                         show = "In #{hours} hours"
                     elsif minutes > 0
                         show = "In #{minutes} minutes"
@@ -1312,18 +1373,19 @@ class OneVMHelper < OpenNebulaHelper::OneHelper
                         show = 'Already done'
                     end
 
-                    if (t1 - vm['STIME'].to_i).to_i > d['WARNING'].to_i
+                    wrn = d['WARNING']
+                    if !wrn.nil? && (t1 - vm['STIME'].to_i).to_i > wrn.to_i
                         "#{show} *"
                     else
                         show
                     end
                 end
-            end.show([vm_hash['VM']['USER_TEMPLATE']['SCHED_ACTION']].flatten,
+            end.show([vm_hash['VM']['TEMPLATE']['SCHED_ACTION']].flatten,
                      {})
         end
 
         if !options[:all]
-            vm.delete_element('/VM/USER_TEMPLATE/SCHED_ACTION')
+            vm.delete_element('/VM/TEMPLATE/SCHED_ACTION')
         end
 
         if vm.has_elements?('/VM/USER_TEMPLATE')

data/lib/one_helper/onezone_helper.rb

@@ -499,6 +499,13 @@ class OneZoneHelper < OpenNebulaHelper::OneHelper
         "onezone.yaml"
     end
 
+    def self.state_to_str(id)
+        id        = id.to_i
+        state_str = Zone::ZONE_STATES[id]
+
+        Zone::SHORT_ZONE_STATES[state_str]
+    end
+
     def format_pool(options)
         config_file = self.class.table_conf
 
@@ -524,7 +531,11 @@ class OneZoneHelper < OpenNebulaHelper::OneHelper
                 helper.get_fed_index(d["TEMPLATE"]['ENDPOINT'])
             end
 
-            default :CURRENT, :ID, :NAME, :ENDPOINT, :FED_INDEX
+            column :STAT, 'Zone status', :left, :size => 6 do |d|
+                OneZoneHelper.state_to_str(d['STATE'])
+            end
+
+            default :CURRENT, :ID, :NAME, :ENDPOINT, :FED_INDEX, :STAT
         end
 
         table
@@ -591,6 +602,7 @@ class OneZoneHelper < OpenNebulaHelper::OneHelper
         CLIHelper.print_header(str_h1 % "ZONE #{zone['ID']} INFORMATION")
         puts str % ["ID",   zone.id.to_s]
         puts str % ["NAME", zone.name]
+        puts str % ["STATE",zone.state_str]
         puts
 
         zone_hash=zone.to_hash

data/lib/one_helper.rb

@@ -576,6 +576,7 @@ EOT
             p_r, p_w = IO.pipe
 
             Signal.trap('PIPE', 'SIG_IGN')
+            Signal.trap('PIPE', 'EXIT')
 
             lpid = fork do
                 $stdin.reopen(p_r)
@@ -615,10 +616,9 @@ EOT
             page     = ""
 
             if options[:xml]
-                pool.each {|e|
-                    elements += 1
-                    page << e.to_xml(true) << "\n"
-                }
+                elements += 1
+
+                page << pool.to_xml(true)
             else
                 pname = pool.pool_name
                 ename = pool.element_name
@@ -899,6 +899,9 @@ EOT
 
 
         def list_pool(options, top=false, filter_flag=nil)
+            # Capture Broken pipe
+            Signal.trap('PIPE', 'EXIT')
+
             table = format_pool(options)
 
             if options[:describe]
@@ -920,15 +923,11 @@ EOT
             elsif options[:json]
                 list_pool_format(pool, options, filter_flag) do |pool|
                     hash        = check_resource_xsd(pool, pname)
-                    hash[pname] = check_resource_xsd(hash[pname], ename)
-
                     puts ::JSON.pretty_generate(hash)
                 end
             elsif options[:yaml]
                 list_pool_format(pool, options, filter_flag) do |pool|
                     hash        = check_resource_xsd(pool, pname)
-                    hash[pname] = check_resource_xsd(hash[pname], ename)
-
                     puts hash.to_yaml(:indent => 4)
                 end
             else
@@ -936,6 +935,9 @@ EOT
             end
 
             return 0
+        rescue SystemExit, Interrupt
+            # Rescue ctrl + c when paginated
+            0
         end
 
         # Check if a resource defined by attributes is referenced in pool
@@ -1223,11 +1225,41 @@ EOT
 
             return hash unless xsd
 
-            hash[ename] = check_xsd(hash[ename], nil, ename, xsd)
+            if xsd.keys.include?('complexType')
+                xsd = xsd['complexType']['sequence']['element']
+            else
+                xsd = xsd['element']
+            end
+
+            xsd = [ xsd ] unless xsd.is_a? Array
+
+            check_xsd(hash[ename], xsd)
 
             hash
         end
 
+
+        # Replaces refs in xsd definition
+        # limited func: only traverse hashes (not arrays), but works well for pools
+        #
+        # @param h [Hash] XSD in hash format
+        #
+        # @return [Object] XSD but where ref were, there inner XSD is loaded
+        def replace_refs(h)
+            return h unless h.is_a? Hash
+
+            if h.keys.include? 'ref'
+                ref_xsd = read_xsd(h['ref'])
+                return ref_xsd unless ref_xsd.nil?
+                return h
+            else
+                h.each do |k,v|
+                    h[k] = replace_refs(v)
+                end
+            end
+        end
+
+
         # Read XSD file and parse to XML
         #
         # @param ename [String] Element name to read XSD
@@ -1250,141 +1282,95 @@ EOT
             end
 
             hash = Hash.from_xml(Nokogiri::XML(File.read(file)).to_s)
+
             hash = hash['schema']['element']
 
-            if hash.keys.include?('complexType')
-                hash['complexType']['sequence']['element']
-            else
-                hash['element']
-            end
+            hash = replace_refs(hash)
+
+            hash
         end
 
-        # Check values XSD
+        # Decides if given xsd definiton should be array in xml
+        # Must be hash and contain either 'maxOccurs' => unbounded'
+        #                              or 'maxOccurs' => >1
         #
-        # @param hash     [Object] Resource information in hash format
-        # @param elements [Array]  Keys to check
-        # @param ename    [String] Element name to take XSD
-        # @param xsd      [Hash]   XSD file content
-        # @param parents  [Array]  Parent keys of current hash
-        def check_xsd(hash, elements, ename, xsd, parents = [])
-            return unless hash
-
-            if (hash.is_a? Hash) && !hash.empty?
-                hash.map do |ki, vi|
-                    vi = [vi].flatten if is_array?(xsd, [ki])
-
-                    if (vi.is_a? Hash) && !vi.empty?
-                        parents << ki
-
-                        vi.map do |kj, vj|
-                            parents << kj
-
-                            path = (parents + [ki, kj]).uniq
-                            vj   = [vj].flatten if is_array?(xsd, path)
-
-                            hash[ki][kj] = check_xsd(vj,
-                                                     [ki, kj],
-                                                     ename,
-                                                     xsd,
-                                                     parents)
-                        end
-
-                        parents.clear
-                    elsif vi.is_a? Array
-                        hash[ki] = check_xsd(vi, [ki], ename, xsd, parents)
-                    else
-                        hash[ki] = check_xsd(vi, [ki], ename, xsd, parents)
-                    end
-                end
-
-                hash
-            elsif hash.is_a? Array
-                ret = []
-
-                hash.each do |v|
-                    ret << check_xsd(v, elements, ename, xsd, parents)
-                end
-
-                ret
-            else
-                check_type(hash) do
-                    type = get_xsd_path(xsd, elements)
-                    type['type'] unless type.nil?
-                end
-            end
+        # @param e [Hash] XSD definition transfomred in hash
+        #
+        # @return [Boolean]
+        #
+        def is_array?(e)
+            return false if e.nil?
+            return false unless e.is_a? Hash
+            e['maxOccurs'] == 'unbounded' || e['maxOccurs'].to_i > 1
         end
 
-        # Get xsd path value
+        # Decides if given xsd definiton is complex type sequence
+        # Must be hash and contain nested hash
+        #   ['complexType']['sequence']['element']
         #
-        # @param xsd      [Hash]  XSD information
-        # @param elements [Array] Path to get
+        # @param  [Hash] XSD definition transfomred in hash
         #
-        # @return [Hash] Path information
-        def get_xsd_path(xsd, elements)
-            return unless elements
-
-            element = elements.shift
-
-            # Return nil, because is an empty complexType
-            return unless element
-
-            element = [xsd].flatten.find do |v|
-                v['name'] == element || v['ref'] == element
-            end
-
-            # Return nil, because element was not find in XSD
-            return unless element
-
-            if element.keys.include?('complexType') && !elements.empty?
-                if element['complexType']['all']
-                    element = element['complexType']['all']['element']
-                else
-                    element = element['complexType']['sequence']['element']
-                end
-
-                get_xsd_path(element, elements)
-            else
-                element
-            end
+        # @return [Boolean]
+        #
+        def xsd_complex_sequence?(x)
+            x['complexType']['sequence']['element'] rescue return false
+            true
         end
 
-        # CHeck if current element is an array
+        # Decides if given xsd definiton is complex type all
+        # Must be hash and contain nested hash
+        #   ['complexType']['all']['element']
         #
-        # @param xsd      [Hash]  XSD information
-        # @param elements [Array] Path to check
+        # @param  [Hash] XSD definition transfomred in hash
         #
-        # @return [Boolean] True if it's an array, false otherwise
-        def is_array?(xsd, elements)
-            max = get_xsd_path(xsd, elements)
-            max = max['maxOccurs'] if max
-
-            max == 'unbounded' || max.to_i > 1
+        # @return [Boolean]
+        #
+        def xsd_complex_all?(x)
+            x['complexType']['all']['element'] rescue return false
+            true
         end
 
-        # Check XSD type for especific value
+        # Recursively traverse the OpenNebula resource (in Hash) and it's XSD
+        # Where array is required in XSD, there encapsulate the entry into [ ]
+        # Typically usefull for single disk, snapshots etc.
         #
-        # @param value [Object] Value to check
+        # @param hash     [Hash]   Resource information in hash format
+        # @param xsd      [Hash]   XSD of the resource, transformed into hash
         #
-        # @return [Object] nil if the type is not correct, value otherwise
-        def check_type(value)
-            type = yield if block_given?
+        def check_xsd(hash, xsd)
+            return unless hash or hash.empty?
 
-            # If there is no type, return current value
-            return value unless type
+            hash.each do |k, v|
 
-            types = %w[string decimal integer boolean date time]
-            type  = type.split(':')[1]
+                # find the elem definition in xsd array
+                xsd_elem = xsd.select { |e| e['name'] == k }.first unless xsd.nil?
 
-            if types.include?(type)
-                # If the current type is different, return string
-                # because this value doesn't respect the type
-                if (value.is_a? Hash) || (value.is_a? Array)
-                    ''
-                else
-                    value
+                if xsd_complex_sequence?(xsd_elem) || xsd_complex_all?(xsd_elem)
+
+                    # go deeper in xsd, xsd is ehter complex sequence or all
+                    begin
+                        inner_xsd = xsd_elem['complexType']['sequence']['element']
+                    rescue
+                        inner_xsd = xsd_elem['complexType']['all']['element']
+                    end
+
+                    # recursively traverse resource - hash
+                    if v.is_a? Hash
+                        hash[k] = check_xsd(v, inner_xsd)
+
+                    # recursively traverse resource - array
+                    elsif v.is_a? Array
+                        hash[k] = []
+                        v.each do |e|
+                            hash[k] << check_xsd(e, inner_xsd)
+                        end
+                    end
+                end
+
+                # if XSD requires array, do so in resource if missing
+                if is_array?(xsd_elem) && (! v.is_a? Array)
+                    hash[k] = [ v ]
                 end
-            else
-                value
             end
         end
     end
@@ -1893,8 +1879,10 @@ EOT
         if options[:size]
             ar << ', SIZE = ' << options[:size]
         else
-            STDERR.puts 'Address range needs to specify size (-s size)'
-            exit(-1)
+            unless options[:ip6]
+                STDERR.puts 'Address range needs to specify size (-s size)'
+                exit(-1)
+            end
         end
 
         if options[:ip6]
@@ -2164,10 +2152,10 @@ EOT
             when 'number', 'number-float'
                 if type == 'number'
                     header += 'Integer: '
-                    exp = INT_EXP
+                    exp = OneTemplateHelper::INT_EXP
                 else
                     header += 'Float: '
-                    exp = FLOAT_EXP
+                    exp = OneTemplateHelper::FLOAT_EXP
                 end
 
                 begin
@@ -2193,13 +2181,13 @@ EOT
                 end
 
                 if type == 'range'
-                    exp = INT_EXP
+                    exp = OneTemplateHelper::INT_EXP
                     min = min.to_i
                     max = max.to_i
 
                     header += "Integer in the range [#{min}..#{max}]: "
                 else
-                    exp = FLOAT_EXP
+                    exp = OneTemplateHelper::FLOAT_EXP
                     min = min.to_f
                     max = max.to_f
 

data/share/schemas/xsd/api_info.xsd

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- The information sent to the hook when $API is used in an API Hook follos the following schema   -->
+<!-- The information sent to the hook when $API is used in an API Hook follow the following schema   -->
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://opennebula.org/XMLSchema" elementFormDefault="qualified" targetNamespace="http://opennebula.org/XMLSchema">
   <xs:element name="CALL_INFO">
     <xs:complexType>
@@ -13,7 +13,7 @@
                 <xs:complexType>
                   <xs:sequence>
                     <xs:element name="POSITION" type="xs:integer"/>
-                    <xs:element name="TYPE" type="xs:integer">
+                    <xs:element name="TYPE" type="xs:string">
                       <xs:simpleType>
                         <xs:restriction base="xs:string">
                         <xs:enumeration value="IN"/>

data/share/schemas/xsd/hook_message_api.xsd

@@ -6,7 +6,7 @@
       <xs:sequence>
         <xs:element name="HOOK_TYPE" type="xs:string" fixed="API"/>
         <xs:element name="CALL" type="xs:string"/>
-         <!-- CALL_INFO type is defined in call_info.xsd   -->
+         <!-- CALL_INFO type is defined in api_info.xsd   -->
         <xs:element ref="CALL_INFO" maxOccurs="unbounded" minOccurs="0"/>
       </xs:sequence>
     </xs:complexType>

data/share/schemas/xsd/hook_message_state.xsd

@@ -16,7 +16,7 @@
         <xs:element name="STATE" type="xs:string"/>
         <xs:element name="LCM_STATE" type="xs:string" maxOccurs="1" minOccurs="0"/>
         <xs:element name="REMOTE_HOST" type="xs:string" maxOccurs="1" minOccurs="0"/>
-         <!-- The template of the resource (VM or Host) is inlcuded here -->
+         <!-- The template of the resource (VM or Host) is included here -->
          <xs:element ref="HOST" maxOccurs="1" minOccurs="0"/>
          <xs:element ref="VM" maxOccurs="1" minOccurs="0"/>
       </xs:sequence>