morpheus-cli 8.0.4.1 → 8.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c318612d24c2d587b52f2a91c23ef6079e31959319c8488f336a2bfe8acb2a1
-  data.tar.gz: a8b0ff7162a1504065e3e46479a54ef5bd77d6ad80bb5f7c4e5f1c056981c2c8
+  metadata.gz: 36e5150354f68d0d1bf97da71cfc98e20bd78e68ab59a919d464b8d453a06ed3
+  data.tar.gz: 7bf57c87149c0eb357886fccafe0c1b8ead22b289c23127d5b6a6b0947ae12e1
 SHA512:
-  metadata.gz: 067e3e48442d8f00f86dc8923898008b410c5882ab3049c3423a7ae46bc3031812f74f5f0f33aab793417d231e568438d5826b921ef4d1fb6764f41537cd2209
-  data.tar.gz: 1c5c68a81dd270f85f83d02602625883ad901bd304a78ba990dfa1ad05b5ecc85dfcb352b6a38fce0bd973db7f0063b9f54727aec8dfa5ce9d75adfb52533553
+  metadata.gz: f3d3be35646cafaf52af86eeef145350af72995ee762b5b958e2d49a10f263eb2803a4223b286f4358bf0d2904e2a1694a5282520ade5941184b7628bcc379d0
+  data.tar.gz: b744429719628a8048759e8844f3687f1800e5e3bb45b5369c87efc76d577a0fa626821b8ff468f3f4166d12f6bef40ee4381a6e208cd9ea6c5f7836896edf3c

data/Dockerfile

@@ -1,5 +1,5 @@
 FROM ruby:2.7.5
 
-RUN gem install morpheus-cli -v 8.0.4.1
+RUN gem install morpheus-cli -v 8.0.5
 
 ENTRYPOINT ["morpheus"]

data/lib/morpheus/api/api_client.rb

@@ -412,6 +412,10 @@ class Morpheus::APIClient
     Morpheus::ServersInterface.new(common_interface_options).setopts(@options)
   end
 
+  def server_devices
+    Morpheus::ServerDevicesInterface.new(common_interface_options).setopts(@options)
+  end
+
   def instances
     Morpheus::InstancesInterface.new(common_interface_options).setopts(@options)
   end

data/lib/morpheus/api/backup_results_interface.rb

@@ -25,4 +25,8 @@ class Morpheus::BackupResultsInterface < Morpheus::APIClient
     execute(method: :delete, url: "#{base_path}/#{CGI::escape(id.to_s)}", params: params, headers: headers)
   end
 
+  def create_options(id, payload={}, params={}, headers={})
+    validate_id!(id)
+    execute(method: :post, url: "#{base_path}/#{CGI::escape(id.to_s)}/create-restore", params: params, payload: payload, headers: headers)
+  end
 end

data/lib/morpheus/api/server_devices_interface.rb

@@ -0,0 +1,30 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::ServerDevicesInterface < Morpheus::APIClient
+
+  def base_path(server_id)
+    "#{@base_url}/api/servers/#{server_id}"
+  end
+
+  # def get(server_id, id, params={})
+  #   raise "#{self.class}.get() passed a blank id!" if id.to_s == ''
+  #   execute({method: :get, url: "#{base_path(server_id)}/devices/#{id}", params: params})
+  # end
+
+  def list(server_id, params={})
+    execute({method: :get, url: "#{base_path(server_id)}/devices", params: params})
+  end
+
+  def assign(server_id, id, payload)
+    execute({method: :put, url: "#{base_path(server_id)}/devices/#{id}/assign", payload: payload.to_json})
+  end
+
+  def attach(server_id, id, payload)
+    execute({method: :put, url: "#{base_path(server_id)}/devices/#{id}/attach", payload: payload.to_json})
+  end
+
+  def detach(server_id, id, payload)
+    execute({method: :put, url: "#{base_path(server_id)}/devices/#{id}/detach", payload: payload.to_json})
+  end
+
+end

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

