opennebula-cli 5.12.9 → 6.0.0.1

data/bin/onesecgroup

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -27,9 +27,12 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
-    require 'rubygems'
-    Gem.use_paths(File.realpath(GEMS_LOCATION))
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -53,8 +56,8 @@ CommandParser::CmdParser.new(ARGV) do
     ########################################################################
     set :option, CommandParser::OPTIONS + OpenNebulaHelper::CLIENT_OPTIONS
 
-    list_options = CLIHelper::OPTIONS
-    list_options << OpenNebulaHelper::XML
+    list_options  = CLIHelper::OPTIONS
+    list_options += OpenNebulaHelper::FORMAT
     list_options << OpenNebulaHelper::NUMERIC
     list_options << OpenNebulaHelper::DESCRIBE
 
@@ -221,7 +224,10 @@ CommandParser::CmdParser.new(ARGV) do
         Shows information for the given Security Group
     EOT
 
-    command :show, show_desc, :secgroupid, :options => OpenNebulaHelper::XML do
+    command :show,
+            show_desc,
+            :secgroupid,
+            :options => OpenNebulaHelper::FORMAT do
         helper.show_resource(args[0], options)
     end
 end

data/bin/oneshowback

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -27,9 +27,12 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
-    require 'rubygems'
-    Gem.use_paths(File.realpath(GEMS_LOCATION))
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -92,27 +95,31 @@ CommandParser::CmdParser.new(ARGV) do
 
         pool = OpenNebula::VirtualMachinePool.new(helper.client)
 
-        if options[:json] || options[:xml]
+        if options[:json] || options[:xml] || options[:yaml]
             xml_str = pool.showback_xml(filter_flag, common_opts)
             if OpenNebula.is_error?(xml_str)
                 puts xml_str.message
                 exit(-1)
             end
 
-            if options[:json]
-                xmldoc = XMLElement.new
-                xmldoc.initialize_xml(xml_str, 'SHOWBACK_RECORDS')
+            xmldoc = XMLElement.new
+            xmldoc.initialize_xml(xml_str, 'SHOWBACK_RECORDS')
 
+            if options[:json]
                 puts JSON.pretty_generate(xmldoc.to_hash)
+            elsif options[:yaml]
+                puts xmldoc.to_hash.to_yaml(:indent => 4)
             elsif options[:xml]
                 puts xml_str
             end
         else
+            # rubocop:disable Naming/VariableNumber
             order_by = {}
             if !options[:csv]
                 order_by[:order_by_1] = 'YEAR'
                 order_by[:order_by_2] = 'MONTH'
             end
+            # rubocop:enable Naming/VariableNumber
 
             data_hash = pool.showback(filter_flag,
                                       common_opts.merge(order_by))
@@ -172,8 +179,9 @@ CommandParser::CmdParser.new(ARGV) do
                                                                end_year)
 
         if OpenNebula.is_error?(rc)
-            if rc.message.include? "ReadTimeout"
-                warn "Showback calculation takes too long, continuing in background"
+            if rc.message.include? 'ReadTimeout'
+                warn 'Showback calculation takes too long, '\
+                     'continuing in background'
                 exit_code 0
             else
                 warn rc.message

data/bin/onetemplate

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -27,9 +27,12 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
-    require 'rubygems'
-    Gem.use_paths(File.realpath(GEMS_LOCATION))
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -78,8 +81,8 @@ CommandParser::CmdParser.new(ARGV) do
     ########################################################################
     set :option, CommandParser::OPTIONS + OpenNebulaHelper::CLIENT_OPTIONS
 
-    list_options = CLIHelper::OPTIONS
-    list_options << OpenNebulaHelper::XML
+    list_options  = CLIHelper::OPTIONS
+    list_options += OpenNebulaHelper::FORMAT
     list_options << OpenNebulaHelper::NUMERIC
     list_options << OpenNebulaHelper::DESCRIBE
 
@@ -263,7 +266,7 @@ CommandParser::CmdParser.new(ARGV) do
                 else
                     optionals = OneTemplateHelper.get_user_inputs(
                         t.to_hash,
-                        options[:user_inputs_keys],
+                        options[:user_inputs_keys]
                     )
 
                     user_inputs = user_inputs + "\n" + optionals
@@ -369,7 +372,8 @@ CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :show, show_desc, :templateid,
-            :options => [OpenNebulaHelper::XML, OneTemplateHelper::EXTENDED] do
+            :options => [OpenNebulaHelper::FORMAT,
+                         OneTemplateHelper::EXTENDED] do
         helper.show_resource(args[0], options)
     end
 

data/bin/oneuser

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -27,9 +27,12 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
-    require 'rubygems'
-    Gem.use_paths(File.realpath(GEMS_LOCATION))
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -68,8 +71,8 @@ CommandParser::CmdParser.new(ARGV) do
     ########################################################################
     set :option, CommandParser::OPTIONS + OpenNebulaHelper::CLIENT_OPTIONS
 
