opennebula-cli 5.6.2 → 5.7.80.pre

data/bin/onevntemplate

@@ -0,0 +1,361 @@
+#!/usr/bin/env ruby
+
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2018, 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
+    RUBY_LIB_LOCATION = '/usr/lib/one/ruby'
+else
+    RUBY_LIB_LOCATION = ONE_LOCATION + '/lib/ruby'
+end
+
+$LOAD_PATH << RUBY_LIB_LOCATION
+$LOAD_PATH << RUBY_LIB_LOCATION + '/cli'
+
+require 'command_parser'
+require 'one_helper/onevntemplate_helper'
+require 'one_helper/onevnet_helper'
+require 'pry'
+
+CommandParser::CmdParser.new(ARGV) do
+    usage '`onevntemplate` <command> [<args>] [<options>]'
+    version OpenNebulaHelper::ONE_VERSION
+
+    helper = OneVNTemplateHelper.new
+
+    before_proc do
+        helper.set_client(options)
+    end
+
+    USE = {
+        :name => 'use',
+        :large => '--use',
+        :description => 'lock use actions'
+    }
+
+    MANAGE = {
+        :name => 'manage',
+        :large => '--manage',
+        :description => 'lock manage actions'
+    }
+
+    ADMIN = {
+        :name => 'admin',
+        :large => '--admin',
+        :description => 'lock admin actions'
+    }
+
+    ALL = {
+        :name => 'all',
+        :large => '--all',
+        :description => 'lock all actions'
+    }
+
+    ########################################################################
+    # Global Options
+    ########################################################################
+    set :option, CommandParser::OPTIONS + OpenNebulaHelper::CLIENT_OPTIONS
+
+    list_options = CLIHelper::OPTIONS
+    list_options << OpenNebulaHelper::XML
+    list_options << OpenNebulaHelper::NUMERIC
+    list_options << OpenNebulaHelper::DESCRIBE
+
+    instantiate_options = [
+        OneVNTemplateHelper::VN_NAME,
+        OneVNTemplateHelper::MULTIPLE,
+        OneVNTemplateHelper::EXTENDED,
+        OpenNebulaHelper::AS_USER,
+        OpenNebulaHelper::AS_GROUP
+    ]
+
+    ########################################################################
+    # Formatters for arguments
+    ########################################################################
+    set :format, :groupid, OpenNebulaHelper.rname_to_id_desc('GROUP') do |arg|
+        OpenNebulaHelper.rname_to_id(arg, 'GROUP')
+    end
+
+    set :format, :userid, OpenNebulaHelper.rname_to_id_desc('USER') do |arg|
+        OpenNebulaHelper.rname_to_id(arg, 'USER')
+    end
+
+    set :format, :templateid, OneVNTemplateHelper.to_id_desc do |arg|
+        helper.to_id(arg)
+    end
+
+    set :format, :templateid_list, OneVNTemplateHelper.list_to_id_desc do |arg|
+        helper.list_to_id(arg)
+    end
+
+    set :format, :filterflag, OneVNTemplateHelper.filterflag_to_i_desc do |arg|
+        helper.filterflag_to_i(arg)
+    end
+
+    ########################################################################
+    # Commands
+    ########################################################################
+
+    create_desc = <<-EOT.unindent
+        Creates a new Virtual Network Template from the given description
+
+        Examples:
+          - using a Virtual Network Template description file:
+
+            onevntemplate create vn_description.tmpl
+
+    EOT
+
+    command :create, create_desc, [:file, nil], :options =>
+            [OpenNebulaHelper::DRY] do
+
+        helper.create_resource(options) do |tmpl|
+            begin
+                if args[0]
+                    template = File.read(args[0])
+                end
+
+                if options[:dry]
+                    puts template
+                    exit 0
+                else
+                    tmpl.allocate(template)
+                end
+            rescue StandardError => e
+                STDERR.puts e.messsage
+                exit(-1)
+            end
+        end
+    end
+
+    clone_desc = <<-EOT.unindent
+        Creates a new VN Template from an existing one
+    EOT
+
+    command :clone, clone_desc, :templateid, :name do
+        helper.perform_action(args[0], options, 'cloned') do |t|
+            res = t.clone(args[1])
+
+            if !OpenNebula.is_error?(res)
+                puts "ID: #{res}"
+            else
+                puts res.message
+            end
+        end
+    end
+
+    delete_desc = <<-EOT.unindent
+        Deletes the given VN Template
+    EOT
+
+    command :delete, delete_desc, [:range, :templateid_list] do
+        helper.perform_actions(args[0], options, 'deleted') do |t|
+            t.delete
+        end
+    end
+
+    instantiate_desc = <<-EOT.unindent
+        Creates a new VN instance from the given VN Template. This VN can be
+        managed with the 'onevnet' command.
+
+        The source Template can be modified adding or replacing attributes with
+        the optional file argument, or with the options.
+    EOT
+
+    command :instantiate, instantiate_desc, :templateid, [:file, nil],
+            :options => instantiate_options + OneVNetHelper::ADDAR_OPTIONS do
+        exit_code = 0
+
+        number = options[:multiple] || 1
+
+        number.times do |i|
+            exit_code = helper.perform_action(args[0], options,
+                                              'instantiated') do |t|
+                name = options[:name]
+                name = name.gsub('%i', i.to_s) if name
+
+                extra_template = ''
+                rc = t.info
+
+                if OpenNebula.is_error?(rc)
+                    STDERR.puts rc.message
+                    exit(-1)
+                end
+
+                if args[1]
+                    extra_template = File.read(args[1])
+                else
+                    res = OpenNebulaHelper.create_template(options, t)
+
+                    if res.first != 0
+                        STDERR.puts res.last
+                        next -1
+                    end
+
+                    extra_template = res.last
+
+                    if OneVNetHelper.add_ar_options_used?(options)
+                        extra_template << OpenNebulaHelper.create_ar(options)
+                    end
+                end
+
+                res = t.instantiate(name, extra_template)
+
+                if !OpenNebula.is_error?(res)
+                    puts "VN ID: #{res}"
+                end
+
+                res
+            end
+
+            break if exit_code == -1
+        end
+
+        exit_code
+    end
+
+    chgrp_desc = <<-EOT.unindent
+        Changes the VN Template group
+    EOT
+
+    command :chgrp, chgrp_desc, [:range, :templateid_list], :groupid do
+        helper.perform_actions(args[0], options, 'Group changed') do |t|
+            t.chown(-1, args[1].to_i)
+        end
+    end
+
+    chown_desc = <<-EOT.unindent
+        Changes the VN Template owner and group
+    EOT
+
+    command :chown, chown_desc, [:range, :templateid_list], :userid,
+            [:groupid, nil] do
+        args[2].nil? ? gid = -1 : gid = args[2].to_i
+        helper.perform_actions(args[0], options, 'Owner/Group changed') do |t|
+            t.chown(args[1].to_i, gid)
+        end
+    end
+
+    chmod_desc = <<-EOT.unindent
+        Changes the VN Template permissions
+    EOT
+
+    command :chmod, chmod_desc, [:range, :templateid_list], :octet do
+        recursive = (options[:recursive] == true)
+
+        helper.perform_actions(args[0], options, 'Permissions changed') do |t|
+            t.chmod_octet(args[1], recursive)
+        end
+    end
+
+    update_desc = <<-EOT.unindent
+        Update the VN template contents. If a path is not provided the editor will
+        be launched to modify the current content.
+    EOT
+
+    command :update, update_desc, :templateid, [:file, nil],
+            :options => OpenNebulaHelper::APPEND do
+        helper.perform_action(args[0], options, 'modified') do |obj|
+            if options[:append]
+                str = OpenNebulaHelper.append_template(args[0], obj, args[1])
+            else
+                str = OpenNebulaHelper.update_template(args[0], obj, args[1])
+            end
+
+            helper.set_client(options)
+            obj = helper.retrieve_resource(obj.id)
+
+            obj.update(str, options[:append])
+        end
+    end
+
+    list_desc = <<-EOT.unindent
+        Lists VN Templates in the pool
+    EOT
+
+    rename_desc = <<-EOT.unindent
+        Renames the VN Template
+    EOT
+
+    command :rename, rename_desc, :templateid, :name do
+        helper.perform_action(args[0], options, 'renamed') do |o|
+            o.rename(args[1])
+        end
+    end
+
+    command :list, list_desc, [:filterflag, nil], :options => list_options do
+        helper.list_pool(options, false, args[0])
+    end
+
+    show_desc = <<-EOT.unindent
+        Shows information for the given VN Template
+    EOT
+
+    command :show, show_desc, :templateid,
+            :options => [OpenNebulaHelper::XML, OneTemplateHelper::EXTENDED] do
+
+        helper.show_resource(args[0], options)
+    end
+
+    top_desc = <<-EOT.unindent
+        Lists Templates continuously
+    EOT
+
+    command :top, top_desc, [:filterflag, nil], :options => list_options do
+        helper.list_pool(options, true, args[0])
+    end
+
+    lock_desc = <<-EOT.unindent
+        Locks a VN template with differents levels for lock any actions with this VN template,
+        show and monitoring never will be locked.
+        Valid states are: All.
+        Levels:
+        [Use]: locks Admin, Manage and Use actions.
+        [Manage]: locks Manage and Use actions.
+        [Admin]: locks only Admin actions.
+    EOT
+
+    command :lock, lock_desc, :templateid,
+            :options => [USE, MANAGE, ADMIN, ALL] do
+        helper.perform_action(args[0], options, 'VN Template locked') do |t|
+            if !options[:use].nil?
+                level = 1
+            elsif !options[:manage].nil?
+                level = 2
+            elsif !options[:admin].nil?
+                level = 3
+            elsif !options[:all].nil?
+                level = 4
+            else
+                level = 1
+            end
+            t.lock(level)
+        end
+    end
+
+    unlock_desc = <<-EOT.unindent
+        Unlocks a VN template for unlock any actions with this VN template.
+        Valid states are: All.
+    EOT
+
+    command :unlock, unlock_desc, :templateid do
+        helper.perform_action(args[0], options, 'VN Template unlocked') do |t|
+            t.unlock
+        end
+    end
+end

