Class: Morpheus::Cli::VdiPoolsCommand

Inherits:
Object
  • Object
show all
Includes:
CliCommand, OptionSourceHelper, ProvisioningHelper, VdiHelper
Defined in:
lib/morpheus/cli/commands/vdi_pools_command.rb

Overview

CLI command VDI Pool management UI is Tools: VDI Pools API is /vdi-pools and returns vdiPools

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from OptionSourceHelper

#find_available_user_option, #find_cloud_option, #find_group_option, #find_tenant_option, #get_available_user_options, #get_cloud_options, #get_group_options, #get_tenant_options, included, #load_option_source_data, #options_interface, #parse_cloud_id_list, #parse_group_id_list, #parse_option_source_id_list, #parse_project_id_list, #parse_tenant_id_list, #parse_user_id_list

Methods included from ProvisioningHelper

#accounts_interface, #add_perms_options, #api_client, #apps_interface, #cloud_datastores_interface, #clouds_interface, #datastores_interface, #find_app_by_id, #find_app_by_name, #find_app_by_name_or_id, #find_cloud_by_id_for_provisioning, #find_cloud_by_name_for_provisioning, #find_cloud_by_name_or_id_for_provisioning, #find_cloud_resource_pool_by_name_or_id, #find_group_by_id_for_provisioning, #find_group_by_name_for_provisioning, #find_group_by_name_or_id_for_provisioning, #find_host_by_id, #find_host_by_name, #find_host_by_name_or_id, #find_instance_by_id, #find_instance_by_name, #find_instance_by_name_or_id, #find_instance_type_by_code, #find_instance_type_by_id, #find_instance_type_by_name, #find_instance_type_by_name_or_id, #find_instance_type_layout_by_id, #find_server_by_id, #find_server_by_name, #find_server_by_name_or_id, #find_workflow_by_id, #find_workflow_by_name, #find_workflow_by_name_or_id, #format_app_status, #format_blueprint_type, #format_container_connection_string, #format_container_status, #format_instance_connection_string, #format_instance_container_display_name, #format_instance_status, #format_metadata, #format_snapshot_status, #get_available_accounts, #get_available_clouds, #get_available_environments, #get_available_groups, #get_available_plans, #get_provision_type_for_zone_type, #get_static_environments, included, #instance_type_layouts_interface, #instance_types_interface, #instances_interface, #load_balance_protocols_dropdown, #options_interface, #parse_blueprint_type, #parse_host_id_list, #parse_instance_id_list, #parse_metadata, #parse_resource_id_list, #parse_server_id_list, #print_permissions, #prompt_evars, #prompt_exposed_ports, #prompt_instance_load_balancer, #prompt_metadata, #prompt_network_interfaces, #prompt_new_instance, #prompt_permissions, #prompt_permissions_v2, #prompt_resize_volumes, #prompt_security_groups, #prompt_service_plan_options, #prompt_volumes, #provision_types_interface, #reject_service_plan_option_types, #servers_interface

Methods included from VdiHelper

#find_vdi_allocation_by_id, #find_vdi_app_by_id, #find_vdi_app_by_name, #find_vdi_app_by_name_or_id, #find_vdi_gateway_by_id, #find_vdi_gateway_by_name, #find_vdi_gateway_by_name_or_id, #find_vdi_pool_by_id, #find_vdi_pool_by_name, #find_vdi_pool_by_name_or_id, #format_vdi_allocation_status, #format_vdi_pool_status, #get_available_vdi_apps, #get_vdi_app_by_name_or_code, included, #vdi_allocation_list_key, #vdi_allocation_object_key, #vdi_allocations_interface, #vdi_app_list_key, #vdi_app_object_key, #vdi_apps_interface, #vdi_gateway_list_key, #vdi_gateway_object_key, #vdi_gateways_interface, #vdi_pool_list_key, #vdi_pool_object_key, #vdi_pools_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

Instance Method Details

#_get(id, params, options) ⇒ Object 



95
96
97
98
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
 
# File 'lib/morpheus/cli/commands/vdi_pools_command.rb', line 95

