morpheus-cli 8.0.7 → 8.0.9

data/lib/morpheus/cli/commands/instances.rb

@@ -2915,12 +2915,18 @@ class Morpheus::Cli::Instances
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[instance]")
-      opts.on( '--name VALUE', String, "Snapshot Name. Default is server name + timestamp" ) do |val|
+      opts.on( '--name VALUE', String, "Snapshot Name. Default is \"{name}.{timestamp}\"" ) do |val|
         options[:options]['name'] = val
       end
       opts.on( '--description VALUE', String, "Snapshot Description." ) do |val|
         options[:options]['description'] = val
       end
+      opts.on('--memory-snapshot [on|off]', String, "Memory Snapshot? Whether to include the memory state in the snapshot.") do |val|
+        options[:options]['memorySnapshot'] = val.to_s == '' || val.to_s == 'on' || val.to_s == 'true'
+      end
+      opts.on('--for-export [on|off]', String, "For Export? Indicates the snapshot is intended for export to storage.") do |val|
+        options[:options]['forExport'] = val.to_s == '' || val.to_s == 'on' || val.to_s == 'true'
+      end
       opts.on('--refresh [SECONDS]', String, "Refresh until execution is complete. Default interval is #{default_refresh_interval} seconds.") do |val|
         options[:refresh_interval] = val.to_s.empty? ? default_refresh_interval : val.to_f
       end
@@ -2937,15 +2943,36 @@ EOT
     verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
     instance = find_instance_by_name_or_id(args[0])
-    unless options[:yes] || ::Morpheus::Cli::OptionTypes::confirm("Are you sure you would like to snapshot the instance '#{instance['name']}'?", options)
-      exit 1
-    end
+    
     payload = {}
     if options[:payload]
       payload = options[:payload]
       payload.deep_merge!({'snapshot' => parse_passed_options(options)})
     else
       payload.deep_merge!({'snapshot' => parse_passed_options(options)})
+      snapshot = payload['snapshot']
+      # prompt for name and description
+      name = prompt_value({'fieldName' => 'name', 'type' => 'text', 'fieldLabel' => 'Snapshot Name', 'description' => "Snapshot Name. Default is \"{name}.{timestamp}\""}, options)
+      snapshot['name'] = name if !name.to_s.empty?
+      description = prompt_value({'fieldName' => 'description', 'type' => 'text', 'fieldLabel' => 'Description', 'description' => "Snapshot Description."}, options)
+      snapshot['description'] = description if !description.to_s.empty?
+      # need to GET provision type for some settings...
+      provision_type = nil
+      begin
+        provision_type = @provision_types_interface.get(instance['layout']['provisionTypeId'])['provisionType']
+      rescue => ex
+        Morpheus::Logging::DarkPrinter.puts "Failed to load provision type!" if Morpheus::Logging.debug?
+      end
+      if provision_type && provision_type['hasMemorySnapshots']
+        # prompt for memorySnapshot
+        memory_snapshot = prompt_value({'fieldName' => 'memorySnapshot', 'type' => 'checkbox', 'fieldLabel' => 'Memory Snapshot?', 'description' => "Snapshot Description."}, options)
+        snapshot['memorySnapshot'] = memory_snapshot if !memory_snapshot.to_s.empty?
+      end
+      # convert "on" and "off" to true/false
+      payload.booleanize!
+    end
+    unless options[:yes] || ::Morpheus::Cli::OptionTypes::confirm("Are you sure you would like to snapshot the instance '#{instance['name']}'?", options)
+      exit 1
     end
     @instances_interface.setopts(options)
     if options[:dry_run]
@@ -3470,17 +3497,18 @@ EOT
   def snapshots(args)
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[instance]")
+      opts.banner = subcommand_usage("[instance] [snapshot]")
       # no pagination yet
       # build_standard_list_options(opts, options)
-      build_standard_get_options(opts, options)
+      build_standard_list_options(opts, options, [:details])
             opts.footer = <<-EOT
 List snapshots for an instance.
 [instance] is required. This is the name or id of an instance
+[snapshot] is optional. this is the name or id a snapshot to filter by.
 EOT
     end
     optparse.parse!(args)
-    verify_args!(args:args, optparse:optparse, count:1)
+    verify_args!(args:args, optparse:optparse, min:1, max: 2)
     connect(options)
     begin
       instance = find_instance_by_name_or_id(args[0])
