morpheus-cli 5.5.3 → 5.5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52fcaca1c4feaa6a3b07b3ed8772a6765cac55ccbac1b8d79eba9525a859829a
-  data.tar.gz: 868ccdde25b11e328c5c275ed61374922f5a287a5d662e5d3901c0218c863808
+  metadata.gz: 1a66b8b7fa9512d6f649a5c369b2a5da24efe9e551b48cce4fe551bc68f9f842
+  data.tar.gz: 285fb4339cbf1c2ea71539d1bff2e8bed75ec6be097cffdaeda751ed49b59b6b
 SHA512:
-  metadata.gz: 1bff4307ff46a0940add6895b3fa16ac23da050e60ddc9d200d3c1d196eb29d1a3aa82025f203abb12b9f1950dd9fe7e7bf082bc13c797c91494bcf5092990ed
-  data.tar.gz: 874cfa21f6d6af7360c13dc504a453f3f7fb1539120c0b91af13a640727b6a19418b7c80912eb18b22dff4b4c94f8dea6f4372ba382ec7153c8936481de1131c
+  metadata.gz: 7fc26b54a4a2d2dfb83429e769acbc730a1f61ff1023468e49b17e056fdfc510d7f5cbb642d07cc76d26e46b1aa8cc7b631e8f658fe7f133c5c7c67301d026e6
+  data.tar.gz: c52f8eb39797f15a3ab811ff9f42557f879d9ef13269c633cee2f99cfce9ec2b51ab9f67ce8998ad68416b3cd94d5b5c44a642ea71167aeb93640e2baed65d82

data/Dockerfile

@@ -1,5 +1,5 @@
 FROM ruby:2.7.5
 
-RUN gem install morpheus-cli -v 5.5.3
+RUN gem install morpheus-cli -v 5.5.3.1
 
 ENTRYPOINT ["morpheus"]

data/lib/morpheus/api/api_client.rb

@@ -798,10 +798,18 @@ class Morpheus::APIClient
     Morpheus::BackupSettingsInterface.new(common_interface_options).setopts(@options)
   end
 
+  def guidance_settings
+    Morpheus::GuidanceSettingsInterface.new(common_interface_options).setopts(@options)
+  end
+
   def log_settings
     Morpheus::LogSettingsInterface.new(common_interface_options).setopts(@options)
   end
 
+  def monitoring_settings
+    Morpheus::MonitoringSettingsInterface.new(common_interface_options).setopts(@options)
+  end
+
   def whitelabel_settings
     Morpheus::WhitelabelSettingsInterface.new(common_interface_options).setopts(@options)
   end
@@ -894,6 +902,10 @@ class Morpheus::APIClient
     Morpheus::NetworkServersInterface.new(common_interface_options).setopts(@options)
   end
 
+  def network_server_groups
+    Morpheus::NetworkServerGroupsInterface.new(common_interface_options).setopts(@options)
+  end
+
   def network_edge_clusters
     Morpheus::NetworkEdgeClustersInterface.new(common_interface_options).setopts(@options)
   end

data/lib/morpheus/api/appliance_settings_interface.rb

@@ -24,4 +24,19 @@ class Morpheus::ApplianceSettingsInterface < Morpheus::APIClient
     opts = {method: :get, url: url, headers: headers}
     execute(opts)
   end
+
+  def maintenance(params={}, payload={})
+    url = "#{base_path}/maintenance"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    opts = {method: :post, url: url, headers: headers, payload: payload}
+    execute(opts)
+  end
+
+  def reindex(params={}, payload={})
+    url = "#{base_path}/reindex"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    opts = {method: :post, url: url, headers: headers, payload: payload}
+    execute(opts)
+  end
+
 end

data/lib/morpheus/api/cypher_interface.rb

@@ -4,8 +4,7 @@ require 'uri'
 class Morpheus::CypherInterface < Morpheus::APIClient
 
   def base_path
-    # can use just "/api/cypher" in 4.1.2
-    "/api/cypher/v1"
+    "/api/cypher"
   end
 
   def get(item_key, params={})

