morpheus-cli 6.1.2 → 6.2.0

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

@@ -1,3 +1,4 @@
+
 require 'morpheus/cli/cli_command'
 
 class Morpheus::Cli::BackupsCommand
@@ -5,17 +6,20 @@ class Morpheus::Cli::BackupsCommand
   include Morpheus::Cli::BackupsHelper
   include Morpheus::Cli::ProvisioningHelper
   include Morpheus::Cli::OptionSourceHelper
-
-  set_command_hidden # hide until ready
   
+  set_command_description "View and manage backups"
   set_command_name :'backups'
+  register_subcommands :list, :get, :add, :update, :remove, :execute #, :restore
+  register_subcommands :list_jobs, :get_job, :add_job, :update_job, :remove_job, :execute_job
+  register_subcommands :list_results, :get_result, :remove_result
+  register_subcommands :list_restores, :get_restore, :remove_restore
 
-  register_subcommands :list, :get, :add, :update, :remove, :run, :restore
-  
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
     @backups_interface = @api_client.backups
     @backup_jobs_interface = @api_client.backup_jobs
+    @backup_results_interface = @api_client.backup_results
+    @backup_restores_interface = @api_client.backup_restores
     @instances_interface = @api_client.instances
     @servers_interface = @api_client.servers
   end
@@ -40,14 +44,9 @@ class Morpheus::Cli::BackupsCommand
       options[:phrase] = args.join(" ")
     end
     params.merge!(parse_list_options(options))
-    @backups_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @backups_interface.dry.list(params)
-      return
-    end
-    json_response = @backups_interface.list(params)
-    backups = json_response['backups']
-    render_response(json_response, options, 'backups') do
+    parse_options(options, params)
+    execute_api(@backups_interface, :list, [], options, 'backup') do |json_response|
+      backups = json_response['backups']
       print_h1 "Morpheus Backups", parse_list_subtitles(options), options
       if backups.empty?
         print cyan,"No backups found.",reset,"\n"
@@ -74,6 +73,7 @@ EOT
     optparse.parse!(args)
     verify_args!(args:args, optparse:optparse, min:1)
     connect(options)
+    parse_options(options, params)
     id_list = parse_id_list(args)
     return run_command_for_each_arg(id_list) do |arg|
       _get(arg, params, options)
@@ -88,14 +88,10 @@ EOT
       end
       id = record['id']
     end
-    @backups_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @backups_interface.dry.get(id, params)
-      return
-    end
-    json_response = @backups_interface.get(id, params)
-    backup = json_response['backup']
-    render_response(json_response, options, 'backup') do
+    options[:params] = params # parse_options(options, params)
+    options.delete(:payload)
+    execute_api(@backups_interface, :get, [id], options, 'backup') do |json_response|
+      backup = json_response['backup']
       print_h1 "Backup Details", [], options
       print cyan
       columns = backup_column_definitions
@@ -105,7 +101,6 @@ EOT
       print_description_list(columns, backup, options)
       print reset,"\n"
     end
-    return 0, nil
   end
 
   def add(args)
@@ -113,7 +108,6 @@ EOT
     params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[name] [options]")
-      # build_option_type_options(opts, options, add_backup_option_types)
       opts.on('--source VALUE', String, "Backup Source: instance, host or provider") do |val|
         options[:options]['source'] = val
       end
@@ -133,7 +127,8 @@ EOT
       opts.on('--name VALUE', String, "Name") do |val|
         options[:options]['name'] = val
       end
-      build_standard_add_options(opts, options)
+      # build_option_type_options(opts, options, add_backup_option_types)
+      build_standard_add_many_options(opts, options)
       opts.footer = <<-EOT
 Create a new backup.
 EOT
@@ -142,13 +137,10 @@ EOT
     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!({'backup' => parse_passed_options(options)})
-    else
-      payload.deep_merge!({'backup' => parse_passed_options(options)})
-
+    parse_payload(options, 'backup') do |payload|
+      # v_prompt = Morpheus::Cli::OptionTypes.no_prompt(add_backup_option_types, options[:options], @api_client)
+      # v_prompt.deep_compact!.booleanize! # remove empty values and convert checkbox "on" and "off" to true and false
+      # params.deep_merge!(v_prompt)
       location_type = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'source', 'fieldLabel' => 'Source', 'type' => 'select', 'selectOptions' => [{'name' => 'Instance', 'value' => 'instance'}, {'name' => 'Host', 'value' => 'server'}, {'name' => 'Provider', 'value' => 'provider'}], 'defaultValue' => 'instance', 'required' => true, 'description' => 'Where is the backup located?'}], options[:options], @api_client)['source']
       params['locationType'] = location_type
       if location_type == 'instance'