data/bin/onevrouter

@@ -16,24 +16,24 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
-ONE_LOCATION=ENV["ONE_LOCATION"]
+ONE_LOCATION = ENV['ONE_LOCATION']
 
 if !ONE_LOCATION
-    RUBY_LIB_LOCATION="/usr/lib/one/ruby"
+    RUBY_LIB_LOCATION = '/usr/lib/one/ruby'
 else
-    RUBY_LIB_LOCATION=ONE_LOCATION+"/lib/ruby"
+    RUBY_LIB_LOCATION = ONE_LOCATION + '/lib/ruby'
 end
 
-$: << RUBY_LIB_LOCATION
-$: << RUBY_LIB_LOCATION+"/cli"
+$LOAD_PATH << RUBY_LIB_LOCATION
+$LOAD_PATH << RUBY_LIB_LOCATION + '/cli'
 
 require 'command_parser'
 require 'one_helper/onevrouter_helper'
 require 'one_helper/onetemplate_helper'
 require 'one_helper/onevm_helper'
 
-cmd=CommandParser::CmdParser.new(ARGV) do
-    usage "`onevrouter` <command> [<args>] [<options>]"
+CommandParser::CmdParser.new(ARGV) do
+    usage '`onevrouter` <command> [<args>] [<options>]'
     version OpenNebulaHelper::ONE_VERSION
 
     helper = OneVirtualRouterHelper.new