def _get(id, params, options)
  vdi_pool = nil
  if id.to_s !~ /\A\d{1,}\Z/
    vdi_pool = find_vdi_pool_by_name(id)
    return 1, "VDI pool not found for #{id}" if vdi_pool.nil?
    id = vdi_pool['id']
  end
  @vdi_pools_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_pools_interface.dry.get(id, params)
    return
  end
  json_response = @vdi_pools_interface.get(id, params)
  vdi_pool = json_response[vdi_pool_object_key]
  config = vdi_pool['config'] || {}
  # export just the config as json or yaml (default)
  if options[:show_config]
    unless options[:json] || options[:yaml] || options[:csv]
      options[:yaml] = true
    end
    return render_with_format(config, options)
  end
  render_response(json_response, options, vdi_pool_object_key) do
    print_h1 "VDI Pool Details", [], options
    print cyan
    show_columns = vdi_pool_column_definitions
    show_columns.delete("VDI Apps") unless vdi_pool['apps']
    show_columns.delete("VDI Gateway") unless vdi_pool['gateway']
    show_columns.delete("Guest Console Jump Host") unless vdi_pool['guestConsoleJumpHost']
    show_columns.delete("Guest Console Jump Port") unless vdi_pool['guestConsoleJumpPort']
    show_columns.delete("Guest Console Jump Username") unless vdi_pool['guestConsoleJumpUsername']
    show_columns.delete("Guest Console Jump Password") unless vdi_pool['guestConsoleJumpPassword']
    show_columns.delete("Guest Console Jump Keypair") unless vdi_pool['guestConsoleJumpKeypair']
    print_description_list(show_columns, vdi_pool)

    # need to make another query if we want to show these here:
    # allocations = @allocations.list({poolId:vdi_pool['id']})['vdiAllocations']
    # if vdi_pool['allocations'] && vdi_pool['allocations'].size > 0
    #   print_h2 "Allocations"
    #   opt_columns = [
    #     {"ID" => lambda {|it| it['id'] } },
    #     {"USER" => lambda {|it| it['user'] ? it['user']['username'] : nil } },
    #     {"STATUS" => lambda {|it| format_vdi_allocation_status(it) } },
    #     {"CREATED" => lambda {|it| format_local_dt it['dateCreated'] } },
    #     {"RELEASE DATE" => lambda {|it| format_local_dt it['releaseDate'] } },
    #   ]
    #   print as_pretty_table(vdi_pool['allocations'], opt_columns)
    # else
    #   # print cyan,"No option types found for this VDI pool.","\n",reset
    # end

    if options[:no_config] != true
      print_h2 "Config YAML"
      if config
        #print reset,(JSON.pretty_generate(config) rescue config),"\n",reset
        #print reset,(as_yaml(config, options) rescue config),"\n",reset
        config_string = as_yaml(config, options) rescue config
        config_lines = config_string.split("\n")
        config_line_count = config_lines.size
        max_lines = 10
        if config_lines.size > max_lines
          config_string = config_lines.first(max_lines).join("\n")
          config_string << "\n\n"
          config_string << "#{dark}(#{(config_line_count - max_lines)} more lines were not shown, use -c to show the config)#{reset}"
          #config_string << "\n"
        end
        # strip --- yaml header
        if config_string[0..3] == "---\n"
          config_string = config_string[4..-1]
        end
        print reset,config_string.chomp("\n"),"\n",reset
      else
        print reset,"(blank)","\n",reset
      end
    
    end

    print reset,"\n"
  end
  return 0, nil
end

#add(args) ⇒ Object 



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
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/morpheus/cli/commands/vdi_pools_command.rb', line 177

def add(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, add_vdi_pool_option_types)
    opts.on('--config-file FILE', String, "Config from a local JSON or YAML file") do |val|
      options[:config_file] = val.to_s
      file_content = nil
      full_filename = File.expand_path(options[:config_file])
      if File.exist?(full_filename)
        file_content = File.read(full_filename)
      else
        print_red_alert "File not found: #{full_filename}"
        return 1
      end
      parse_result = parse_json_or_yaml(file_content)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:error]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
        options[:options]['config'] = params['config'] # or file_content
      end
    end
    opts.on( '-i', '--interactive', "Interactive Config, prompt for each input of the instance configuration" ) do
      options[:interactive_config] = true
    end
    build_standard_add_options(opts, options)
    opts.footer = <<-EOT