@@ -183,7 +175,6 @@ EOT
           end
         elsif location_type == 'server'
           
-          
         end
         # Backup Type
         avail_backup_types = (create_results['backupTypes'] || []).collect {|it| {'name' => it['name'], 'value' => it['code']} }
@@ -197,9 +188,15 @@ EOT
         params['jobAction'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'jobAction', 'fieldLabel' => 'Backup Job Type', 'type' => 'select', 'optionSource' => 'backupJobActions', 'required' => true, 'defaultValue' => 'new'}], options[:options], @api_client)['jobAction']
         if params['jobAction'] == 'new'
           params['jobName'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'jobName', 'fieldLabel' => 'Job Name', 'type' => 'text', 'required' => false, 'defaultValue' => nil}], options[:options], @api_client)['jobName']
-          default_retention_count = create_results['backup'] ? create_results['backup']['retentionCount'] : nil
+          default_retention_count = (create_results['backup'] && create_results['backup']['retentionCount']) ? create_results['backup']['retentionCount'] : ((create_results['backupSettings'] && create_results['backupSettings']['retentionCount']) ? create_results['backupSettings']['retentionCount'] : nil)
           params['retentionCount'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'retentionCount', 'fieldLabel' => 'Retention Count', 'type' => 'number', 'required' => false, 'defaultValue' => default_retention_count}], options[:options], @api_client)['retentionCount']
-          params['jobSchedule'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'jobSchedule', 'fieldLabel' => 'Backup Schedule', 'type' => 'select', 'optionSource' => 'executeSchedules', 'required' => true}], options[:options], @api_client)['jobSchedule']
+          params['jobSchedule'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'jobSchedule', 'fieldLabel' => 'Backup Schedule', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
+            schedules = api_client.options.options_for_source('executeSchedules',{})['data']
+            [{"name" => "Manual", "value" => "manual"}] + schedules
+          }, 'required' => false}], options[:options], @api_client)['jobSchedule']
+          if params['jobSchedule'] == 'manual' || params['jobSchedule'] == ''
+            params.delete('jobSchedule')
+          end
         elsif params['jobAction'] == 'clone'
           params['jobId'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'jobId', 'fieldLabel' => 'Backup Job', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
             @backup_jobs_interface.list({max:10000})['jobs'].collect {|backup_job|
@@ -215,21 +212,13 @@ EOT
           }, 'required' => true}], options[:options], @api_client)['jobId']
         end
       end
-
       payload['backup'].deep_merge!(params)
     end
-    @backups_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @backups_interface.dry.create(payload)
-      return 0, nil
-    end
-    json_response = @backups_interface.create(payload)
-    backup = json_response['backup']
-    render_response(json_response, options, 'backup') do
+    execute_api(@backups_interface, :create, [], options, 'backup') do |json_response|
+      backup = json_response['backup']
       print_green_success "Added backup #{backup['name']}"
-      return _get(backup["id"], {}, options)
+      _get(backup["id"], {}, options)
     end
-    return 0, nil
   end
 
   def update(args)
@@ -238,8 +227,16 @@ EOT
     payload = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[backup] [options]")
+      # opts.on('--name NAME', String, "Name") do |val|
+      #   options[:options]['name'] = val
+      # end
+      # opts.on('--job JOB', String, "Name or ID of the Backup Job to associate this backup with") do |val|
+      #   options[:options]['jobId'] = val
+      # end
+      # opts.on('--enabled [on|off]', String, "Can be used to disable") do |val|
+      #   options[:options]['enabled'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s.empty?
+      # end
       build_option_type_options(opts, options, update_backup_option_types)
-      build_option_type_options(opts, options, update_backup_advanced_option_types)
       build_standard_update_options(opts, options)
       opts.footer = <<-EOT
 Update a backup.
@@ -251,36 +248,21 @@ EOT
     connect(options)
     backup = find_backup_by_name_or_id(args[0])
     return 1 if backup.nil?
