opennebula-cli 7.0.2 → 7.1.80.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50f8ce43747b5160398fa1f2c496d59ac6854d2a3c23d3c8beaf29ed7a0638e0
-  data.tar.gz: 0d2b1ec37420a46c6832cb0ddbd2e53c3659c6fc4e2b7573e97c3ff095d8a61a
+  metadata.gz: 4e0a75e568244920c5ad5f5ef5c91d27a059240c29290bdbcadc12825689f7ff
+  data.tar.gz: 8b999e8828e35f872fc7c98b81d4a2643c84e0731a135c5bf76b141a8581aeec
 SHA512:
-  metadata.gz: 9d72ac369a7d99c345d06a2a2bc930f025568cb07e5bb5e72dabafe4244ca5820bd956152ac2c58f8abba28f15e2431fc29fe59ac55f38902c4b8fcd6534c1c4
-  data.tar.gz: 6f034ba5eab33981186ce1088b04456990ef375ad62586998c7fe4bc9099e865fe0263bc7679aefa7427d4714c7dedcc008952756abdc0819f9574ee993a37fe
+  metadata.gz: c4713fa611ccaad4a2b733056c749b8ef77a0b6cfddcdae0bc54b3638b9c84e945c44a173114515104f80e2b5cc34de31aba637a870ea7cdb2d5c40b37b2e5fd
+  data.tar.gz: 1fca59489877e11016777870efe98bc8d3a58099ec2cb24d1717a4cc8a1c6e16ec2024d7f88760ed5732e49d3f16e508e37d7582f3b230b7f259211c3075c62e

data/bin/oneform

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2025, 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.                                             #
+#--------------------------------------------------------------------------- #
+
+ONE_LOCATION = ENV['ONE_LOCATION']
+
+if !ONE_LOCATION
+    LIB_LOCATION      = '/usr/lib/one'
+    RUBY_LIB_LOCATION = '/usr/lib/one/ruby'
+    GEMS_LOCATION     = '/usr/share/one/gems'
+else
+    LIB_LOCATION      = ONE_LOCATION + '/lib'
+    RUBY_LIB_LOCATION = ONE_LOCATION + '/lib/ruby'
+    GEMS_LOCATION     = ONE_LOCATION + '/share/gems'
+end
+
+require 'load_opennebula_paths'
+
+$LOAD_PATH << RUBY_LIB_LOCATION
+$LOAD_PATH << RUBY_LIB_LOCATION + '/cli'
+
+USER_AGENT = 'CLI'
+
+require 'command_parser'
+require 'one_helper'
+require 'opennebula/oneform_client'
+require 'tempfile'
+
+require 'one_helper/oneform_helper'
+
+CommandParser::CmdParser.new(ARGV) do
+    FORMAT = [OpenNebulaHelper::JSON, OpenNebulaHelper::YAML]
+
+    usage '`oneform` <command> [<args>] [<options>]'
+    version OpenNebulaHelper::ONE_VERSION
+
+    set :option, OneForm::Client::DEFAULT_OPTIONS
+    set :option, CommandParser::VERSION
+    set :option, CommandParser::HELP
+
+    ENABLED = {
+        :name => 'enabled',
+        :short => '-e',
+        :large => '--enabled',
+        :description => 'Show only enabled providers',
+        :default => false
+    }
+
+    helper = OneFormHelper.new
+
+    ########################################################################
+    # Commands for interacting with oneform drivers
+    ########################################################################
+
+    list_desc = <<-EOT.unindent
+        List all drivers installed on the system.
+    EOT
+
+    command :list,
+            list_desc,
+            :options => FORMAT + CLIHelper::OPTIONS + [OpenNebulaHelper::DESCRIBE, ENABLED] do
+        enabled = options[:enabled] || false
+        helper.list_driver_pool(helper.client(options), options, :enabled => enabled)
+    end
+
+    top_desc = <<-EOT.unindent
+        List the available drivers continuously.
+    EOT
+
+    command :top,
+            top_desc,
+            :options => FORMAT + [CLIHelper::DELAY, ENABLED] do
+        Signal.trap('INT') { exit(-1) }
+        enabled = options[:enabled] || false
+        helper.top_driver_pool(helper.client(options), options, :enabled => enabled)
+
+        0
+    end
+
+    show_desc = <<-EOT.unindent
+        Show details of a specific driver.
+    EOT
+
+    command :show, show_desc, :driver_name, :options => FORMAT do
+        driver_name = args[0]
+
+        helper.format_resource(helper.client(options), driver_name, options)
+    end
+
+    sync_desc = <<-EOT.unindent
+        Synchronize OneForm drivers, refreshing and update available drivers
+    EOT
+
+    command :sync, sync_desc do
+        client      = helper.client(options)
+
+        response = client.sync_drivers
+
+        return [response[:err_code], response[:message]] \
+            if CloudClient.is_error?(response)
+
+        0
+    end
+
+    enable_desc = <<-EOT.unindent
+        Enable a driver in OneForm to permit the creation of new resources based on it.
+    EOT
+
+    command :enable, enable_desc, :driver_name do
+        client      = helper.client(options)
+        driver_name = args[0]
+
+        response = client.enable_driver(driver_name)
+
+        return [response[:err_code], response[:message]] \
+            if CloudClient.is_error?(response)
+
+        0
+    end
+
+    disable_desc = <<-EOT.unindent
+        Disables a driver in OneForm, avoiding creation of new resources based on it.
+    EOT
+
+    command :disable, disable_desc, :driver_name do
+        client   = helper.client(options)
+        driver_name = args[0]
+
+        response = client.disable_driver(driver_name)
+
+        return [response[:err_code], response[:message]] \
+            if CloudClient.is_error?(response)
+
+        0
+    end
+end

