opennebula-cli 6.4.3 → 6.5.80.pre

data/bin/onevm

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #
@@ -195,32 +195,6 @@ 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'
-    }
-
     NIC_ID = {
         :name   => 'nic_id',
         :large  => '--nic-id nic_id',
@@ -249,6 +223,40 @@ CommandParser::CmdParser.new(ARGV) do
         :description => 'VNC client to use'
     }
 
+    PCI = {
+        :name => 'pci',
+        :large => '--pci short_address',
+        :format => String,
+        :description => 'Select PCI device by its short address'
+    }
+
+    PCI_DEVICE = {
+        :name => 'pci_device',
+        :large => '--pci_device device ID',
+        :format => String,
+        :description => 'Select PCI device by its device ID'
+    }
+
+    PCI_VENDOR = {
+        :name => 'pci_vendor',
+        :large => '--pci_vendor vendor ID',
+        :format => String,
+        :description => 'Select PCI device by its vendor ID'
+    }
+
+    PCI_CLASS = {
+        :name => 'pci_class',
+        :large => '--pci_class class ID',
+        :format => String,
+        :description => 'Select PCI device by its class ID'
+    }
+
+    RESET_BACKUP = {
+        :name => 'reset',
+        :large => '--reset',
+        :description => 'Creates a new backup image, from a new full backup (only for incremental)'
+    }
+
     OpenNebulaHelper::TEMPLATE_OPTIONS_VM.delete_if do |v|
         %w[as_gid as_uid].include?(v[:name])
     end
@@ -853,8 +861,11 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     nic_attach_desc = <<-EOT.unindent
-        Attaches a NIC to a running VM. When using --file add only one
-        NIC instance.
+        Attaches a NIC to a VM. When using --file add only one NIC instance.
+
+        To hotplug a PCI device and use it as a NIC interface in the VM select
+        it with --pci (short_address) or --pci_device (device ID),
+        --pci_class (class ID) and/or --pci_vendor (vendor ID).
 
         To attach a nic alias, use --file or --alias option.
 
@@ -866,7 +877,11 @@ CommandParser::CmdParser.new(ARGV) do
                          OneVMHelper::NETWORK,
                          OneVMHelper::IP,
                          OneVMHelper::ALIAS,
-                         OneVMHelper::NIC_NAME] do
+                         OneVMHelper::NIC_NAME,
+                         PCI,
+                         PCI_CLASS,
+                         PCI_VENDOR,
+                         PCI_DEVICE] do
         if options[:file].nil? && options[:network].nil?
             STDERR.puts 'Provide a template file or a network:'
             STDERR.puts "\t--file    <file>"
@@ -878,36 +893,36 @@ CommandParser::CmdParser.new(ARGV) do
             template = File.read(options[:file])
         else
             network_id = options[:network]
-            ip = options[:ip]
-            nic_alias = options[:alias]
-            nic_name = options[:nic_name]
-
-            if ip
-                if !nic_alias && !nic_name
-                    template = "NIC = [ NETWORK_ID = #{network_id}, \
-                                IP = #{ip} ]"
-                elsif !nic_alias && nic_name
-                    template = "NIC = [ NETWORK_ID = #{network_id},
-                                        IP = #{ip},
-                                        NAME = #{nic_name} ]"
-                else
-                    template = "NIC_ALIAS = \
-                                [ NETWORK_ID = #{network_id},\
-                                  IP = #{ip},\
-                                  PARENT = #{nic_alias} ]"
-                end
+            ip         = options[:ip]
+            nic_alias  = options[:alias]
+            nic_name   = options[:nic_name]
+
+            is_pci = [:pci, :pci_device, :pci_vendor, :pci_class].any? do |o|
+                !options[o].nil?
+            end
+
+            if is_pci
+                pcia = options[:pci]
+                pcid = options[:pci_device]
+                pcic = options[:pci_class]
+                pciv = options[:pci_vendor]
+
+                template  = 'PCI = [ TYPE = NIC'
+                template << ", NETWORK_ID    = #{network_id}"
+                template << ", SHORT_ADDRESS = \"#{pcia}\"" if pcia
+                template << ", DEVICE        = \"#{pcid}\"" if pcid
+                template << ", CLASS         = \"#{pcic}\"" if pcic
+                template << ", VENDOR        = \"#{pciv}\"" if pciv
+            elsif nic_alias
+                template  = "NIC_ALIAS = [ PARENT = #{nic_alias}"
+                template << ", NETWORK_ID = #{network_id}"
             else