@@ -42,34 +42,34 @@ cmd=CommandParser::CmdParser.new(ARGV) do
         helper.set_client(options)
     end
 
-    USE={
-        :name  => "use",
-        :large => "--use",
-        :description => "lock use actions"
+    USE = {
+        :name => 'use',
+        :large => '--use',
+        :description => 'lock use actions'
     }
 
-    MANAGE={
-        :name  => "manage",
-        :large => "--manage",
-        :description => "lock manage actions"
+    MANAGE = {
+        :name => 'manage',
+        :large => '--manage',
+        :description => 'lock manage actions'
     }
 
-    ADMIN={
-        :name  => "admin",
-        :large => "--admin",
-        :description => "lock admin actions"
+    ADMIN = {
+        :name => 'admin',
+        :large => '--admin',
+        :description => 'lock admin actions'
     }
 
-    ALL={
-        :name  => "all",
-        :large => "--all",
-        :description => "lock all actions"
+    ALL = {
+        :name => 'all',
+        :large => '--all',
+        :description => 'lock all actions'
     }
 
     ########################################################################
     # Global Options
     ########################################################################
-    set :option, CommandParser::OPTIONS+OpenNebulaHelper::CLIENT_OPTIONS
+    set :option, CommandParser::OPTIONS + OpenNebulaHelper::CLIENT_OPTIONS
 
     list_options = CLIHelper::OPTIONS
     list_options << OpenNebulaHelper::XML
@@ -79,28 +79,31 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     ########################################################################
     # Formatters for arguments
     ########################################################################
-    set :format, :groupid, OpenNebulaHelper.rname_to_id_desc("GROUP") do |arg|
-        OpenNebulaHelper.rname_to_id(arg, "GROUP")
+    set :format, :groupid, OpenNebulaHelper.rname_to_id_desc('GROUP') do |arg|
+        OpenNebulaHelper.rname_to_id(arg, 'GROUP')
     end
 
-    set :format, :userid, OpenNebulaHelper.rname_to_id_desc("USER") do |arg|
-        OpenNebulaHelper.rname_to_id(arg, "USER")
+    set :format, :userid, OpenNebulaHelper.rname_to_id_desc('USER') do |arg|
+        OpenNebulaHelper.rname_to_id(arg, 'USER')
     end
 
     set :format, :vrouterid, OneVirtualRouterHelper.to_id_desc do |arg|
         helper.to_id(arg)
     end
 
-    set :format, :vrouterid_list, OneVirtualRouterHelper.list_to_id_desc do |arg|
+    set :format, :vrouterid_list,
+        OneVirtualRouterHelper.list_to_id_desc do |arg|
         helper.list_to_id(arg)
     end
 
-    set :format, :filterflag, OneVirtualRouterHelper.filterflag_to_i_desc do |arg|
+    set :format, :filterflag,
+        OneVirtualRouterHelper.filterflag_to_i_desc do |arg|
         helper.filterflag_to_i(arg)
     end
 
-    set :format, :templateid, OpenNebulaHelper.rname_to_id_desc("VMTEMPLATE") do |arg|
-        OpenNebulaHelper.rname_to_id(arg, "VMTEMPLATE")
+    set :format, :templateid,
+        OpenNebulaHelper.rname_to_id_desc('VMTEMPLATE') do |arg|
+        OpenNebulaHelper.rname_to_id(arg, 'VMTEMPLATE')
     end
 
     ########################################################################
@@ -117,9 +120,9 @@ cmd=CommandParser::CmdParser.new(ARGV) do
                 template = File.read(args[0])
 
                 obj.allocate(template)
-            rescue => e
+            rescue StandardError => e
                 STDERR.puts e.messsage
-                exit -1
+                exit(-1)
             end
         end
     end
@@ -139,27 +142,28 @@ cmd=CommandParser::CmdParser.new(ARGV) do
         OneVMHelper::HOLD
     ]
 
-    command :instantiate, instantiate_desc, :vrouterid, :templateid, [:file, nil],
-            :options=>instantiate_options+OpenNebulaHelper::TEMPLATE_OPTIONS do
-        exit_code=0
+    command :instantiate, instantiate_desc,
+            :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."
-            next -1
+            STDERR.puts 'You cannot use both template file and template' \
+                        ' creation options.'
+            exit(-1)
         end
 
         number = options[:multiple] || 1
         user_inputs = nil
 
-        helper.perform_action(args[0], options, "instantiated") do |vr|
-            name = options[:name] || ""
+        helper.perform_action(args[0], options, 'instantiated') do |vr|
+            name = options[:name] || ''
 
             t = OpenNebula::Template.new_with_id(args[1], helper.client)
 
-            on_hold = options[:hold] != nil
+            on_hold = !options[:hold].nil?
 
-            extra_template = ""
+            extra_template = ''
             rc = t.info
 
             if OpenNebula.is_error?(rc)
@@ -180,7 +184,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
                 extra_template = res.last
             end
 
-            user_inputs = OneTemplateHelper.get_user_inputs(t.to_hash) unless user_inputs
+            user_inputs ||= OneTemplateHelper.get_user_inputs(t.to_hash)
 
             extra_template << "\n" << user_inputs
 
@@ -193,7 +197,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :delete, delete_desc, [:range, :vrouterid_list] do
-        helper.perform_actions(args[0],options,"deleted") do |obj|
+        helper.perform_actions(args[0], options, 'deleted') do |obj|
             obj.delete
         end
     end
@@ -202,8 +206,8 @@ cmd=CommandParser::CmdParser.new(ARGV) do
         Changes the Virtual Router group
     EOT
 
-    command :chgrp, chgrp_desc,[:range, :vrouterid_list], :groupid do
-        helper.perform_actions(args[0],options,"Group changed") do |obj|
+    command :chgrp, chgrp_desc, [:range, :vrouterid_list], :groupid do
+        helper.perform_actions(args[0], options, 'Group changed') do |obj|
             obj.chown(-1, args[1].to_i)
         end
     end
@@ -213,9 +217,9 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :chown, chown_desc, [:range, :vrouterid_list], :userid,
-            [:groupid,nil] do
-        gid = args[2].nil? ? -1 : args[2].to_i
-        helper.perform_actions(args[0],options,"Owner/Group changed") do |obj|
+            [:groupid, nil] do
+        args[2].nil? ? gid = -1 : gid = args[2].to_i
+        helper.perform_actions(args[0], options, 'Owner/Group changed') do |obj|
             obj.chown(args[1].to_i, gid)
         end
     end
@@ -225,7 +229,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :chmod, chmod_desc, [:range, :vrouterid_list], :octet do
-        helper.perform_actions(args[0],options, "Permissions changed") do |obj|
+        helper.perform_actions(args[0], options, 'Permissions changed') do |obj|
             obj.chmod_octet(args[1])
         end
     end
@@ -236,8 +240,8 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :update, update_desc, :vrouterid, [:file, nil],
-    :options=>OpenNebulaHelper::APPEND do
-        helper.perform_action(args[0],options,"modified") do |obj|
+            :options => OpenNebulaHelper::APPEND do
+        helper.perform_action(args[0], options, 'modified') do |obj|
             if options[:append]
                 str = OpenNebulaHelper.append_template(args[0], obj, args[1])
             else
@@ -253,7 +257,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :rename, rename_desc, :vrouterid, :name do
-        helper.perform_action(args[0],options,"renamed") do |obj|
+        helper.perform_action(args[0], options, 'renamed') do |obj|
             obj.rename(args[1])
         end
     end
@@ -267,14 +271,16 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :"nic-attach", nic_attach_desc, :vrouterid,
-            :options => [OneVMHelper::FILE, OneVMHelper::NETWORK, OneVMHelper::IP,
+            :options => [OneVMHelper::FILE,
+                         OneVMHelper::NETWORK,
+                         OneVMHelper::IP,
                          OneVirtualRouterHelper::FLOAT] do
 
-        if options[:file].nil? and options[:network].nil?
-            STDERR.puts "Provide a template file or a network:"
+        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
+            exit(-1)
         end
 
         if options[:file]
@@ -291,13 +297,13 @@ cmd=CommandParser::CmdParser.new(ARGV) do
             end
 
             if float
-                template += ", FLOATING_IP =\"yes\""
+                template += ', FLOATING_IP ="yes"'
             end
 
-            template += " ]"
+            template += ' ]'
         end
 
-        helper.perform_action(args[0],options,"Attach NIC") do |vr|
+        helper.perform_action(args[0], options, 'Attach NIC') do |vr|
             vr.nic_attach(template)
         end
     end
@@ -309,7 +315,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     command :"nic-detach", nic_detach_desc, :vrouterid, :nicid do
         nicid = args[1].to_i
 
-        helper.perform_action(args[0],options,"Detach NIC") do |vr|
+        helper.perform_action(args[0], options, 'Detach NIC') do |vr|
             vr.nic_detach(nicid)
         end
     end
@@ -318,7 +324,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
         Lists the Virtual Routers in the pool
     EOT
 
-    command :list, list_desc, [:filterflag, nil], :options=>list_options do
+    command :list, list_desc, [:filterflag, nil], :options => list_options do
         helper.list_pool(options, false, args[0])
     end
 
@@ -327,15 +333,15 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :show, show_desc, :vrouterid,
-            :options=>[OpenNebulaHelper::XML, OneVMHelper::ALL_TEMPLATE] do
-        helper.show_resource(args[0],options)
+            :options => [OpenNebulaHelper::XML, OneVMHelper::ALL_TEMPLATE] do
+        helper.show_resource(args[0], options)
     end
 
     top_desc = <<-EOT.unindent
         Lists Virtual Routers continuously
     EOT
 
-    command :top, top_desc, [:filterflag, nil], :options=>list_options do
+    command :top, top_desc, [:filterflag, nil], :options => list_options do
         helper.list_pool(options, true, args[0])
     end
 
@@ -350,8 +356,8 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :lock, lock_desc, :vrouterid,
-        :options => [USE, MANAGE, ADMIN, ALL] do
-        helper.perform_action(args[0],options,"VRouter locked") do |vr|
+            :options => [USE, MANAGE, ADMIN, ALL] do
+        helper.perform_action(args[0], options, 'VRouter locked') do |vr|
             if !options[:use].nil?
                 level = 1
             elsif !options[:manage].nil?
@@ -373,7 +379,7 @@ cmd=CommandParser::CmdParser.new(ARGV) do
     EOT
 
     command :unlock, unlock_desc, :vrouterid do
-        helper.perform_action(args[0],options,"VRouter unlocked") do |vr|
+        helper.perform_action(args[0], options, 'VRouter unlocked') do |vr|
             vr.unlock
         end
     end