-    payload = {}
-    if options[:payload]
-      payload = options[:payload]
-      payload.deep_merge!({'backup' => parse_passed_options(options)})
-    else
-      payload.deep_merge!({'backup' => parse_passed_options(options)})
+    parse_payload(options, 'backup') do |payload|
       # do not prompt on update
-      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_backup_option_types, options[:options], @api_client, options[:params])
-      v_prompt.deep_compact!
+      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_backup_option_types, options[:options], @api_client)
+      v_prompt.deep_compact!.booleanize! # remove empty values and convert checkbox "on" and "off" to true and false
       params.deep_merge!(v_prompt)
-      advanced_config = Morpheus::Cli::OptionTypes.no_prompt(update_backup_advanced_option_types, options[:options], @api_client, options[:params])
-      advanced_config.deep_compact!
-      params.deep_merge!(advanced_config)
       payload.deep_merge!({'backup' => params})
       if payload['backup'].empty? # || options[:no_prompt]
         raise_command_error "Specify at least one option to update.\n#{optparse}"
       end
     end
-    @backups_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @backups_interface.dry.update(backup['id'], payload)
-      return
-    end
-    json_response = @backups_interface.update(backup['id'], payload)
-    backup = json_response['backup']
-    render_response(json_response, options, 'backup') do
+    execute_api(@backups_interface, :update, [backup['id']], options, 'backup') do |json_response|
+      backup = json_response['backup']
       print_green_success "Updated backup #{backup['name']}"
       return _get(backup["id"], {}, options)
     end
-    return 0, nil
   end
 
   def remove(args)
@@ -299,23 +281,169 @@ EOT
     connect(options)
     backup = find_backup_by_name_or_id(args[0])
     return 1 if backup.nil?
-    @backups_interface.setopts(options)
-    if options[:dry_run]
-      print_dry_run @backups_interface.dry.destroy(backup['id'], params)
-      return
+    parse_options(options, params)
+    confirm!("Are you sure you want to delete the backup #{backup['name']}?", options)
+    execute_api(@backups_interface, :destroy, [backup['id']], options, 'backup') do |json_response|
+      print_green_success "Removed backup #{backup['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 = subcommand_usage("[backup] [options]")
+      build_standard_post_options(opts, options)
+      opts.footer = <<-EOT
+Execute a backup to create a new backup result.
+[backup] is required. This is the name or id of a backup.
+EOT
     end
-    json_response = @backups_interface.destroy(backup['id'], params)
-    render_response(json_response, options) do
-      print_green_success "Removed backup #{backup['name']}"
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    backup = find_backup_by_name_or_id(args[0])
+    return 1 if backup.nil?
+    parse_payload(options)
+    execute_api(@backups_interface, :execute_backup, [backup['id']], options, 'backup') do |json_response|
+      print_green_success "Executing backup #{backup['name']}"
+      # should get the result maybe, or could even support refreshing until it is complete...
+      # return _get(backup["id"], {}, options)
+    end
+  end
+
+  def restore(args)
+    raise "Not Yet Implemented"
+    options = {}
+    params = {}
+    payload = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[backup] [result] [options]")
+      build_standard_post_options(opts, options)
+      opts.on('--result ID', String, "Backup Result ID that is being restored") do |val|
+        options[:options]['backupResultId'] = val
+      end
+      opts.on('--restore-instance existing|new', String, "Instance being targeted for the restore, existing to restore the current instance or new to create a new instance. The current instance is targeted by default.") do |val|
+        # restoreInstanceSelect=current|new and the flag on the restore object is called 'restoreToNew'
+        options[:options]['restoreInstanceSelect'] = val
+      end
+      opts.footer = <<-EOT
+Restore a backup, replacing the existing target with the specified backup result.
+[backup] is required. This is the name or id of a backup.
+--result ID is required. This is the id of a backup result being restored.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, max:1)
+    connect(options)
+    backup = nil
+    backup_result = nil
+    if args[0]
+      backup = find_backup_by_name_or_id(args[0])
+      return 1 if backup.nil?
+    else
+      # Prompt for backup
+      if backup.nil?
+        # Backup
+        available_backups = @backups_interface.list({max:10000})['backups'].collect {|it| {'name' => it['name'], 'value' => it['id']}}
+        backup_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'backupId', 'fieldLabel' => 'Backup', 'type' => 'select', 'selectOptions' => available_backups, 'required' => true}], options[:options], @api_client)['backupId']
+        backup = find_backup_by_name_or_id(backup_id)
+      return 1 if backup.nil?
+      end
+    end
+    # Prompt for backup result
+    if backup_result.nil?
+
+      # Instance
+        available_backup_results = @backups_interface.list({backupId: backup['id'], max:10000})['results'].collect {|it| {'name' => it['name'], 'value' => it['id']}}
+        params['backupResultId'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'backupResultId', 'fieldLabel' => 'Backup Result', 'type' => 'select', 'selectOptions' => available_backup_results, 'required' => true}], options[:options], @api_client)['backupResultId']
+        # Name
+        params['name'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true, 'description' => 'Backup Name'}], options[:options], @api_client)['name']
+    end
+    
+    parse_payload(options, 'restore') do |payload|
+      # Prompt for restore configuration
+      # We should probably require identifying the instance by name or id too, just to be safe.
+      # Target Instance
+      if backup_result['instance']
+        params['restoreInstanceSelect'] = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true, 'description' => 'Instance being targeted for the restore, existing to restore the current instance or new to create a new instance. By default the existing instance is restored.'}], options[:options], @api_client)['restoreInstanceSelect']
+      end
+      payload['backup'].deep_merge!(params)
+    end
+
+    print cyan,"#{bold}WARNING!#{reset}#{cyan} Restoring a backup will erase all data when restored to an existing instance.",reset,"\n"
+    confirm!("Are you sure you want to restore the backup result ID: #{backup_result['id']} Name: #{backup_result['backup']['name'] rescue ''} Date: (#{format_local_dt(backup_result['dateCreated'])})?", options)
+    execute_api(@backups_interface, :restore, [backup['id']], options, 'backup') do |json_response|
+      print_green_success "Restoring backup result ID: #{backup_result['id']} Name: #{backup_result['backup']['name'] rescue ''} Date: (#{format_local_dt(backup_result['dateCreated'])}"
+      # should get the restore maybe, or could even support refreshing until it is complete...
+      # restore = json_response["restore"]
+      # return _get_restore(restore["id"], {}, options)
     end
