morpheus-cli 4.2.16 → 4.2.21

data/lib/morpheus/cli/boot_scripts_command.rb

@@ -279,7 +279,7 @@ class Morpheus::Cli::BootScriptsCommand
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[boot-script]")
-      build_common_options(opts, options, [:account, :auto_confirm, :json, :dry_run, :remote])
+      build_common_options(opts, options, [:auto_confirm, :json, :dry_run, :remote])
     end
     optparse.parse!(args)
 

data/lib/morpheus/cli/budgets_command.rb

@@ -570,16 +570,16 @@ class Morpheus::Cli::BudgetsCommand
       {'fieldName' => 'description', 'fieldLabel' => 'Description', 'type' => 'text', 'displayOrder' => 1},
       # {'fieldName' => 'enabled', 'fieldLabel' => 'Enabled', 'type' => 'checkbox', 'defaultValue' => true},
       {'fieldName' => 'scope', 'fieldLabel' => 'Scope', 'code' => 'budget.scope', 'type' => 'select', 'selectOptions' => [{'name'=>'Account','value'=>'account'},{'name'=>'Tenant','value'=>'tenant'},{'name'=>'Cloud','value'=>'cloud'},{'name'=>'Group','value'=>'group'},{'name'=>'User','value'=>'user'}], 'defaultValue' => 'account', 'required' => true, 'displayOrder' => 3},
