Class: Morpheus::Cli::VdiGatewaysCommand

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

Overview

CLI command VDI Gateway management UI is Tools: VDI Gateways API is /vdi-gateways and returns vdiGateways

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



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
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/morpheus/cli/commands/vdi_gateways_command.rb', line 84

def _get(id, params, options)
  vdi_gateway = nil
  if id.to_s !~ /\A\d{1,}\Z/
    vdi_gateway = find_vdi_gateway_by_name(id)
    return 1, "VDI gateway not found for #{id}" if vdi_gateway.nil?
    id = vdi_gateway['id']
  end
  @vdi_gateways_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_gateways_interface.dry.get(id, params)
    return
  end
  json_response = @vdi_gateways_interface.get(id, params)
  vdi_gateway = json_response[vdi_gateway_object_key]
  config = vdi_gateway['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_gateway_object_key) do
    print_h1 "VDI Gateway Details", [], options
    print cyan
    show_columns = vdi_gateway_column_definitions
    show_columns.delete("VDI Apps") unless vdi_gateway['apps']
    show_columns.delete("VDI Gateway") unless vdi_gateway['gateway']
    show_columns.delete("Guest Console Jump Host") unless vdi_gateway['guestConsoleJumpHost']
    show_columns.delete("Guest Console Jump Port") unless vdi_gateway['guestConsoleJumpPort']
    show_columns.delete("Guest Console Jump Username") unless vdi_gateway['guestConsoleJumpUsername']
    show_columns.delete("Guest Console Jump Password") unless vdi_gateway['guestConsoleJumpPassword']
    show_columns.delete("Guest Console Jump Keypair") unless vdi_gateway['guestConsoleJumpKeypair']
    print_description_list(show_columns, vdi_gateway)


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

#add(args) ⇒ Object 



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

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_gateway_option_types)
    build_standard_add_options(opts, options)
    opts.footer = <<-EOT
Create a new VDI gateway.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:0, max:1)
  options[:options]['name'] = args[0] if args[0]
  connect(options)
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({vdi_gateway_object_key => parse_passed_options(options)})
  else
    payload.deep_merge!({vdi_gateway_object_key => parse_passed_options(options)})
    v_prompt = Morpheus::Cli::OptionTypes.prompt(add_vdi_gateway_option_types, options[:options], @api_client, options[:params])
    params.deep_merge!(v_prompt)
    params.booleanize!
    payload[vdi_gateway_object_key].deep_merge!(params)
  end
  @vdi_gateways_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_gateways_interface.dry.create(payload)
    return 0, nil
  end
  json_response = @vdi_gateways_interface.create(payload)
  vdi_gateway = json_response[vdi_gateway_object_key]
  render_response(json_response, options, vdi_gateway_object_key) do
    print_green_success "Added VDI gateway #{vdi_gateway['name']}"
    return _get(vdi_gateway["id"], {}, options)
  end
  return 0, nil
end

#connect(opts) ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/morpheus/cli/commands/vdi_gateways_command.rb', line 16

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @vdi_gateways_interface = @api_client.vdi_gateways
  @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 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/morpheus/cli/commands/vdi_gateways_command.rb', line 63

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



24
25
26
 
# File 'lib/morpheus/cli/commands/vdi_gateways_command.rb', line 24

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



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

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 VDI gateways."
  end
  optparse.parse!(args)
  connect(options)
  if args.count > 0
    options[:phrase] = args.join(" ")
  end
  params.merge!(parse_list_options(options))
  @vdi_gateways_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_gateways_interface.dry.list(params)
    return
  end
  json_response = @vdi_gateways_interface.list(params)
  render_response(json_response, options, vdi_gateway_list_key) do
    vdi_gateways = json_response[vdi_gateway_list_key]
    print_h1 "Morpheus VDI Gateways", parse_list_subtitles(options), options
    if vdi_gateways.empty?
      print cyan,"No VDI gateways found.",reset,"\n"
    else
      print as_pretty_table(vdi_gateways, vdi_gateway_list_column_definitions.upcase_keys!, options)
      print_results_pagination(json_response)
    end
    print reset,"\n"
  end
  return 0, nil
end

#remove(args) ⇒ Object 



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

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

#update(args) ⇒ Object 



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

def update(args)
  options = {}
  params = {}
  payload = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[gateway] [options]")
    build_option_type_options(opts, options, update_vdi_gateway_option_types)
    build_standard_update_options(opts, options)
    opts.footer = <<-EOT
Update a VDI gateway.
[gateway] is required. This is the name or id of a VDI gateway.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)
  vdi_gateway = find_vdi_gateway_by_name_or_id(args[0])
  return 1 if vdi_gateway.nil?
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({vdi_gateway_object_key => parse_passed_options(options)})
  else
    payload.deep_merge!({vdi_gateway_object_key => parse_passed_options(options)})
    v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_vdi_gateway_option_types, options[:options], @api_client, options[:params])
    v_prompt.deep_compact!
    params.deep_merge!(v_prompt)
    params.booleanize!
    payload.deep_merge!({vdi_gateway_object_key => params})
    if payload[vdi_gateway_object_key].empty? # || options[:no_prompt]
      raise_command_error "Specify at least one option to update.\n#{optparse}"
    end
  end
  @vdi_gateways_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @vdi_gateways_interface.dry.update(vdi_gateway['id'], payload)
    return
  end
  json_response = @vdi_gateways_interface.update(vdi_gateway['id'], payload)
  vdi_gateway = json_response[vdi_gateway_object_key]
  render_response(json_response, options, vdi_gateway_object_key) do
    print_green_success "Updated VDI gateway #{vdi_gateway['name']}"
    return _get(vdi_gateway["id"], {}, options)
  end
  return 0, nil
end