morpheus-cli 5.2.4.1 → 5.3.1

data/lib/morpheus/cli/vdi_allocations_command.rb

@@ -0,0 +1,159 @@
+require 'morpheus/cli/cli_command'
+
+# CLI command VDI Allocation management
+# UI is Tools: VDI Allocations
+# API is /vdi-allocations and returns vdiAllocations
+class Morpheus::Cli::VdiAllocationsCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::VdiHelper
+  include Morpheus::Cli::OptionSourceHelper
+
+  set_command_name :'vdi-allocations'
+  set_command_description "View VDI allocations"
+
+  register_subcommands :list, :get
+  
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @vdi_pools_interface = @api_client.vdi_pools
+    @vdi_allocations_interface = @api_client.vdi_allocations
+    @option_types_interface = @api_client.option_types
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end
+
+  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.on('--id ID', String, "Filter by VDI Allocation ID" ) do |val|
+        params['id'] = parse_id_list(val)
+      end
+      opts.on('--status STATUS', String, "Filter by VDI Allocation Status" ) do |val|
+        params['status'] = parse_id_list(val)
+      end
+      opts.on('--pool POOL', String, "Filter by VDI Pool Name or ID" ) do |val|
+        options[:pool] = val
+      end
+      opts.on('-u', '--user USER', "Filter by User Username or ID" ) do |val|
+        options[:user] = val
+      end
+      opts.footer = "List VDI allocations."
+    end
+    optparse.parse!(args)
+    connect(options)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
+    params.merge!(parse_list_options(options))
+    # --id
+    if options[:pool]
+      pool_ids = parse_id_list(options[:pool]).collect { |it|
+        vdi_pool = find_vdi_pool_by_name_or_id(it)
+        vdi_pool ? vdi_pool['id'] : nil
+      }
+      return 1 if pool_ids.include?(nil)
+      params['poolId'] = pool_ids
+    end
+    # --pool
+    if options[:pool]
+      pool_ids = parse_id_list(options[:pool]).collect { |it|
+        vdi_pool = find_vdi_pool_by_name_or_id(it)
+        vdi_pool ? vdi_pool['id'] : nil
+      }
+      return 1 if pool_ids.include?(nil)
+      params['poolId'] = pool_ids
+    end
+    # --user
+    if options[:user]
+      user_ids = parse_user_id_list(options[:user])
+      return 1 if user_ids.nil?
+      params['userId'] = user_ids
+    end
+    @vdi_allocations_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @vdi_allocations_interface.dry.list(params)
+      return
+    end
+    json_response = @vdi_allocations_interface.list(params)
+    render_response(json_response, options, vdi_allocation_list_key) do
+      vdi_allocations = json_response[vdi_allocation_list_key]
+      print_h1 "Morpheus VDI Allocations", parse_list_subtitles(options), options
+      if vdi_allocations.empty?
+        print cyan,"No VDI allocations found.",reset,"\n"
+      else
+        list_columns = vdi_allocation_column_definitions.upcase_keys!
+        print as_pretty_table(vdi_allocations, list_columns, options)
+        print_results_pagination(json_response)
+      end
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+  
+  def get(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[allocation]")
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a specific VDI allocation.
+[allocation] is required. This is the id of a VDI allocation.
+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
+
+  def _get(id, params, options)
+    @vdi_allocations_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @vdi_allocations_interface.dry.get(id, params)
+      return
+    end
+    json_response = @vdi_allocations_interface.get(id, params)
+    vdi_allocation = json_response[vdi_allocation_object_key]
+    render_response(json_response, options, vdi_allocation_object_key) do
+      print_h1 "VDI Allocation Details", [], options
+      print cyan
+      show_columns = vdi_allocation_column_definitions
+      print_description_list(show_columns, vdi_allocation)
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+
+  private
+
+  def vdi_allocation_column_definitions()
+    {
+      "ID" => lambda {|it| it['id'] },
+      "Pool" => lambda {|it| it['pool'] ? it['pool']['name'] : nil },
+      "Instance" => lambda {|it| it['instance'] ? it['instance']['name'] : nil },
+      "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'] },
+      "Last Reserved" => lambda {|it| format_local_dt it['lastReserved'] },
+      "Release Date" => lambda {|it| format_local_dt it['releaseDate'] }
+    }
+  end
+
+  def vdi_allocation_list_column_definitions()
+    vdi_allocation_column_definitions()
+  end
+
+  # finders are in VdiHelper mixin
+
+end

data/lib/morpheus/cli/vdi_apps_command.rb

@@ -0,0 +1,317 @@
+require 'morpheus/cli/cli_command'
+
+# CLI command VDI App management
+# UI is Tools: VDI Apps
+# API is /vdi-apps and returns vdiApps
+class Morpheus::Cli::VdiAppsCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::VdiHelper
+  include Morpheus::Cli::OptionSourceHelper
+
+  set_command_name :'vdi-apps'
+  set_command_description "View and manage VDI apps"
+
+  register_subcommands :list, :get, :add, :update, :remove
+  
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @vdi_apps_interface = @api_client.vdi_apps
+    @vdi_apps_interface = @api_client.vdi_apps
+    @vdi_apps_interface = @api_client.vdi_apps
+    @option_types_interface = @api_client.option_types
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end
+
+  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 apps."
+    end
+    optparse.parse!(args)
+    connect(options)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
+    params.merge!(parse_list_options(options))
+    @vdi_apps_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @vdi_apps_interface.dry.list(params)
+      return
+    end
+    json_response = @vdi_apps_interface.list(params)
+    render_response(json_response, options, vdi_app_list_key) do
+      vdi_apps = json_response[vdi_app_list_key]
+      print_h1 "Morpheus VDI Apps", parse_list_subtitles(options), options
+      if vdi_apps.empty?
+        print cyan,"No VDI apps found.",reset,"\n"
+      else
+        print as_pretty_table(vdi_apps, vdi_app_list_column_definitions.upcase_keys!, options)
+        print_results_pagination(json_response)
+      end
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+  
+  def get(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[app]")
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a specific VDI app.
+[app] is required. This is the name or id of a VDI app.
+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
+
+  def _get(id, params, options)
+    vdi_app = nil
+    if id.to_s !~ /\A\d{1,}\Z/
+      vdi_app = find_vdi_app_by_name(id)
+      return 1, "VDI app not found for #{id}" if vdi_app.nil?
+      id = vdi_app['id']
+    end
+    @vdi_apps_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @vdi_apps_interface.dry.get(id, params)
+      return
+    end
+    json_response = @vdi_apps_interface.get(id, params)
+    vdi_app = json_response[vdi_app_object_key]
+    config = vdi_app['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_app_object_key) do
+      print_h1 "VDI App Details", [], options
+      print cyan
+      show_columns = vdi_app_column_definitions
+      show_columns.delete("VDI Apps") unless vdi_app['apps']
+      show_columns.delete("VDI App") unless vdi_app['app']
+      show_columns.delete("Guest Console Jump Host") unless vdi_app['guestConsoleJumpHost']
+      show_columns.delete("Guest Console Jump Port") unless vdi_app['guestConsoleJumpPort']
+      show_columns.delete("Guest Console Jump Username") unless vdi_app['guestConsoleJumpUsername']
+      show_columns.delete("Guest Console Jump Password") unless vdi_app['guestConsoleJumpPassword']
+      show_columns.delete("Guest Console Jump Keypair") unless vdi_app['guestConsoleJumpKeypair']
+      print_description_list(show_columns, vdi_app)
+
+
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+
+  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_app_option_types)
+      build_standard_add_options(opts, options)
+      opts.footer = <<-EOT
+Create a new VDI app.
+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_app_object_key => parse_passed_options(options)})
+    else
+      payload.deep_merge!({vdi_app_object_key => parse_passed_options(options)})
+      v_prompt = Morpheus::Cli::OptionTypes.prompt(add_vdi_app_option_types, options[:options], @api_client, options[:params])
+      params.deep_merge!(v_prompt)
+      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
+      payload[vdi_app_object_key].deep_merge!(params)
+    end
+    @vdi_apps_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @vdi_apps_interface.dry.create(payload)
+      return 0, nil
+    end
+    json_response = @vdi_apps_interface.create(payload)
+    vdi_app = json_response[vdi_app_object_key]
+    render_response(json_response, options, vdi_app_object_key) do
+      print_green_success "Added VDI app #{vdi_app['name']}"
+      return _get(vdi_app["id"], {}, options)
+    end
+    return 0, nil
+  end
+
+  def update(args)
+    options = {}
+    params = {}
+    payload = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[app] [options]")
+      build_option_type_options(opts, options, update_vdi_app_option_types)
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Update a VDI app.
+[app] is required. This is the name or id of a VDI app.
+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_app = find_vdi_app_by_name_or_id(args[0])
+    return 1 if vdi_app.nil?
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!({vdi_app_object_key => parse_passed_options(options)})
+    else
+      payload.deep_merge!({vdi_app_object_key => parse_passed_options(options)})
+      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_vdi_app_option_types, options[:options], @api_client, options[:params])
+      v_prompt.deep_compact!
+      params.deep_merge!(v_prompt)
+      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
+      payload.deep_merge!({vdi_app_object_key => params})
+      if payload[vdi_app_object_key].empty? # || options[:no_prompt]
+        raise_command_error "Specify at least one option to update.\n#{optparse}"
+      end
+    end
+    @vdi_apps_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @vdi_apps_interface.dry.update(vdi_app['id'], payload)
+      return
+    end
+    json_response = @vdi_apps_interface.update(vdi_app['id'], payload)
+    vdi_app = json_response[vdi_app_object_key]
+    render_response(json_response, options, vdi_app_object_key) do
+      print_green_success "Updated VDI app #{vdi_app['name']}"
+      return _get(vdi_app["id"], {}, options)
+    end
+    return 0, nil
+  end
+
+  def remove(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[app] [options]")
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete a VDI app.
+[app] is required. This is the name or id of a VDI app.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    vdi_app = find_vdi_app_by_name_or_id(args[0])
+    return 1 if vdi_app.nil?
+    @vdi_apps_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @vdi_apps_interface.dry.destroy(vdi_app['id'], params)
+      return
+    end
+    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the VDI app #{vdi_app['name']}?")
+      return 9, "aborted command"
+    end
+    json_response = @vdi_apps_interface.destroy(vdi_app['id'], params)
+    render_response(json_response, options) do
+      print_green_success "Removed VDI app #{vdi_app['name']}"
+    end
+    return 0, nil
+  end
+
+  private
+  
+  def vdi_app_list_column_definitions()
+
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      # "Description" => 'description',
+      "Launch Prefix" => 'launchPrefix',
+      # "Logo" => 'logo',
+      # "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+      # "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
+    }
+  end
+
+  def vdi_app_column_definitions()
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Description" => 'description',
+      "Launch Prefix" => 'launchPrefix',
+      "Logo" => 'logo',
+      "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+      "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
+    }
+  end
+
+  def add_vdi_app_option_types
+    [
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true, 'description' => 'Choose a unique name for the VDI App'},
+      {'fieldName' => 'description', 'fieldLabel' => 'Description', 'type' => 'text', 'description' => 'Description'},
+      {'fieldName' => 'launchPrefix', 'fieldLabel' => 'Launch Prefix', 'type' => 'text', 'required' => true, 'description' => 'The RDS App Name Prefix. Note: Must start with || (i.e. ||notepad) to launch notepad'},
+      #{'code' => 'vdiApp.iconPath', 'fieldName' => 'iconPath', 'fieldLabel' => 'Logo', 'type' => 'select', 'optionSource' => 'iconList', 'defaultValue' => 'resource'},
+      # iconList does not include custom, so add it ourselves..
+      # only prompt for logo file if custom
+      {'code' => 'vdiApp.iconPath', 'fieldName' => 'iconPath', 'fieldLabel' => 'Logo', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
+        dropdown = api_client.options.options_for_source("iconList")['data']
+        if !dropdown.find {|it| it['value'] == 'custom'}
+          dropdown.push({'name' => 'Custom', 'value' => 'custom'})
+        end
+        dropdown
+      }, 'description' => 'Logo icon path or custom if uploading a custom logo', 'defaultValue' => 'resource'},
+      {'dependsOnCode' => 'vdiApp.iconPath:custom', 'fieldName' => 'logo', 'fieldLabel' => 'Logo File', 'type' => 'file', 'required' => true, 'description' => 'Local filepath of image file to upload as custom icon'},
+    ]
+  end
+
+  def update_vdi_app_option_types
+    list = add_vdi_app_option_types.collect {|it|
+      it.delete('required')
+      it.delete('defaultValue')
+      it
+    }
+    list = list.reject {|it| ["type"].include? it['fieldName'] }
+    list
+  end
+
+  # finders are in VdiHelper mixin
+
+end