data/lib/morpheus/api/guidance_settings_interface.rb

@@ -0,0 +1,17 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::GuidanceSettingsInterface < Morpheus::APIClient
+
+  def base_path
+    "/api/guidance-settings"
+  end
+
+  def get(params={}, headers={})
+    execute(method: :get, url: "#{base_path}", params: params, headers: headers)
+  end
+
+  def update(payload, params={}, headers={})
+    execute(method: :put, url: "#{base_path}", payload: payload, params: params, headers: headers)
+  end
+
+end

data/lib/morpheus/api/monitoring_settings_interface.rb

@@ -0,0 +1,25 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::MonitoringSettingsInterface < Morpheus::APIClient
+
+  def base_path
+    "/api/monitoring-settings"
+  end
+
+  def get(params={}, headers={})
+    execute(method: :get, url: "#{base_path}", params: params, headers: headers)
+  end
+
+  def update(payload, params={}, headers={})
+    execute(method: :put, url: "#{base_path}", payload: payload, params: params, headers: headers)
+  end
+
+  def update_service_now(payload, params={}, headers={})
+    execute(method: :put, url: "#{base_path}/service-now", payload: payload, params: params, headers: headers)
+  end
+
+  def update_new_relic(payload, params={}, headers={})
+    execute(method: :put, url: "#{base_path}/new-relic", payload: payload, params: params, headers: headers)
+  end
+
+end

data/lib/morpheus/api/network_server_groups_interface.rb

@@ -0,0 +1,7 @@
+require 'morpheus/api/secondary_rest_interface'
+
+class Morpheus::NetworkServerGroupsInterface < Morpheus::SecondaryRestInterface
+  def base_path(network_server_id)
+    "/api/networks/servers/#{network_server_id}/groups"
+  end
+end

data/lib/morpheus/cli/cli_command.rb

@@ -1614,7 +1614,16 @@ module Morpheus
         interface_name = "@#{type.pluralize}_interface"
         interface = instance_variable_get(interface_name)
         if interface.nil?
-          raise "#{self.class} has not defined interface #{interface_name}"
+          api_client = instance_variable_get("@api_client")
+          if api_client
+            if api_client.respond_to?(type.pluralize)
+              interface = api_client.send(type.pluralize)
+            else
+              raise "@api_client.#{type.pluralize} is not a recognized interface"
+            end
+          else
+            raise "#{self.class} has not defined interface #{interface_name} or @api_client"
+          end
         end
         begin
           json_response = interface.get(*ids)

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

@@ -6,7 +6,7 @@ class Morpheus::Cli::ApplianceSettingsCommand
 
   set_command_name :'appliance-settings'
 
-  register_subcommands :get, :update
+  register_subcommands :get, :update, :toggle_maintenance, :'reindex'
   
   set_default_subcommand :get
 
@@ -103,7 +103,7 @@ class Morpheus::Cli::ApplianceSettingsCommand
         print cyan
         print enabled_zone_types.collect {|it| it['name']}.join(', ')
       end
-      print reset "\n"
+      print reset, "\n"
       return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
@@ -307,6 +307,61 @@ class Morpheus::Cli::ApplianceSettingsCommand
     end
   end
 