@@ -3491,25 +3519,52 @@ EOT
         return
       end
       json_response = @instances_interface.snapshots(instance['id'], params)
-      snapshots = json_response['snapshots']      
+      snapshots = json_response['snapshots']
+      # [snapshots] is done with post api filtering by id or name or externalId
+      if args[1]
+        if args[1] =~ /\A\d{1,}\Z/
+          snapshots = snapshots.select {|it| it['id'].to_s == args[1] }
+        else
+          # snapshots = snapshots.select {|it| it['name'] == args[1] || it['externalId'] == args[1] }
+          # match beginning of name of externalId
+          snapshots = snapshots.select {|it| it['name'].to_s.index(args[1]) == 0 || it['externalId'].to_s.index(args[1])  == 0 }
+        end
+        json_response['snapshots'] = snapshots # update response for -j filtering too
+      end
       render_response(json_response, options, 'snapshots') do
         print_h1 "Snapshots: #{instance['name']} (#{instance['instanceType']['name']})", [], options
         if snapshots.empty?
-          print cyan,"No snapshots found",reset,"\n"
+          if args[1]
+            print cyan,"No snapshots found for '#{args[1]}'",reset,"\n"
+          elsif
+            print cyan,"No snapshots found",reset,"\n"
+          end
+          print reset, "\n"
         else