-    list_options = CLIHelper::OPTIONS
-    list_options << OpenNebulaHelper::XML
+    list_options  = CLIHelper::OPTIONS
+    list_options += OpenNebulaHelper::FORMAT
     list_options << OpenNebulaHelper::NUMERIC
     list_options << OpenNebulaHelper::DESCRIBE
 
@@ -559,7 +562,7 @@ CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :show, show_desc, [:userid, nil],
-            :options => OpenNebulaHelper::XML do
+            :options => OpenNebulaHelper::FORMAT do
         user = args[0] || OpenNebula::User::SELF
         helper.show_resource(user, options)
     end
@@ -801,4 +804,24 @@ CommandParser::CmdParser.new(ARGV) do
             user.login(username, '', 0)
         end
     end
+
+    enable_desc = <<-EOT.unindent
+        Enables the given User
+    EOT
+
+    command :enable, enable_desc, [:range, :userid_list] do
+        helper.perform_actions(args[0], options, 'enabled') do |user|
+            user.enable
+        end
+    end
+
+    disable_desc = <<-EOT.unindent
+        Disables the given User
+    EOT
+
+    command :disable, disable_desc, [:range, :userid_list] do
+        helper.perform_actions(args[0], options, 'disabled') do |user|
+            user.disable
+        end
+    end
 end

data/bin/onevcenter

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -29,9 +29,12 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
-    require 'rubygems'
-    Gem.use_paths(File.realpath(GEMS_LOCATION))
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -236,7 +239,7 @@ CommandParser::CmdParser.new(ARGV) do
                     " this input: #{args.first}"
             end
 
-            importer.process_import(indexes) do |object_info|
+            importer.process_import(indexes, options) do |object_info|
                 helper.cli_dialogue(object_info)
             end
 
@@ -265,12 +268,6 @@ CommandParser::CmdParser.new(ARGV) do
                 indexes = importer.get_indexes(args.first)
             end
 
-            if indexes.nil?
-                raise "Could not get any unimported #{options[:object]}"\
-                    " resources info in host: #{options[:host]} with"\
-                    " this input: #{args.first}"
-            end
-
             importer.process_import(indexes, options)
 
             importer.stdout

data/bin/onevdc

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -27,9 +27,12 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
-    require 'rubygems'
-    Gem.use_paths(File.realpath(GEMS_LOCATION))
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -53,8 +56,8 @@ CommandParser::CmdParser.new(ARGV) do
     ########################################################################
     set :option, CommandParser::OPTIONS + OpenNebulaHelper::CLIENT_OPTIONS
 
-    list_options = CLIHelper::OPTIONS
-    list_options << OpenNebulaHelper::XML
+    list_options  = CLIHelper::OPTIONS
+    list_options += OpenNebulaHelper::FORMAT
     list_options << OpenNebulaHelper::NUMERIC
     list_options << OpenNebulaHelper::DESCRIBE
 
@@ -297,7 +300,7 @@ CommandParser::CmdParser.new(ARGV) do
         Shows information for the given VDC
     EOT
 
-    command :show, show_desc, :vdcid, :options => OpenNebulaHelper::XML do
+    command :show, show_desc, :vdcid, :options => OpenNebulaHelper::FORMAT do
         helper.show_resource(args[0], options)
     end
 end

data/bin/onevm

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -27,9 +27,12 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
-    require 'rubygems'
-    Gem.use_paths(File.realpath(GEMS_LOCATION))
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -37,6 +40,8 @@ $LOAD_PATH << RUBY_LIB_LOCATION + '/cli'
 
 require 'command_parser'
 require 'one_helper/onevm_helper'
+require 'one_helper/onedatastore_helper'
+require 'opennebula/virtual_machine_ext'
 
 CommandParser::CmdParser.new(ARGV) do
     usage '`onevm` <command> [<args>] [<options>]'
@@ -176,6 +181,32 @@ CommandParser::CmdParser.new(ARGV) do
         :description => 'lock all actions'
     }
 
+    LOGGER = {
+        :name   => 'logger',
+        :large  => '--logger logger',
+        :format => String,
+        :description => 'Set logger to STDOUT or FILE'
+    }
+
+    KEEP = {
+        :name  => 'keep',
+        :large => '--keep-backup',
+        :description => 'Keep previous backup when creating a new one'
+    }
+
+    ONESHOT = {
+        :name  => 'oneshot',
+        :large => '--oneshot',
+        :description => 'Take an snapshot of the VM without saving backup info'
+    }
+
+    MARKET = {
+        :name   => 'market',
+        :large  => '--market market_id',
+        :format => Integer,
+        :description => 'Market to save oneshot'
+    }
+
     ########################################################################
     # Global Options
     ########################################################################