-      {'fieldName' => 'tenant', 'fieldLabel' => 'Tenant', 'type' => 'select', 'optionSource' => lambda { 
+      {'fieldName' => 'tenant', 'fieldLabel' => 'Tenant', 'type' => 'select', 'optionSource' => lambda {|api_client, api_params| 
         @options_interface.options_for_source("tenants", {})['data']
       }, 'required' => true, 'dependsOnCode' => 'budget.scope:tenant', 'displayOrder' => 4},
-      {'fieldName' => 'user', 'fieldLabel' => 'User', 'type' => 'select', 'optionSource' => lambda { 
+      {'fieldName' => 'user', 'fieldLabel' => 'User', 'type' => 'select', 'optionSource' => lambda {|api_client, api_params|
         @options_interface.options_for_source("users", {})['data']
       }, 'required' => true, 'dependsOnCode' => 'budget.scope:user', 'displayOrder' => 5},
-      {'fieldName' => 'group', 'fieldLabel' => 'Group', 'type' => 'select', 'optionSource' => lambda { 
+      {'fieldName' => 'group', 'fieldLabel' => 'Group', 'type' => 'select', 'optionSource' => lambda {|api_client, api_params| 
         @options_interface.options_for_source("groups", {})['data']
       }, 'required' => true, 'dependsOnCode' => 'budget.scope:group', 'displayOrder' => 6},
-      {'fieldName' => 'cloud', 'fieldLabel' => 'Cloud', 'type' => 'select', 'optionSource' => lambda { 
+      {'fieldName' => 'cloud', 'fieldLabel' => 'Cloud', 'type' => 'select', 'optionSource' => lambda {|api_client, api_params| 
         @options_interface.options_for_source("clouds", {})['data']
       }, 'required' => true, 'dependsOnCode' => 'budget.scope:cloud', 'displayOrder' => 7},
       {'fieldName' => 'year', 'fieldLabel' => 'Period', 'type' => 'text', 'required' => true, 'defaultValue' => Time.now.year, 'description' => "The period (year) the budget applies to. Default is the current year.", 'displayOrder' => 8},

data/lib/morpheus/cli/cli_command.rb

@@ -1,5 +1,6 @@
 require 'yaml'
 require 'json'
+require 'fileutils'
 require 'morpheus/logging'
 require 'morpheus/benchmarking'
 require 'morpheus/cli/option_parser'
@@ -232,11 +233,11 @@ module Morpheus
       ## the standard options for a command that makes api requests (most of them)
 
       def build_standard_get_options(opts, options, includes=[], excludes=[])
-        build_common_options(opts, options, [:query, :json, :yaml, :csv, :fields, :quiet, :dry_run, :remote] + includes, excludes)
+        build_common_options(opts, options, includes + [:query, :json, :yaml, :csv, :fields, :quiet, :dry_run, :remote], excludes)
       end
 
       def build_standard_post_options(opts, options, includes=[], excludes=[])
-        build_common_options(opts, options, [:options, :payload, :json, :quiet, :dry_run, :remote] + includes, excludes)
+        build_common_options(opts, options, includes + [:options, :payload, :json, :quiet, :dry_run, :remote], excludes)
       end
 
       def build_standard_put_options(opts, options, includes=[], excludes=[])
@@ -244,7 +245,7 @@ module Morpheus
       end
 
       def build_standard_delete_options(opts, options, includes=[], excludes=[])
-        build_common_options(opts, options, [:auto_confirm, :query, :json, :quiet, :dry_run, :remote] + includes, excludes)
+        build_common_options(opts, options, includes + [:auto_confirm, :query, :json, :quiet, :dry_run, :remote], excludes)
       end
 
       # list is GET that supports phrase,max,offset,sort,direction
@@ -285,13 +286,24 @@ module Morpheus
         while (option_key = option_keys.shift) do
           case option_key.to_sym
 
-          when :account
-            opts.on('-a','--account ACCOUNT', "Account Name or ID") do |val|
+          when :tenant, :account
+            # todo: let's deprecate this in favor of :tenant --tenant to keep -a reserved for --all perhaps?
+            opts.on('--tenant TENANT', String, "Tenant (Account) Name or ID") do |val|
               options[:account] = val
             end
-            opts.on('-A','--account-id ID', "Account ID") do |val|
+            opts.on('--tenant-id ID', String, "Tenant (Account) ID") do |val|
               options[:account_id] = val
             end
+            # todo: let's deprecate this in favor of :tenant --tenant to keep -a reserved for --all perhaps?
+            opts.on('-a','--account ACCOUNT', "Alias for --tenant") do |val|
+              options[:account] = val
+            end
+            opts.on('-A','--account-id ID', "Tenant (Account) ID") do |val|
+              options[:account_id] = val
+            end
+            opts.add_hidden_option('--tenant-id') if opts.is_a?(Morpheus::Cli::OptionParser)
+            opts.add_hidden_option('-a, --account') if opts.is_a?(Morpheus::Cli::OptionParser)
+            opts.add_hidden_option('-A, --account-id') if opts.is_a?(Morpheus::Cli::OptionParser)
 
           when :options
             options[:options] ||= {}
@@ -459,7 +471,7 @@ module Morpheus
             end
 
             # arbitrary query parameters in the format -Q "category=web&phrase=nginx"
-            # opts.on( '-Q', '--query PARAMS', "Query parameters. PARAMS format is 'phrase=foobar&category=web'" ) do |val|
+            # opts.on( '-Q', '--query PARAMS', "Query parameters. PARAMS format is 'foo=bar&category=web'" ) do |val|
             #   options[:query_filters_raw] = val
             #   options[:query_filters] = {}
             #   # todo: smarter parsing
@@ -477,7 +489,7 @@ module Morpheus
 
           when :query, :query_filters
             # arbitrary query parameters in the format -Q "category=web&phrase=nginx"
-            opts.on( '-Q', '--query PARAMS', "Query parameters. PARAMS format is 'phrase=foobar&category=web'" ) do |val|
+            opts.on( '-Q', '--query PARAMS', "Query parameters. PARAMS format is 'foo=bar&category=web'" ) do |val|
               options[:query_filters_raw] = val
               options[:query_filters] = {}
               # todo: smarter parsing
@@ -512,6 +524,12 @@ module Morpheus
               end
             end
 
+          when :find_by_name
+            opts.on('--find-by-name', "Always treat the identifier argument as a name, never an ID. Useful for specifying names that look like numbers. eg. '1234'" ) do
+              options[:find_by_name] = true
+            end
+            # opts.add_hidden_option('--find-by-name') if opts.is_a?(Morpheus::Cli::OptionParser)
+
           when :remote
             opts.on( '-r', '--remote REMOTE', "Remote name. The current remote is used by default." ) do |val|
               options[:remote] = val
@@ -603,9 +621,17 @@ module Morpheus
             opts.add_hidden_option('json-raw') if opts.is_a?(Morpheus::Cli::OptionParser)
 
           when :yaml
-            opts.on(nil, '--yaml', "YAML Output") do
-              options[:yaml] = true
-              options[:format] = :yaml
+            # -y for --yes and for --yaml
+            if includes.include?(:auto_confirm)
+              opts.on(nil, '--yaml', "YAML Output") do
+                options[:yaml] = true
+                options[:format] = :yaml
+              end
+            else
+              opts.on('-y', '--yaml', "YAML Output") do
+                options[:yaml] = true
+                options[:format] = :yaml
+              end
             end
             opts.on(nil, '--yml', "alias for --yaml") do
               options[:yaml] = true
@@ -783,7 +809,11 @@ module Morpheus
         end
         opts.add_hidden_option('--no-debug') if opts.is_a?(Morpheus::Cli::OptionParser)
 
-
+        opts.on('--hidden-help', "Print help that includes all the hidden options, like this one." ) do
+          puts opts.full_help_message({show_hidden_options:true})
+          exit # return 0 maybe?
+        end
+        opts.add_hidden_option('--hidden-help') if opts.is_a?(Morpheus::Cli::OptionParser)
         opts.on('-h', '--help', "Print this help" ) do
           puts opts
           exit # return 0 maybe?
@@ -1011,7 +1041,7 @@ module Morpheus
         #   raise_command_error "Please specify a remote appliance with -r or see the command `remote use`"
         # end
 
-        Morpheus::Logging::DarkPrinter.puts "establishing connection to remote #{display_appliance(@appliance_name, @appliance_url)}" if Morpheus::Logging.debug?
+        Morpheus::Logging::DarkPrinter.puts "establishing connection to remote #{display_appliance(@appliance_name, @appliance_url)}" if Morpheus::Logging.debug? # && !options[:quiet]
 
         if options[:no_authorization]
           # maybe handle this here..
@@ -1082,7 +1112,7 @@ module Morpheus
         else
           if opts[:min]
             if args.count < opts[:min]
-              raise_args_error("not many arguments, expected #{opts[:min] || '0'}-#{opts[:max] || 'N'} and got #{args.count == 0 ? '0' : args.count.to_s + ': '}#{args.join(', ')}", args, opts[:optparse])
+              raise_args_error("not enough arguments, expected #{opts[:min] || '0'}-#{opts[:max] || 'N'} and got #{args.count == 0 ? '0' : args.count.to_s + ': '}#{args.join(', ')}", args, opts[:optparse])
             end
           end
           if opts[:max]
@@ -1173,22 +1203,32 @@ module Morpheus
         payload
       end
 
-      def render_response(json_response, options, object_key=nil, &block)
-        render_result = render_with_format(json_response, options, object_key)
-        if render_result
-          return  0, nil
-        else
-          if block_given?
-            return yield
+      def validate_outfile(outfile, options)
+        full_filename = File.expand_path(outfile)
+        outdir = File.dirname(full_filename)
+        if Dir.exists?(full_filename)
+          print_red_alert "[local-file] is invalid. It is the name of an existing directory: #{outfile}"
+          return false
+        end
+        if !Dir.exists?(outdir)
+          if options[:mkdir]
+            print cyan,"Creating local directory #{outdir}",reset,"\n"
+            FileUtils.mkdir_p(outdir)
           else
-            return 0, nil
+            print_red_alert "[local-file] is invalid. Directory not found: #{outdir}"
+            return false
           end
         end
+        if File.exists?(full_filename) && !options[:overwrite]
+          print_red_alert "[local-file] is invalid. File already exists: #{outfile}\nUse -f to overwrite the existing file."
+          return false
+        end
+        return true
       end
 
       # basic rendering for options :json, :yml, :csv, :quiet, and :outfile
       # returns the string rendered, or nil if nothing was rendered.
-      def render_with_format(json_response, options, object_key=nil, &block)
+      def render_response(json_response, options, object_key=nil, &block)
         output = nil
         if options[:json]
           output = as_json(json_response, options, object_key)
@@ -1201,32 +1241,50 @@ module Morpheus
           else
             output = records_as_csv([row], options)
           end
-        elsif options[:quiet]
-          # note: returning non nil means the calling function knows to return rght away.. kinda weird..
-          # but means we need less if options[:quiet] blocks in every action.
-          return ""
         end
-        if output
-          if options[:outfile]
+        if options[:outfile]
+          full_outfile = File.expand_path(options[:outfile])
+          if output
             print_to_file(output, options[:outfile], options[:overwrite])
+            print "#{cyan}Wrote output to file #{options[:outfile]} (#{File.size(full_outfile)} B)\n" unless options[:quiet]
           else
-            puts output
+            # uhhh ok lets try this
+            Morpheus::Logging::DarkPrinter.puts "using experimental feature: --out without a common format like json, yml or csv" if Morpheus::Logging.debug?
+            result = with_stdout_to_file(options[:outfile], options[:overwrite], 'w+', &block)
+            if result && result != 0
+              return result
+            end
+            print "#{cyan}Wrote output to file #{options[:outfile]} (#{File.size(full_outfile)} B)\n" unless options[:quiet]
+            return 0, nil
           end
         else
-          if block_given?
-            # invoke the user given block to render (print output)
-            # hope it returned something well formed, there's a parse method for that..
-            cmd_render_result = yield
-            # could try to support writing output to options[:outfile] here too.. 
-            # output is already printed inside block though
-            # if cmd_render_result
-            #   return output
-            # end
-          end 
+          # --quiet means do not render, still want to print to outfile though
+          if options[:quiet]
+            return 0, nil
+          end
+          # render ouput generated above
+          if output
+            puts output
+            return 0, nil
+          else
+            # no render happened, so calling the block if given
+            if block_given?
+              result = yield
+              if result
+                return result
+              else
+                return 0, nil
+              end
+            else
+              # nil means nothing was rendered, some methods still using render_with_format() are relying on this
+              return nil
+            end
+          end
         end
-        return output
       end
 
+      alias :render_with_format :render_response
+
       module ClassMethods
 
         def set_command_name(cmd_name)

data/lib/morpheus/cli/cloud_resource_pools_command.rb

@@ -326,6 +326,9 @@ class Morpheus::Cli::CloudResourcePoolsCommand
       opts.on('--active [on|off]', String, "Can be used to disable a resource pool") do |val|
         options['active'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
       end
+      opts.on('--default-pool [on|off]', String, "Set resource pool as the default") do |val|
+        options['defaultPool'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
+      end
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote])
       opts.footer = "Update a resource pool." + "\n" +
                     "[cloud] is required. This is the name or id of the cloud."
@@ -437,6 +440,11 @@ class Morpheus::Cli::CloudResourcePoolsCommand
         else
           payload['resourcePool']['active'] = true
         end
+
+        # Default
+        if options['defaultPool'] != nil
+          payload['resourcePool']['defaultPool'] = options['defaultPool']
+        end
         
         # Visibility
         if options['visibility'] != nil
@@ -552,6 +560,9 @@ class Morpheus::Cli::CloudResourcePoolsCommand
       opts.on('--active [on|off]', String, "Can be used to disable a resource pool") do |val|
         options['active'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
       end
+      opts.on('--default-pool [on|off]', String, "Set resource pool as the default") do |val|
+        options['defaultPool'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
+      end
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote])
       opts.footer = "Update a resource pool." + "\n" +
                     "[cloud] is required. This is the name or id of the cloud." + "\n"
@@ -641,6 +652,11 @@ class Morpheus::Cli::CloudResourcePoolsCommand
         if options['active'] != nil
           payload['resourcePool']['active'] = options['active']
         end
+
+        # Default
+        if options['defaultPool'] != nil
+          payload['resourcePool']['defaultPool'] = options['defaultPool']
+        end
         
         # Visibility
         if options['visibility'] != nil

data/lib/morpheus/cli/clouds.rb

@@ -46,11 +46,15 @@ class Morpheus::Cli::Clouds
       opts.on( '-t', '--type TYPE', "Cloud Type" ) do |val|
         options[:zone_type] = val
       end
-      build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
+      build_standard_list_options(opts, options)
       opts.footer = "List clouds."
     end
     optparse.parse!(args)
     connect(options)
+    # verify_args!(args:args, optparse:optparse, count:0)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
     begin
       if options[:zone_type]
         cloud_type = cloud_type_for_name(options[:zone_type])
@@ -71,15 +75,7 @@ class Morpheus::Cli::Clouds
       end
 
       json_response = @clouds_interface.list(params)
-      if options[:json]
-        puts as_json(json_response, options, "zones")
-        return 0
-      elsif options[:yaml]
-        puts as_yaml(json_response, options, "zones")
-        return 0
-      elsif options[:csv]
-        puts records_as_csv(json_response['zones'], options)
-      else
+      render_response(json_response, options, 'zones') do
         clouds = json_response['zones']
         title = "Morpheus Clouds"
         subtitles = []
@@ -99,6 +95,7 @@ class Morpheus::Cli::Clouds
         end
         print reset,"\n"
       end
+      return 0, nil
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
       exit 1

data/lib/morpheus/cli/clusters.rb

@@ -609,15 +609,6 @@ class Morpheus::Cli::Clusters
         option_type_list = ((controller_type['optionTypes'].reject { |type| !type['enabled'] || type['fieldComponent'] } rescue []) + layout['optionTypes'] +
           (cluster_type['optionTypes'].reject { |type| !type['enabled'] || !type['creatable'] || type['fieldComponent'] } rescue [])).sort { |type| type['displayOrder'] }
 
-        # remove volume options if volumes were configured
-        if !server_payload['volumes'].empty?
-          option_type_list = reject_volume_option_types(option_type_list)
-        end
-        # remove networkId option if networks were configured above
-        if !server_payload['networkInterfaces'].empty?
-          option_type_list = reject_networking_option_types(option_type_list)
-        end
-
         server_payload.deep_merge!(Morpheus::Cli::OptionTypes.prompt(option_type_list, options[:options], @api_client, {zoneId: cloud['id'], siteId: group['id'], layoutId: layout['id']}))
 
         # Worker count
@@ -1197,15 +1188,6 @@ class Morpheus::Cli::Clusters
           (type['fieldContext'] == 'instance.networkDomain' && type['fieldName'] == 'id')
         } rescue [])
 
-        # remove volume options if volumes were configured
-        if !server_payload['volumes'].empty?
-          option_type_list = reject_volume_option_types(option_type_list)
-        end
-        # remove networkId option if networks were configured above
-        if !server_payload['networkInterfaces'].empty?
-          option_type_list = reject_networking_option_types(option_type_list)
-        end
-
         server_payload.deep_merge!(Morpheus::Cli::OptionTypes.prompt(option_type_list, options[:options], @api_client, {zoneId: cloud['id'], siteId: group['id'], layoutId: layout['id']}))
 
         # Create User

data/lib/morpheus/cli/commands/standard/benchmark_command.rb

@@ -363,7 +363,7 @@ EOT
         else
           out << "\texit: 0 "
         end
-        total_time_str = "#{benchmark_record.duration.round((benchmark_record.duration > 0.002) ? 3 : 6)}s"
+        total_time_str = "#{benchmark_record.duration.round((benchmark_record.duration > 0.002) ? 3 : 6)} s"
         out << "\t #{total_time_str.ljust(9, ' ')}"
       else
         benchmark_records = []
@@ -384,8 +384,8 @@ EOT
         # all_durations = benchmark_records.collect {|benchmark_record| benchmark_record.duration }
         # total_duration = all_durations.inject(0.0) {|acc, i| acc + i }
         # avg_duration = total_duration / all_durations.size
-        # total_time_str = "#{total_duration.round((total_duration > 0.002) ? 3 : 6)}s"
-        # avg_time_str = "#{avg_duration.round((total_duration > 0.002) ? 3 : 6)}s"
+        # total_time_str = "#{total_duration.round((total_duration > 0.002) ? 3 : 6)} s"
+        # avg_time_str = "#{avg_duration.round((total_duration > 0.002) ? 3 : 6)} s"
 
         all_durations = []
         stats = {total: 0, avg: nil, min: nil, max: nil}
@@ -406,10 +406,10 @@ EOT
           stats[:avg] = stats[:total].to_f / all_durations.size
         end
 
-        total_time_str = "#{stats[:total].round((stats[:total] > 0.002) ? 3 : 6)}s"
-        min_time_str = stats[:min] ? "#{stats[:min].round((stats[:min] > 0.002) ? 3 : 6)}s" : ""
-        max_time_str = stats[:max] ? "#{stats[:max].round((stats[:max] > 0.002) ? 3 : 6)}s" : ""
-        avg_time_str = stats[:avg] ? "#{stats[:avg].round((stats[:avg] > 0.002) ? 3 : 6)}s" : ""
+        total_time_str = "#{stats[:total].round((stats[:total] > 0.002) ? 3 : 6)} s"
+        min_time_str = stats[:min] ? "#{stats[:min].round((stats[:min] > 0.002) ? 3 : 6)} s" : ""
+        max_time_str = stats[:max] ? "#{stats[:max].round((stats[:max] > 0.002) ? 3 : 6)} s" : ""
+        avg_time_str = stats[:avg] ? "#{stats[:avg].round((stats[:avg] > 0.002) ? 3 : 6)} s" : ""
 
         out = ""
         # <benchmark name or command>

data/lib/morpheus/cli/commands/standard/man_command.rb

@@ -176,7 +176,7 @@ morpheus v#{Morpheus::Cli::VERSION}
 
     To learn more about the Morpheus Appliance, visit https://www.morpheusdata.com/features
 
-    To learn more about the Morpheus API, visit http://bertramdev.github.io/morpheus-apidoc/ 
+    To learn more about the Morpheus API, visit https://apidocs.morpheusdata.com
 
 ## GLOBAL OPTIONS
 

data/lib/morpheus/cli/credentials.rb

@@ -87,7 +87,7 @@ module Morpheus
           rescue ::RestClient::Exception => e
             #raise e
             print_red_alert "Token not valid."
-            if options[:debug] || options[:debug]
+            if options[:debug]
               print_rest_exception(e, options)
             end
             wallet = nil
@@ -255,8 +255,7 @@ module Morpheus
         true
       end
 
-      def use_refresh_token(options = {})
-        #puts "use_refresh_token(#{options})"
+      def use_refresh_token(refresh_token_value, options = {})
         
         wallet = load_saved_credentials
 
@@ -265,22 +264,25 @@ module Morpheus
           return nil
         end
 
-        if wallet['refresh_token'].nil?
-          print_red_alert yellow,"No refresh token found for #{display_appliance(@appliance_name, @appliance_url)}",reset,"\n"
-          return nil
+        if refresh_token_value.nil?
+          if wallet['refresh_token']
+            refresh_token_value = wallet['refresh_token']
+          else
+            print_red_alert yellow,"No refresh token found for #{display_appliance(@appliance_name, @appliance_url)}",reset,"\n"
+            return nil
+          end
         end
 
-
         username = wallet['username']
 
         begin
           auth_interface = Morpheus::AuthInterface.new({url:@appliance_url})
           auth_interface.setopts(options)
           if options[:dry_run]
-            print_dry_run auth_interface.dry.use_refresh_token(wallet['refresh_token'])
+            print_dry_run auth_interface.dry.use_refresh_token(refresh_token_value)
             return nil
           end
-          json_response = auth_interface.use_refresh_token(wallet['refresh_token'])
+          json_response = auth_interface.use_refresh_token(refresh_token_value)
           #wallet = json_response
           login_date = Time.now
           expire_date = nil
@@ -311,6 +313,8 @@ module Morpheus
             print_rest_exception(e, options)
           end
           wallet = nil
+          # return now or else it will log them out
+          return nil
         end
 
         # save wallet to credentials file