morpheus-cli 6.1.2 → 6.2.0

data/lib/morpheus/cli/commands/backup_jobs_command.rb

@@ -10,7 +10,7 @@ class Morpheus::Cli::BackupJobsCommand
 
   set_command_name :'backup-jobs'
 
-  register_subcommands :list, :get, :add, :update, :remove, :run
+  register_subcommands :list, :get, :add, :update, :remove, :execute
 
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
@@ -27,7 +27,7 @@ class Morpheus::Cli::BackupJobsCommand
     params = {}
     ref_ids = []
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[search]")
+      opts.banner = "Usage: #{prog_name} backups list-jobs [search]"
       build_standard_list_options(opts, options)
       opts.footer = "List backup jobs."
     end
@@ -50,7 +50,7 @@ class Morpheus::Cli::BackupJobsCommand
       if backup_jobs.empty?
         print yellow,"No backup jobs found.",reset,"\n"
       else
-        print as_pretty_table(backup_jobs, backup_job_column_definitions.upcase_keys!, options)
+        print as_pretty_table(backup_jobs, backup_job_list_column_definitions.upcase_keys!, options)
         print_results_pagination(json_response)
       end
       print reset,"\n"
@@ -62,7 +62,8 @@ class Morpheus::Cli::BackupJobsCommand
     params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[job]")
+      # opts.banner = subcommand_usage("[job]")
+      opts.banner = "Usage: #{prog_name} backups get-job [job]"
       build_standard_get_options(opts, options)
       opts.footer = <<-EOT
 Get details about a specific backup job.
@@ -99,9 +100,21 @@ EOT
     json_response = @backup_jobs_interface.get(id, params)
     backup_job = json_response['job']
     render_response(json_response, options, 'job') do
+      backup_job = json_response['job']
+      backups = backup_job['backups'] || []
       print_h1 "Backup Job Details", [], options
       print cyan
-      print_description_list(backup_job_column_definitions, backup_job)
+      columns = backup_job_column_definitions
+      columns.delete("Provider") if backup_job['backupProvider'].nil?
+      columns.delete("Repository") if backup_job['backupRepository'].nil?
+      print_description_list(columns, backup_job)
+      # print reset,"\n"
+      print_h2 "Backups", options
+      if backups.empty?
+        print yellow,"This job has no backups associated with it.",reset,"\n"
+      else
+        print as_pretty_table(backups, [:id, :name], options)
+      end
       print reset,"\n"
     end
     return 0, nil
@@ -111,7 +124,7 @@ EOT
     options = {}
     params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[name] [options]")
+      opts.banner = "Usage: #{prog_name} backups add-job [name]"
       build_option_type_options(opts, options, add_backup_job_option_types)
       build_option_type_options(opts, options, add_backup_job_advanced_option_types)
       build_standard_add_options(opts, options)
@@ -131,6 +144,9 @@ EOT
       payload.deep_merge!({'job' => parse_passed_options(options)})
       v_prompt = Morpheus::Cli::OptionTypes.prompt(add_backup_job_option_types(), options[:options], @api_client, options[:params])
       params.deep_merge!(v_prompt)
+      if params['scheduleId'] == 'manual' || params['scheduleId'] == ''
+        params['scheduleId'] = nil
+      end
       advanced_config = Morpheus::Cli::OptionTypes.no_prompt(add_backup_job_advanced_option_types, options[:options], @api_client, options[:params])
       advanced_config.deep_compact!
       params.deep_merge!(advanced_config)
@@ -155,7 +171,7 @@ EOT
     params = {}
     payload = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[job] [options]")
+      opts.banner = "Usage: #{prog_name} backups update-job [job]"
       build_option_type_options(opts, options, update_backup_job_option_types)
       build_option_type_options(opts, options, update_backup_job_advanced_option_types)
       build_standard_update_options(opts, options)
