morpheus-cli 5.3.2.3 → 5.3.3

data/lib/morpheus/cli/monitoring_checks_command.rb

@@ -158,11 +158,13 @@ class Morpheus::Cli::MonitoringChecksCommand
           end
         },
         "Type" => lambda {|it| format_monitoring_check_type(it) },
+        "API Key" => lambda {|it| it['apiKey'] },
         "Created By" => lambda {|it| it['createdBy'] ? it['createdBy']['username'] : "System" },
         "Date Created" => lambda {|it| format_local_dt(it['dateCreated']) },
         "Last Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
         # "Last Error" => lambda {|it| format_local_dt(it['lastErrorDate']) },
       }
+      description_cols.delete("API Key") if !['pushCheck'].include?(check['checkType']['code']) || check['apiKey'].nil?
       print_description_list(description_cols, check)
 
       # Last Error

data/lib/morpheus/cli/networks_command.rb

@@ -619,7 +619,7 @@ class Morpheus::Cli::NetworksCommand
           api_params['network.site.id'] = group ? group['id'] : 'shared'
           api_params['network.type.id'] = network_type['id']
           api_params['network.networkServer.id'] = network_server_id if !network_server_id.nil?
-          network_type_params = Morpheus::Cli::OptionTypes.prompt(network_type_option_types,options[:options],@api_client, api_params)
+          network_type_params = Morpheus::Cli::OptionTypes.prompt(network_type_option_types,(options[:options] || {}).merge(payload),@api_client, api_params)
           # network context options belong at network level and not network.network
           network_context_params = network_type_params.delete('network')
           payload['network'].deep_merge!(network_context_params) if network_context_params

data/lib/morpheus/cli/option_parser.rb

@@ -32,27 +32,35 @@ module Morpheus
           #out << "Options:\n"
           # the default way..
           # out << summarize().join("")
-
           # super hacky, should be examining the option, not the fully formatted description
           my_summaries = summarize()
-          summarize().each do |opt_description|
-            is_hidden = (@hidden_options || []).find { |hidden_switch|
-              # opt_description.include?("--#{hidden_switch}")
-              if hidden_switch.start_with?("-")
-                opt_description.to_s.strip.start_with?("#{hidden_switch} ")
-              else
-                opt_description.to_s.strip.start_with?("--#{hidden_switch} ")
-              end
-            }
-            if is_hidden
-              if opts[:show_hidden_options]
-                # out << opt_description + " (hidden)"
-                out << opt_description
+          if opts[:show_hidden_options]
+            my_summaries.each do |full_line|
+              out << full_line
+            end
+          else
+            on_hidden_option = false
+            my_summaries.each do |full_line|
+              opt_description = full_line.to_s.strip
+              if opt_description.start_with?("-")
+                is_hidden = (@hidden_options || []).find { |hidden_switch|
+                  if hidden_switch.start_with?("-")
+                    opt_description.start_with?("#{hidden_switch} ")
+                  else
+                    opt_description.start_with?("--#{hidden_switch} ")
+                  end
+                }
+                if is_hidden
+                  on_hidden_option = true
+                else
+                  on_hidden_option = false
+                  out << full_line
+                end
               else
-                # hidden
+                if on_hidden_option == false
+                  out << full_line
+                end
               end
-            else
-              out << opt_description
             end
           end
         end

data/lib/morpheus/cli/option_types.rb

@@ -61,11 +61,11 @@ module Morpheus
         ).each do |option_type|
           context_map = results
           value = nil
-          value_found=false
+          value_found = false
+          field_group = (option_type['fieldGroup'] || 'default').to_s.sub(/options\Z/i, "").strip # avoid "ADVANCED OPTION OPTIONS"
 
-          if cur_field_group != (option_type['fieldGroup'] || 'default')
-            cur_field_group = option_type['fieldGroup']
-            cur_field_group = cur_field_group.to_s.sub(/options\Z/i, "").strip # avoid "ADVANCED OPTION OPTIONS"
+          if cur_field_group != field_group
+            cur_field_group = field_group
             print "\n#{cur_field_group.upcase} OPTIONS\n#{"=" * ("#{cur_field_group} OPTIONS".length)}\n\n"
           end
 
@@ -102,10 +102,10 @@ module Morpheus
             end
 
             found_dep_value = match_type == 'all' ? true : false
-            visible_option_check_value.split(',').each do |value|
+            visible_option_check_value.sub(',', ' ').split(' ').each do |value|
               parts = value.split(':')
               depends_on_code = parts[0]