data/bin/onemarketapp

@@ -39,6 +39,9 @@ require 'command_parser'
 require 'one_helper/onemarketapp_helper'
 require 'one_helper/onemarket_helper'
 require 'one_helper/onedatastore_helper'
+require 'opennebula/template_pool'
+require 'opennebula/virtual_machine_pool'
+require 'opennebula/flow'
 
 CommandParser::CmdParser.new(ARGV) do
     usage '`onemarket` <command> [<args>] [<options>]'

data/bin/onetemplate

@@ -203,7 +203,8 @@ CommandParser::CmdParser.new(ARGV) do
             if !OpenNebula.is_error?(res)
                 puts "ID: #{res}"
             else
-                puts res.message
+                STDERR.puts res.message
+                exit(-1)
             end
         end
     end
@@ -253,6 +254,18 @@ CommandParser::CmdParser.new(ARGV) do
 
         number      = options[:multiple] || 1
         user_inputs = options[:user_inputs]
+        persistent  = !options[:persistent].nil?
+        flag        = nil
+
+        if persistent && (number > 1)
+            if options[:name] && !options[:name].include?('%i')
+                flag = '-%i'
+            elsif !options[:name]
+                STDERR.puts 'Persistent template cannot be instantiated multiple times ' <<
+                "without including a name (use '%i' to chose where to insert the index)."
+                next -1
+            end
+        end
 
         number.times.each_with_index do |i, index|
             exit_code = helper.perform_action(
@@ -260,7 +273,7 @@ CommandParser::CmdParser.new(ARGV) do
                 options,
                 'instantiated'
             ) do |t|
-                name   = options[:name]
+                name   = "#{options[:name]}#{flag}" if options[:name]
                 prefix = options[:prefix]
                 c_i    = nil
                 p      = nil
@@ -325,8 +338,6 @@ CommandParser::CmdParser.new(ARGV) do
 
                 extra_template.strip!
 
-                persistent = !options[:persistent].nil?
-
                 res = t.instantiate(name, on_hold, extra_template, persistent)
 
                 if !OpenNebula.is_error?(res)

data/bin/oneuser

@@ -52,7 +52,8 @@ CommandParser::CmdParser.new(ARGV) do
             rescue StandardError => e
                 STDERR.puts e.message
 
-                if e.message != OpenNebula::Client::NO_ONE_AUTH_ERROR
+                if e.message != OpenNebula::Client::NO_ONE_AUTH_ERROR &&
+                   e.message != OpenNebula::Client::GRPC_NOT_SUPPORTED
                     STDERR.puts e.backtrace
                 end
 

data/bin/onevm

@@ -41,6 +41,8 @@ require 'one_helper/onevm_helper'
 require 'one_helper/onedatastore_helper'
 require 'opennebula/virtual_machine_ext'
 
+require 'base64'
+
 CommandParser::CmdParser.new(ARGV) do
     usage '`onevm` <command> [<args>] [<options>]'
     version OpenNebulaHelper::ONE_VERSION
@@ -256,6 +258,13 @@ CommandParser::CmdParser.new(ARGV) do
         :description => 'Use only selected disk ID'
     }
 