@@ -177,6 +193,9 @@ EOT
       payload.deep_merge!({'job' => parse_passed_options(options)})
       v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_backup_job_option_types, options[:options], @api_client, options[:params])
       v_prompt.deep_compact!
+      if v_prompt['scheduleId'] == 'manual' || v_prompt['scheduleId'] == ''
+        v_prompt['scheduleId'] = nil
+      end
       params.deep_merge!(v_prompt)
       advanced_config = Morpheus::Cli::OptionTypes.no_prompt(update_backup_job_advanced_option_types, options[:options], @api_client, options[:params])
       advanced_config.deep_compact!
@@ -204,7 +223,7 @@ EOT
     options = {}
     params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[job] [options]")
+      opts.banner = "Usage: #{prog_name} backups remove-job [job]"
       build_standard_remove_options(opts, options)
       opts.footer = <<-EOT
 Delete a backup job.
@@ -216,28 +235,63 @@ EOT
     connect(options)
     backup_job = find_backup_job_by_name_or_id(args[0])
     return 1 if backup_job.nil?
-    @backup_jobs_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @backup_jobs_interface.dry.destroy(backup_job['id'], params)
-      return
+    parse_options(options, params)
+    confirm!("Are you sure you want to delete the backup job #{backup_job['name']}?", options)
+    execute_api(@backup_jobs_interface, :destroy, [backup_job['id']], options) do |json_response|
+      print_green_success "Removed backup job #{backup_job['name']}"
     end
-    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the backup #{backup['name']}?")
-      return 9, "aborted command"
+  end
+
+  def execute(args)
+    options = {}
+    params = {}
+    payload = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} backups execute-job [job]"
+      build_standard_post_options(opts, options)
+      opts.footer = <<-EOT
+Execute a backup job to create a new backup result for all the backups in the job.
+[job] is required. This is the name or id of a backup job.
+EOT
     end
-    json_response = @backup_jobs_interface.destroy(backup_job['id'], params)
-    render_response(json_response, options) do
-      print_green_success "Removed backup job #{backup_job['name']}"
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    backup_job = find_backup_job_by_name_or_id(args[0])
+    return 1 if backup_job.nil?
+    parse_payload(options)
+    execute_api(@backup_jobs_interface, :execute_job, [backup_job['id']], options, 'job') do |json_response|
+      print_green_success "Executing backup job #{backup_job['name']}"
+      # should get the result maybe, or could even support refreshing until it is complete...
+      # return _get(backup_job["id"], {}, options)
     end
-    return 0, nil
   end
 
   private
 
   def backup_job_column_definitions()
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Code" => 'code',
+      "Schedule" => lambda {|it| it['schedule']['name'] rescue '' },
+      "Next" => lambda {|it| format_local_dt(it['nextFire']) },
+      "Retention Count" => lambda {|it| it['retentionCount'] rescue '' },
+      "Provider" => lambda {|it| it['backupProvider']['name'] rescue '' },
+      "Repository" => lambda {|it| it['backupRepository']['name'] rescue '' },
+      "Source" => lambda {|it| it['source'] },
+      "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+      "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
+    }
+  end
+
+  def backup_job_list_column_definitions()
     {
       "ID" => 'id',
       "Name" => 'name',
       "Schedule" => lambda {|it| it['schedule']['name'] rescue '' },
+      "Next" => lambda {|it| format_local_dt(it['nextFire']) },
+      "Retention Count" => lambda {|it| it['retentionCount'] rescue '' },
       "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
       "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
     }