-              depends_on_value = parts.count > 1 ? parts[1].to_s.strip : '.'
+              depends_on_value = parts.count > 1 ? parts[1].to_s.strip : nil
               depends_on_option_type = option_types.find {|it| it["code"] == depends_on_code }
               if !depends_on_option_type
                 depends_on_option_type = option_types.find {|it|
@@ -115,13 +115,18 @@ module Morpheus
 
               if depends_on_option_type
                 depends_on_field_key = depends_on_option_type['fieldContext'].nil? || depends_on_option_type['fieldContext'].empty? ? "#{depends_on_option_type['fieldName']}" : "#{depends_on_option_type['fieldContext']}.#{depends_on_option_type['fieldName']}"
-                field_value = get_object_value(results, depends_on_field_key) || get_object_value(options, depends_on_field_key)
+              else
+                depends_on_field_key = depends_on_code
+              end
 
-                if !field_value.nil? && field_value.match?(depends_on_value)
-                  found_dep_value = true if match_type != 'all'
-                else
-                  found_dep_value = false if match_type == 'all'
-                end
+              field_value = get_object_value(results, depends_on_field_key) ||
+                            get_object_value(options, depends_on_field_key) ||
+                            get_object_value(api_params, depends_on_field_key)
+
+              if !field_value.nil? && (depends_on_value.nil? || depends_on_value.empty? || field_value.match?(depends_on_value))
+                found_dep_value = true if match_type != 'all'
+              else
+                found_dep_value = false if match_type == 'all'
               end
             end
             next if !found_dep_value
@@ -237,7 +242,7 @@ module Morpheus
               # I suppose the entered value should take precedence
               # api_params = api_params.merge(options) # this might be good enough
               # dup it
-              value = select_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), options[:no_prompt], nil, paging_enabled)
+              value = select_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).deep_merge(results)), options[:no_prompt], nil, paging_enabled)
               if value && option_type['type'] == 'multiSelect'
                 value = [value]
                 while self.confirm("Add another #{option_type['fieldLabel']}?", {:default => false}) do
@@ -276,7 +281,8 @@ module Morpheus
             value = [value] if !value.nil? && !value.is_a?(Array)
             # parent_context_map[parent_ns] = value
           end
-          context_map[field_name] = value
+          context_map[field_name] = value if !(value.nil? || (value.is_a?(Hash) && value.empty?))
+          parent_context_map.reject! {|k,v| k == parent_ns && (v.nil? || (v.is_a?(Hash) && v.empty?))}
         end
         results
       end
@@ -947,8 +953,9 @@ module Morpheus
         out << "\n"
         out << "#{header}\n"
         out << "#{'=' * header.length}\n"
+
         select_options.each do |option|
-          out << " * #{option['name']} [#{option['value']}]\n"
+          out << (option['isGroup'] ? "- #{option['name']}\n" : " * #{option['name']} [#{option['value']}]\n")
         end
         return out
       end

data/lib/morpheus/cli/vdi_pools_command.rb

@@ -418,6 +418,7 @@ EOT
       "Name" => 'name',
       "Description" => 'description',
       "Persistent" => lambda {|it| format_boolean(it['persistentUser']) },