+    CMD_STDIN = {
+        :name => 'stdin',
+        :large => '--stdin stdin',
+        :format => String,
+        :description => 'Data to pass to the command executed on the VM'
+    }
+
     OpenNebulaHelper::TEMPLATE_OPTIONS_VM.delete_if do |v|
         ['as_gid', 'as_uid'].include?(v[:name])
     end
@@ -647,8 +656,7 @@ CommandParser::CmdParser.new(ARGV) do
 
     migrate_desc = <<-EOT.unindent
         Migrates the given running VM to another Host. If used with --live
-        parameter the migration is done without downtime. Datastore migration is
-        not supported for --live flag.
+        parameter the migration is done without downtime.
 
         States: RUNNING
     EOT
@@ -1272,7 +1280,7 @@ CommandParser::CmdParser.new(ARGV) do
             )
 
             if !rc.nil?
-                puts rc.message
+                STDERR.puts rc.message
                 exit(-1)
             end
 
@@ -1517,6 +1525,43 @@ CommandParser::CmdParser.new(ARGV) do
         end
     end
 
+    exec_desc = <<-EOT.unindent
+        Execute a command inside a Virtual Machine.
+
+        States: RUNNING.
+    EOT
+
+    command :exec, exec_desc, [:range, :vmid_list], :cmd,
+            :options => [CMD_STDIN] do
+        helper.perform_actions(args[0], options, 'Executing a command') do |vm|
+            vm.exec(args[1], Base64.strict_encode64(options[:stdin] || ''))
+        end
+    end
+
+    exec_retry_desc = <<-EOT.unindent
+        Retries to execute the last command executed inside a Virtual Machine.
+
+        States: RUNNING.
+    EOT
+
+    command :"exec-retry", exec_retry_desc, [:range, :vmid_list] do
+        helper.perform_actions(args[0], options, 'Retrying last command') do |vm|
+            vm.exec_retry
+        end
+    end
+
+    exec_cancel_desc = <<-EOT.unindent
+        Cancel the command being executed inside a Virtual Machine.
+
+        States: RUNNING.
+    EOT
+
+    command :"exec-cancel", exec_cancel_desc, [:range, :vmid_list] do
+        helper.perform_actions(args[0], options, 'Canceling last command') do |vm|
+            vm.exec_cancel
+        end
+    end
+
     ########################### Charters Management ############################
 
     create_chart_desc = <<-EOT.unindent
@@ -1685,7 +1730,7 @@ CommandParser::CmdParser.new(ARGV) do
         You can specify the PCI device with --pci (short_address) or
         --pci_device (device ID), --pci_class (class ID) and/or --pci_vendor (vendor ID).
 
-        States: POWEROFF
+        States: POWEROFF, UNDEPLOYED
     EOT
 
     command :"pci-attach", pci_attach_desc, :vmid,
@@ -1730,7 +1775,7 @@ CommandParser::CmdParser.new(ARGV) do
     pci_detach_desc = <<-EOT.unindent
         Detaches a PCI device from a VM
 
-        States: POWEROFF
+        States: POWEROFF, UNDEPLOYED
     EOT
 
     command :"pci-detach", pci_detach_desc, :vmid, :pciid do

data/bin/onevntemplate

@@ -173,7 +173,8 @@ CommandParser::CmdParser.new(ARGV) do
             if !OpenNebula.is_error?(res)
                 puts "ID: #{res}"
             else
-                puts res.message
+                STDERR.puts res.message
+                exit(-1)
             end
         end
     end

data/bin/onezone

@@ -130,15 +130,20 @@ CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :"server-add", addserver_desc, :zoneid, :options =>
-        [OneZoneHelper::SERVER_NAME, OneZoneHelper::SERVER_ENDPOINT] do
-        if options[:server_name].nil? || options[:server_rpc].nil?
+        [OneZoneHelper::SERVER_NAME, OneZoneHelper::SERVER_ENDPOINT,
+         OneZoneHelper::SERVER_ENDPOINT_GRPC] do
+        if options[:server_name].nil? || (options[:server_rpc].nil? && options[:server_grpc].nil?)
             STDERR.puts 'To add a server set:'
             STDERR.puts "\t-n <server name>"
-            STDERR.puts "\t-r <RPC endpoint>"
+            STDERR.puts "\t-r <XML-RPC endpoint>"
+            STDERR.puts "\t-g <gRPC endpoint>"
             exit(-1)
         end
 
