opennebula-cli 6.6.2 → 6.7.80.pre

data/bin/onevmgroup

@@ -108,7 +108,9 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     set :format, :vmgroupid, OneVMGroupHelper.to_id_desc do |arg|
-        helper.to_id(arg)
+        tmp = helper.to_id(arg)
+        @current_vmg = tmp[1]
+        tmp
     end
 
     set :format, :vmgroupid_list, OneVMGroupHelper.list_to_id_desc do |arg|
@@ -119,6 +121,10 @@ CommandParser::CmdParser.new(ARGV) do
         helper.filterflag_to_i(arg)
     end
 
+    format :roleid, 'Role identifier' do |arg|
+        helper.retrieve_role_id(@current_vmg, arg)
+    end
+
     ########################################################################
     # Commands
     ########################################################################
@@ -151,7 +157,7 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     list_desc = <<-EOT.unindent
-        Lists VM Group in the pool
+        Lists VM Group in the pool. #{OneVMGroupHelper.list_layout_help}
     EOT
 
     command :list, list_desc, [:filterflag, nil], :options => list_options do
@@ -270,4 +276,61 @@ CommandParser::CmdParser.new(ARGV) do
             vmg.unlock
         end
     end
+
+    role_add_desc = <<-EOT.unindent
+        Add role to VM Group.
+    EOT
+
+    command :"role-add", role_add_desc, :vmgroupid, [:file, nil] do
+        begin
+            template = File.read(args[1]) if args[1]
+            template = STDIN.read if STDIN.wait_readable(0)
+        rescue StandardError => e
+            STDERR.puts "Error reading template: #{e.message}."
+            exit(-1)
+        end
+
+        # Ensure the template attributes are in ROLE section
+        unless template.gsub(' ', '').match(/ROLE=\[/)
+            template = "ROLE=[\n#{template.split("\n").join(",\n")}]"
+        end
+
+        helper.perform_action(args[0], options, 'Role added') do |vmg|
+            vmg.role_add(template)
+        end
+    end
+
+    role_delete_desc = <<-EOT.unindent
+        Deletes role from VM Group.
+    EOT
+
+    command :"role-delete", role_delete_desc, :vmgroupid, :roleid do
+        roleid = args[1].to_i
+
+        helper.perform_action(args[0], options, 'Role removed') do |vmg|
+            vmg.role_delete(roleid)
+        end
+    end
+
+    role_update_desc = <<-EOT.unindent
+        Update VM Group role
+    EOT
+
+    command :"role-update", role_update_desc, :vmgroupid, :roleid, [:file, nil] do
+        vmg_id = args[0].to_i
+        role_id = args[1].to_i
+        file = args[2]
+
+        helper.perform_action(vmg_id, options, 'Role updated') do |vmg|
+            str = OpenNebulaHelper.update_template(vmg_id, vmg, file,
+                                                   "ROLES/ROLE[ID=#{role_id}]")
+
+            # Ensure the updated attributes are in ROLE section
+            unless str.gsub(' ', '').match(/ROLE=\[/)
+                str = "ROLE=[\n#{str.split("\n").join(",\n")}]"
+            end
+
+            vmg.role_update(role_id, str)
+        end
+    end
 end

data/bin/onevnet

@@ -161,15 +161,18 @@ CommandParser::CmdParser.new(ARGV) do
     ########################################################################
 
     create_desc = <<-EOT.unindent
-        Creates a new Virtual Network from the given template file
+        Creates a new Virtual Network from the given template
+
+        #{OpenNebulaHelper::TEMPLATE_INPUT}
     EOT
 
-    command :create, create_desc, :file, :options => CREATE_OPTIONS do
+    command :create, create_desc, [:file, nil], :options => CREATE_OPTIONS do
         cid = options[:cluster] || ClusterPool::NONE_CLUSTER_ID
 
         helper.create_resource(options) do |vn|
             begin
-                template = File.read(args[0])
+                template = File.read(args[0]) if args[0]
+                template = STDIN.read if STDIN.wait_readable(0)
                 vn.allocate(template, cid)
             rescue StandardError => e
                 STDERR.puts "Error creating network: #{e.message}"
@@ -347,7 +350,7 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     list_desc = <<-EOT.unindent
-        Lists Virtual Networks in the pool
+        Lists Virtual Networks in the pool. #{OneVNetHelper.list_layout_help}
     EOT
 
     command :list, list_desc, [:filterflag, nil],

data/bin/onevntemplate

@@ -340,7 +340,7 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     list_desc = <<-EOT.unindent
-        Lists VN Templates in the pool
+        Lists VN Templates in the pool. #{OneVNTemplateHelper.list_layout_help}
     EOT
 
     rename_desc = <<-EOT.unindent

data/bin/onevrouter

@@ -134,13 +134,14 @@ CommandParser::CmdParser.new(ARGV) do
 
     create_desc = <<-EOT.unindent
         Creates a new Virtual Router from the given description
+        #{OpenNebulaHelper::TEMPLATE_INPUT}
     EOT
 
-    command :create, create_desc, :file do
+    command :create, create_desc, [:file, nil] do
         helper.create_resource(options) do |obj|
             begin
-                template = File.read(args[0])
-
+                template = File.read(args[0]) if args[0]
+                template = STDIN.read if STDIN.wait_readable(0)
                 obj.allocate(template)
             rescue StandardError => e
                 STDERR.puts e.message
@@ -153,6 +154,8 @@ CommandParser::CmdParser.new(ARGV) do
         Creates a new VM instance from the given Template. This VM can be
         managed with the 'onevm' command.
 
+        #{OpenNebulaHelper::TEMPLATE_INPUT}
+
         The NIC elements defined in the Virtual Router will be used. The
         source Template can be modified adding or replacing attributes with
         the optional file argument, or with the options.
@@ -168,9 +171,10 @@ CommandParser::CmdParser.new(ARGV) do
             :vrouterid, :templateid, [:file, nil],
             :options => instantiate_options +
                         OpenNebulaHelper::TEMPLATE_OPTIONS do
-        if args[2] && OpenNebulaHelper.create_template_options_used?(options)
-            STDERR.puts 'You cannot use both template file and template' \
-                        ' creation options.'
+        if (args[2] || STDIN.wait_readable(0)) &&
+            OpenNebulaHelper.create_template_options_used?(options)
+
+            STDERR.puts 'You cannot use both template and template creation options.'
             exit(-1)
         end
 
@@ -194,6 +198,8 @@ CommandParser::CmdParser.new(ARGV) do
 
             if args[2]
                 extra_template = File.read(args[2])
+            elsif STDIN.wait_readable(0)
+                extra_template = STDIN.read
             else
                 res = OpenNebulaHelper.create_template(options, t)
 
@@ -292,20 +298,15 @@ CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :"nic-attach", nic_attach_desc, :vrouterid,
-            :options => [OneVMHelper::FILE,
+            :options => [OpenNebulaHelper::FILE,
                          OneVMHelper::NETWORK,
                          OneVMHelper::IP,
                          OneVirtualRouterHelper::FLOAT] do
-        if options[:file].nil? && options[:network].nil?
-            STDERR.puts 'Provide a template file or a network:'
-            STDERR.puts "\t--file    <file>"
-            STDERR.puts "\t--network <network>"
-            exit(-1)
-        end
-
         if options[:file]
             template = File.read(options[:file])
-        else
+        elsif STDIN.wait_readable(0)
+            template = STDIN.read
+        elsif options[:network]
             network_id = options[:network]
             ip         = options[:ip]
             float      = options[:float]
@@ -321,6 +322,11 @@ CommandParser::CmdParser.new(ARGV) do
             end
 
             template += ' ]'
+        else
+            STDERR.puts 'Provide a template or a network:'
+            STDERR.puts "\t--file    <file>"
+            STDERR.puts "\t--network <network>"
+            exit(-1)
         end
 
         helper.perform_action(args[0], options, 'Attach NIC') do |vr|
@@ -341,7 +347,7 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     list_desc = <<-EOT.unindent
-        Lists the Virtual Routers in the pool
+        Lists the Virtual Routers in the pool. #{OneVirtualRouterHelper.list_layout_help}
     EOT
 
     command :list, list_desc, [:filterflag, nil], :options => list_options do

data/bin/onezone

@@ -211,7 +211,7 @@ CommandParser::CmdParser.new(ARGV) do
     end
 
     list_desc = <<-EOT.unindent
-        Lists Zones in the pool
+        Lists Zones in the pool. #{OneZoneHelper.list_layout_help}
     EOT
 
     command :list, list_desc, :options => list_options do

data/lib/command_parser.rb

@@ -312,15 +312,9 @@ module CommandParser
         end
 
         def deprecated_command(name, new_command)
-            cmd = Hash.new
-            cmd[:desc] = "Deprecated, use #{new_command} instead"
-            cmd[:arity] = 0
-            cmd[:options] = []
-            cmd[:args_format] = [[:string, nil]] * 20
+            cmd = @commands[name.to_sym] || Hash.new
+            cmd[:desc] += "\nDeprecated, use #{new_command} instead"
             cmd[:deprecated] = new_command
-            cmd[:proc] = lambda do
-                print_deprecated(new_command)
-            end
 
             @commands[name.to_sym] = cmd
         end
@@ -800,7 +794,6 @@ module CommandParser
         def print_deprecated(new_command)
             puts "This command is deprecated, use instead:"
             puts "  $ #{File.basename $0} #{new_command}"
-            exit(-1)
         end
 
         def word_wrap(size, text, first_size=nil)

data/lib/one_helper/oneacl_helper.rb

@@ -34,7 +34,7 @@ class OneAclHelper < OpenNebulaHelper::OneHelper
     def self.resource_mask(str)
         resource_type=str.split('/')[0]
 
-        mask = '------------------'
+        mask = '-------------------'
 
         resource_type.split('+').each do |type|
             case type
@@ -74,6 +74,8 @@ class OneAclHelper < OpenNebulaHelper::OneHelper
                 mask[16] = 'P'
             when 'VNTEMPLATE'
                 mask[17] = 't'
+            when 'BACKUPJOB'
+                mask[18] = 'B'
             end
         end
         mask
@@ -128,9 +130,9 @@ class OneAclHelper < OpenNebulaHelper::OneHelper
                 d['STRING'].split(' ')[0]
             end
 
-            column :RES_VHNIUTGDCOZSvRMAPt,
+            column :RES_VHNIUTGDCOZSvRMAPtB,
                    'Resource to which the rule applies',
-                   :size => 22 do |d|
+                   :size => 23 do |d|
                 OneAclHelper.resource_mask d['STRING'].split(' ')[1]
             end
 
@@ -155,7 +157,7 @@ class OneAclHelper < OpenNebulaHelper::OneHelper
                 d['STRING']
             end
 
-            default :ID, :USER, :RES_VHNIUTGDCOZSvRMAPt, :RID, :OPE_UMAC, :ZONE
+            default :ID, :USER, :RES_VHNIUTGDCOZSvRMAPtB, :RID, :OPE_UMAC, :ZONE
         end
     end
     # rubocop:enable Lint/IneffectiveAccessModifier

data/lib/one_helper/onebackupjob_helper.rb

@@ -0,0 +1,284 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2023, 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    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'one_helper'
+
+# Helper for onebackupjob command
+class OneBackupJobHelper < OpenNebulaHelper::OneHelper
+
+    def self.rname
+        'BACKUPJOB'
+    end
+
+    def self.conf_file
+        'onebackupjob.yaml'
+    end
+
+    TEMPLATE_OPTIONS = [
+        {
+            :name => 'name',
+            :large => '--name name',
+            :format => String,
+            :description => 'Name of the new backup job'
+        },
+        {
+            :name => 'description',
+            :large => '--description description',
+            :format => String,
+            :description => 'Description for the new Image'
+        },
+        {
+            :name => 'backup_vms',
+            :large => '--vms "vm_id1,vm_id2..."',
+            :format => String,
+            :description => 'List of VM IDs to backup'
+        },
+        {
+            :name => 'keep_last',
+            :large => '--keep N',
+            :format => String,
+            :description => 'Keep N backups for the VMs in this backup job'
+        },
+        {
+            :name => 'mode',
+            :large => '--mode <increment|full>',
+            :format => String,
+            :description => 'Backup mode'
+        }
+    ]
+
+    def format_pool(options)
+        config_file = self.class.table_conf
+
+        CLIHelper::ShowTable.new(config_file, self) do
+            column :ID, 'ONE identifier for the Backup Job', :size=>4 do |d|
+                d['ID']
+            end
+
+            column :USER, 'Username of the Backup Job owner', :left,
+                   :size=>15 do |d|
+                helper.user_name(d, options)
+            end
+
+            column :GROUP, 'Group of the Backup Job', :left, :size=>15 do |d|
+                helper.group_name(d, options)
+            end
+
+            column :PRIO, 'Priority of the Backup Job', :left, :size=>4 do |d|
+                d['PRIORITY'].to_i
+            end
+
+            column :NAME, 'Date for the last backup operation', :left, :size=>15 do |d|
+                d['NAME']
+            end
+
+            column :LAST, 'Date for the last backup operation', :size => 15 do |d|
+                begin
+                    btime = d['LAST_BACKUP_TIME'].to_i
+                rescue StandardError
+                    btime = 0
+                end
+                OpenNebulaHelper.time_to_str(btime, false, true, true)
+            end
+
+            column :VMS, 'VM IDs part of this backup job', :size => 15 do |d|
+                begin
+                    vm = d['TEMPLATE']['BACKUP_VMS']
+                    vm[12..-1]='...' if vm.size > 15
+                    vm
+                rescue StandardError
+                    '-'
+                end
+            end
+
+            default :ID, :USER, :GROUP, :PRIO, :NAME, :LAST, :VMS
+        end
+    end
+
+    def schedule_actions(ids, options, warning = nil)
+        # Verbose by default
+        options[:verbose] = true
+
+        message = if options[:schedule].class == Integer
+                      "backup scheduled at #{Time.at(options[:schedule])}"
+                  else
+                      "backup scheduled after #{options[:schedule]}s"
+                  end
+
+        tmp_str = OpenNebulaHelper.schedule_action_tmpl(options, nil, warning)
+
+        perform_actions(ids, options, message) do |bj|
+            rc = bj.sched_action_add(tmp_str)
+
+            if OpenNebula.is_error?(rc)
+                STDERR.puts rc.message
+                exit(-1)
+            end
+        end
+    end
+
+    # Update schedule action
+    #
+    # @param id        [Integer] BackupJob ID
+    # @param action_id [Integer] Sched action ID
+    # @param file      [String]  File path with update content
+    # @param options
+    def update_schedule_action(id, action_id, file, options)
+        perform_action(id, options, 'Sched action updated') do |bj|
+            rc = bj.info
+
+            if OpenNebula.is_error?(rc)
+                STDERR.puts "Error #{rc.message}"
+                exit(-1)
+            end
+
+            xpath = "TEMPLATE/SCHED_ACTION[ID=#{action_id}]"
+
+            unless bj.retrieve_elements(xpath)
+                STDERR.puts "Sched action #{action_id} not found"
+                exit(-1)
+            end
+
+            # Get user information
+            if file
+                str = File.read(file)
+            else
+                str = OpenNebulaHelper.update_template(id, bj, nil, xpath)
+            end
+
+            # Add the modified sched action
+            tmp_str = "\nSCHED_ACTION = ["
+            tmp_str << str.split("\n").join(',')
+            tmp_str << ']'
+
+            rc = bj.sched_action_update(action_id, tmp_str)
+
+            if OpenNebula.is_error?(rc)
+                STDERR.puts "Error updating: #{rc.message}"
+                exit(-1)
+            end
+        end
+    end
+
+    def self.create_backupjob_template(options)
+        template_options = TEMPLATE_OPTIONS.map do |o|
+            o[:name].to_sym
+        end
+
+        template_options << :name
+
+        t = ''
+        template_options.each do |n|
+            t << "#{n.to_s.upcase}=\"#{options[n]}\"\n" if options[n]
+        end
+
+        t
+    end
+
+    private
+
+    def factory(id = nil)
+        if id
+            OpenNebula::BackupJob.new_with_id(id, @client)
+        else
+            xml=OpenNebula::BackupJob.build_xml
+            OpenNebula::BackupJob.new(xml, @client)
+        end
+    end
+
+    def factory_pool(user_flag = -2)
+        OpenNebula::BackupJobPool.new(@client, user_flag)
+    end
+
+    def format_resource(bj, options = {})
+        bj_hash = bj.to_hash
+
+        str='%-15s: %-20s'
+        str_h1='%-80s'
+
+        # ----------------------------------------------------------------------
+        CLIHelper.print_header(
+            str_h1 % "BACKUP JOB #{bj['ID']} INFORMATION"
+        )
+        # ----------------------------------------------------------------------
+        puts format(str, 'ID', bj.id.to_s)
+        puts format(str, 'NAME', bj.name)
+        puts format(str, 'USER', bj['UNAME'])
+        puts format(str, 'GROUP', bj['GNAME'])
+        puts format(str, 'LOCK', OpenNebulaHelper.level_lock_to_str(bj['LOCK/LOCKED']))
+
+        CLIHelper.print_header(str_h1 % 'PERMISSIONS', false)
+
+        ['OWNER', 'GROUP', 'OTHER'].each do |e|
+            mask = '---'
+            mask[0] = 'u' if bj["PERMISSIONS/#{e}_U"] == '1'
+            mask[1] = 'm' if bj["PERMISSIONS/#{e}_M"] == '1'
+            mask[2] = 'a' if bj["PERMISSIONS/#{e}_A"] == '1'
+
+            puts format(str, e, mask)
+        end
+        puts
+
+        # ----------------------------------------------------------------------
+        CLIHelper.print_header(
+            str_h1 % 'LAST BACKUP JOB EXECUTION INFORMATION'
+        )
+        # ----------------------------------------------------------------------
+        puts format(str, 'TIME', OpenNebulaHelper.time_to_str(bj['LAST_BACKUP_TIME']))
+        puts format(str, 'DURATION', OpenNebulaHelper.period_to_str(bj['LAST_BACKUP_DURATION']))
+        puts
+
+        # ----------------------------------------------------------------------
+        CLIHelper.print_header(
+            str_h1 % 'VIRTUAL MACHINE BACKUP STATUS'
+        )
+        # ----------------------------------------------------------------------
+        up  = bj.retrieve_elements('UPDATED_VMS/ID')
+        out = bj.retrieve_elements('OUTDATED_VMS/ID')
+        act = bj.retrieve_elements('BACKING_UP_VMS/ID')
+        err = bj.retrieve_elements('ERROR_VMS/ID')
+
+        up  = [] if up.nil?
+        out = [] if out.nil?
+        act = [] if act.nil?
+        err = [] if err.nil?
+
+        puts format(str, 'UPDATED', up.join(','))
+        puts format(str, 'OUTDATED', out.join(','))
+        puts format(str, 'ONGOING', act.join(','))
+        puts format(str, 'ERROR', err.join(','))
+
+        if bj.has_elements?('/BACKUPJOB/TEMPLATE/SCHED_ACTION')
+            puts
+            CLIHelper.print_header(str_h1 % 'SCHEDULED ACTIONS', false)
+
+            table = OpenNebulaHelper.scheduled_action_table(self)
+            table.show([bj_hash['BACKUPJOB']['TEMPLATE']['SCHED_ACTION']].flatten, {})
+        end
+
+        if !options[:all]
+            bj.delete_element('/BACKUPJOB/TEMPLATE/SCHED_ACTION')
+        end
+
+        puts
+
+        # ----------------------------------------------------------------------
+        CLIHelper.print_header(str_h1 % 'TEMPLATE CONTENTS', false)
+        # ----------------------------------------------------------------------
+        puts bj.template_str
+    end
+
+end