+      "Recyclable" => lambda {|it| it['recyclable'].nil? ? nil : format_boolean(it['recyclable']) },
       "Enabled" => lambda {|it| format_boolean(it['enabled']) },
       "Pool Usage" => lambda {|it| 
         # todo: [==      ]  2/8 would be neat generate_usage_bar(...)
@@ -447,12 +448,13 @@ EOT
       "Max Size" => lambda {|it| format_number(it['maxPoolSize']) rescue '' },
       "Lease Timeout" => lambda {|it| format_number(it['allocationTimeoutMinutes']) rescue '' },
       "Persistent" => lambda {|it| format_boolean(it['persistentUser']) },
+      "Recyclable" => lambda {|it| it['recyclable'].nil? ? nil : format_boolean(it['recyclable']) },
+      "Enabled" => lambda {|it| format_boolean(it['enabled']) },
       "Allow Copy" => lambda {|it| format_boolean(it['allowCopy']) },
       "Allow Printer" => lambda {|it| format_boolean(it['allowPrinter']) },
       "Allow File Share" => lambda {|it| format_boolean(it['allowFileshare']) },
       "Allow Hypervisor Console" => lambda {|it| format_boolean(it['allowHypervisorConsole']) },
       "Auto Create User" => lambda {|it| format_boolean(it['autoCreateLocalUserOnReservation']) },
-      "Enabled" => lambda {|it| format_boolean(it['enabled']) },
       "Logo" => lambda {|it| it['logo'] || it['imagePath'] },
       #"Config" => lambda {|it| it['config'] },
       "Group" => lambda {|it| it['group'] ? it['group']['name'] : nil },
@@ -484,6 +486,7 @@ EOT
       {'fieldName' => 'maxPoolSize', 'fieldLabel' => 'Max Size', 'type' => 'number', 'required' => true, 'description' => 'Max limit on number of allocations and instances within the pool.'},
       {'fieldName' => 'allocationTimeoutMinutes', 'fieldLabel' => 'Lease Timeout', 'type' => 'number', 'description' => 'Time (in minutes) after a user disconnects before an allocation is recycled or shutdown depending on persistence.'},
       {'fieldName' => 'persistentUser', 'fieldLabel' => 'Persistent', 'type' => 'checkbox', 'defaultValue' => false},
+      {'fieldName' => 'recyclable', 'fieldLabel' => 'Recyclable', 'type' => 'checkbox', 'defaultValue' => false, 'description' => 'Recyclable VDI Pools only work with cloud types that support snapshot management (i.e. Vmware, Nutanix, VCD)'},
       {'fieldName' => 'allowCopy', 'fieldLabel' => 'Allow Copy', 'type' => 'checkbox', 'defaultValue' => false},
       {'fieldName' => 'allowPrinter', 'fieldLabel' => 'Allow Printer', 'type' => 'checkbox', 'defaultValue' => false},
       {'fieldName' => 'allowFileshare', 'fieldLabel' => 'Allow File Share', 'type' => 'checkbox', 'defaultValue' => false},

data/lib/morpheus/cli/version.rb

@@ -1,6 +1,6 @@
 
 module Morpheus
   module Cli
-    VERSION = "5.3.2.3"
+    VERSION = "5.3.3"
   end
 end

data/lib/morpheus/cli/virtual_images.rb

@@ -11,8 +11,7 @@ class Morpheus::Cli::VirtualImages
   include Morpheus::Cli::ProvisioningHelper
 
   register_subcommands :list, :get, :add, :add_file, :remove_file, :update, :remove, :types => :virtual_image_types
-  alias_subcommand :details, :get
-  set_default_subcommand :list
+  register_subcommands :list_locations, :get_location, :remove_location
 
   # def initialize() 
   # 	# @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance	
@@ -188,6 +187,7 @@ EOT
       image = json_response['virtualImage']
       image_config = image['config'] || {}
       image_volumes = image['volumes'] || []
+      image_locations = image['locations'] || []
       image_files = json_response['cloudFiles'] || json_response['files']
       image_type = virtual_image_type_for_name_or_code(image['imageType'])
       image_type_display = image_type ? "#{image_type['name']}" : image['imageType']
@@ -255,7 +255,7 @@ EOT
           # print "\n", reset
         end
 
-        if image_files
+        if image_files && !image_files.empty?
           print_h2 "Files (#{image_files.size})"
           # image_files.each {|image_file|
           #   pretty_filesize = Filesize.from("#{image_file['size']} B").pretty
@@ -270,6 +270,11 @@ EOT
           print as_pretty_table(image_file_rows, [:filename, :size])
           # print reset,"\n"
         end
+        
+        if image_locations && !image_locations.empty?
+          print_h2 "Locations", options
+          print as_pretty_table(image_locations, virtual_image_location_list_column_definitions.upcase_keys!, options)
+        end
 
         if options[:details] && image_config && !image_config.empty?
           print_h2 "Config", options
@@ -689,7 +694,7 @@ EOT
       image = find_virtual_image_by_name_or_id(image_name)
       return 1 if image.nil?
       unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the virtual image filename #{filename}?")
-        exit
+        return 9, "aborted"
       end
       @virtual_images_interface.setopts(options)
       if options[:dry_run]
@@ -709,44 +714,188 @@ EOT
   end
 
   def remove(args)
+    params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[name]")
-      build_common_options(opts, options, [:auto_confirm, :json, :dry_run, :remote])
+      opts.banner = subcommand_usage("[image] [location]")
+      opts.on('--remove-from-cloud [true|false]', String, "Remove from all clouds. Default is true.") do |val|
+        options[:options]['removeFromCloud'] = ['','true','on'].include?(val.to_s)
+      end
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete a virtual image.
+[image] is required. This is the name or id of a virtual image.
+EOT
     end
     optparse.parse!(args)
-    if args.count < 1
-      puts optparse
-      exit 1
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    image = find_virtual_image_by_name_or_id(args[0])
+    return 1, "virtual image not found for '#{args[0]}'" if image.nil?
+    params.merge!(parse_query_options(options))
+    # Delete prompt
+    # [ X ] Remove from all clouds
+    v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'removeFromCloud', 'fieldLabel' => 'Remove from all clouds', 'type' => 'checkbox', 'defaultValue' => true, 'required' => true, 'description' => "Remove from all clouds"}], options[:options], @api_client)
+    remove_from_cloud = v_prompt['removeFromCloud'].to_s == 'true' || v_prompt['removeFromCloud'].to_s == 'on'
+    params['removeFromCloud'] = remove_from_cloud
+    
+    # Delete confirmation
+    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the virtual image #{image['name']}?")
+      return 9, "aborted"
+    end
+    
+    @virtual_images_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_images_interface.dry.destroy(image['id'], params)
+      return
+    end
+    json_response = @virtual_images_interface.destroy(image['id'], params)
+    render_response(json_response, options) do
+      print_green_success "Removed virtual image #{image['name']}"
+    end
+    return 0, nil
+  end
+
+  def list_locations(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[image]")
+      build_standard_list_options(opts, options)
+      opts.footer = <<-EOT
+List virtual image locations for a specific virtual image.
+[image] is required. This is the name or id of a virtual image.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1)
+    if args.count > 1
+      options[:phrase] = args[1..-1].join(" ")
     end
