Class: Morpheus::Cli::Remote

Inherits:
Object
  • Object
show all
Extended by:
Term::ANSIColor
Includes:
CliCommand
Defined in:
lib/morpheus/cli/remote.rb

Constant Summary collapse

@@appliance_config =

for caching the the contents of YAML file $home/appliances it is structured like :appliance_name => => “htt[://api.gomorpheus.com”, :active => true not named @@appliances to avoid confusion with the instance variable . This is also a command class…

nil

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CliCommand

#build_common_options, #build_option_type_options, #command_name, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_id_list, #parse_list_options, #parse_list_subtitles, #print, #print_error, #puts, #puts_error, #raise_command_error, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!

Constructor Details

#initialize ⇒ Remote

Returns a new instance of Remote.



17
18
19
 
# File 'lib/morpheus/cli/remote.rb', line 17

def initialize()
  @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
end

Class Method Details

.active_appliance ⇒ Object

Returns two things, the remote appliance name and url



968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/morpheus/cli/remote.rb', line 968

def active_appliance
  if self.appliances.empty?
    return nil, nil
  end
  app_name, app_map = self.appliances.find {|k,v| v[:active] == true }
  app_url = app_map ? (app_map[:host] || app_map[:url]).to_s : nil
  if app_name
    return app_name, app_url
  else
    return nil, nil
  end
end

.appliance_config ⇒ Object 



963
964
965
 
# File 'lib/morpheus/cli/remote.rb', line 963

def appliance_config
  @@appliance_config ||= load_appliance_file || {}
end

.appliances ⇒ Object 



959
960
961
 
# File 'lib/morpheus/cli/remote.rb', line 959

def appliances
  self.appliance_config
end

.appliances_file_path ⇒ Object 



1082
1083
1084
 
# File 'lib/morpheus/cli/remote.rb', line 1082

def appliances_file_path
  File.join(Morpheus::Cli.home_directory,"appliances")
end

.clear_active_appliance ⇒ Object 



1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/morpheus/cli/remote.rb', line 1057

def clear_active_appliance
  #return set_active_appliance(nil)
  new_appliances = self.appliances
  new_appliances.each do |k,v|
    v.delete(:active)
  end
  save_appliances(new_appliances)
end

.delete_remote(app_name) ⇒ Object 



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/morpheus/cli/remote.rb', line 1129

def delete_remote(app_name)
  app_name = app_name.to_sym
  cur_appliances = self.appliances #.clone
  app_map = cur_appliances[app_name]
  if !app_map
    return nil
  end
  # remove it from config and delete credentials
  cur_appliances.delete(app_name)
  ::Morpheus::Cli::Remote.save_appliances(cur_appliances)
  # this should be a class method too
  ::Morpheus::Cli::Credentials.new(app_name, nil).clear_saved_credentials(app_name)
  # delete from groups too..
  ::Morpheus::Cli::Groups.clear_active_group(app_name)
  # return the deleted value
  return app_map
end

.load_active_remote ⇒ Object

Returns Hash info about the active appliance.

Returns:

  • Hash info about the active appliance



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/morpheus/cli/remote.rb', line 1011

def load_active_remote()
  # todo: use this in favor of Remote.active_appliance perhaps?
  if self.appliances.empty?
    return nil
  end
  result = nil
  app_name, app_map = self.appliances.find {|k,v| v[:active] == true }
  if app_map
    result = app_map
    result[:name] = app_name # app_name.to_s to be more consistant with other display values
  end
  return result
end

.load_all_remotes(params = {}) ⇒ Array

Returns all the appliances in the configuration

Parameters:

  • params (Hash) (defaults to: {}) —

    not used right now

Returns:

  • (Array) —

    of appliances, all of them.



984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/morpheus/cli/remote.rb', line 984

def load_all_remotes(params={})
  if self.appliances.empty?
    return []
  end
  all_appliances = self.appliances.collect do |app_name, app_map|
    row = app_map.clone # OStruct.new(app_map) tempting
    row[:name] = app_name
    row
    # {
    #   active: v[:active],
    #   name: app_name,
    #   host: v[:host], # || v[:url],
    #   #"LICENSE": v[:licenseIsInstalled] ? "Installed" : "(unknown)" # never return a license key from the server, ever!
    #   status: v[:status],
    #   username: v[:username],
    #   last_check: v[:last_check],
    #   last_whoami: v[:last_whoami],
    #   last_api_request: v[:last_api_request],
    #   last_api_result: v[:last_api_result],
    #   last_command: v[:last_command],
    #   last_command_result: v[:last_command_result]
    # }
  end
  return all_appliances
end

.load_appliance_file ⇒ Object 



1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/morpheus/cli/remote.rb', line 1066

def load_appliance_file
  fn = appliances_file_path
  if File.exist? fn
    Morpheus::Logging::DarkPrinter.puts "loading appliances file #{fn}" if Morpheus::Logging.debug?
    return YAML.load_file(fn)
  else
    return {}
    # return {
    #   morpheus: {
    #     host: 'https://api.gomorpheus.com',
    #     active: true
    #   }
    # }
  end
end

.load_remote(app_name) ⇒ Hash

Returns info about the appliance.

Parameters:

  • name (String or Symbol) —

    of the remote to load (converted to symbol)

Returns:

  • (Hash) —

    info about the appliance



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/morpheus/cli/remote.rb', line 1027

def load_remote(app_name)
  if self.appliances.empty? || app_name.nil?
    return nil
  end
  result = nil
  app_map = self.appliances[app_name.to_sym]
  if app_map
    result = app_map
    result[:name] = app_name # .to_s probably better
  end
  return result
end

.refresh_remote(app_name) ⇒ Object

refresh_remote makes an api request to the configured appliance url and updates the appliance’s build version, status and last_check attributes



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
 
# File 'lib/morpheus/cli/remote.rb', line 1149

def refresh_remote(app_name)
  # this might be better off staying in the CliCommands themselves
  # todo: public api /api/setup/check should move to /api/version or /api/server-info
  app_name = app_name.to_sym
  cur_appliances = self.appliances
  app_map = cur_appliances[app_name] || {}
  app_url = (app_map[:host] || app_map[:url]).to_s

  if !app_url
    raise "appliance config is missing url!" # should not need this
  end

  # todo: this insecure flag needs to applied everywhere now tho..
  if app_map[:insecure]
    Morpheus::RestClient.enable_ssl_verification = false
  end
  # Morpheus::RestClient.enable_http = app_map[:insecure].to_s == 'true'
  setup_interface = Morpheus::SetupInterface.new(app_url)
  begin
    now = Time.now.to_i
    app_map[:last_check] = {}
    app_map[:last_check][:success] = false
    app_map[:last_check][:timestamp] = Time.now.to_i
    # todo: move /api/setup/check to /api/version or /api/server-info
    check_json_response = setup_interface.check()
    # puts "REMOTE CHECK RESPONSE:"
    # puts JSON.pretty_generate(check_json_response), "\n"
    app_map[:last_check][:http_status] = 200
    app_map[:build_version] = check_json_response['buildVersion'] # || check_json_response['build_version']
    #app_map[:last_check][:success] = true
    if check_json_response['success'] == true
      app_map[:status] = 'ready'
      app_map[:last_check][:success] = true
      # consider bumping this after every successful api command
      app_map[:last_success_at] = Time.now.to_i
      app_map.delete(:error)
    end
    if check_json_response['setupNeeded'] == true
      app_map[:setup_needed] = true
      app_map[:status] = 'fresh'
    else
      app_map.delete(:setup_needed)
    end

  rescue SocketError => err
    app_map[:status] = 'unreachable'
    app_map[:last_check][:http_status] = nil
    app_map[:last_check][:error] = err.message
  rescue RestClient::Exceptions::Timeout => err
    # print_rest_exception(e, options)
    # exit 1
    app_map[:status] = 'http-timeout'
    app_map[:last_check][:http_status] = nil
  rescue Errno::ECONNREFUSED => err
    app_map[:status] = 'net-error'
    app_map[:last_check][:error] = err.message
  rescue OpenSSL::SSL::SSLError => err
    app_map[:status] = 'ssl-error'
    app_map[:last_check][:error] = err.message
  rescue RestClient::Exception => err
    app_map[:status] = 'http-error'
    app_map[:http_status] = err.response ? err.response.code : nil
    app_map[:last_check][:error] = err.message
    # fallback to /ping for older appliance versions (pre 2.10.5)
    begin
      Morpheus::Logging::DarkPrinter.puts "falling back to remote check via /ping ..." if Morpheus::Logging.debug?
      setup_interface.ping()
      app_map[:last_check][:ping_fallback] = true
      app_map[:last_check][:http_status] = 200
      app_map[:last_check][:success] = true
      app_map[:last_check][:ping_fallback] = true
      app_map[:build_version] = "" # unknown until whoami is executed..
      app_map[:status] = 'ready'
      # consider bumping this after every successful api command
      app_map[:last_success_at] = Time.now.to_i
      app_map.delete(:error)
    rescue => ping_err
      Morpheus::Logging::DarkPrinter.puts "/ping failed too: #{ping_err.message} ..." if Morpheus::Logging.debug?
    end
  rescue => err
    # should save before raising atleast..sheesh
    raise err
    # Morpheus::Cli::ErrorHandler.new.handle_error(e)
    app_map[:status] = 'error'
    app_map[:last_check][:error] = err.message
  end

  # if app_map[:status] == 'ready'
  #   app_map.delete(:error)
  # end

  # save changes to disk ... and
  # ... class variable returned by Remote.appliances is updated in there too...
  save_remote(app_name, app_map)

  # return the updated data
  return app_map

end

.save_appliances(new_config) ⇒ Object 



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/morpheus/cli/remote.rb', line 1086

def save_appliances(new_config)
  fn = appliances_file_path
  if !Dir.exists?(File.dirname(fn))
    FileUtils.mkdir_p(File.dirname(fn))
  end
  File.open(fn, 'w') {|f| f.write new_config.to_yaml } #Store
  FileUtils.chmod(0600, fn)
  #@@appliance_config = load_appliance_file
  @@appliance_config = new_config
end

.save_remote(app_name, app_map) ⇒ Hash

save_remote updates the appliance info

Parameters:

  • app_name (Symbol) —

    name and key for the appliance

  • app_map (Hash) —

    appliance configuration data :url, :insecure, :active, :etc

Returns:

  • (Hash) —

    updated appliance config data



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'lib/morpheus/cli/remote.rb', line 1101

def save_remote(app_name, app_map)
  app_name = app_name.to_sym
  # it's probably better to use load_appliance_file() here instead
  cur_appliances = self.appliances #.clone
  cur_appliances[app_name] = app_map
  cur_appliances[app_name] ||= {:status => "unknown", :error => "Bad configuration. Missing url. See 'remote update --url'" }
  
  # this is the new set_active_appliance(), instead just pass :active => true
  # remove active flag from others
  if app_map[:active]
    cur_appliances.each do |k,v|
      is_match = (app_name ? (k == app_name) : false)
      if is_match
        v[:active] = true
      else
        v.delete(:active)
        # v.delete('active')
        # v[:active] = false
      end
    end
  end

  # persist all appliances
  save_appliances(cur_appliances)

  return app_map
end

.set_active_appliance(app_name) ⇒ Object 



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/morpheus/cli/remote.rb', line 1040

def set_active_appliance(app_name)
  app_name = app_name.to_sym
  new_appliances = self.appliances
  new_appliances.each do |k,v|
    is_match = (app_name ? (k == app_name) : false)
    if is_match
      v[:active] = true
    else
      v.delete(:active)
      # v.delete('active')
      # v[:active] = false
    end
  end
  save_appliances(new_appliances)
  return load_remote(app_name)
end

Instance Method Details

#_check_all_appliances ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/morpheus/cli/remote.rb', line 308

def _check_all_appliances()
  # reresh all appliances and then display the list view
  id_list = ::Morpheus::Cli::Remote.appliances.keys # sort ?
  if id_list.size > 1
    print cyan
    print "Checking #{id_list.size} appliances "
  end
  id_list.each do |appliance_name|
    print "."
    ::Morpheus::Cli::Remote.refresh_remote(appliance_name)
  end
  print "\n"
  list([])

end

#_check_appliance(appliance_name, options) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/morpheus/cli/remote.rb', line 324

def _check_appliance(appliance_name, options)
  begin
    appliance = nil
    if appliance_name == "current"
      appliance = ::Morpheus::Cli::Remote.load_active_remote()
      if !appliance
        raise_command_error "No current appliance, see `remote use`."
      end
      appliance_name = appliance[:name]
    else
      appliance = ::Morpheus::Cli::Remote.load_remote(appliance_name)
      if !appliance
        raise_command_error "Remote appliance not found by the name '#{appliance_name}'"
      end
    end

    # found appliance
    # now refresh it
    
    start_time = Time.now

    Morpheus::Logging::DarkPrinter.puts "checking remote appliance url: #{appliance[:host]} ..." if Morpheus::Logging.debug?      

    appliance = ::Morpheus::Cli::Remote.refresh_remote(appliance_name)

    took_sec = (Time.now - start_time)

    if options[:quiet]
      return 0
    end

    Morpheus::Logging::DarkPrinter.puts "remote appliance check completed in #{took_sec.round(3)}s" if Morpheus::Logging.debug?

    # puts "remote #{appliance[:name]} status: #{format_appliance_status(appliance)}"

    # if options[:json]
    #   print JSON.pretty_generate(json_response), "\n"
    #   return
    # end

    # show user latest info
    return _get(appliance[:name], {})

  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#_get(appliance_name, options) ⇒ Object 



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/morpheus/cli/remote.rb', line 462

def _get(appliance_name, options)
  begin
    appliance = nil
    if appliance_name == "current"
      appliance = ::Morpheus::Cli::Remote.load_active_remote()
      if !appliance
        raise_command_error "No current appliance, see `remote use`."
      end
      appliance_name = appliance[:name]
    else
      appliance = ::Morpheus::Cli::Remote.load_remote(appliance_name)
      if !appliance
        raise_command_error "Remote appliance not found by the name '#{appliance_name}'"
      end
    end

    if options[:json]
      json_response = {remote_appliance: appliance} # mock payload
      puts as_json(json_response, options)
      return
    end

    # expando
    # appliance = OStruct.new(appliance)

    # todo: just go ahead and refresh it now...
    # _check(appliance_name, {:quiet => true})
    # appliance = ::Morpheus::Cli::Remote.refresh_remote(appliance_name)

    if appliance[:active]
      # print_h1 "Current Remote Appliance: #{appliance[:name]}"
      print_h1 "Remote Appliance: #{appliance[:name]}"
    else
      print_h1 "Remote Appliance: #{appliance[:name]}"
    end
    print cyan
    description_cols = {
      "Name" => :name,
      "URL" => :host,
      "Secure" => lambda {|it| format_appliance_secure(it) },
      "Version" => lambda {|it| it[:build_version] ? "#{it[:build_version]}" : 'unknown' },
      "Status" => lambda {|it| format_appliance_status(it, cyan) },
      "Username" => :username,
      # "Authenticated" => lambda {|it| format_boolean it[:authenticated] },
      # todo: fix this layout, obv
      "Activity" => lambda {|it| get_appliance_session_blurbs(it).join("\n" + (' '*10)) }
    }
    print cyan
    puts as_description_list(appliance, description_cols)

    # if appliance[:insecure]
    #   puts " Ignore SSL Errors: Yes"
    # else
    #   puts " Ignore SSL Errors: No"
    # end
    
    if appliance[:active]
      # print cyan
      print cyan, " => This is the current appliance.", reset, "\n\n"
    end

    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#add(args) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/morpheus/cli/remote.rb', line 99

def add(args)
  exit_code, err = 0, nil
  options = {}
  params = {}
  new_appliance_map = {}
  use_it = false
  is_insecure = nil
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    banner = subcommand_usage("[name] [url]")
    banner_args = <<-EOT
  [name]                           The name for your appliance. eg. mymorph
  [url]                            The url of your appliance eg. https://morpheus.mycompany.com
EOT
    opts.banner = banner + "\n" + banner_args
    opts.on(nil, '--use', "Make this the current appliance" ) do
      use_it = true
      new_appliance_map[:active] = true
    end
    # let's free up the -d switch for global options, maybe?
    opts.on( '-d', '--default', "Does the same thing as --use" ) do
      use_it = true
      new_appliance_map[:active] = true
    end
    opts.on(nil, "--secure", "Prevent insecure HTTPS communication.  This is enabled by default.") do
      params[:secure] = true
    end
    opts.on(nil, "--insecure", "Allow insecure HTTPS communication.  i.e. Ignore SSL errors.") do
      params[:insecure] = true
    end
    build_common_options(opts, options, [:quiet])
    opts.footer = <<-EOT
This will add a new remote appliance to your morpheus client configuration.
If the new remote is your one and only, --use is automatically applied and 
it will be made the current remote appliance.
This command will prompt you to login and/or setup a fresh appliance.
Prompting can be skipped with use of the --quiet option.
EOT
  end
  optparse.parse!(args)
  if args.count < 2
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "#{command_name} add expects 2 arguments: [name] [url]"
    puts_error optparse
    return 1
  end

  # load current appliances
  appliances = ::Morpheus::Cli::Remote.appliances

  # always use the first one
  if appliances.empty?
    new_appliance_map[:active] = true
  end

  # validate options
  # construct new appliance map
  # and save it in the config file
  new_appliance_name = args[0].to_sym

  # for the sake of sanity
  if [:current, :all].include?(new_appliance_name)
    raise_command_error "The specified appliance name is invalid: '#{args[0]}'"
  end
  # unique name
  if appliances[new_appliance_name] != nil
    raise_command_error "Remote appliance already configured with the name '#{args[0]}'"
  end
  new_appliance_map[:name] = new_appliance_name

  if params[:insecure]
    new_appliance_map[:insecure] = true
  elsif params[:secure]
    new_appliance_map.delete(:insecure)
  end
  if params[:url] || params[:host]
    url = params[:url] || params[:host]
  end

  url = args[1]
  if url !~ /^https?\:\/\/.+/
    raise_command_error "The specified appliance url is invalid: '#{args[1]}'"
    #puts optparse
    return 1
  end
  new_appliance_map[:host] = url

  # save it
  appliance = ::Morpheus::Cli::Remote.save_remote(new_appliance_name, new_appliance_map)

  if !options[:quiet]
    # print_green_success "Added remote #{new_appliance_name}"
    print_green_success "Added remote #{new_appliance_name}"
  end

  # hit check api and store version and other info
  if !options[:quiet]
    print cyan
    puts "Inspecting remote appliance url: #{appliance[:host]} ..."
  end
  appliance = ::Morpheus::Cli::Remote.refresh_remote(new_appliance_name)
  if !options[:quiet]
    print cyan
    puts "Status is: #{format_appliance_status(appliance)}"
  end
  # puts "refreshed appliance #{appliance.inspect}"
  # determine command exit_code and err
  exit_code = (appliance[:status] == 'ready' || appliance[:status] == 'fresh') ? 0 : 1

  if exit_code == 0
    if appliance[:error]
      exit_code = 1
      err = "Check Failed: #{appliance[:error]}"
    end
  end

  if options[:quiet]
    return exit_code, err
  end

  # check_cmd_result = check_appliance([new_appliance_name, "--quiet"])
  # check_cmd_result = check_appliance([new_appliance_name])

  if appliance[:status] == 'fresh' # || appliance[:setup_needed] == true
    print cyan
    puts "It looks like this appliance needs to be setup. Starting setup ..."
    return setup([new_appliance_name])
    # no need to login, setup() handles that
  end

  
  # only login if you are using this remote
  # maybe remote use should do the login prompting eh?
  # if appliance[:active] && appliance[:status] == 'ready'
  if appliance[:status] == 'ready'
    print reset
    if ::Morpheus::Cli::OptionTypes::confirm("Would you like to login now?", options.merge({default: true}))
       = ::Morpheus::Cli::Login.new.handle(["--remote", appliance[:name].to_s])
      keep_trying = true
      if  == 0
        keep_trying = false
      end
      while keep_trying do
        if ::Morpheus::Cli::OptionTypes::confirm("Login was unsuccessful. Would you like to try again?", options.merge({default: true}))
           = ::Morpheus::Cli::Login.new.handle(["--remote", appliance[:name].to_s])
          if  == 0
            keep_trying = false
          end
        else
          keep_trying = false
        end
      end

    end

    if !appliance[:active]
      if ::Morpheus::Cli::OptionTypes::confirm("Would you like to switch to using this remote now?", options.merge({default: true}))
        use([appliance[:name]])
      end
    end

  else
    #puts "Status is #{format_appliance_status(appliance)}"
  end

  # print new appliance details
  _get(appliance[:name], {})

  return exit_code, err
end

#check(args) ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/morpheus/cli/remote.rb', line 273

def check(args)
  options = {}
  checkall = false
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    opts.on("-a",'--all', "Refresh all appliances") do
      checkall = true
    end
    build_common_options(opts, options, [:quiet])
    opts.footer = <<-EOT
This can be used to refresh a remote appliance status.
It makes an api request to the configured appliance url, and stores the status 
of the server and other info, e.g. version, in the local morpheus cli configuration.
EOT
  end
  optparse.parse!(args)
  id_list = nil
  checkall = true if args[0] == "all" and args.size == 1 # sure, why not
  if checkall
    # id_list = ::Morpheus::Cli::Remote.appliances.keys # sort ?
    return _check_all_appliances()
  elsif args.count < 1
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "#{command_name} update expects argument [name] or option --all"
    puts_error optparse
    return 1
  else
    id_list = parse_id_list(args)
  end
  #connect(options)
  return run_command_for_each_arg(id_list) do |arg|
    _check_appliance(arg, options)
  end
end

#current(args) ⇒ Object 



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/morpheus/cli/remote.rb', line 647

def current(args)
  options = {}
  name_only = false
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    opts.on( '-n', '--name', "Print only the name." ) do
      name_only = true
    end
    build_common_options(opts, options, [])
    opts.footer = "Print details about the current remote appliance." +
                  "The default behavior is the same as 'remote get current'."
  end
  optparse.parse!(args)

  if name_only
    return print_current(args)
  else
    return _get("current", {})
  end

  if @appliance_name
    print cyan, @appliance_name,"\n",reset
  else
    print yellow, "No active appliance, see `remote use`\n", reset
    return false
  end
end

#format_appliance_secure(app_map, return_color = cyan) ⇒ Object 



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/morpheus/cli/remote.rb', line 874

def format_appliance_secure(app_map, return_color=cyan)
  return "" if !app_map
  out = ""
  app_url = (app_map[:host] || app_map[:url]).to_s
  is_ssl = app_url =~ /^https/
  if !is_ssl
    out << "No (no SSL)"
  else
    if app_map[:insecure]
      out << "No (Ignore SSL Errors)"
    else
      # should have a flag that gets set when everything actually looks good..
      out << "Yes"
    end
  end
  out
end

#format_appliance_status(app_map, return_color = cyan) ⇒ Object 



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/morpheus/cli/remote.rb', line 849

def format_appliance_status(app_map, return_color=cyan)
  return "" if !app_map
  status_str = app_map[:status] || app_map['status'] || "unknown" # get_object_value(app_map, :status)
  status_str = status_str.empty? ? "unknown" : status_str.to_s.downcase
  out = ""
  if status_str == "new"
    out << "#{cyan}#{status_str.upcase}#{return_color}"
  elsif status_str == "ready"
    out << "#{green}#{status_str.upcase}#{return_color}"
  elsif status_str == "unreachable"
    out << "#{red}#{status_str.upcase}#{return_color}"
  elsif status_str.include?("error")
    out << "#{red}#{status_str.upcase}#{return_color}"
  # elsif status_str == "unknown"
  #   out << "#{yellow}#{status_str}#{return_color}"
  elsif status_str == "fresh" 
    # cold appliance, needs setup
    out << "#{magenta}#{status_str.upcase}#{return_color}"
  else
    # dunno
    out << "#{status_str}"
  end
  out
end

#get(args) ⇒ Object 



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/morpheus/cli/remote.rb', line 442

def get(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:json,:csv, :fields, :quiet])
  end
  optparse.parse!(args)
  if args.count < 1
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "#{command_name} get expects argument [name]."
    puts_error optparse
    return 1
  end
  #connect(options)
  id_list = parse_id_list(args)
  return run_command_for_each_arg(id_list) do |arg|
    _get(arg, options)
  end
end

#get_appliance_session_blurbs(app_map) ⇒ Object

get display info about the current and past sessions



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/morpheus/cli/remote.rb', line 894

def get_appliance_session_blurbs(app_map)
  # app_map = OStruct.new(app_map)
  blurbs = []
  # Current User
  # 
  username = app_map[:username]
  # creds = app_map[:access_token]
  #creds = Morpheus::Cli::Credentials.new(app_map[:name], app_map[:host]).load_saved_credentials()
  
  
  
  if app_map[:status] == 'ready'

    if app_map[:authenticated]
      #blurbs << app_map[:username] ? "Authenticated as #{app_map[:username]}" : "Authenticated"
      blurbs << "Authenticated."
      if app_map[:last_login_at]
        blurbs << "Logged in #{format_duration(app_map[:last_login_at])} ago."
      end
    else
      if app_map[:last_logout_at]
        blurbs << "Logged out #{format_duration(app_map[:last_logout_at])} ago."
      else
        blurbs << "Logged out."
      end
      if app_map[:last_login_at]
        blurbs << "Last login at #{format_local_dt(app_map[:last_login_at])}."
      end
    end

    if app_map[:last_success_at]
      blurbs << "Last success at #{format_local_dt(app_map[:last_success_at])}"
    end

  else
    
    if app_map[:last_check]
      if app_map[:last_check][:timestamp]
        blurbs << "Last checked #{format_duration(app_map[:last_check][:timestamp])} ago."
      end
      if app_map[:last_check][:error]
        blurbs << "Error: #{app_map[:last_check][:error]}"
      end
      if app_map[:last_check][:http_status]
        blurbs << "HTTP #{app_map[:last_check][:http_status]}"
      end
    end

    if app_map[:last_success_at]
      blurbs << "Last Success: #{format_local_dt(app_map[:last_success_at])}"
    end

  end

  return blurbs
end

#handle(args) ⇒ Object 



21
22
23
24
25
26
27
28
 
# File 'lib/morpheus/cli/remote.rb', line 21

def handle(args)
  # if args.count == 0
  #   list(args)
  # else
  #   handle_subcommand(args)
  # end
  handle_subcommand(args)
end

#list(args) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/morpheus/cli/remote.rb', line 30

def list(args)
  options = {}
  show_all_activity = false
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    opts.on("-a",'--all', "Show all the appliance activity details") do
      show_all_activity = true
    end
    build_common_options(opts, options, [:json, :yaml, :csv, :fields])
    opts.footer = <<-EOT
This outputs a list of the configured remote appliances. It also indicates
the current appliance. The current appliance is where morpheus will send 
its commands by default. That is, in absence of the '--remote' option.
EOT
  end
  optparse.parse!(args)
  if args.count > 0
    raise ::OptionParser::NeedlessArgument.new("#{args.join(' ')}")
  end
  @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
  appliances = ::Morpheus::Cli::Remote.load_all_remotes({})
  # if appliances.empty?
  #   raise_command_error "You have no appliances configured. See the `remote add` command."
  # end
  
  json_response = {"appliances" => appliances}
  if options[:json]
    puts as_json(json_response, options, "appliances")
    return 0
  elsif options[:yaml]
    puts as_yaml(json_response, options, "appliances")
    return 0
  elsif options[:csv]
    puts records_as_csv(appliances, options)
    return 0
  end

  print_h1 "Morpheus Appliances"
  if appliances.empty?
    print yellow
    puts "You have no appliances configured. See the `remote add` command."
    print reset, "\n"
  else
    print cyan
    #tp rows, {:active => {:display_name => ""}}, {:name => {:width => 16}}, {:host => {:width => 40}}
    columns = [
      {:active => {:display_name => "", :display_method => lambda {|it| it[:active] ? "=>" : "" } } },
      {:name => {:width => 16} }, 
      {:url => {display_method: lambda {|it| it[:host] || it[:url] }, :width => 40 } },
      {:version => lambda {|it| it[:build_version] } },
      {:status => lambda {|it| format_appliance_status(it, cyan) } },
      :username,
      # {:session => {display_method: lambda {|it| get_appliance_session_blurbs(it).join('  ') }, max_width: 24} }
      {:activity => {display_method: lambda {|it| show_all_activity ? get_appliance_session_blurbs(it).join("\t") : get_appliance_session_blurbs(it).first } } }
    ]
    print as_pretty_table(appliances, columns, options)
    print reset
    if @appliance_name
      #unless appliances.keys.size == 1
        print cyan, "\n# => Currently using #{@appliance_name}\n", reset
      #end
    else
      print "\n# => No current remote appliance, see `remote use`\n", reset
    end
    print reset, "\n"
  end
  return 0, nil
end

#print_current(args) ⇒ Object 



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/morpheus/cli/remote.rb', line 675

def print_current(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [])
    opts.footer = "Prints the name of the current remote appliance"
  end
  optparse.parse!(args)

  if @appliance_name
    print cyan, @appliance_name,"\n",reset
  else
    print yellow, "No active appliance, see `remote use`\n", reset
    return false
  end
end

#refresh(args) ⇒ Object 



269
270
271
 
# File 'lib/morpheus/cli/remote.rb', line 269

def refresh(args)
  check_appliance(args)
end

#remove(args) ⇒ Object 



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/morpheus/cli/remote.rb', line 530

def remove(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    # opts.on( '-f', '--force', "Remote appliance anyway??" ) do
    #   options[:default] = true
    # end
    opts.footer = "This will delete an appliance from your list."
    build_common_options(opts, options, [:auto_confirm, :quiet])
  end
  optparse.parse!(args)
  if args.count < 1
    #raise_command_error "#{command_name} remove requires argument [name].", optparse
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "#{command_name} remove requires argument [name]."
    puts_error optparse
    return 1, nil
  end
  appliance_name = args[0].to_sym
  appliance = ::Morpheus::Cli::Remote.load_remote(appliance_name)
  if !appliance
    raise_command_error "Remote appliance not found by the name '#{appliance_name}'"
  end
  unless options[:yes] || ::Morpheus::Cli::OptionTypes::confirm("Are you sure you would like to delete '#{appliance_name}' from your list of remote appliances?", options)
    return 9, "aborted command" # new exit code for aborting confirmation
  end

  # ok, delete it
  ::Morpheus::Cli::Remote.delete_remote(appliance_name)

  # return result
  if options[:quiet]
    return 0, nil
  end
  print_green_success "Deleted remote #{appliance_name}"
  list([])
  # recalcuate echo vars
  Morpheus::Cli::Echo.recalculate_variable_map()
  # recalculate shell prompt after this change
  if Morpheus::Cli::Shell.has_instance?
    Morpheus::Cli::Shell.instance.reinitialize()
  end
  return 0, nil
end

#setup(args) ⇒ Object

this is a wizard that walks through the /api/setup controller it only needs to be used once to initialize a new appliance



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/morpheus/cli/remote.rb', line 694

def setup(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [:options, :json, :dry_run])
    opts.on('-I','--insecure', "Allow insecure HTTPS communication.  i.e. bad SSL certificate.") do |val|
      options[:insecure] = true
      Morpheus::RestClient.enable_ssl_verification = false
    end
    opts.footer = "This can be used to initialize a new appliance.\n" + 
                  "You will be prompted to create the master account.\n" + 
                  "This is only available on a new, freshly installed, remote appliance."
  end
  optparse.parse!(args)

  if !@appliance_name
    print yellow, "No active appliance, see `remote use`\n", reset
    return false
  end

  # this works without any authentication!
  # it will allow anyone to use it, if there are no users/accounts in the system.
  #@api_client = establish_remote_appliance_connection(options)
  #@setup_interface = @api_client.setup
  @setup_interface = Morpheus::SetupInterface.new(@appliance_url)
  appliance_status_json = nil
  begin
    appliance_status_json = @setup_interface.get()
    if appliance_status_json['success'] != true
      print red, "Setup not available for appliance #{@appliance_name} - #{@appliance_url}.\n", reset
      print red, "#{appliance_status_json['msg']}\n", reset
      return false
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    return false
  end
  
  payload = {}

  if appliance_status_json['hubRegistrationEnabled']
    link = File.join(@appliance_url, '/setup')
    print red, "Sorry, setup with hub registration is not yet available.\n", reset
    print "You can use the UI to setup your appliance.\n"
    print "Go to #{link}\n", reset
    # if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
    #   system "start #{link}"
    # elsif RbConfig::CONFIG['host_os'] =~ /darwin/
    #   system "open #{link}"
    # elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
    #   system "xdg-open #{link}"
    # end
    return false
  else
    print_h1 "Morpheus Appliance Setup"

    puts "It looks like you're the first one here."
    puts "Let's initialize your remote appliance at #{@appliance_url}"


    
    # Master Account
    print_h2 "Create Master Account"
     = [
      {'fieldName' => 'accountName', 'fieldLabel' => 'Master Account Name', 'type' => 'text', 'required' => true, 'displayOrder' => 1},
    ]
    v_prompt = Morpheus::Cli::OptionTypes.prompt(, options[:options])
    payload.merge!(v_prompt)

    # Master User
    print_h2 "Create Master User"
    user_option_types = [
      {'fieldName' => 'firstName', 'fieldLabel' => 'First Name', 'type' => 'text', 'required' => false, 'displayOrder' => 1},
      {'fieldName' => 'lastName', 'fieldLabel' => 'Last Name', 'type' => 'text', 'required' => false, 'displayOrder' => 2},
      {'fieldName' => 'username', 'fieldLabel' => 'Username', 'type' => 'text', 'required' => true, 'displayOrder' => 3},
      {'fieldName' => 'email', 'fieldLabel' => 'Email', 'type' => 'text', 'required' => true, 'displayOrder' => 4},
    ]
    v_prompt = Morpheus::Cli::OptionTypes.prompt(user_option_types, options[:options])
    payload.merge!(v_prompt)

    # Password prompt with re-prompting if no match
    password_option_types = [
      {'fieldName' => 'password', 'fieldLabel' => 'Password', 'type' => 'password', 'required' => true, 'displayOrder' => 6},
      {'fieldName' => 'passwordConfirmation', 'fieldLabel' => 'Confirm Password', 'type' => 'password', 'required' => true, 'displayOrder' => 7},
    ]
    v_prompt = Morpheus::Cli::OptionTypes.prompt(password_option_types, options[:options])
    while v_prompt['passwordConfirmation'] != v_prompt['password']
      print red, "Password confirmation does not match. Re-enter your new password.", reset, "\n"
      v_prompt = Morpheus::Cli::OptionTypes.prompt(password_option_types, options[:options])
    end
    payload.merge!(v_prompt)

    # Extra settings
    print_h2 "Initial Setup"
    extra_option_types = [
      {'fieldName' => 'applianceName', 'fieldLabel' => 'Appliance Name', 'type' => 'text', 'required' => true, 'defaultValue' => nil},
      {'fieldName' => 'applianceUrl', 'fieldLabel' => 'Appliance URL', 'type' => 'text', 'required' => true, 'defaultValue' => appliance_status_json['applianceUrl']},
      {'fieldName' => 'backups', 'fieldLabel' => 'Enable Backups', 'type' => 'checkbox', 'required' => false, 'defaultValue' => 'off'},
      {'fieldName' => 'monitoring', 'fieldLabel' => 'Enable Monitoring', 'type' => 'checkbox', 'required' => false, 'defaultValue' => 'on'},
      {'fieldName' => 'logs', 'fieldLabel' => 'Enable Logs', 'type' => 'checkbox', 'required' => false, 'defaultValue' => 'on'}
    ]
    v_prompt = Morpheus::Cli::OptionTypes.prompt(extra_option_types, options[:options])
    payload.merge!(v_prompt)

    begin
      if options[:dry_run]
        print_dry_run @setup_interface.dry.init(payload)
        return
      end
      if !options[:json]
        print "Initializing the appliance...\n"
      end
      json_response = @setup_interface.init(payload)
    rescue RestClient::Exception => e
      print_rest_exception(e, options)
      return false
    end

    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
      return
    end
    print "\n"
    print cyan, "You have successfully setup the appliance.\n"
    #print cyan, "You may now login with the command `login`.\n"
    # uh, just use Credentials.login(username, password, {save: true})
    cmd_res = Morpheus::Cli::Login.new.(['--username', payload['username'], '--password', payload['password'], '-q'])
    # print "\n"
    print cyan, "You are now logged in as the System Admin #{payload['username']}.\n"
    print reset
    #print "\n"

    if ::Morpheus::Cli::OptionTypes::confirm("Would you like to apply your License Key now?", options.merge({:default => true}))
      cmd_res = Morpheus::Cli::License.new.apply([])
      # license_is_valid = cmd_res != false
    end

    if ::Morpheus::Cli::OptionTypes::confirm("Do you want to create the first group now?", options.merge({:default => true}))
      cmd_res = Morpheus::Cli::Groups.new.add(['--use'])

      #print "\n"

      # if cmd_res !=
        if ::Morpheus::Cli::OptionTypes::confirm("Do you want to create the first cloud now?", options.merge({:default => true}))
          cmd_res = Morpheus::Cli::Clouds.new.add([])
          #print "\n"
        end
      # end
    end
    print "\n",reset

  end
end

#unuse(args) ⇒ Object 



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/morpheus/cli/remote.rb', line 621

def unuse(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    opts.footer = "" +
      "This clears the current remote appliance.\n" +
      "You will need to use an appliance, or pass the --remote option to your commands."
    build_common_options(opts, options, [])
  end
  optparse.parse!(args)
  @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
  if !@appliance_name
    puts "You are not using any appliance"
    return false
  end
  Morpheus::Cli::Remote.clear_active_appliance()
  puts "You are no longer using the appliance #{@appliance_name}"
  # recalcuate echo vars
  Morpheus::Cli::Echo.recalculate_variable_map()
  # recalculate shell prompt after this change
  if Morpheus::Cli::Shell.has_instance?
    Morpheus::Cli::Shell.instance.reinitialize()
  end
  return true
end

#update(args) ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/morpheus/cli/remote.rb', line 373

def update(args)
  options = {}
  params = {}
  use_it = false
  is_insecure = nil
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    # opts.on(nil, "--name STRING", "Update the name of your remote appliance") do |val|
    #   params['name'] = val
    # end
    opts.on("--url URL", String, "Update the url of your remote appliance") do |val|
      params[:host] = val
    end
    opts.on(nil, "--secure", "Prevent insecure HTTPS communication.  This is enabled by default") do
      params[:secure] = true
    end
    opts.on(nil, "--insecure", "Allow insecure HTTPS communication.  i.e. Ignore SSL errors.") do
      params[:insecure] = true
    end
    opts.on(nil, '--use', "Make this the current appliance" ) do
      use_it = true
      params[:active] = true
    end
    build_common_options(opts, options, [:quiet])
    opts.footer = "This can be used to update remote appliance settings.\n"
  end
  optparse.parse!(args)
  if args.count != 1
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "#{command_name} update expects argument [name]."
    puts_error optparse
    return 1
  end

  appliance_name = args[0].to_sym
  appliance = ::Morpheus::Cli::Remote.load_remote(appliance_name)
  if !appliance
    raise_command_error "Remote appliance not found by the name '#{appliance_name}'"
  end

  # params[:url] = args[1] if args[1]
  
  if params.empty?
    print_error Morpheus::Terminal.angry_prompt
    puts_error "Specify atleast one option to update"
    puts_error optparse
    return 1
  end
  
  if params[:insecure]
    appliance[:insecure] = true
  elsif params[:secure]
    appliance.delete(:insecure)
  end
  if params[:url] || params[:host]
    appliance[:host] = params[:url] || params[:host]
  end

  ::Morpheus::Cli::Remote.save_remote(appliance_name, appliance)

  print_green_success "Updated remote #{appliance_name}"
  # todo: just go ahead and refresh it now...
  # _check(appliance_name, {:quiet => true})
  appliance = ::Morpheus::Cli::Remote.refresh_remote(appliance_name)
  # print new appliance details
  _get(appliance[:name], {})
  return 0, nil
end

#use(args) ⇒ Object 



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/morpheus/cli/remote.rb', line 575

def use(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:quiet])
    opts.footer = "Make an appliance the current remote appliance.\n" +
                  "This allows you to switch between your different appliances.\n" + 
                  "You may override this with the --remote option in your commands."
  end
  optparse.parse!(args)
  if args.count < 1
    print_error Morpheus::Terminal.angry_prompt
    puts_error  "#{command_name} use expects argument [name]."
    puts_error optparse
    return 1
  end
  appliance_name = args[0].to_sym
  appliance = ::Morpheus::Cli::Remote.load_remote(appliance_name)
  if !appliance
    raise_command_error "Remote appliance not found by the name '#{appliance_name}'"
  end
  
  if appliance[:active] == true
    if !options[:quiet]
      print cyan
      puts "Using remote #{appliance_name} (still)"
    end
    return true
  end
  # appliance = ::Morpheus::Cli::Remote.set_active_appliance(appliance_name)
  appliance[:active] = true
  appliance = ::Morpheus::Cli::Remote.save_remote(appliance_name, appliance)
  
  # recalcuate echo vars
  Morpheus::Cli::Echo.recalculate_variable_map()
  # recalculate shell prompt after this change
  if Morpheus::Cli::Shell.has_instance?
    Morpheus::Cli::Shell.instance.reinitialize()
  end

  if !options[:quiet]
    puts "#{cyan}Using remote #{appliance_name}#{reset}"
  end
  return true
end