+  def toggle_maintenance(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage()
+      opts.on("--enabled [on|off]", String, "Enabled (on) or Disabled (off)") do |val|
+        params['enabled'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == '1' || val.to_s == ''
+      end
+      build_standard_update_options(opts, options, [:auto_confirm], [:payload, :options])
+      opts.footer = "Toggle maintenance mode."
+    end
+    optparse.parse!(args)
+    connect(options)
+    verify_args!(args:args, optparse:optparse, count:0)
+    if params['enabled'].nil?
+      confirm!("Are you sure you would like to toggle maintenance mode?", options)
+    else
+      confirm!("Are you sure you would like to toggle maintenance mode: #{params['enabled'] ? 'on' : 'off'}?", options)
+    end
+    @appliance_settings_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @appliance_settings_interface.dry.maintenance(params)
+      return
+    end
+    json_response = @appliance_settings_interface.maintenance(params)
+    render_response(json_response, options) do
+      print_green_success "Toggled maintenance mode: '#{params['enabled'] ? 'on' : 'off'}'"
+    end
+    return 0, nil
+  end
+
+  def reindex(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage()
+      build_standard_update_options(opts, options, [:auto_confirm], [:payload, :options])
+      opts.footer = "Reindex all search data."
+    end
+    optparse.parse!(args)
+    connect(options)
+    verify_args!(args:args, optparse:optparse, count:0)
+    confirm!("Are you sure you would like reindex all search data?", options)
+    @appliance_settings_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @appliance_settings_interface.dry.reindex(params)
+      return
+    end
+    json_response = @appliance_settings_interface.reindex(params)
+    render_response(json_response, options) do
+      print_green_success "Reindexing all search data..."
+    end
+    return 0, nil
+  end
+
   private
 
   def format_days(days)

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

@@ -66,7 +66,7 @@ class Morpheus::Cli::BackupSettingsCommand
         "Backup Retention Count" => lambda {|it| it['retentionCount'] }
       }
       print_description_list(description_cols, backup_settings)
-      print reset "\n"
+      print reset, "\n"
       return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)

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

@@ -660,6 +660,8 @@ EOT
       "Labels" => lambda {|it| format_list(it['labels'], '', 3) },
       "Description" => 'description',
       "Type" => lambda {|it| format_catalog_type(it) },
+      "Visibility" => 'visibility',
+      "Layout Code" => 'layoutCode',
       "Blueprint" => lambda {|it| it['blueprint'] ? it['blueprint']['name'] : nil },
       "Workflow" => lambda {|it| it['workflow'] ? it['workflow']['name'] : nil },
       "Context" => lambda {|it| it['context'] },
@@ -679,6 +681,8 @@ EOT
       "Labels" => lambda {|it| format_list(it['labels']) },
       "Description" => 'description',
       "Type" => lambda {|it| format_catalog_type(it) },
+      "Visibility" => 'visibility',
+      "Layout Code" => 'layoutCode',
       "Blueprint" => lambda {|it| it['blueprint'] ? it['blueprint']['name'] : nil },
       "Workflow" => lambda {|it| it['workflow'] ? it['workflow']['name'] : nil },
       "Context" => lambda {|it| it['context'] },
@@ -725,7 +729,8 @@ EOT
       {'fieldName' => 'enabled', 'fieldLabel' => 'Enabled', 'type' => 'checkbox', 'defaultValue' => true, 'displayOrder' => 4},
       {'fieldName' => 'featured', 'fieldLabel' => 'Featured', 'type' => 'checkbox', 'defaultValue' => false, 'displayOrder' => 5},
       {'fieldName' => 'visibility', 'fieldLabel' => 'Visibility', 'type' => 'select', 'selectOptions' => [{'name' => 'Private', 'value' => 'private'}, {'name' => 'Public', 'value' => 'public'}], 'defaultValue' => 'private', 'required' => true, 'displayOrder' => 6},
-      {'fieldName' => 'iconPath', 'fieldLabel' => 'Logo', 'type' => 'select', 'optionSource' => 'iconList', 'displayOrder' => 7},
+      {'fieldName' => 'layoutCode', 'fieldLabel' => 'Layout Code', 'type' => 'text', 'required' => false, 'displayOrder' => 7},
+      {'fieldName' => 'iconPath', 'fieldLabel' => 'Logo', 'type' => 'select', 'optionSource' => 'iconList', 'displayOrder' => 8},
       #{'fieldName' => 'optionTypes', 'fieldLabel' => 'Option Types', 'type' => 'text', 'description' => 'Option Types to include, comma separated list of names or IDs.', 'displayOrder' => 8},
       {'dependsOnCode' => 'catalogItemType.type:instance', 'fieldName' => 'config', 'fieldLabel' => 'Config', 'type' => 'code-editor', 'description' => 'JSON or YAML', 'required' => true, 'displayOrder' => 9},
       {'dependsOnCode' => 'catalogItemType.type:blueprint', 'fieldName' => 'blueprint', 'fieldLabel' => 'Blueprint', 'type' => 'select', 'optionSource' => 'blueprints', 'description' => 'Choose a blueprint to apply to the catalog item.', 'required' => true, 'noParams' => true, 'displayOrder' => 10},

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

@@ -274,6 +274,9 @@ EOT
           ttl = val
         end
       end
+      opts.on( '--type string|object', "The type of data being stored: string or object." ) do |val|
+        params['type'] = val
+      end
       # opts.on( '--no-overwrite', '--no-overwrite', "Do not overwrite existing keys. Existing keys are overwritten by default." ) do
       #   params['overwrite'] = false
       # end

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

@@ -73,7 +73,7 @@ class Morpheus::Cli::GuidanceCommand
         print "#{cyan}#{level.capitalize}".rjust(14, ' ') + ": " + stats['type'][level].to_s.ljust(10, ' ')
         println generate_usage_bar(stats['type'][level], stats['type'].collect{|k, v| v}.reduce(:+), {:max_bars => 20, :bar_color => color})
       end
-      print reset "\n"
+      print reset, "\n"
       return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
@@ -126,7 +126,7 @@ class Morpheus::Cli::GuidanceCommand
           {"CODE" => lambda {|it| it['code']}}
       ];
       print as_pretty_table(types, cols, options)