@@ -373,10 +373,21 @@ EOT
         # could actually fetch the instance.., only need name and id right now though.
         raise_command_error "Backup instance not found" if instance.nil?
         params['restoreInstance'] = prompt_value({'fieldName' => 'restoreInstance', 'fieldLabel' => 'Restore Instance', 'type' => 'select', 'selectOptions' => [{'name' => 'Current Instance', 'value' => 'existing'}, {'name' => 'New Instance', 'value' => 'new'}], 'defaultValue' => 'existing', 'required' => true, 'description' => 'Restore the current instance or a new instance?'}, options)
+        restore_options = @backup_results_interface.create_options(backup_result['id'])
         if params['restoreInstance'] == 'new'
           # new instance
-          config_map = prompt_restore_instance_config(options)
-          params['instanceConfig'] = config_map
+          if restore_options['vmRestore']
+            group_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'group', 'type' => 'select', 'fieldLabel' => 'Group', 'selectOptions' => get_available_groups(), 'required' => true, 'description' => 'Select Group.'}],options[:options],@api_client,{'serverTypeId' => restore_options['servierTypeId']})['group']
+            name = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true, 'description' => 'Instance Name', 'defaultValue' => "#{backup['name']}-restore"}], options[:options], @api_client)['name']
+            params['groupId'] = group_id
+            params['name'] = name
+            v_prompt = Morpheus::Cli::OptionTypes.prompt(restore_options['restoreNewOptionTypes'], options[:options], @api_client, {'zoneId' => backup_result['zoneId'], 'siteId' => group_id})
+            v_prompt.deep_compact!.booleanize! # remove empty values and convert checkbox "on" and "off" to true and false
+            params.deep_merge!(v_prompt)
+          else
+            config_map = prompt_restore_instance_config(options)
+            params['instanceConfig'] = config_map
+          end
         else
           # existing instance
           # confirm the instance
@@ -393,6 +404,9 @@ EOT
               print_red_alert "The value '#{instance_id}' does not match the existing instance #{instance['name']} [#{instance['id'] rescue ''}]. Please try again."
             end
           end
+          v_prompt = Morpheus::Cli::OptionTypes.prompt(restore_options['restoreExistingOptionTypes'], options[:options], @api_client, {'zoneId' => backup_result['zoneId'], 'siteId' => group_id})
+          v_prompt.deep_compact!.booleanize! # remove empty values and convert checkbox "on" and "off" to true and false
+          params.deep_merge!(v_prompt)
         end
       elsif backup['locationType'] == 'server'
         # prompt for server type backup restore

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

@@ -4248,7 +4248,7 @@ class Morpheus::Cli::Clusters
   end
 
   def find_layout_by_name(name)
-    @cluster_layouts_interface.list({phrase:name}).find { it['name'].downcase == name.downcase || it['code'].downcase == name.downcase }
+    @cluster_layouts_interface.list({phrase:name}).find { |it| it['name'].downcase == name.downcase || it['code'].downcase == name.downcase }
   end
 
   def layouts_for_dropdown(zone_id, group_type_id)

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

@@ -12,7 +12,8 @@ class Morpheus::Cli::Hosts
                        {:'types' => :list_types},
                        {:exec => :execution_request},
                        :wiki, :update_wiki,
-                       :maintenance, :leave_maintenance, :placement
+                       :maintenance, :leave_maintenance, :placement,
+                       :list_devices, :assign_device, :detach_device, :attach_device
   alias_subcommand :details, :get
   set_default_subcommand :list
 
@@ -2281,7 +2282,7 @@ EOT
       end
       payload[:server][:deleteLocalData] = options.fetch(:deleteLocalData) do
         prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'deleteLocalData', 'fieldLabel' => 'Delete Local Data', 'type' => 'checkbox', 'defaultValue' => false, 'required' => false}], options, @api_client, {})
-        prompt['force'] == 'on'
+        prompt['deleteLocalData'] == 'on'
       end
     end
     
@@ -2354,7 +2355,7 @@ EOT
     end
     json_response = @servers_interface.leave_maintenance(server['id'], payload, params)
     render_response(json_response, options) do