@@ -246,9 +300,12 @@ EOT
   def add_backup_job_option_types
     [
       {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true, 'displayOrder' => 1},
-      #{'fieldName' => 'code', 'fieldLabel' => 'Code', 'type' => 'text', 'required' => false, 'displayOrder' => 2},
+      {'fieldName' => 'code', 'fieldLabel' => 'Code', 'type' => 'text', 'required' => false, 'displayOrder' => 2},
       {'fieldName' => 'retentionCount', 'fieldLabel' => 'Retention Count', 'type' => 'number', 'displayOrder' => 3},
-      {'fieldName' => 'scheduleId', 'fieldLabel' => 'Schedule', 'type' => 'select', 'optionSource' => 'executeSchedules', 'displayOrder' => 4}, # should use jobSchedules instead maybe? do we support manual schedules for backups?
+      {'fieldName' => 'scheduleId', 'fieldLabel' => 'Schedule', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
+        schedules = api_client.options.options_for_source('executeSchedules',{})['data']
+        [{"name" => "Manual", "value" => "manual"}] + schedules
+      }, 'displayOrder' => 4},
     ]
   end
 

data/lib/morpheus/cli/commands/backup_restores_command.rb

@@ -0,0 +1,144 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::BackupRestoresCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::BackupsHelper
+  # include Morpheus::Cli::ProvisioningHelper
+  # include Morpheus::Cli::OptionSourceHelper
+
+  set_command_hidden # hide until ready
+
+  set_command_name :'backup-restores'
+
+  register_subcommands :list, :get, :remove
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @backups_interface = @api_client.backups
+    @backup_restores_interface = @api_client.backup_restores
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end  
+
+  def list(args)
+    options = {}
+    params = {}
+    ref_ids = []
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} backups list-restores [search]"
+      build_standard_list_options(opts, options)
+      opts.footer = "List backup restores."
+    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))
+    @backup_restores_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_restores_interface.dry.list(params)
+      return
+    end
+    json_response = @backup_restores_interface.list(params)
+    backup_restores = json_response['restores']
+    render_response(json_response, options, 'restores') do
+      print_h1 "Morpheus Backup Restores", parse_list_subtitles(options), options
+      if backup_restores.empty?
+        print yellow,"No backup restores found.",reset,"\n"
+      else
+        print as_pretty_table(backup_restores, backup_restore_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 = "Usage: #{prog_name} backups get-restore [restore]"
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a specific backup restore.
+[restore] is required. This is the id of a backup restore.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1)
+    connect(options)
+    id_list = parse_id_list(args)
+    id_list = id_list.collect do |id|
+      if id.to_s =~ /\A\d{1,}\Z/
+        id
+      else
+        backup_restore = find_backup_restore_by_name(id)
+        if backup_restore
+          backup_restore['id']
+        else
+          return 1, "backup restore not found for name '#{id}'"
+        end
+      end
+    end
+    return run_command_for_each_arg(id_list) do |arg|
+      _get(arg, params, options)
+    end
+  end
+
+  def _get(id, params, options)
+    @backup_restores_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_restores_interface.dry.get(id, params)
+      return
+    end
+    json_response = @backup_restores_interface.get(id, params)
+    backup_restore = json_response['restore']
+    render_response(json_response, options, 'restore') do
+      backup_restore = json_response['restore']
+      backups = backup_restore['backups'] || []
+      print_h1 "Backup Restore Details", [], options
+      print cyan
+      print_description_list(backup_restore_column_definitions, backup_restore)
+      if backup_restore['errorMessage']
+        print_h2 "Error Message", options
+        print red, backup_restore['errorMessage'], reset, "\n"
+      end
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+
+  def remove(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} backups remove-restore [restore]"
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete a backup restore.
+[restore] is required. This is the id of a backup restore.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    backup_restore = @backup_restores_interface.get(args[0])['restore']
+    #backup_restore = find_backup_restore_by_name_or_id(args[0])
+    #return 1 if backup_restore.nil?
+    parse_options(options, params)
+    confirm!("Are you sure you want to delete the backup restore #{backup_restore['id']}?", options)
+    execute_api(@backup_restores_interface, :destroy, [backup_restore['id']], options) do |json_response|
+      print_green_success "Removed backup restore #{backup_restore['name']}"
+    end
+  end
+
+  private
+
+  # helper methods are defined in BackupsHelper
+  
+end

data/lib/morpheus/cli/commands/backup_results_command.rb