-      print reset "\n"
+      print reset, "\n"
       return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)

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

@@ -0,0 +1,148 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::GuidanceSettings
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::AccountsHelper
+
+  set_command_name :'guidance-settings'
+  set_command_description "View and manage guidance settings"
+  register_subcommands :get, :update
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @guidance_settings_interface = @api_client.guidance_settings
+    @options_interface = @api_client.options
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end
+
+  def get(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage()
+      build_standard_get_options(opts, options)
+      opts.footer = "Get guidance settings."
+    end
+    optparse.parse!(args)
+    connect(options)
+    verify_args!(args:args, optparse:optparse, count:0)
+    params.merge!(parse_query_options(options))
+    @guidance_settings_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @guidance_settings_interface.dry.get(options)
+      return
+    end
+    json_response = @guidance_settings_interface.get(options)
+    render_response(json_response, options, object_key) do
+      guidance_settings = json_response[object_key]
+      print_h1 "Guidance Settings", options
+      print_h2 "Power Settings", options.merge(:border_style => :thin)
+      #Power shutdown will be suggested when all of the following baseline thresholds are exceeded for a resource
+      print_description_list({
+        "Average CPU (%)" => lambda {|it| it['cpuAvgCutoffPower'] }, # #Lower limit for average CPU usage
+        "Maximum CPU (%)" => lambda {|it| it['cpuMaxCutoffPower'] }, #Lower limit for peak CPU usage
+        "Network threshold (bytes)" => lambda {|it| it['networkCutoffPower'] }, #Lower limit for average network bandwidth
+      }, guidance_settings, options)
+      #print reset, "\n"
+
+      print_h2 "CPU Up-size Settings", options.merge(:border_style => :thin)
+      #Up-size will be suggested when all of the following baseline thresholds are exceeded for a resource
+      print_description_list({
+        "Average CPU (%)" => lambda {|it| it['cpuUpAvgStandardCutoffRightSize'] }, #Upper limit for CPU usage
+        "Maximum CPU (%)" => lambda {|it| it['cpuUpMaxStandardCutoffRightSize'] }, #Upper limit for peak CPU usage
+      }, guidance_settings, options)
+      #print reset, "\n"
+    
+      print_h2 "Memory Up-size Settings", options.merge(:border_style => :thin)
+      #Up-size is suggested when all of the following baseline thresholds are exceeded for a resource
+      print_description_list({
+        "Minimum Free Memory (%)" => lambda {|it| it['memoryUpAvgStandardCutoffRightSize'] }, #Lower limit for average free memory usage
+      }, guidance_settings, options)
+      #print reset, "\n"
+
+      print_h2 "Memory Down-size Settings", options.merge(:border_style => :thin)
+      #Down-size is suggested when all of the following baseline thresholds are exceeded for a resource
+      print_description_list({
+        #Upper limit for average free memory
+        "Average Free Memory (%)" => lambda {|it| it['memoryDownAvgStandardCutoffRightSize'] },
+        #Upper limit for peak memory usage
+        "Maximum Free Memory (%)" => lambda {|it| it['memoryDownMaxStandardCutoffRightSize'] },
+      }, guidance_settings, options)
+      print reset, "\n"
+    end
+    return 0, nil
+  end
+
+  def update(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = opts.banner = subcommand_usage()
+      opts.on('--power-cpu-avg PERCENT', String, "Power Shutdown Average CPU (%). Lower limit for average CPU usage") do |val|
+        params['cpuAvgCutoffPower'] = val.to_i
+      end
+      opts.on('--power-cpu-max PERCENT', String, "Power Shutdown Maximum CPU (%). Lower limit for peak CPU usage") do |val|
+        params['cpuMaxCutoffPower'] = val.to_i
+      end
+      opts.on('--power-network BYTES', String, "Power Shutdown Network threshold (bytes). Lower limit for average network bandwidth") do |val|
+        params['networkCutoffPower'] = val.to_i
+      end
+      opts.on('--cpu-up-avg PERCENT', String, "CPU Up-size Average CPU (%). Upper limit for CPU usage") do |val|
+        params['cpuUpAvgStandardCutoffRightSize'] = val.to_i
+      end
+      opts.on('--cpu-up-max PERCENT', String, "CPU Up-size Maximum CPU (%). Upper limit for peak CPU usage") do |val|
+        params['cpuUpMaxStandardCutoffRightSize'] = val.to_i
+      end
+      opts.on('--memory-up-avg PERCENT', String, "Memory Up-size Minimum Free Memory (%). Lower limit for average free memory usage") do |val|
+        params['memoryUpAvgStandardCutoffRightSize'] = val.to_i
+      end
+      opts.on('--memory-down-avg PERCENT', String, "Memory Down-size Maximum Free Memory (%). Upper limit for average free memory") do |val|
+        params['memoryDownAvgStandardCutoffRightSize'] = val.to_i
+      end
+      opts.on('--memory-down-max PERCENT', String, "Memory Down-size Maximum Free Memory (%). Upper limit for peak memory usage") do |val|
+        params['memoryDownMaxStandardCutoffRightSize'] = val.to_i
+      end
+      build_standard_update_options(opts, options)
+      opts.footer = "Update guidance settings."
+    end
+    optparse.parse!(args)
+    connect(options)
+    verify_args!(args:args, optparse:optparse, count:0)
+    payload = parse_payload(options)
+    if !payload
+      payload = {}
+      payload.deep_merge!({object_key => parse_passed_options(options)}) # inject options passed with -O foo=bar
+      payload.deep_merge!({object_key => params}) # inject options --foo bar
+    end
+    if payload[object_key].empty?
+      raise_command_error "Specify at least one option to update.\n#{optparse}"
+    end
+    @guidance_settings_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @guidance_settings_interface.dry.update(payload)
+      return
+    end
+    json_response = @guidance_settings_interface.update(payload)
+    exit_code, err = 0, nil
+    render_response(json_response, options, object_key) do
+      if json_response['success']
+        print_green_success "Updated guidance settings"
+        get([] + (options[:remote] ? ["-r",options[:remote]] : []))
+      else
+        exit_code, err = 1, "Error updating guidance settings: #{json_response['msg'] || json_response['errors']}"
+        print_rest_errors(json_response)
+      end
+    end
+    return exit_code, err
+  end
+
+  private
+
+  def object_key
+    'guidanceSettings'
+  end
+
+end

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

@@ -78,7 +78,7 @@ class Morpheus::Cli::LogSettingsCommand
         print cyan
         print as_pretty_table(log_settings['integrations'], [:name, :enabled, :host, :port])
       end
-      print reset "\n"
+      print reset, "\n"
       return 0
     rescue RestClient::Exception => e
       print_rest_exception(e, options)