Create a new VDI pool.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:0, max:1)
  options[:options]['name'] = args[0] if args[0]
  if options[:options]['logo']
    options[:options]['iconPath'] = 'custom'
  end
  connect(options)
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({vdi_pool_object_key => parse_passed_options(options)})
  else
    params.deep_merge!(parse_passed_options(options))
    # prompt for option types
    # skip config if using interactive prompt
    filtered_option_types = add_vdi_pool_option_types
    if options[:interactive_config] || options[:options]['instanceConfig']
      filtered_option_types = filtered_option_types.reject {|it| it['fieldName'] == 'config' }
    end
    v_prompt = Morpheus::Cli::OptionTypes.prompt(filtered_option_types, options[:options], @api_client, options[:params])
    params.deep_merge!(v_prompt)
    # convert checkbox "on" and "off" to true and false
    params.booleanize!
    # logo upload requires multipart instead of json
    if params['logo']
      params['logo'] = File.new(File.expand_path(params['logo']), 'rb')
      payload[:multipart] = true
    end
    # convert config string to a map
    config = params['config']
    if config && config.is_a?(String)
      parse_result = parse_json_or_yaml(config)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:error]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
      end
    end
    # pass instanceConfig: "{...}" instead of config: {} to preserve config order...
    if params['config']
      config_map = params.delete('config')
      params['instanceConfig'] = as_json(config_map, {:pretty_json => true})
    end
    if options[:interactive_config]
      print_h2 "Instance Config"
      config_map = prompt_vdi_config(options)
      params['config'] = config_map
    end
    # massage association params a bit
    params['gateway'] = {'id' => params['gateway']}  if params['gateway'] && !params['gateway'].is_a?(Hash)
    # params['apps'] = ...
    payload.deep_merge!({vdi_pool_object_key => params})
  end
  @vdi_pools_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_pools_interface.dry.create(payload)
    return 0, nil
  end
  json_response = @vdi_pools_interface.create(payload)
  vdi_pool = json_response[vdi_pool_object_key]
  render_response(json_response, options, vdi_pool_object_key) do
    print_green_success "Added VDI pool #{vdi_pool['name']}"
    return _get(vdi_pool["id"], {}, options)
  end
  return 0, nil
end

#connect(opts) ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/morpheus/cli/commands/vdi_pools_command.rb', line 17

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @vdi_pools_interface = @api_client.vdi_pools
  @vdi_allocations_interface = @api_client.vdi_allocations
  @vdi_apps_interface = @api_client.vdi_apps
  @vdi_gateways_interface = @api_client.vdi_gateways
  @option_types_interface = @api_client.option_types
end

#get(args) ⇒ Object 



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

def get(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[pool]")
    opts.on( '-c', '--config', "Display raw config only. Default is YAML. Combine with -j for JSON instead." ) do
      options[:show_config] = true
    end
    opts.on('--no-config', "Do not display Config YAML." ) do
      options[:no_config] = true
    end
    build_standard_get_options(opts, options)
    opts.footer = <<-EOT
Get details about a specific VDI pool.
[pool] is required. This is the name or id of a VDI pool.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:1)
  connect(options)
  params.merge!(parse_query_options(options))
  id_list = parse_id_list(args)
  return run_command_for_each_arg(id_list) do |arg|
    _get(arg, params, options)
  end
end

#handle(args) ⇒ Object 



26
27
28
 
# File 'lib/morpheus/cli/commands/vdi_pools_command.rb', line 26

def handle(args)
  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
 
# File 'lib/morpheus/cli/commands/vdi_pools_command.rb', line 30

def list(args)
  options = {}
  params = {}
  ref_ids = []
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[search]")
    opts.on( '--enabled [on|off]', String, "Filter by enabled" ) do |val|
      params['enabled'] = (val.to_s != 'false' && val.to_s != 'off')
    end
    build_standard_list_options(opts, options)
    opts.footer = "List VDI pools."
  end
  optparse.parse!(args)
  connect(options)
  if args.count > 0
    options[:phrase] = args.join(" ")
  end
  params.merge!(parse_list_options(options))
  @vdi_pools_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_pools_interface.dry.list(params)
    return
  end
  json_response = @vdi_pools_interface.list(params)
  render_response(json_response, options, vdi_pool_list_key) do
    vdi_pools = json_response[vdi_pool_list_key]
    print_h1 "Morpheus VDI Pools", parse_list_subtitles(options), options
    if vdi_pools.empty?
      print cyan,"No VDI pools found.",reset,"\n"
    else
      print as_pretty_table(vdi_pools, vdi_pool_list_column_definitions.upcase_keys!, options)
      print_results_pagination(json_response)
    end
    print reset,"\n"
  end
  return 0, nil
