morpheus-cli 5.2.2 → 5.3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91687d55f353976028bdebb05b8b588fc56ae1d590694da9948115098b05fb5f
-  data.tar.gz: 370d606fe6b918dcc18a94f191fc9706bba0aef4832a3ec1aa24da8fc8d3377a
+  metadata.gz: f860d6a411e83d66114f0c40e20aec9980aa97315af9872f5776686f4def717e
+  data.tar.gz: fa2b969306e2345724805ddf065343d46629ec9ab546ee6c502377a7529bc462
 SHA512:
-  metadata.gz: dba600f78525d9176052b7a6319db0c2131c4e1cbf140eea951613ff5920b3b7be3b2cf597a9dfa77c512336a936122c1b2cfc2c0d4436ee857c016ecf6da200
-  data.tar.gz: 7cc0c47c12664abe7f012dd6520762fcbb8be6a9cc95a75d81688e7f3340bdcf8fbdd73c7347d3fc741bcc67853eaf42fe490ed097ba69558f76a1482d702fb9
+  metadata.gz: 4a84820acae372fc570a52750eaa03bb978812a7a40b6303ee85b0537f8fc1105eba5bc944da1f8f0876cae19b2d16c8abfd00fa7685949ef70a051f64c19a4a
+  data.tar.gz: de7be6c0d53e63c60e0941265deedca0f86574ed0060f7873fb38c54411daa6c142ba68818710d44fbf34240e0c2c81c0214f0d2d4a18b9346f452762967c7e6

data/Dockerfile

@@ -1,5 +1,5 @@
 FROM ruby:2.5.1
 
-RUN gem install morpheus-cli -v 5.2.2
+RUN gem install morpheus-cli -v 5.3.0.1
 
 ENTRYPOINT ["morpheus"]

data/README.md