-                if !nic_alias && !nic_name
-                    template = "NIC = [ NETWORK_ID = #{network_id} ]"
-                elsif !nic_alias && nic_name
-                    template = "NIC = [ NETWORK_ID = #{network_id},
-                                        NAME = #{nic_name} ]"
-                else
-                    template = "NIC_ALIAS = \
-                                [ NETWORK_ID = #{network_id},\
-                                  PARENT = #{nic_alias} ]"
-                end
+                template = "NIC = [ NETWORK_ID = #{network_id}"
             end
+
+            template << ", IP   = #{ip}" if ip
+            template << ", NAME = #{nic_name}" if nic_name
+            template << ']'
         end
 
         helper.perform_action(args[0], options, 'Attaching NIC') do |vm|
@@ -929,6 +944,40 @@ CommandParser::CmdParser.new(ARGV) do
         end
     end
 
+    nic_update_desc = <<-EOT.unindent
+        Updates a NIC for a VM. In case the VM is running, trigger NIC update on the host.
+
+        States: Almost all, except BOOT*, MIGRATE and HOTPLUG-NIC
+    EOT
+
+    command :"nic-update", nic_update_desc, :vmid, :nicid,
+            [:file, nil], :options => OpenNebulaHelper::APPEND do
+        vm_id = args[0].to_i
+        nic_id = args[1].to_i
+        file = args[2]
+        helper.perform_action(vm_id, options, 'Updating VM NIC') do |obj|
+            if options[:append]
+                str = OpenNebulaHelper
+                      .append_template(vm_id, obj, file,
+                                       "TEMPLATE/NIC[NIC_ID=#{nic_id}]")
+            else
+                str = OpenNebulaHelper
+                      .update_template(vm_id, obj, file,
+                                       "TEMPLATE/NIC[NIC_ID=#{nic_id}]")
+            end
+
+            # Ensure the updated attributes are in NIC section
+            unless str.gsub(' ', '').match(/NIC=\[/)
+                str = "NIC=[\n#{str.split("\n").join(",\n")}]"
+            end
+
+            helper.set_client(options)
+            obj = helper.retrieve_resource(obj.id)
+
+            obj.nic_update(nic_id, str, options[:append])
+        end
+    end
+
     sg_attach_desc = <<-EOT.unindent
         Attaches a Security Group to a VM.
 
@@ -1340,8 +1389,8 @@ CommandParser::CmdParser.new(ARGV) do
     updateconf_desc = <<-EOT.unindent
         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.
+        In running state only changes in CONTEXT and BACKUP_CONFIG 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:
@@ -1352,6 +1401,7 @@ CommandParser::CmdParser.new(ARGV) do
         GRAPHICS  = ["TYPE", "LISTEN", "PASSWD", "KEYMAP" ]
         RAW       = ["DATA", "DATA_VMX", "TYPE", "VALIDATE"]
         CPU_MODEL = ["MODEL"]
+        BACKUP_CONFIG = ["FS_FREEZE", "KEEP_LAST", "BACKUP_VOLATILE", "MODE"]
         CONTEXT (any value, **variable substitution will be made**)
     EOT
 
@@ -1376,10 +1426,15 @@ CommandParser::CmdParser.new(ARGV) do
                     exit(-1)
                 end
 
+                backup   = vm.template_like_str('BACKUPS', true,
+                                                'BACKUP_CONFIG')
                 template = vm.template_like_str('TEMPLATE', true,
                                                 'OS | FEATURES | INPUT | '\
                                                 'GRAPHICS | RAW | CONTEXT | '\
                                                 'CPU_MODEL')
+
+                template << "\n" << backup
+
                 template = OpenNebulaHelper.editor_input(template)
             end
 
@@ -1497,108 +1552,43 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     backup_vm_desc = <<-EOT.unindent
-        Creates a VM backup and stores it in the marketplace
+        Creates a VM backup on the given datastore
+
+        States: RUNNING, POWEROFF
     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)