@@ -1152,7 +1183,7 @@ CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :show, show_desc, :vmid,
-            :options => [OpenNebulaHelper::XML,
+            :options => [OpenNebulaHelper::FORMAT,
                          OpenNebulaHelper::DECRYPT,
                          OneVMHelper::ALL_TEMPLATE] do
         helper.show_resource(args[0], options)
@@ -1210,7 +1241,11 @@ CommandParser::CmdParser.new(ARGV) do
 
     command :save, save_desc, :vmid, :name, :options => [PERSISTENT] do
         helper.perform_action(args[0], options, 'Saving VM') do |vm|
-            res = vm.save_as_template(args[1], options[:persistent])
+            vm.extend(VirtualMachineExt)
+
+            res = vm.save_as_template(args[1],
+                                      '',
+                                      :persistent => options[:persistent])
 
             if !OpenNebula.is_error?(res)
                 puts "Template ID: #{res}"
@@ -1221,15 +1256,16 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     updateconf_desc = <<-EOT.unindent
-        Updates the configuration of a VM. The VM cannot be in an active (running)
-        state, valid states are: pending, failure, poweroff, undeploy, hold or
-        cloning.
+        Updates the configuration of a VM. Valid states are: running, pending,
+        failure, poweroff, undeploy, hold or cloning.
+        In running state only changes in CONTEXT take effect immediately,
+        other values may need a VM restart.
 
         This command accepts a template file or opens an editor, the full list of
         configuration attributes are:
 
-        OS        = ["ARCH", "MACHINE", "KERNEL", "INITRD", "BOOTLOADER", "BOOT"]
-        FEATURES  = ["ACPI", "PAE", "APIC", "LOCALTIME", "HYPERV", "GUEST_AGENT"]
+        OS        = ["ARCH", "MACHINE", "KERNEL", "INITRD", "BOOTLOADER", "BOOT", "UUID"]
+        FEATURES  = ["ACPI", "PAE", "APIC", "LOCALTIME", "HYPERV", "GUEST_AGENT", "IOTHREADS"]
         INPUT     = ["TYPE", "BUS"]
         GRAPHICS  = ["TYPE", "LISTEN", "PASSWD", "KEYMAP" ]
         RAW       = ["DATA", "DATA_VMX", "TYPE"]
@@ -1383,6 +1419,105 @@ CommandParser::CmdParser.new(ARGV) do
         0
     end
 
+    backup_vm_desc = <<-EOT.unindent
+        Creates a VM backup and stores it in the marketplace
+    EOT
+
+    command :backup,
+            backup_vm_desc,
+            :vmid,
+            :options => [LOGGER, KEEP, ONESHOT, MARKET] do
+        require 'logger'
+
+        if options.key?(:oneshot) && !options.key?(:market)
+            STDERR.puts 'ERROR: no market given'
+            exit(-1)
+        end
+
+        helper.perform_action(args[0], options, 'Backup') do |vm|
+            vm.extend(OpenNebula::VirtualMachineExt)
+
+            # If logger is specified use it, if not use STDOUT
+            options[:logger].nil? ? log_to = STDOUT : log_to = options[:logger]
+
+            # Read user options
+            keep   = options.key?(:keep)
+            logger = Logger.new(log_to)
+            format = '%Y-%m-%d %H:%M:%S'
+
+            logger.formatter = proc do |severity, datetime, _p, msg|
+                "#{datetime.strftime(format)} #{severity.ljust(5)} : #{msg}\n"
+            end
+
+            if options.key?(:oneshot)
+                binfo        = {}
+                binfo[:name] = "VM #{vm.id} BACKUP - " \
+                               "#{Time.now.strftime('%Y%m%d_%k%M')}"
+                binfo[:freq]   = 1
+                binfo[:last]   = Time.now.to_i - 100
+                binfo[:market] = options[:market]
+            end
+
+            begin
+                rc = vm.backup(keep, logger, binfo)
+
+                if OpenNebula.is_error?(rc)
+                    STDERR.puts rc.message
+                    exit(-1)
+                else
+                    0
+                end
+            rescue StandardError => e
+                STDERR.puts e
+                exit(-1)
+            end
+        end
+    end
+
+    restore_vm_desc = <<-EOT.unindent
+        Restores a VM from a previous backup
+    EOT
+
+    command :restore,
+            restore_vm_desc,
+            :vmid,
+            :options => [OneDatastoreHelper::DATASTORE, LOGGER] do
+        require 'logger'
+
+        unless options[:datastore]
+            STDERR.puts 'ERROR: no datastore given'
+            exit(-1)
+        end
+
+        helper.perform_action(args[0], options, 'Restore') do |vm|
+            vm.extend(OpenNebula::VirtualMachineExt)
+
+            # If logger is specified use it, if not use STDOUT
+            options[:logger].nil? ? log_to = STDOUT : log_to = options[:logger]
+            logger = Logger.new(log_to)
+            format = '%Y-%m-%d %H:%M:%S'
+
+            logger.formatter = proc do |severity, datetime, _p, msg|
+                "#{datetime.strftime(format)} #{severity.ljust(5)} : #{msg}\n"
+            end
+
+            begin
+                rc = vm.restore(options[:datastore], logger)
+
+                if OpenNebula.is_error?(rc)
+                    STDERR.puts rc.message
+                    exit(-1)
+                else
+                    puts "ID: #{rc}"
+                    0
+                end
+            rescue StandardError => e
+                STDERR.puts e
+                exit(-1)
+            end
+        end
+    end
+
     # Deprecated commands
 
     deprecated_command(:shutdown, 'terminate')