end

#remove(args) ⇒ Object 



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

def remove(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[pool] [options]")
    build_standard_remove_options(opts, options)
    opts.footer = <<-EOT
Delete a VDI pool.
[pool] is required. This is the name or id of a VDI pool.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)
  vdi_pool = find_vdi_pool_by_name_or_id(args[0])
  return 1 if vdi_pool.nil?
  @vdi_pools_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_pools_interface.dry.destroy(vdi_pool['id'], params)
    return
  end
  unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the VDI pool #{vdi_pool['name']}?")
    return 9, "aborted command"
  end
  json_response = @vdi_pools_interface.destroy(vdi_pool['id'], params)
  render_response(json_response, options) do
    print_green_success "Removed VDI pool #{vdi_pool['name']}"
  end
  return 0, nil
end

#update(args) ⇒ Object 



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
311
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/morpheus/cli/commands/vdi_pools_command.rb', line 282

def update(args)
  options = {}
  params = {}
  payload = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[pool] [options]")
    build_option_type_options(opts, options, update_vdi_pool_option_types)
    opts.on('--config-file FILE', String, "Config from a local JSON or YAML file") do |val|
      options[:config_file] = val.to_s
      file_content = nil
      full_filename = File.expand_path(options[:config_file])
      if File.exist?(full_filename)
        file_content = File.read(full_filename)
      else
        print_red_alert "File not found: #{full_filename}"
        return 1
      end
      parse_result = parse_json_or_yaml(file_content)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:error]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
        options[:options]['config'] = params['config'] # or file_content
      end
    end
    build_standard_update_options(opts, options)
    opts.footer = <<-EOT
Update a VDI pool.
[pool] is required. This is the name or id of a VDI pool.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  if options[:options]['logo']
    options[:options]['iconPath'] = 'custom'
  end
  connect(options)
  vdi_pool = find_vdi_pool_by_name_or_id(args[0])
  return 1 if vdi_pool.nil?
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({vdi_pool_object_key => parse_passed_options(options)})
  else
    params.deep_merge!(parse_passed_options(options))
    # do not prompt on update
    v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_vdi_pool_option_types, options[:options], @api_client, options[:params])
    v_prompt.deep_compact!
    params.deep_merge!(v_prompt)
    # convert checkbox "on" and "off" to true and false
    params.booleanize!
    # logo upload requires multipart instead of json
    if params['logo']
      params['logo'] = File.new(File.expand_path(params['logo']), 'rb')
      payload[:multipart] = true
    end
    # convert config string to a map
    config = params['config']
    if config && config.is_a?(String)
      parse_result = parse_json_or_yaml(config)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:error]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
      end
    end
    # pass instanceConfig: "{...}" instead of config: {} to preserve config order...
    if params['config']
      config_map = params.delete('config')
      params['instanceConfig'] = as_json(config_map, {:pretty_json => true})
    end
    # massage association params a bit
    params['gateway'] = {'id' => params['gateway']}  if params['gateway'] && !params['gateway'].is_a?(Hash)
    # params['apps'] = ...
    payload.deep_merge!({vdi_pool_object_key => params})
    if payload[vdi_pool_object_key].empty? # || options[:no_prompt]
      raise_command_error "Specify at least one option to update.\n#{optparse}"
    end
  end
  @vdi_pools_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_pools_interface.dry.update(vdi_pool['id'], payload)
    return
  end
  json_response = @vdi_pools_interface.update(vdi_pool['id'], payload)
  vdi_pool = json_response[vdi_pool_object_key]
  render_response(json_response, options, vdi_pool_object_key) do
    print_green_success "Updated VDI pool #{vdi_pool['name']}"
    return _get(vdi_pool["id"], {}, options)
  end
  return 0, nil
end