-    image_name = args[0]
     connect(options)
-    begin
-      image = find_virtual_image_by_name_or_id(image_name)
-      return 1 if image.nil?
-      unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the virtual image #{image['name']}?")
-        exit
-      end
-      @virtual_images_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @virtual_images_interface.dry.destroy(image['id'])
-        return
-      end
-      json_response = @virtual_images_interface.destroy(image['id'])
-      if options[:json]
-        print JSON.pretty_generate(json_response)
+    image = find_virtual_image_by_name_or_id(args[0])
+    return 1, "virtual image not found for '#{args[0]}'" if image.nil?
+    params.merge!(parse_list_options(options))
+    @virtual_images_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_images_interface.dry.list_locations(image['id'], params)
+      return
+    end
+    json_response = @virtual_images_interface.list_locations(image['id'], params)
+    records = json_response['locations']
+    render_response(json_response, options, 'virtualImages') do
+      title = "Virtual Image Locations"
+      subtitles = parse_list_subtitles(options)
+      print_h1 title, subtitles
+      if records.empty?
+        print cyan,"No virtual image locations found.",reset,"\n"
       else
-        print "\n", cyan, "Virtual Image #{image['name']} removed", reset, "\n\n"
+        print as_pretty_table(records, virtual_image_location_list_column_definitions.upcase_keys!, options)
+        print_results_pagination(json_response)
       end
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+
+  def get_location(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[image] [location]")
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a virtual image location.
+[image] is required. This is the name or id of a virtual image.
+[location] is required. This is the name or id of a virtual image location.
+EOT
     end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:2)
+    connect(options)
+    image = find_virtual_image_by_name_or_id(args[0])
+    return 1, "virtual image not found for '#{args[0]}'" if image.nil?
+    location = find_virtual_image_location_by_name_or_id(image['id'], args[1])
+    return 1, "location not found for '#{args[1]}'" if location.nil?
+    params.merge!(parse_query_options(options))
+    @virtual_images_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_images_interface.dry.get_location(image['id'], location['id'])
+      return 0, nil
+    end
+    # json_response = @virtual_images_interface.get(image['id'], location['id'])
+    json_response = {'location' => location} # skip redundant request
+    render_response(json_response, options, 'location') do
+      location = json_response['location']
+      volumes = location['volumes'] || []
+      print_h1 "Virtual Image Location Details", [], options
+      print_description_list(virtual_image_location_column_definitions, location, options)
+      if volumes && !volumes.empty?
+        print_h2 "Volumes", options
+        volume_rows = location_volumes.collect do |volume|
+          {name: volume['name'], size: Filesize.from("#{volume['rawSize']} B").pretty}
+        end
+        print cyan
+        print as_pretty_table(volume_rows, [:name, :size], options)
+        print cyan
+        # print "\n", reset
+      end
+      print reset,"\n"
+    end
+    return 0, nil
   end
 
