Class: Morpheus::Cli::VdiCommand

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

Overview

CLI command for the VDI (Persona)

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 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 



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
112
113
114
115
116
 
# File 'lib/morpheus/cli/commands/vdi_command.rb', line 87

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, "Virtual desktop not found for #{id}" if vdi_pool.nil?
    id = vdi_pool['id']
  end
  @vdi_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_interface.dry.get(id, params)
    return
  end
  json_response = @vdi_interface.get(id, params)
  vdi_pool = json_response[vdi_desktop_object_key]
  render_response(json_response, options, vdi_desktop_object_key) do
    print_h1 "Virtual Desktop Details", [], options
    print cyan
    show_columns = {
      #"ID" => lambda {|it| it['id'] },
      "Name" => lambda {|it| it['name'] },
      "Status" => lambda {|it| it['status'] },
      #"Allocation ID" => lambda {|it| it['allocation']['id'] rescue '' },
      # todo: more allocation info can be shown here perhaps...
    }
    #show_columns.delete("Allocation ID") unless vdi_pool['allocation'] && vdi_pool['allocation']['id']
    print as_description_list(vdi_pool, show_columns, options)
    print reset,"\n"
  end
  return 0, nil
end

#allocate(args) ⇒ Object 



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

def allocate(args)
  options = {}
  params = {}
  payload = {}
  pool_id = nil
  
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[desktop] [options]")
    opts.on('--desktop DESKTOP', String, "Virtual Desktop Name or ID") do |val|
      pool_id = val.to_s
    end
    build_standard_update_options(opts, options)
    opts.footer = <<-EOT
Allocate a virtual desktop for use.
[desktop] is required, this is name or id of a virtual desktop (VDI Pool).
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:0)
  connect(options)
  if args.count > 0
    pool_id = args.join(" ")
  end

  # prompt for Virtual Desktop (VDI Pool) to allocate
  vdi_pool = nil
  if pool_id
    vdi_pool = find_vdi_pool_by_name_or_id(pool_id)
    return [1, "Virtual Desktop not found"] if vdi_pool.nil?
    pool_id = vdi_pool['id']
  elsif
    vdi_pool_option_type = {'fieldName' => 'desktop', 'fieldLabel' => 'Virtual Desktop', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
      # @options_interface.options_for_source("vdiPools", {})['data']
      @vdi_interface.list({max:10000})[vdi_desktop_list_key].collect {|it|
        {'name' => it['name'], 'value' => it['id']}
      } }, 'required' => true, 'description' => 'Virtual Desktop (VDI pool) name or id'}
    pool_id = Morpheus::Cli::OptionTypes.prompt([vdi_pool_option_type], options[:options], @api_client, options[:params])['desktop']
    vdi_pool = find_vdi_pool_by_name_or_id(pool_id.to_s)
    return [1, "Virtual Desktop not found"] if vdi_pool.nil?
    pool_id = vdi_pool['id']
  end

  payload = {}
  if options[:payload]
    payload = options[:payload]
  end
  payload.deep_merge!(parse_passed_options(options))
  
  @vdi_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_interface.dry.allocate(vdi_pool['id'], payload, params)
    return
  end
  json_response = @vdi_interface.allocate(vdi_pool['id'], payload, params)
  vdi_pool = json_response[vdi_desktop_object_key]
  render_response(json_response, options) do
    print_green_success "Allocated virtual desktop '#{vdi_pool['name']}'"
    #_get([vdi_pool['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
  end
  return 0, nil
end

#connect(opts) ⇒ Object 



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

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @vdi_interface = @api_client.vdi
end

#get(args) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/morpheus/cli/commands/vdi_command.rb', line 66