-      print_green_success "Maintenance mode enabled for host #{server['name']}"
+      print_green_success "Left Maintenance Mode for host #{server['name']}"
       #get([server['id']])
     end
     return 0, nil
@@ -2418,6 +2419,24 @@ EOT
     return 0, nil
   end
 
+    ## Server Devices
+
+    def list_devices(args)
+      Morpheus::Cli::ServerDevicesCommand.new.list(args)
+    end
+    
+    def assign_device(args)
+      Morpheus::Cli::ServerDevicesCommand.new.assign(args)
+    end
+
+    def attach_device(args)
+      Morpheus::Cli::ServerDevicesCommand.new.attach(args)
+    end
+  
+    def detach_device(args)
+      Morpheus::Cli::ServerDevicesCommand.new.detach(args)
+    end
+    
   private
 
   def find_host_by_id(id)
@@ -2440,7 +2459,9 @@ EOT
       print_red_alert "Server not found by name #{name}"
       exit 1
     elsif results['servers'].size > 1
-      print_red_alert "Multiple Servers exist with the name #{name}. Try using id instead"
+      print_red_alert "Multiple Servers exist with the name '#{name}'"
+      puts_error as_pretty_table(results['servers'], [:id, :name], {color:red})
+      print_red_alert "Try using ID instead"
       exit 1
     end
     return results['servers'][0]

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