+  def remove_location(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[image] [location]")
+      opts.on('--remove-from-cloud [true|false]', String, "Remove from cloud. Default is true.") do |val|
+        options[:options]['removeFromCloud'] = ['','true','on'].include?(val.to_s)
+      end
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete a virtual image location.
+[image] is required. This is the name or id of a virtual image.
+[location] is required. This is the name or id of a virtual image location.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:2)
+    connect(options)
+    image = find_virtual_image_by_name_or_id(args[0])
+    return 1, "virtual image not found for '#{args[0]}'" if image.nil?
+    location = find_virtual_image_location_by_name_or_id(image['id'], args[1])
+    return 1, "location not found for '#{args[1]}'" if location.nil?
+
+    params.merge!(parse_query_options(options))
+    
+    # Delete prompt
+    # [ X ] Remove from cloud
+    v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'removeFromCloud', 'fieldLabel' => 'Remove from cloud', 'type' => 'checkbox', 'defaultValue' => true, 'required' => true, 'description' => "Remove from cloud"}], options[:options], @api_client)
+    remove_from_cloud = v_prompt['removeFromCloud'].to_s == 'true' || v_prompt['removeFromCloud'].to_s == 'on'
+    params['removeFromCloud'] = remove_from_cloud
+    
+    # Delete confirmation
+    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the virtual image location #{location['id']}?")
+      return 9, "aborted"
+    end
+    
+    @virtual_images_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_images_interface.dry.destroy_location(image['id'], location['id'], params)
+      return
+    end
+    json_response = @virtual_images_interface.destroy_location(image['id'], location['id'], params)
+    render_response(json_response, options) do
+      print_green_success "Removed virtual image location #{location['id']}"
+    end
+    return 0, nil
+  end
 
   private
-    def find_virtual_image_by_name_or_id(val)
+  
+  def find_virtual_image_by_name_or_id(val)
     if val.to_s =~ /\A\d{1,}\Z/
       return find_virtual_image_by_id(val)
     else
@@ -911,4 +1060,75 @@ EOT
     out
   end
 
+
+  ## Virtual Image Locations
+
+  def virtual_image_location_object_key
+    "location"
+  end
+
+  def virtual_image_location_list_key
+    "locations"
+  end
+
+  def find_virtual_image_location_by_name_or_id(virtual_image_id, val)
+    if val.to_s =~ /\A\d{1,}\Z/
+      return find_virtual_image_location_by_id(virtual_image_id, val)
+    else
+      return find_virtual_image_location_by_name(virtual_image_id, val)
+    end
+  end
+
+  def virtual_image_location_list_column_definitions
+    virtual_image_location_column_definitions
+  end
+
+  def virtual_image_location_column_definitions
+    {
+      "ID" => 'id',
+      "Name" => 'imageName',
+      "Cloud" => lambda {|it| it['cloud']['name'] rescue '' }, 
+      "Public" => lambda {|it| format_boolean(it['isPublic']) },
+      "Region" => lambda {|it| it['imageRegion'] }, 
+      "External ID" => lambda {|it| it['externalId'] }, 
+      "Price Plan" => lambda {|it| it['pricePlan'] ? it['pricePlan']['name'] : nil }, 
+      # "Virtual Image" => lambda {|it| it['virtualImage']['name'] rescue '' }, 
+      # "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+      # "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) }
+    }
+  end
+
+
+  def find_virtual_image_location_by_id(virtual_image_id, id)
+    begin
+      json_response = @virtual_images_interface.get_location(virtual_image_id, id.to_i)
+      return json_response[virtual_image_location_object_key]
+    rescue RestClient::Exception => e
+      if e.response && e.response.code == 404
+        print_red_alert "Virtual Image Location not found by id '#{id}'"
+      else
+        raise e
+      end
+    end
+  end
+
+  def find_virtual_image_location_by_name(virtual_image_id, name)
+    json_response = @virtual_images_interface.list_locations(virtual_image_id, {imageName: name.to_s})
+    virtual_image_locations = json_response[virtual_image_location_list_key]
+    if virtual_image_locations.empty?
+      print_red_alert "Virtual Image Location not found by name '#{name}'"
+      return nil
+    elsif virtual_image_locations.size > 1
+      print_red_alert "#{virtual_image_locations.size} Virtual Image Locations found by name '#{name}'"
+      print_error "\n"
+      puts_error as_pretty_table(virtual_image_locations, {"ID" => 'id', "NAME" => 'imageName'}, {color:red})
+      print_red_alert "Try using ID instead"
+      print_error reset,"\n"
+      return nil
+    else
+      return virtual_image_locations[0]
+    end
+  end
+
+
 end