-    return 0, nil
+  end
+
+  # Delegate jobs, results and restores 
+  # to backup-jobs, backup-results and backup-restores
+  # which are hidden in the docs
+
+  ## Backup Jobs
+
+  def list_jobs(args)
+    Morpheus::Cli::BackupJobsCommand.new.list(args)
+  end
+  
+  def get_job(args)
+    Morpheus::Cli::BackupJobsCommand.new.get(args)
+  end
+
+  def add_job(args)
+    Morpheus::Cli::BackupJobsCommand.new.add(args)
+  end
+
+  def update_job(args)
+    Morpheus::Cli::BackupJobsCommand.new.update(args)
+  end
+
+  def remove_job(args)
+    Morpheus::Cli::BackupJobsCommand.new.remove(args)
+  end
+
+  def execute_job(args)
+    Morpheus::Cli::BackupJobsCommand.new.execute(args)
+  end
+
+  ## Backup Results
+
+  def list_results(args)
+    Morpheus::Cli::BackupResultsCommand.new.list(args)
+  end
+  
+  def get_result(args)
+    Morpheus::Cli::BackupResultsCommand.new.get(args)
+  end
+
+  def remove_result(args)
+    Morpheus::Cli::BackupResultsCommand.new.remove(args)
+  end
+
+  ## Backup Restores
+
+  def list_restores(args)
+    Morpheus::Cli::BackupRestoresCommand.new.list(args)
+  end
+  
+  def get_restore(args)
+    Morpheus::Cli::BackupRestoresCommand.new.get(args)
+  end
+
+  def remove_restore(args)
+    Morpheus::Cli::BackupRestoresCommand.new.remove(args)
   end
 
   private
 
+  ## Backups
+
   def backup_list_column_definitions()
     {
       "ID" => 'id',
@@ -345,12 +473,13 @@ EOT
       "Host" => lambda {|it| it['server']['name'] rescue '' },
       "Schedule" => lambda {|it| it['schedule']['name'] rescue '' },
       "Backup Job" => lambda {|it| it['job']['name'] rescue '' },
+      "Enabled" => lambda {|it| format_boolean(it['enabled']) },
       "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
       "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
     }
   end
 
-  # this is not so simple, need to first choose select instance, host or provider
+  # not used atm, this is not so simple, need to first choose select instance, host or provider
   def add_backup_option_types
     [
       {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true},
@@ -364,24 +493,16 @@ EOT
     ]
   end
 