@@ -1,12 +1,12 @@
+<img src="https://morpheusdata.com/wp-content/uploads/2020/04/morpheus-logo-v2.svg" width="200px">
+
 # Morpheus CLI
 
 - Website: https://www.morpheusdata.com/
 - Guide: [Morpheus CLI Wiki](https://github.com/gomorpheus/morpheus-cli/wiki)
-- Docs: [Morpheus Documentation](https://docs.morpheusdata.com)
+- Docs: [Morpheus CLI Documentation](https://clidocs.morpheusdata.com)
 - Support: [Morpheus Support](https://support.morpheusdata.com)
 
-<img src="https://www.morpheusdata.com/wp-content/uploads/2018/06/cropped-morpheus_highres.png" width="600px">
-
 This library is a Ruby gem that provides a command line interface for interacting with the Morpheus Data appliance. The features provided include provisioning clusters, hosts, and containers, deploying and monitoring applications, automating tasks, and much more.
 
 ## Installation

data/lib/morpheus/api/instances_interface.rb

@@ -190,6 +190,27 @@ class Morpheus::InstancesInterface < Morpheus::APIClient
     execute(opts)
   end
 
+  def clone_image(id, payload)
+    url = "#{@base_url}/api/instances/#{id}/clone-image"
+    headers = {:authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    opts = {method: :put, url: url, headers: headers, payload: payload.to_json}
+    execute(opts)
+  end
+
+  def lock(id, payload)
+    url = "#{@base_url}/api/instances/#{id}/lock"
+    headers = {:authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    opts = {method: :put, url: url, headers: headers, payload: payload.to_json}
+    execute(opts)
+  end
+
+  def unlock(id, payload)
+    url = "#{@base_url}/api/instances/#{id}/unlock"
+    headers = {:authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    opts = {method: :put, url: url, headers: headers, payload: payload.to_json}
+    execute(opts)
+  end
+
   def firewall_disable(id)
     url = "#{@base_url}/api/instances/#{id}/security-groups/disable"
     headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }

data/lib/morpheus/cli/activity_command.rb

@@ -22,6 +22,9 @@ class Morpheus::Cli::ActivityCommand
     params, options = {}, {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage()
+      opts.on('-a', '--details', "Display more details object id, full date and time, etc." ) do
+        options[:details] = true
+      end
       opts.on('-t','--type TYPE', "Activity Type eg. Provisioning, Admin") do |val|
         options[:type] ||= []
         options[:type] << val
@@ -115,20 +118,20 @@ EOT
           # {"SEVERITY" => lambda {|record| format_activity_severity(record['severity']) } },
           {"TYPE" => lambda {|record| record['activityType'] } },
           {"NAME" => lambda {|record| record['name'] } },
-          {"RESOURCE" => lambda {|record| "#{record['objectType']} #{record['objectId']}" } },
+          options[:details] ? {"RESOURCE" => lambda {|record| "#{record['objectType']} #{record['objectId']}" } } : nil,
           {"MESSAGE" => lambda {|record| record['message'] || '' } },
           {"USER" => lambda {|record| record['user'] ? record['user']['username'] : record['userName'] } },
           #{"DATE" => lambda {|record| "#{format_duration_ago(record['ts'] || record['timestamp'])}" } },
           {"DATE" => lambda {|record| 
-            # show full time if searching for custom timerange, otherwise the default is to show relative time
-            if params['start'] || params['end'] || params['timeframe']
+            # show full time if searching for custom timerange or --details, otherwise the default is to show relative time
+            if params['start'] || params['end'] || params['timeframe'] || options[:details]
               "#{format_local_dt(record['ts'] || record['timestamp'])}"
             else
               "#{format_duration_ago(record['ts'] || record['timestamp'])}"
             end
 
           } },
-        ]
+        ].compact
         print as_pretty_table(activity, columns, options)
         print_results_pagination(json_response)
       end

data/lib/morpheus/cli/backup_jobs_command.rb

@@ -10,7 +10,7 @@ class Morpheus::Cli::BackupJobsCommand
 
   set_command_name :'backup-jobs'
 
-  register_subcommands :list, :get, :add, :update, :remove, :run
+  register_subcommands :list, :get #, :add, :update, :remove, :run
 
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)

data/lib/morpheus/cli/backups_command.rb

@@ -10,7 +10,7 @@ class Morpheus::Cli::BackupsCommand
   
   set_command_name :'backups'
 
-  register_subcommands :list, :get, :add, :update, :remove, :run, :restore
+  register_subcommands :list, :get #, :add, :update, :remove, :run, :restore
   
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
@@ -82,8 +82,7 @@ EOT
     end
   end
 
-  def _get(id, options)
-    params = {}
+  def _get(id, params, options)
     @backups_interface.setopts(options)
     if options[:dry_run]
       print_dry_run @backups_interface.dry.get(id, params)

data/lib/morpheus/cli/cli_command.rb

@@ -466,11 +466,16 @@ module Morpheus
 
           when :list
             opts.on( '-m', '--max MAX', "Max Results" ) do |val|
-              max = val.to_i
-              if max <= 0
-                raise ::OptionParser::InvalidArgument.new("must be a positive integer")
+              # api supports max=-1 for all at the moment..
+              if val.to_s == "all" || val.to_s == "-1"
+                options[:max] = "-1"
+              else
+                max = val.to_i
+                if max <= 0
+                  raise ::OptionParser::InvalidArgument.new("must be a positive integer")
+                end
+                options[:max] = max
               end
-              options[:max] = max
             end
 
             opts.on( '-o', '--offset OFFSET', "Offset Results" ) do |val|
@@ -486,12 +491,17 @@ module Morpheus
             end
 
             opts.on( '-S', '--sort ORDER', "Sort Order. DIRECTION may be included as \"ORDER [asc|desc]\"." ) do |v|
-              v_parts = v.to_s.split(" ")
-              if v_parts.size > 1
-                options[:sort] = v_parts[0]
-                options[:direction] = (v_parts[1].strip == "desc") ? "desc" : "asc"
-              else
+              if v.to_s.include?(",")
+                # sorting on multiple properties, just pass it as is, newer api supports multiple fields
                 options[:sort] = v
+              else
+                v_parts = v.to_s.split(" ")
+                if v_parts.size > 1
+                  options[:sort] = v_parts[0]
+                  options[:direction] = (v_parts[1].strip == "desc") ? "desc" : "asc"
+                else
+                  options[:sort] = v
+                end
               end
             end
 

data/lib/morpheus/cli/clusters.rb

@@ -934,6 +934,9 @@ class Morpheus::Cli::Clusters
         end
       else
         payload = {"permissions" => prompt_permissions(options.merge({:available_plans => namespace_service_plans}))}
+        # if payload["permissions"] && payload["permissions"]["resourcePool"]
+        #   payload["permissions"].delete("resourcePool")
+        # end
       end
 
       @clusters_interface.setopts(options)
@@ -3897,8 +3900,8 @@ class Morpheus::Cli::Clusters
     perms = prompt_permissions(options.merge({:available_plans => namespace_service_plans}))
     if perms['resourcePool'] && !perms['resourcePool']['visibility'].nil?
       rtn['visibility'] = perms['resourcePool']['visibility']
-      perms.delete('resourcePool')
     end
+    perms.delete('resourcePool')
     rtn['permissions'] = perms
     rtn
   end

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

@@ -14,14 +14,14 @@ class Morpheus::Cli::HistoryCommand
   # AND start logging every terminal command, not just shell...
   def handle(args)
     options = {show_pagination:false}
-    optparse = Morpheus::Cli::OptionParser.new do|opts|
-      opts.banner = "Usage: morpheus #{command_name} [search]"
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} #{command_name} [search]"
       # -n is a hidden alias for -m
       opts.on( '-n', '--max-commands MAX', "Alias for -m, --max option." ) do |val|
         options[:max] = val
       end
       opts.add_hidden_option('-n')
-      opts.on( '-p', '--pagination', "Display pagination and count info eg. Viewing 1-M of N" ) do
+      opts.on( '-p', '--pagination', "Display pagination and count info eg. Viewing 1-25 of 42" ) do
         options[:show_pagination] = true
       end
       opts.on( nil, '--flush', "Flush history, purges entire shell history file." ) do
@@ -38,10 +38,9 @@ Examples:
     history "instances list"
     history --flush
 
-The most recently executed commands are seen by default.  Use --reverse to see the oldest commands.
+The most recently executed commands are seen by default.  Use --desc to see the oldest commands.
 EOT
     end
-    raw_cmd = "#{command_name} #{args.join(' ')}"
     optparse.parse!(args)
     # verify_args!(args:args, count: 0, optparse:optparse)
     if args.count > 0

data/lib/morpheus/cli/dashboard_command.rb

@@ -272,20 +272,20 @@ This includes instance and backup counts, favorite instances, monitoring and rec
           # {"SEVERITY" => lambda {|record| format_activity_severity(record['severity']) } },
           {"TYPE" => lambda {|record| record['activityType'] } },
           {"NAME" => lambda {|record| record['name'] } },
-          {"RESOURCE" => lambda {|record| "#{record['objectType']} #{record['objectId']}" } },
+          options[:details] ? {"RESOURCE" => lambda {|record| "#{record['objectType']} #{record['objectId']}" } } : nil,
           {"MESSAGE" => lambda {|record| record['message'] || '' } },
           {"USER" => lambda {|record| record['user'] ? record['user']['username'] : record['userName'] } },
           #{"DATE" => lambda {|record| "#{format_duration_ago(record['ts'] || record['timestamp'])}" } },
           {"DATE" => lambda {|record| 
             # show full time if searching for custom timerange, otherwise the default is to show relative time
-            if params['start'] || params['end'] || params['timeframe']
+            if params['start'] || params['end'] || params['timeframe'] || options[:details]
               "#{format_local_dt(record['ts'] || record['timestamp'])}"
             else
               "#{format_duration_ago(record['ts'] || record['timestamp'])}"
             end
 
           } },
-        ]
+        ].compact
         print as_pretty_table(activity, columns, options)
         # print_results_pagination(json_response)
         # print reset,"\n"

data/lib/morpheus/cli/execution_request_command.rb

@@ -31,6 +31,10 @@ class Morpheus::Cli::ExecutionRequestCommand
     handle_subcommand(args)
   end
 
+  def default_refresh_interval
+    5
+  end
+
   def get(args)
     raw_args = args
     options = {}
@@ -134,7 +138,7 @@ class Morpheus::Cli::ExecutionRequestCommand
     options = {}
     params = {}
     script_content = nil
-    do_refresh = true
+    options[:refresh_until_finished] = true
     optparse = Morpheus::Cli::OptionParser.new do|opts|
       opts.banner = subcommand_usage("[options]")
       opts.on('--server ID', String, "Server ID") do |val|
@@ -161,8 +165,14 @@ class Morpheus::Cli::ExecutionRequestCommand
           exit 1
         end
       end
-      opts.on(nil, '--no-refresh', "Do not refresh until finished" ) do
-        do_refresh = false
+      opts.on('--refresh [SECONDS]', String, "Refresh until execution is finished. Default interval is #{default_refresh_interval} seconds.") do |val|
+        options[:refresh_until_finished] = true
+        if !val.to_s.empty?
+          options[:refresh_interval] = val.to_f
+        end
+      end
+      opts.on(nil, '--no-refresh', "Do not refresh. The default behavior is to refresh until finished." ) do
+        options[:refresh_until_finished] = false
       end
       #build_option_type_options(opts, options, add_user_source_option_types())
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
@@ -212,8 +222,8 @@ class Morpheus::Cli::ExecutionRequestCommand
       end
       execution_request = json_response['executionRequest']
       print_green_success "Executing request #{execution_request['uniqueId']}"
-      if do_refresh
-        get([execution_request['uniqueId'], "--refresh"] + (options[:remote] ? ["-r",options[:remote]] : []))
+      if options[:refresh_until_finished]
+        get([execution_request['uniqueId'], "--refresh", options[:refresh_interval] ? options[:refresh_interval].to_s : nil].compact + (options[:remote] ? ["-r",options[:remote]] : []))
       else
         get([execution_request['uniqueId']] + (options[:remote] ? ["-r",options[:remote]] : []))
       end

data/lib/morpheus/cli/hosts.rb

@@ -117,6 +117,12 @@ class Morpheus::Cli::Hosts
       opts.on( '--tenant TENANT', "Tenant Name or ID" ) do |val|
         options[:account] = val
       end
+      opts.on('--labels label',String, "Filter by labels (keywords).") do |val|
+        val.split(",").each do |k|
+          options[:labels] ||= []
+          options[:labels] << k.strip
+        end
+      end
       opts.on('--tags Name=Value',String, "Filter by tags.") do |val|
         val.split(",").each do |value_pair|
           k,v = value_pair.strip.split("=")
@@ -186,6 +192,7 @@ class Morpheus::Cli::Hosts
           params['clusterId'] = cluster['id']
         end
       end
+      params['labels'] = options[:labels] if options[:labels]
       if options[:tags] && !options[:tags].empty?
         options[:tags].each do |k,v|
           params['tags.' + k] = v
@@ -542,6 +549,7 @@ class Morpheus::Cli::Hosts
         "Name" => 'name',
         "Hostname" => 'hostname',
         "Description" => 'description',
+        "Labels" => lambda {|it| it['labels'] ? it['labels'].join(',') : '' },
         "Tags" => lambda {|it| tags ? format_metadata(tags) : '' },
         "Owner" => lambda {|it| it['owner'] ? it['owner']['username'] : '' },
         "Tenant" => lambda {|it| it['account'] ? it['account']['name'] : '' },
@@ -566,6 +574,7 @@ class Morpheus::Cli::Hosts
       # server_columns.delete("Tenant") if multi_tenant != true
       server_columns.delete("Cost") if server['hourlyCost'].to_f == 0
       server_columns.delete("Price") if server['hourlyPrice'].to_f == 0 || server['hourlyPrice'] == server['hourlyCost']
+      server_columns.delete("Labels") if server['labels'].nil? || server['labels'].empty?
       server_columns.delete("Tags") if tags.nil? || tags.empty?
 
       print_description_list(server_columns, server)
@@ -993,6 +1002,9 @@ class Morpheus::Cli::Hosts
       opts.on('--power-schedule-type ID', String, "Power Schedule Type ID") do |val|
         params['powerScheduleType'] = val == "null" ? nil : val
       end
+      opts.on('--labels [LIST]', String, "Labels (keywords) in the format 'foo, bar'") do |val|
+        params['labels'] = val.to_s.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
+      end
       opts.on('--tags LIST', String, "Tags in the format 'name:value, name:value'. This will add and remove tags.") do |val|
         options[:tags] = val
       end

data/lib/morpheus/cli/instances.rb

@@ -19,6 +19,7 @@ class Morpheus::Cli::Instances
                        :history, {:'history-details' => :history_details}, {:'history-event' => :history_event_details}, 
                        :stats, :stop, :start, :restart, :actions, :action, :suspend, :eject, :stop_service, :start_service, :restart_service, 
                        :backup, :backups, :resize, :clone, :envs, :setenv, :delenv, 
+                       :lock, :unlock, :clone_image,
                        :security_groups, :apply_security_groups, :run_workflow, :import_snapshot, :snapshot, :snapshots,
                        :console, :status_check, {:containers => :list_containers}, 
                        :scaling, {:'scaling-update' => :scaling_update},
@@ -603,8 +604,8 @@ class Morpheus::Cli::Instances
       opts.on('--group GROUP', String, "Group Name or ID") do |val|
         options[:group] = val
       end
-      opts.on('--labels LIST', String, "Labels (keywords) in the format 'foo, bar'") do |val|
-        params['labels'] = val.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
+      opts.on('--labels [LIST]', String, "Labels (keywords) in the format 'foo, bar'") do |val|
+        params['labels'] = val.to_s.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
       end
       opts.on('--tags LIST', String, "Tags in the format 'name:value, name:value'. This will add and remove tags.") do |val|
         options[:tags] = val
@@ -1350,6 +1351,7 @@ class Morpheus::Cli::Instances
         "Shutdown Date" => lambda {|it| it['shutdownDate'] ? format_local_dt(it['shutdownDate']) : '' },
         "Nodes" => lambda {|it| it['containers'] ? it['containers'].count : 0 },
         "Connection" => lambda {|it| format_instance_connection_string(it) },
+        "Locked" => lambda {|it| format_boolean(it['locked']) },
         "Status" => lambda {|it| format_instance_status(it) }
       }
       description_cols.delete("Labels") if labels.nil? || labels.empty?