@@ -316,7 +316,12 @@ class Morpheus::Cli::License
       "Start Date" => lambda {|it| format_local_dt(it['startDate']) },
       "End Date" => lambda {|it| 
         if it['endDate']
-          format_local_dt(it['endDate']).to_s + ' (' + format_duration(Time.now, it['endDate']).to_s + ')' 
+          end_date = parse_time(it['endDate']) rescue nil
+          if end_date && Time.now > end_date
+            format_local_dt(it['endDate']).to_s + red + ' (expired)' + cyan
+          else
+            format_local_dt(it['endDate']).to_s + ' (' + format_duration(Time.now, it['endDate']).to_s + ')' 
+          end
         else
           'Never'
         end
@@ -424,7 +429,12 @@ class Morpheus::Cli::License
       "Start Date" => lambda {|it| format_local_dt(it['startDate']) },
       "End Date" => lambda {|it| 
         if it['endDate']
-          format_local_dt(it['endDate']).to_s + ' (' + format_duration(Time.now, it['endDate']).to_s + ')' 
+          end_date = parse_time(it['endDate']) rescue nil
+          if end_date && Time.now > end_date
+            format_local_dt(it['endDate']).to_s + red + ' (expired)' + cyan
+          else
+            format_local_dt(it['endDate']).to_s + ' (' + format_duration(Time.now, it['endDate']).to_s + ')' 
+          end
         else
           'Never'
         end

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

@@ -0,0 +1,207 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::ServerDevicesCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::ProvisioningHelper
+  # include Morpheus::Cli::OptionSourceHelper
+
+  set_command_hidden # hide and prefer `hosts list-devices, get-device, assign-device. for now
+
+  set_command_name :'host-devices'
+
+  register_subcommands :list, :assign, :attach, :detach
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @servers_interface = @api_client.servers
+    @server_devices_interface = @api_client.server_devices
+  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} hosts [host] list-devices"
+      build_standard_list_options(opts, options)
+      opts.footer = <<-EOT
+List host devices.
+[host] is required. This is the id of the host.
+EOT
+    end
+    optparse.parse!(args)
+    connect(options)
+    verify_args!(args:args, optparse:optparse, count:1)
+    server_id = args[0] =~ /\A\d{1,}\Z/ ? args[0].to_i : find_server_by_name(args[0])['id']
+    @server_devices_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @server_devices_interface.dry.list(server_id, params)
+      return
+    end
+    json_response = @server_devices_interface.list(server_id, params)
+    render_response(json_response, options, 'devices') do
+      server_devices = json_response['devices']
+      print_h1 "Host Devices: #{server_id}", parse_list_subtitles(options), options
+      if server_devices.empty?
+        print cyan,"No host devices found.",reset,"\n"
+      else
+        print as_pretty_table(server_devices, server_device_list_column_definitions.upcase_keys!, options)
+        print_results_pagination(json_response)
+      end
+      print reset,"\n"
+    end
+  end
+  
+
+  def assign(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} hosts assign [host] [device] [target]"
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Assign a host device to a target server.
+[host] is required. This is the id of the host.
+[device] is required. This is the id of the device.
+[target] is required. This is the id of the target server.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1, max:3)
+    connect(options)
+    server_id = args[0] =~ /\A\d{1,}\Z/ ? args[0].to_i : find_server_by_name(args[0])['id']
+    device_id = args[1] ? args[1].to_i : nil
+    if device_id.nil?
+      avail_devices = @server_devices_interface.list(server_id)['devices'].collect {|it| {'name' => it['name'], 'value' => it['id']}}
+      device_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'deviceId', 'fieldLabel' => 'Device', 'type' => 'select', 'selectOptions' => avail_devices, 'required' => true}], options[:options], @api_client)['deviceId']        
+    end
+    target_server_id = args[2] ? args[2].to_i : nil
+    parse_payload(options) do |payload|
+      if target_server_id.nil?
+        # avail_servers = @servers_interface.list({max:10000, 'parentId' => server_id})['servers'].collect {|it| {'name' => it['name'], 'value' => it['id']}}
+        # target_server_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'targetServerId', 'fieldLabel' => 'Target Server', 'type' => 'select', 'selectOptions' => avail_servers, 'required' => true}], options[:options], @api_client)['targetServerId']
+        target_server_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'targetServerId', 'fieldLabel' => 'Target Server', 'type' => 'select', 'optionSource' => 'hostVms', 'required' => true}], options[:options], @api_client, {'parentId' => server_id})['targetServerId']
+      end
+      payload['targetServerId'] = target_server_id
+    end
+    execute_api(@server_devices_interface, :assign, [server_id, device_id], options) do |json_response|
+      print_green_success "Assigned host device to target server"
+    end
+  end
+
+  def attach(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} hosts attach [host] [device]"
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Attach a host device.
+[host] is required. This is the id of the host.
+[device] is required. This is the id of the device.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1, max:3)
+    connect(options)
+    server_id = args[0] =~ /\A\d{1,}\Z/ ? args[0].to_i : find_server_by_name(args[0])['id']
+    device_id = args[1] ? args[1].to_i : nil
+    if device_id.nil?
+      avail_devices = @server_devices_interface.list(server_id)['devices'].collect {|it| {'name' => it['name'], 'value' => it['id']}}
+      device_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'deviceId', 'fieldLabel' => 'Device', 'type' => 'select', 'selectOptions' => avail_devices, 'required' => true}], options[:options], @api_client)['deviceId']        
+    end
+    parse_payload(options) do |payload|
+      
+    end
+    execute_api(@server_devices_interface, :attach, [server_id, device_id], options) do |json_response|
+      print_green_success "Attached host device"
+    end
+  end
+
+  def detach(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} hosts detach [host] [device]"
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Detach a host device.
+[host] is required. This is the id of the host.
+[device] is required. This is the id of the device.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, min:1, max:3)
+    connect(options)
+    server_id = args[0] =~ /\A\d{1,}\Z/ ? args[0].to_i : find_server_by_name(args[0])['id']
+    device_id = args[1] ? args[1].to_i : nil
+    if device_id.nil?
+      avail_devices = @server_devices_interface.list(server_id)['devices'].collect {|it| {'name' => it['name'], 'value' => it['id']}}
+      device_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'deviceId', 'fieldLabel' => 'Device', 'type' => 'select', 'selectOptions' => avail_devices, 'required' => true}], options[:options], @api_client)['deviceId']        
+    end
+    parse_payload(options) do |payload|
+      
+    end
+    execute_api(@server_devices_interface, :detach, [server_id, device_id], options) do |json_response|
+      print_green_success "Detached host device"
+    end
+  end
+
+  private
+
+  # helper methods
+
+  def server_device_list_column_definitions()
+    # {
+    #   "ID" => 'id',
+    #   "Name" => 'name',
+    #   "Ref" => lambda {|it| "#{it['refType']} #{it['refId']}" },
+    #   "Type" => lambda {|it| it['type']['name'] rescue '' },
+    #   "Status" => lambda {|it| format_server_device_status(it) },
+    #   "External ID" => 'externalId',
+    #   "Domain ID" => 'domainId',
+    #   "Bus" => 'bus',
+    #   "Slot" => 'slot',
+    #   "Device" => 'device',
+    #   "Vendor ID" => 'vendorId',
+    #   "Product ID" => 'productId',
+    #   "Function ID" => 'functionId',
+    #   "Unique ID" => 'uniqueId',
+    #   "IOMMU Group" => 'iommuGroup',
+    #   "IOMMU Device Count" => 'iommuDeviceCount',
+    # }
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Type" => lambda {|it| it['type']['name'] rescue '' },
+      "Bus" => 'bus',
+      "Slot" => 'slot',
+      "Status" => lambda {|it| format_server_device_status(it) },
+      "Assignee" => lambda {|it| "#{it['refType']} #{it['refId']}" },
+    }
+  end
+
+  def server_device_column_definitions()
+    server_device_list_column_definitions()
+  end
+
+  def format_server_device_status(server_device, return_color=cyan)
+    out = ""
+    status_string = server_device['status'].to_s.upcase
+    if status_string == 'ATTACHED' # || status_string == 'ASSIGNED'
+      out <<  "#{green}#{status_string.upcase}#{return_color}"
+    elsif status_string == "PENDING"
+      out <<  "#{yellow}#{status_string.upcase}#{return_color}"
+    elsif status_string
+      out <<  "#{cyan}#{status_string.upcase}#{return_color}"
+    else
+      out <<  ""
+    end
+    out
+  end
+  
+end

data/lib/morpheus/cli/mixins/provisioning_helper.rb

@@ -329,7 +329,9 @@ module Morpheus::Cli::ProvisioningHelper
       print_red_alert "Server not found by name #{name}"
       exit 1
     elsif results['servers'].size > 1
-      print_red_alert "Multiple servers exist with the name #{name}. Try using id instead"
+      print_red_alert "Multiple Servers exist with the name '#{name}'"
+      puts_error as_pretty_table(results['servers'], [:id, :name], {color:red})
+      print_red_alert "Try using ID instead"
       exit 1
     end
     return results['servers'][0]

data/lib/morpheus/cli/version.rb

@@ -1,6 +1,6 @@
 
 module Morpheus
   module Cli
-    VERSION = "8.0.4.1"
+    VERSION = "8.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: morpheus-cli
 version: !ruby/object:Gem::Version
-  version: 8.0.4.1
+  version: 8.0.5
 platform: ruby
 authors:
 - David Estes
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix
@@ -365,6 +365,7 @@ files:
 - lib/morpheus/api/security_package_types_interface.rb
 - lib/morpheus/api/security_packages_interface.rb
 - lib/morpheus/api/security_scans_interface.rb
+- lib/morpheus/api/server_devices_interface.rb
 - lib/morpheus/api/server_types_interface.rb
 - lib/morpheus/api/servers_interface.rb
 - lib/morpheus/api/service_catalog_interface.rb
@@ -548,6 +549,7 @@ files:
 - lib/morpheus/cli/commands/security_packages.rb
 - lib/morpheus/cli/commands/security_scans.rb
 - lib/morpheus/cli/commands/self_service_command.rb
+- lib/morpheus/cli/commands/server_devices_command.rb
 - lib/morpheus/cli/commands/service_catalog_command.rb
 - lib/morpheus/cli/commands/service_plans_command.rb
 - lib/morpheus/cli/commands/set_prompt_command.rb