-  def add_backup_advanced_option_types
-    []
-  end
-
   def update_backup_option_types
-    add_backup_option_types.collect {|it|
-      it.delete('required')
-      it.delete('defaultValue')
-      it
-    }
-  end
-
-  def update_backup_advanced_option_types
-    add_backup_advanced_option_types.collect {|it|
-      it.delete('required')
-      it.delete('defaultValue')
-      it
-    }
+    [
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text'},
+      {'fieldName' => 'jobId', 'fieldLabel' => 'Backup Job', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
+        @backup_jobs_interface.list({max:10000})['jobs'].collect {|backup_job|
+          {'name' => backup_job['name'], 'value' => backup_job['id'], 'id' => backup_job['id']}
+        }
+      } },
+      {'fieldName' => 'enabled', 'fieldLabel' => 'Enabled', 'type' => 'checkbox'},
+    ]
   end
 
 end

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

@@ -1500,8 +1500,19 @@ class Morpheus::Cli::Hosts
     params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[name] [workflow] [options]")
+      opts.banner = subcommand_usage("[host] [workflow] [options]")
+      opts.on("--phase PHASE", String, "Task Phase to run for Provisioning workflows. The default is provision.") do |val|
+        options[:phase] = val
+      end
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
+      opts.footer = <<-EOT
+Run workflow for a host.
+[host] is required. This is the name or id of a host
+[workflow] is required. This is the name or id of a workflow
+By default the provision phase is executed.
+Use the --phase option to execute a different phase.
+The available phases are start, stop, preProvision, provision, postProvision, preDeploy, deploy, reconfigure, teardown, startup and shutdown.
+EOT
     end
     optparse.parse!(args)
     if args.count != 2
@@ -1555,7 +1566,9 @@ class Morpheus::Cli::Hosts
       payload['taskSet']["#{workflow['id']}"] ||= {}
       payload['taskSet']["#{workflow['id']}"].deep_merge!(params)
     end
-
+    if options[:phase]
+      payload['taskPhase'] = options[:phase]
+    end
     begin
       @servers_interface.setopts(options)
       if options[:dry_run]

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

@@ -258,7 +258,7 @@ class Morpheus::Cli::Instances
           end
           row = {
             id: instance['id'],
-            name: instance['name'],
+            name: instance['displayName'] ? instance['displayName'] : instance['name'],
             labels: format_list(instance['labels'], '', 3),
             connection: format_instance_connection_string(instance),
             environment: instance['instanceContext'],
@@ -3357,7 +3357,18 @@ EOT
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[instance] [workflow] [options]")
+      opts.on("--phase PHASE", String, "Task Phase to run for Provisioning workflows. The default is provision.") do |val|
+        options[:phase] = val
+      end
       build_common_options(opts, options, [:options, :json, :dry_run, :remote])
+      opts.footer = <<-EOT
+Run workflow for an instance.
+[instance] is required. This is the name or id of an instance
+[workflow] is required. This is the name or id of a workflow
+By default the provision phase is executed.
+Use the --phase option to execute a different phase.
+The available phases are start, stop, preProvision, provision, postProvision, preDeploy, deploy, reconfigure, teardown, startup and shutdown.
+EOT
     end
     optparse.parse!(args)
     if args.count != 2
@@ -3391,6 +3402,9 @@ EOT
     # end
 
     workflow_payload = {taskSet: {"#{workflow['id']}" => params }}
+    if options[:phase]
+      workflow_payload['taskPhase'] = options[:phase]
+    end
     begin
       @instances_interface.setopts(options)
       if options[:dry_run]
@@ -5298,6 +5312,7 @@ private
     rescue RestClient::Exception => e
       if e.response && e.response.code == 404
         print_red_alert "Workflow not found by id #{id}"
+        exit 1
       else
         raise e
       end
@@ -5308,12 +5323,12 @@ private
     workflows = @task_sets_interface.list({name: name.to_s})['taskSets']
     if workflows.empty?
       print_red_alert "Workflow not found by name #{name}"
-      return nil
+      exit 1
     elsif workflows.size > 1
       print_red_alert "#{workflows.size} workflows by name #{name}"
       print_workflows_table(workflows, {color: red})
       print reset,"\n\n"
-      return nil
+      exit 1
     else
       return workflows[0]
     end