-          snapshot_column_definitions = {
-            "ID" => lambda {|it| it['id'] },
-            "Name" => lambda {|it| it['name'] },
-            "Description" => lambda {|it| it['description'] },
-            # "Type" => lambda {|it| it['snapshotType'] },
-            "Date Created" => lambda {|it| format_local_dt(it['snapshotCreated']) },
-            "Status" => lambda {|it| format_snapshot_status(it) }
-          }
-          print cyan
-          print as_pretty_table(snapshots, snapshot_column_definitions.upcase_keys!, options)
-          print_results_pagination({size: snapshots.size, total: snapshots.size})
+          if options[:details]
+            if snapshots.size > 3
+              print cyan, "Showing first 3 snapshots. Use the ID to get more details.", reset, "\n"
+              snapshots = snapshots.first(3) # this actually makes a request for each one here so don't go crazy...
+            end
+            snapshots.each do |snapshot|
+              Morpheus::Cli::Snapshots.new.handle(["get", snapshot['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
+            end
+          else
+            # Snapshots List
+            snapshot_column_definitions = {
+              "ID" => lambda {|it| it['id'] },
+              "Name" => lambda {|it| it['name'] },
+              "Description" => lambda {|it| it['description'] },
+              # "Type" => lambda {|it| it['snapshotType'] },
+              "Date Created" => lambda {|it| format_local_dt(it['snapshotCreated']) },
+              "Status" => lambda {|it| format_snapshot_status(it) }
+            }
+            print cyan
+            print as_pretty_table(snapshots, snapshot_column_definitions.upcase_keys!, options)
+            print_results_pagination({size: snapshots.size, total: snapshots.size})
+            print reset, "\n"
+          end
         end
-        print reset, "\n"
       end
       return 0
     rescue RestClient::Exception => e

data/lib/morpheus/cli/commands/snapshots.rb

@@ -77,11 +77,15 @@ class Morpheus::Cli::Snapshots
         "Snapshot Type" => 'snapshotType',
         "Cloud" => lambda {|it| format_name_and_id(it['zone']) },
         "Datastore" => lambda {|it| format_name_and_id(it['datastore']) },
+        "Memory Snapshot" => lambda {|it| format_boolean(it['memorySnapshot']) },
+        "For Export" => lambda {|it| format_boolean(it['forExport']) },
         "Parent Snapshot" => lambda {|it| format_name_and_id(it['parentSnapshot']) },
         "Active" => lambda {|it| format_boolean(it['currentlyActive']) },
         "Date Created" => lambda {|it| format_local_dt(it['dateCreated']) },
         "Status" => lambda {|it| format_snapshot_status(it) }
       }
+      description_cols.delete("Memory Snapshot") if !snapshot['memorySnapshot']
+      description_cols.delete("For Export") if !snapshot['forExport']
       print_description_list(description_cols, snapshot)
 
       print reset, "\n"

data/lib/morpheus/cli/commands/virtual_images.rb

@@ -6,7 +6,8 @@ class Morpheus::Cli::VirtualImages
   include Morpheus::Cli::CliCommand
   include Morpheus::Cli::ProvisioningHelper
 
-  register_subcommands :list, :get, :add, :add_file, :remove_file, :update, :remove, :convert, :types => :virtual_image_types
+  register_subcommands :list, :get, :add, :add_file, :remove_file, :update, :remove, 
+                       :convert, {:types => :virtual_image_types}, :download
   register_subcommands :list_locations, :get_location, :remove_location
 
   # def initialize() 
@@ -973,6 +974,94 @@ EOT
     return 0, nil
   end
 
+  def download(args)
+    full_command_string = "#{command_name} download #{args.join(' ')}".strip
+    options = {}
+    outfile = nil
+    do_overwrite = false
+    do_mkdir = false
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[image] [local-file]")
+      opts.on( '-f', '--force', "Overwrite existing [local-file] if it exists." ) do
+        do_overwrite = true
+        # do_mkdir = true
+      end
+      opts.on( '-p', '--mkdir', "Create missing directories for [local-file] if they do not exist." ) do
+        do_mkdir = true
+      end
+      build_common_options(opts, options, [:dry_run, :quiet])
+      opts.footer = "Download a virtual image as a .zip file.\n" + 
+                    "[image] is required. This is the name or id of a virtual image.\n" +
+                    "[local-file] is required. This is the full local filepath for the downloaded zip file."
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:2)
+    connect(options)
+    
+    virtual_image = find_virtual_image_by_name_or_id(args[0])
+    return 1 if virtual_image.nil?
+    outfile = args[1]
+    # if outfile.end_with?(".zip")
+    #   print_red_alert "[local-file] is invalid. It must use extension .zip: #{outfile}"
+    #   return 1
+    # end
+    outfile = File.expand_path(outfile)
+    if Dir.exist?(outfile)
+      raise_command_error "[local-file] is invalid. It is the name of an existing directory: #{outfile}", args, optparse
+    end
+    destination_dir = File.dirname(outfile)
+    if !Dir.exist?(destination_dir)
+      if do_mkdir
+        print cyan,"Creating local directory #{destination_dir}",reset,"\n"
+        FileUtils.mkdir_p(destination_dir)
+      else
+        raise_command_error "[local-file] is invalid. Directory not found: #{destination_dir}", args, optparse
+      end
+    end
+    if File.exist?(outfile)
+      if do_overwrite
+        # uhh need to be careful wih the passed filepath here..
+        # don't delete, just overwrite.
+        # File.delete(outfile)
+      else
+        raise_command_error "[local-file] is invalid. File already exists: #{outfile}", "Use -f to overwrite the existing file.", args, optparse
+      end
+    end
+    
+    @virtual_images_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_images_interface.dry.download_chunked(virtual_image['id'], outfile), full_command_string
+      return 0, nil
+    end
+    if !options[:quiet]
+      print cyan + "Downloading archive file #{virtual_image['name']} to #{outfile} ... "
+    end
+
+    http_response = @virtual_images_interface.download_chunked(virtual_image['id'], outfile)
+
+    # FileUtils.chmod(0600, outfile)
+    success = http_response.code.to_i == 200
+    if success
+      if !options[:quiet]
+        print green + "SUCCESS" + reset + "\n"
+      end
+      return 0, nil
+    else
+      if !options[:quiet]
+        print red + "ERROR" + reset + " HTTP #{http_response.code}" + "\n"
+      end
+      # F it, just remove a bad result
+      if File.exist?(outfile) && File.file?(outfile)
+        Morpheus::Logging::DarkPrinter.puts "Deleting bad file download: #{outfile}" if Morpheus::Logging.debug?
+        File.delete(outfile)
+      end
+      if options[:debug]
+        puts_error http_response.inspect
+      end
+      return 1, "Error downloading file"
+    end
+  end
+
   private
   
   def find_virtual_image_by_name_or_id(val)

data/lib/morpheus/cli/version.rb

@@ -1,6 +1,6 @@
 
 module Morpheus
   module Cli
-    VERSION = "8.0.7"
+    VERSION = "8.0.9"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: morpheus-cli
 version: !ruby/object:Gem::Version
-  version: 8.0.7
+  version: 8.0.9
 platform: ruby
 authors:
 - David Estes
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-13 00:00:00.000000000 Z
+date: 2025-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix