Class: Morpheus::Cli::KeyPairs

Inherits:
Object
  • Object
show all
Includes:
AccountsHelper, CliCommand
Defined in:
lib/morpheus/cli/commands/key_pairs.rb

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from AccountsHelper

#account_column_definitions, #account_users_interface, #accounts_interface, #find_account_by_id, #find_account_by_name, #find_account_by_name_or_id, #find_account_from_options, #find_all_user_ids, #find_role_by_id, #find_role_by_name, #find_role_by_name_or_id, #find_user_by_id, #find_user_by_username, #find_user_by_username_or_id, #find_user_group_by_id, #find_user_group_by_name, #find_user_group_by_name_or_id, #format_access_string, #format_role_type, #format_user_role_names, #format_user_status, #get_access_color, #get_access_string, included, #list_account_column_definitions, #list_user_column_definitions, #list_user_group_column_definitions, #role_column_definitions, #roles_interface, #subtenant_role_column_definitions, #user_column_definitions, #user_group_column_definitions, #user_groups_interface

Methods included from CliCommand

#add_query_parameter, #apply_options, #build_common_options, #build_get_options, #build_list_options, #build_option_type_options, #build_standard_add_many_options, #build_standard_add_options, #build_standard_api_options, #build_standard_delete_options, #build_standard_get_options, #build_standard_list_options, #build_standard_post_options, #build_standard_put_options, #build_standard_remove_options, #build_standard_update_options, #command_description, #command_name, #confirm, #confirm!, #default_refresh_interval, #default_sigdig, #default_subcommand, #establish_remote_appliance_connection, #execute_api, #execute_api_payload, #execute_api_request, #find_all, #find_all_json, #find_by_id, #find_by_name, #find_by_name_or_id, #find_record, #find_record_json, #full_command_usage, #get_interface, #get_list_key, #get_object_key, #get_subcommand_description, #handle_each_payload, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_array, #parse_bytes_param, #parse_get_options!, #parse_id_list, #parse_labels, #parse_list_options, #parse_list_options!, #parse_list_subtitles, #parse_options, #parse_parameter_as_resource_id!, #parse_passed_options, #parse_payload, #parse_query_options, #print, #print_error, #println, #prog_name, #puts, #puts_error, #raise_args_error, #raise_command_error, #render_response, #run_command_for_each_arg, #subcommand_aliases, #subcommand_description, #subcommand_usage, #subcommands, #usage, #validate_outfile, #verify_args!, #visible_subcommands

Constructor Details

#initializeKeyPairs

Returns a new instance of KeyPairs.



9
10
11
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 9

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

Instance Method Details

#add(args) ⇒ Object



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
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 113

def add(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    opts.on('', '--public-key-file FILENAME', "Public Key File" ) do |filename|
      if File.exist?(File.expand_path(filename))
        options['publicKey'] = File.read(File.expand_path(filename))
        options[:options] ||= {}
        options[:options]['publicKey'] = options['publicKey']
      else
        print_red_alert "File not found: #{filename}"
        exit 1
      end
    end

    opts.on('', '--public-key TEXT', "Public Key Text" ) do |val|
      options['publicKey'] = val
      options[:options] ||= {}
      options[:options]['publicKey'] = options['publicKey']
    end

    opts.on('', '--private-key-file FILENAME', "Private Key File" ) do |filename|
      if File.exist?(File.expand_path(filename))
        options['privateKey'] = File.read(File.expand_path(filename))
        options[:options] ||= {}
        options[:options]['privateKey'] = options['privateKey']
      else
        print_red_alert "File not found: #{filename}"
        exit 1
      end
    end

    opts.on('', '--private-key TEXT', "Private Key Text" ) do |val|
      options['privateKey'] = val
      options[:options] ||= {}
      options[:options]['privateKey'] = options['privateKey']
    end

    build_common_options(opts, options, [:account, :options, :json, :dry_run, :remote])
    opts.footer = <<-EOT
Add a key pair.
    EOT
  end
  optparse.parse!(args)
  # if args.count < 1
  #   puts optparse
  #   exit 1
  # end
  if args[0]
    options[:options] ||= {}
    options[:options]['name'] ||= args[0]
  end
  connect(options)
  begin
     = (options)
     =  ? ['id'] : nil

    params = Morpheus::Cli::OptionTypes.prompt(add_key_pair_option_types, options[:options], @api_client, options[:params])

    if params['publicKey'].to_s.empty? && params['privateKey'].to_s.empty?
      print_red_alert "publicKey or privateKey is required"
      return 1
    end
    # if !params['publicKey']
    #   print_red_alert "publicKey is required"
    #   exit 1
    # elsif !params['privateKey']
    #   print_red_alert "privateKey is required"
    #   exit 1
    # end
    #params['name'] = args[0]

    key_pair_payload = params.select {|k,v| ['name','publicKey', 'privateKey', 'passphrase'].include?(k) }
    payload = {keyPair: key_pair_payload}
    @key_pairs_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @key_pairs_interface.dry.create(, payload)
      return
    end
    json_response = @key_pairs_interface.create(, payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Key Pair #{key_pair_payload['name']} added"
      get([json_response['keyPair']['id']])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#connect(opts) ⇒ Object



13
14
15
16
17
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 13

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @accounts_interface = @api_client.accounts
  @key_pairs_interface = @api_client.key_pairs
end

#generate(args) ⇒ Object



312
313
314
315
316
317
318
319
320
321
322
323
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
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 312

def generate(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:account, :options, :json, :dry_run, :remote])
    opts.footer = <<-EOT
Generate a key pair.
    EOT
  end
  optparse.parse!(args)
  # if args.count < 1
  #   puts optparse
  #   exit 1
  # end
  if args[0]
    options[:options] ||= {}
    options[:options]['name'] ||= args[0]
  end
  connect(options)
  begin
     = (options)
     =  ? ['id'] : nil
    params = Morpheus::Cli::OptionTypes.prompt(add_key_pair_option_types.select {|it| ['name'].include?(it['fieldName'])}, options[:options], @api_client, options[:params])
    key_pair_payload = params.select {|k,v| ['name'].include?(k) }
    payload = {keyPair: key_pair_payload}
    @key_pairs_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @key_pairs_interface.dry.generate(, payload)
      return
    end
    json_response = @key_pairs_interface.generate(, payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Key Pair #{key_pair_payload['name']} added"
      print_key_pair_details(, json_response['keyPair'])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#get(args) ⇒ Object



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 70

def get(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:account, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)

  if args.count < 1
    puts optparse
    exit 1
  end

  connect(options)
  begin
     = (options)
     =  ? ['id'] : nil

    @key_pairs_interface.setopts(options)
    if options[:dry_run]
      if args[0].to_s =~ /\A\d{1,}\Z/
        print_dry_run @key_pairs_interface.dry.get(, args[0])
      else
        print_dry_run @key_pairs_interface.dry.list(, {name: args[0]})
      end
      return 0
    end
    key_pair = find_key_pair_by_name_or_id(, args[0])
    return 1 if key_pair.nil?
    json_response = {'keyPair' => key_pair}
    render_result = render_with_format(json_response, options, 'keyPair')
    return 0 if render_result
    
    unless options[:quiet]
      print_key_pair_details(, key_pair)
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#handle(args) ⇒ Object



19
20
21
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 19

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object



23
24
25
26
27
28
29
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
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 23

def list(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [:account, :list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)
  connect(options)
  begin

     = (options)
     =  ? ['id'] : nil

    params.merge!(parse_list_options(options))
    @key_pairs_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @key_pairs_interface.dry.list(, params)
      return 0
    end
    json_response = @key_pairs_interface.list(, params)
    render_result = render_with_format(json_response, options, 'keyPairs')
    return 0 if render_result
    key_pairs = json_response['keyPairs']
    unless options[:quiet]
      title = "Morpheus Key Pairs"
      subtitles = []
      if 
        subtitles << "Account: #{['name']}".strip
      end
      subtitles += parse_list_subtitles(options)
      print_h1 title, subtitles
      if key_pairs.empty?
        puts yellow,"No key pairs found.",reset
      else
        print_key_pairs_table(key_pairs)
        print_results_pagination(json_response)
      end
      print reset,"\n"
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#remove(args) ⇒ Object



264
265
266
267
268
269
270
271
272
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
307
308
309
310
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 264

def remove(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:account, :auto_confirm, :json, :dry_run, :remote])
    opts.footer = <<-EOT
Delete a key pair.
[name] is required. This is the name or id of a key pair.
    EOT
  end
  optparse.parse!(args)

  if args.count < 1
    puts optparse
    exit 1
  end

  connect(options)
  begin
    # current user account by default
     = (options)
     =  ? ['id'] : nil
    # allow finding by ID since name is not unique!
    key_pair = find_key_pair_by_name_or_id(, args[0])
    exit 1 if key_pair.nil?

    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the key pair #{key_pair['name']}?")
      exit
    end
    @key_pairs_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @key_pairs_interface.dry.destroy(, key_pair['id'])
      return
    end
    json_response = @key_pairs_interface.destroy(, key_pair['id'])
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Key Pair #{key_pair['name']} removed"
      # list([])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#update(args) ⇒ Object



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
# File 'lib/morpheus/cli/commands/key_pairs.rb', line 206

def update(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, update_key_pair_option_types)
    build_common_options(opts, options, [:account, :options, :json, :dry_run, :remote])
    opts.footer = <<-EOT
Update a key pair.
[name] is required. This is the name or id of a key pair.
    EOT
  end
  optparse.parse!(args)

  if args.count < 1
    puts optparse
    exit 1
  end

  connect(options)
  begin

     = (options)
     =  ? ['id'] : nil

    key_pair = find_key_pair_by_name_or_id(, args[0])
    exit 1 if key_pair.nil?

    #params = Morpheus::Cli::OptionTypes.prompt(update_key_pair_option_types, options[:options], @api_client, options[:params])
    params = options[:options] || {}

    if params.empty?
      puts optparse
      option_lines = update_key_pair_option_types.collect {|it| "\t-O #{it['fieldName']}=\"value\"" }.join("\n")
      puts "\nAvailable Options:\n#{option_lines}\n\n"
      exit 1
    end

    key_pair_payload = params.select {|k,v| ['name'].include?(k) }
    payload = {keyPair: key_pair_payload}
    @key_pairs_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @key_pairs_interface.dry.update(, key_pair['id'], payload)
      return
    end
    json_response = @key_pairs_interface.update(, key_pair['id'], payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Key Pair #{key_pair_payload['name'] || key_pair['name']} updated"
      get([json_response['keyPair']['id']])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end