-
-            # Read user options
-            if options[:verbose]
-                log_to = STDOUT
-            elsif !options[:logger].nil?
-                log_to = options[:logger]
-            end
-
-            keep = options.key?(:keep)
-
-            if log_to
-                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
-            end
-
-            binfo          = {}
-            binfo[:market] = options[:market]
-
-            if options.key?(:oneshot)
-                binfo[:name] = "VM #{vm.id} BACKUP - " \
-                               "#{Time.now.strftime('%Y%m%d_%k%M')}"
-                binfo[:freq]   = 1
-                binfo[:last]   = Time.now.to_i - 100
-            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'
+            :options => [RESET_BACKUP,
+                         OneDatastoreHelper::DATASTORE,
+                         OneVMHelper::SCHEDULE,
+                         OneVMHelper::WEEKLY,
+                         OneVMHelper::MONTHLY,
+                         OneVMHelper::YEARLY,
+                         OneVMHelper::HOURLY,
+                         OneVMHelper::END_TIME] do
+        if options[:datastore].nil?
+            STDERR.puts 'Datastore to save the backup is mandatory: '
+            STDERR.puts "\t -d datastore_id | name"
             exit(-1)
         end
 
-        helper.perform_action(args[0], options, 'Restore') do |vm|
-            vm.extend(OpenNebula::VirtualMachineExt)
+        reset = options[:reset] == true
 
-            # 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'
+        if !options[:schedule].nil?
+            options[:args] = options[:datastore]
 
-            logger.formatter = proc do |severity, datetime, _p, msg|
-                "#{datetime.strftime(format)} #{severity.ljust(5)} : #{msg}\n"
-            end
+            helper.schedule_actions([args[0]], options, @comm_name)
+        else
 
-            begin
-                rc = vm.restore(options[:datastore], logger)
+            helper.perform_action(args[0], options, 'Backup') do |vm|
+                rc = vm.backup(options[:datastore], reset)
 
                 if OpenNebula.is_error?(rc)
-                    STDERR.puts rc.message
+                    STDERR.puts "Error creating VM backup: #{rc.message}"
                     exit(-1)
-                else
-                    puts "ID: #{rc}"
-                    0
                 end
-            rescue StandardError => e
-                STDERR.puts e
-                exit(-1)
             end
         end
     end

data/bin/onevmgroup

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/bin/onevnet

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #
@@ -114,6 +114,13 @@ CommandParser::CmdParser.new(ARGV) do
         :description => 'No recover action possible, delete the Virtual Network'
     }
 
+    RETRY = {
+        :name => 'retry',
+        :large => '--retry',
+        :description => 'Recover a Virtual Network by retrying the last ' \
+                        'failed action'
+    }
+
     ########################################################################
     # Global Options
     ########################################################################
@@ -363,6 +370,8 @@ CommandParser::CmdParser.new(ARGV) do
     update_desc = <<-EOT.unindent
         Update the template contents. If a path is not provided the editor will
         be launched to modify the current content.
+
+        Note: Triggers Virtual Machine updates for used leases.
     EOT
 
     command :update, update_desc, :vnetid, [:file, nil],
@@ -456,19 +465,22 @@ CommandParser::CmdParser.new(ARGV) do
         YOU NEED TO MANUALLY CHECK THE VN STATUS, to decide if the
         operation was successful or not, or if it can be retried.
 
-        States for success/failure recovers: LOCK_CREATE, LOCK_DELETE state.
-        States for a retry recover: LOCK_CREATE, LOCK_DELETE state
+        States for success recovers: LOCK_CREATE, LOCK_DELETE, UPDATE_FAILURE state.
+        States for failure recovers: LOCK_CREATE, LOCK_DELETE state.
+        States for a retry recover: UPDATE_FAILURE
         States for delete: Any but READY
     EOT
 
     command :recover, recover_desc, [:range, :vmid_list],
-            :options => [SUCCESS, FAILURE, DELETE] do
+            :options => [SUCCESS, FAILURE, DELETE, RETRY] do
         if !options[:success].nil?
             result = 1
         elsif !options[:failure].nil?
             result = 0
         elsif !options[:delete].nil?
             result = 2
+        elsif !options[:retry].nil?
+            result = 3
         else
             error_message = <<-EOT.unindent
             Need to specify the result of the pending action.

data/bin/onevntemplate

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/bin/onevrouter

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/bin/onezone

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/cli_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/command_parser.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/oneacct_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/oneacl_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/onecluster_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/onedatastore_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/oneflow_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/oneflowtemplate_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/onegroup_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #

data/lib/one_helper/onehook_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2022, 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    #