@@ -1359,6 +1361,7 @@ class Morpheus::Cli::Instances
       description_cols.delete("Shutdown Date") if instance['shutdownDate'].nil?
       description_cols["Removal Date"] = lambda {|it| format_local_dt(it['removalDate'])} if instance['status'] == 'pendingRemoval'
       description_cols.delete("Last Deployment") if instance['lastDeploy'].nil?
+      description_cols.delete("Locked") if instance['locked'] != true
       #description_cols.delete("Environment") if instance['instanceContext'].nil?
       print_description_list(description_cols, instance)
 
@@ -3888,6 +3891,117 @@ EOT
     return 0
   end
 
+  def clone_image(args)
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[instance]")
+      opts.on( '--name VALUE', String, "Image Name (Template Name). Default is server name + timestamp" ) do |val|
+        options[:options]['templateName'] = val
+      end
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Clone to image (template) for an instance
+[instance] is required. This is the name or id of an instance
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    instance = find_instance_by_name_or_id(args[0])
+    return 1 if instance.nil?
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!(parse_passed_options(options))
+    else
+      payload.deep_merge!(parse_passed_options(options))
+      if payload['templateName'].nil?
+        v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'templateName', 'type' => 'text', 'fieldLabel' => 'Image Name', 'description' => 'Choose a name for the new image template. Default is the server name + timestamp'}], options[:options])
+        if v_prompt['templateName'].to_s != ''
+          payload['templateName'] = v_prompt['templateName']
+        end
+      end
+    end
+    @instances_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @instances_interface.dry.clone_image(instance['id'], payload)
+      return
+    end
+    json_response = @instances_interface.clone_image(instance['id'], payload)
+    render_response(json_response, options) do
+      print_green_success "Clone Image initiated."
+    end
+    return 0, nil
+  end
+
+  def lock(args)
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[instance]")
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Lock an instance
+[instance] is required. This is the name or id of an instance
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    instance = find_instance_by_name_or_id(args[0])
+    return 1 if instance.nil?
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!(parse_passed_options(options))
+    else
+      payload.deep_merge!(parse_passed_options(options))
+    end
+    @instances_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @instances_interface.dry.lock(instance['id'], payload)
+      return
+    end
+    json_response = @instances_interface.lock(instance['id'], payload)
+    render_response(json_response, options) do
+      print_green_success "Locked instance #{instance['name']}"
+    end
+    return 0, nil
+  end
+
+  def unlock(args)
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[instance]")
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Unlock an instance
+[instance] is required. This is the name or id of an instance
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    instance = find_instance_by_name_or_id(args[0])
+    return 1 if instance.nil?
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!(parse_passed_options(options))
+    else
+      payload.deep_merge!(parse_passed_options(options))
+    end
+    @instances_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @instances_interface.dry.unlock(instance['id'], payload)
+      return
+    end
+    json_response = @instances_interface.unlock(instance['id'], payload)
+    render_response(json_response, options) do
+      print_green_success "Unlocked instance #{instance['name']}"
+    end
+    return 0, nil
+  end
+
 private
 
   def find_zone_by_name_or_id(group_id, val)