def get(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_standard_get_options(opts, options)
    opts.footer = <<-EOT
Get details about a specific virtual desktop.
[name] is required. This is the name or id of a virtual desktop (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 



19
20
21
 
# File 'lib/morpheus/cli/commands/vdi_command.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
 
# File 'lib/morpheus/cli/commands/vdi_command.rb', line 23

def list(args)
  options = {}
  params = {}
  ref_ids = []
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[search]")
    build_standard_list_options(opts, options)
    opts.footer = "List available virtual desktops (VDI pool)."
  end
  optparse.parse!(args)
  connect(options)
  # verify_args!(args:args, optparse:optparse, count:0)
  if args.count > 0
    options[:phrase] = args.join(" ")
  end
  params.merge!(parse_list_options(options))
  @vdi_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_interface.dry.list(params)
    return
  end
  json_response = @vdi_interface.list(params)
  vdi_pools = json_response[vdi_desktop_list_key]
  render_response(json_response, options, vdi_desktop_list_key) do
    print_h1 "Morpheus Virtual Desktops", parse_list_subtitles(options), options
    if vdi_pools.empty?
      print cyan,"No virtual desktops found.",reset,"\n"
    else
      list_columns = {
        # "ID" => lambda {|it| it['id'] },
        "Name" => lambda {|it| it['name'] },
        "Status" => lambda {|it| format_virtual_desktop_status(it) },
      }
      #list_columns["Config"] = lambda {|it| truncate_string(it['config'], 100) }
      print as_pretty_table(vdi_pools, list_columns.upcase_keys!, options)
      print_results_pagination(json_response)

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

#open(args) ⇒ Object 



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

def open(args)
  options = {}
  params = {}
  payload = {}
  pool_id = nil
  
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[desktop] [options]")
    opts.on('--desktop DESKTOP', String, "Virtual Desktop Name or ID") do |val|
      pool_id = val.to_s
    end
    build_standard_update_options(opts, options)
    opts.footer = <<-EOT
Open a virtual desktop console in your web browser.
[desktop] is required, this is name or id of a virtual desktop (VDI Pool).
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:0)
  connect(options)
  if args.count > 0
    pool_id = args.join(" ")
  end

  # prompt for Virtual Desktop (VDI Pool) to allocate
  vdi_pool = nil
  if pool_id
    vdi_pool = find_vdi_pool_by_name_or_id(pool_id)
    return [1, "Virtual Desktop not found"] if vdi_pool.nil?
    pool_id = vdi_pool['id']
  elsif
    vdi_pool_option_type = {'fieldName' => 'desktop', 'fieldLabel' => 'Virtual Desktop', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
      # @options_interface.options_for_source("vdiPools", {})['data']
      @vdi_interface.list({max:10000})[vdi_desktop_list_key].collect {|it|
        {'name' => it['name'], 'value' => it['id']}
      } }, 'required' => true, 'description' => 'Virtual Desktop (VDI pool) name or id'}
    pool_id = Morpheus::Cli::OptionTypes.prompt([vdi_pool_option_type], options[:options], @api_client, options[:params])['desktop']
    vdi_pool = find_vdi_pool_by_name_or_id(pool_id.to_s)
    return [1, "Virtual Desktop not found"] if vdi_pool.nil?
    pool_id = vdi_pool['id']
  end

  # find allocation ID
  # if not found, prompt to allocate now before opening a link to the terminal URL
  allocation_id = nil
  if vdi_pool['allocation']
    allocation_id = vdi_pool['allocation']['id']
    # could check vdi_pool['allocation']['status']
  else
    puts cyan + "You are not currently allocated desktop '#{vdi_pool['name']}'" + reset
    # could check vdi_pool['status'] and error if not 'available'
    if !options[:no_prompt]
      if ::Morpheus::Cli::OptionTypes::confirm("Would you like to allocate this desktop for use now?", options.merge({default: true}))
        # allocate([vdi_pool['id']])
        json_response = @vdi_interface.allocate(vdi_pool['id'], {}, {})
        vdi_pool = json_response[vdi_desktop_object_key]
        allocation_id = vdi_pool['allocation']['id']
      end
    end
  end
  
  if allocation_id.nil?
    print_red_alert "You must first allocate virtual desktop '#{vdi_pool['name']}'"
    print_red_alert "Try `vdi allocate \"#{vdi_pool['name']}\"`"
    return 1, "No allocation"
  end

  link = "#{@appliance_url}/login/oauth-redirect?access_token=#{@access_token}\\&redirectUri=/vdi/terminal/#{allocation_id}"

  if options[:dry_run]
    puts Morpheus::Util.open_url_command(link)
    return 0
  end
  return Morpheus::Util.open_url(link)

end