-        if !%r{^(http|https):\/\/}.match(options[:server_rpc])
+        puts "#{options[:server_rpc]}:#{options[:server_grpc]}"
+
+        if !options[:server_rpc].nil? && !options[:server_rpc].empty? &&
+           !%r{^(http|https):\/\/}.match(options[:server_rpc])
             puts 'Wrong protocol specified. Only http or https allowed!'
             exit(-1)
         end
@@ -146,7 +151,8 @@ CommandParser::CmdParser.new(ARGV) do
         template = <<-EOT
             SERVER = [
               NAME="#{options[:server_name]}",
-              ENDPOINT="#{options[:server_rpc]}"
+              ENDPOINT="#{options[:server_rpc]}",
+              ENDPOINT_GRPC="#{options[:server_grpc]}"
             ]
         EOT
 

data/lib/cli_helper.rb

@@ -265,6 +265,158 @@ module CLIHelper
         exit(-1)
     end
 
+    # Render a small HTML subset for terminal output
+    # Supports: p, br, ul/ol/li, strong/b, em/i, code, a[href]
+    def self.render_html(text)
+        return '' if text.nil? || text.empty?
+
+        use_ansi = $stdout.tty?
+
+        bold_on  = use_ansi ? "\33[1m"  : ''
+        faint_on = use_ansi ? "\33[2m"  : ''
+        reset    = use_ansi ? "\33[0m"  : ''
+        mono_on  = use_ansi ? "\33[36m" : ''
+        bullet   = use_ansi ? '•' : '*'
+
+        # OSC 8 hyperlink escape (clickable links)
+        osc8_link = lambda do |label, url|
+            return "#{label} (#{url})" unless use_ansi
+
+            "\e]8;;#{url}\a#{label}\e]8;;\a"
+        end
+
+        s = text.to_s.gsub("\r\n", "\n")
+
+        # Block tags -> newlines
+        s = s.gsub(%r{<\s*br\s*/?\s*>}i, "\n")
+        s = s.gsub(%r{<\s*/\s*p\s*>}i, "\n")
+        s = s.gsub(/<\s*p\b[^>]*>/i, '')
+        s = s.gsub(%r{<\s*/\s*(div|section|article)\s*>}i, "\n\n")
+        s = s.gsub(/<\s*(div|section|article)\b[^>]*>/i, '')
+
+        # Links: <a href="url">label</a>
+        s = s.gsub(%r{<\s*a\b[^>]*href\s*=\s*["']([^"']+)["'][^>]*>(.*?)<\s*/\s*a\s*>}im) do
+            url   = Regexp.last_match(1).strip
+            label = Regexp.last_match(2).to_s
+            osc8_link.call(label, url)
+        end
+
+        # Lists
+        s = s.gsub(/<\s*li\b[^>]*>/i, "#{bullet} ")
+
+        # Inline formatting
+        if use_ansi
+            s = s.gsub(%r{<\s*/\s*(strong|b)\s*>}i, reset)
+            s = s.gsub(/<\s*(strong|b)\b[^>]*>/i, bold_on)
+
+            s = s.gsub(%r{<\s*/\s*(em|i)\s*>}i, reset)
+            s = s.gsub(/<\s*(em|i)\b[^>]*>/i, faint_on)
+
+            # <code>
+            s = s.gsub(%r{<\s*code\b[^>]*>(.*?)<\s*/\s*code\s*>}im) do
+                "#{faint_on}#{mono_on}#{Regexp.last_match(1)}#{reset}"
+            end
+        else
+            s = s.gsub(%r{<\s*/?\s*(strong|b|em|i|code)\b[^>]*>}i, '')
+        end
+
+        # Remove any remaining tags
+        s = s.gsub(/<[^>]+>/, '')
+
+        # Decode minimal HTML entities
+        s = s.gsub('&amp;', '&')
+             .gsub('&lt;', '<')
+             .gsub('&gt;', '>')
+             .gsub('&quot;', '"')
+             .gsub('&#39;', "'")
+             .gsub('&nbsp;', ' ')
+
+        # Normalize whitespace
+        s = s.lines.map(&:rstrip).join("\n")
+        s.gsub(/\n{3,}/, "\n\n").strip
+    end
+
+    # Render a small Markdown subset for terminal output. Supports headings,
+    # bold, italic, inline code, and unordered lists.
+    def self.render_md(text)
+        return '' if text.nil? || text.empty?
+
+        use_ansi  = $stdout.tty?
+
+        bold_on   = use_ansi ? "\33[1m"  : ''
+        reset     = use_ansi ? "\33[0m"  : ''
+        faint_on  = use_ansi ? "\33[2m"  : ''
+        mono_on   = use_ansi ? "\33[36m" : ''
+        bullet    = use_ansi ? '•' : '*'
+
+        # OSC 8 hyperlink sequences
+        osc8_link = lambda do |label, url|
+            return "#{label} (#{url})" unless use_ansi
+
+            "\e]8;;#{url}\a#{label}\e]8;;\a"
+        end
+
+        lines = text.to_s.gsub("\r\n", "\n").split("\n", -1)
+
+        out = lines.map do |line|
+            # Preserve empty lines
+            if line.strip.empty?
+                ''
+            # Headings (#, ##, ###)
+            elsif (m = line.match(/\A\s{0,3}(\#{1,3})\s+(.*)\z/))
+                title = m[2].strip
+                "#{bold_on}#{title}#{reset}"
+            # Unordered list items (*, -, +)
+            elsif (m = line.match(/\A(\s*)[*+-]\s+(.*)\z/))
+                indent = m[1]
+                item   = m[2]
+                "#{indent}#{bullet} #{item}"
+            else
+                line
+            end
+        end.join("\n")
+
+        # Links [label](url)
+        out = out.gsub(/\[([^\]]+)\]\(([^)]+)\)/) do
+            label = Regexp.last_match(1)
+            url   = Regexp.last_match(2).strip
+            osc8_link.call(label, url)
+        end
+
+        # Autolinks <https://example.com>
+        out = out.gsub(/<((?:https?|mailto):[^>\s]+)>/) do
+            url = Regexp.last_match(1)
+            osc8_link.call(url, url)
+        end
+
+        # Inline formatting (simple, non-nested)
+        if use_ansi
+            # Inline code: `code`
+            out = out.gsub(/`([^`]+)`/) do
+                m = Regexp.last_match(1)
+                "#{faint_on}#{mono_on}#{m}#{reset}"
+            end
+
+            # Bold: **text**
+            out = out.gsub(/\*\*([^\*]+)\*\*/) do
+                m = Regexp.last_match(1)
+                "#{bold_on}#{m}#{reset}"
+            end
+
+            # Italic: *text*
+            out = out.gsub(/(^|[^*])\*([^*\n]+)\*(?!\*)/) do
+                m1 = Regexp.last_match(1)
+                m2 = Regexp.last_match(2)
+                "#{m1}#{faint_on}#{m2}#{reset}"
+            end
+        else
+            # Non-tty, keep markdown mostly as-is, but normalize list bullets
+            out = out.gsub(/\A(\s*)[*+-]\s+/m, "\\1#{bullet} ")
+        end
+
+        out
+    end
+
     # Check if value is in base64
     #
     # @param value [String] Value to check

data/lib/one_helper/oneacct_helper.rb

@@ -16,6 +16,8 @@
 
 require 'one_helper'
 require 'optparse/time'
+require 'opennebula/virtual_machine'
+require 'opennebula/virtual_machine_pool'
 
 class AcctHelper < OpenNebulaHelper::OneHelper
     TIME_ZONE_CUR = {

data/lib/one_helper/oneacl_helper.rb

@@ -15,6 +15,8 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/acl'
+require 'opennebula/acl_pool'
 
 # Helper for oneacl command
 class OneAclHelper < OpenNebulaHelper::OneHelper

data/lib/one_helper/onebackupjob_helper.rb

@@ -15,6 +15,8 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/backupjob'
+require 'opennebula/backupjob_pool'
 
 # Helper for onebackupjob command
 class OneBackupJobHelper < OpenNebulaHelper::OneHelper

data/lib/one_helper/onecluster_helper.rb

@@ -15,6 +15,9 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/cluster'
+require 'opennebula/cluster_pool'
+require 'opennebula/host'
 
 # OneCluster CLI command helper
 class OneClusterHelper < OpenNebulaHelper::OneHelper

data/lib/one_helper/onedatastore_helper.rb

@@ -15,6 +15,9 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/datastore'
+require 'opennebula/datastore_pool'
+require 'opennebula/image'
 
 class OneDatastoreHelper < OpenNebulaHelper::OneHelper
     DATASTORE = {