@@ -0,0 +1,149 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::BackupResultsCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::BackupsHelper
+  # include Morpheus::Cli::ProvisioningHelper
+  # include Morpheus::Cli::OptionSourceHelper
+
+  set_command_hidden # hide and prefer backups list-results, get-result, etc. for now
+
+  set_command_name :'backup-results'
+
+  register_subcommands :list, :get, :remove
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @backups_interface = @api_client.backups
+    @backup_results_interface = @api_client.backup_results
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end  
+
+  def list(args)
+    options = {}
+    params = {}
+    ref_ids = []
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} backups list-results [search]"
+      opts.on('--backup BACKUP', String, "Backup Name or ID") do |val|
+        options[:backup] = val
+      end
+      opts.on('--instance INSTANCE', String, "Instance Name or ID") do |val|
+        options[:instance] = val
+      end
+      build_standard_list_options(opts, options)
+      opts.footer = "List backup results."
+    end
+    optparse.parse!(args)
+    connect(options)
+    # verify_args!(args:args, optparse:optparse, max:1)
+    parse_list_options!(args, options, params)
+    execute_api(@backup_results_interface, :list, [], options, 'results') do |json_response|
+      backup_results = json_response['results']
+      subtitles = []
+      subtitles << "Backup: #{options[:backup]}" if options[:backup]
+      subtitles += parse_list_subtitles(options)
+      print_h1 "Morpheus Backup Results", subtitles, options
+      if backup_results.empty?
+        print yellow,"No backup results found.",reset,"\n"
+      else
+        print as_pretty_table(backup_results, backup_result_list_column_definitions.upcase_keys!, options)
+        print_results_pagination(json_response)
+      end
+      print reset,"\n"
+    end
+  end
+  
+  def get(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} backups get-result [result]"
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a specific backup result.
+[result] is required. This is the id of a backup result.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1)
+    connect(options)
+    id_list = parse_id_list(args)
+    id_list = id_list.collect do |id|
+      if id.to_s =~ /\A\d{1,}\Z/
+        id
+      else
+        backup_result = find_backup_result_by_name(id)
+        if backup_result
+          backup_result['id']
+        else
+          return 1, "backup result not found for name '#{id}'"
+        end
+      end
+    end
+    return run_command_for_each_arg(id_list) do |arg|
+      _get(arg, params, options)
+    end
+  end
+
+  def _get(id, params, options)
+    @backup_results_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @backup_results_interface.dry.get(id, params)
+      return
+    end
+    json_response = @backup_results_interface.get(id, params)
+    backup_result = json_response['result']
+    render_response(json_response, options, 'result') do
+      backup_result = json_response['result']
+      backups = backup_result['backups'] || []
+      print_h1 "Backup Result Details", [], options
+      print cyan
+      print_description_list(backup_result_column_definitions, backup_result)
+      if backup_result['errorMessage']
+        print_h2 "Error Message", options
+        print red, backup_result['errorMessage'], reset, "\n"
+      end
+      print reset,"\n"
+    end
+    return 0, nil
+  end
+
+  def remove(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} backups remove-result [result]"
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete a backup result.
+[result] is required. This is the id of a backup result.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    backup_result = @backup_results_interface.get(args[0])['result']
+    # backup_result = find_backup_result_by_name_or_id(args[0])
+    # return 1 if backup_result.nil?
+    parse_options(options, params)
+    confirm!("Are you sure you want to delete the backup result #{backup_result['id']}?", options)
+    execute_api(@backup_results_interface, :destroy, [backup_result['id']], options) do |json_response|
+      print_green_success "Removed backup result #{backup_result['name']}"
+    end
+  end
+
+  private
+
+  # helper methods are defined in BackupsHelper
+
+  def parse_list_options!(args, options, params)
+    parse_parameter_as_resource_id!(:backup, options, params, 'backupId')
+    parse_parameter_as_resource_id!(:instance, options, params, 'instanceId')
+    super
+  end
+
+end