morpheus-cli 5.5.1.4 → 5.5.2

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

@@ -2,172 +2,45 @@ require 'morpheus/cli/cli_command'
 
 class Morpheus::Cli::NetworkPoolServersCommand
   include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::RestCommand
   include Morpheus::Cli::InfrastructureHelper
 
+  set_command_description "View and manage network pool servers (IPAM integrations)"
   set_command_name :'network-pool-servers'
 
   register_subcommands :list, :get, :add, :update, :remove
+  register_subcommands :list_types, :get_type
   
-  # set_default_subcommand :list
-  
-  def initialize()
-    # @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
-  end
-
-  def connect(opts)
-    @api_client = establish_remote_appliance_connection(opts)
-    @network_pool_servers_interface = @api_client.network_pool_servers
-    @clouds_interface = @api_client.clouds
-    @options_interface = @api_client.options
-  end
+  # RestCommand settings
+  register_interfaces :network_pool_servers, :network_pool_server_types, :clouds, :options
+  set_rest_has_type true
+  # set_rest_type :network_pool_server_types
 
   def handle(args)
     handle_subcommand(args)
   end
 
-  def list(args)
-    options = {}
-    params = {}
-    optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage()
-      build_common_options(opts, options, [:list, :json, :yaml, :csv, :fields, :json, :dry_run, :remote])
-      opts.footer = "List network pool servers."
-    end
-    optparse.parse!(args)
-    connect(options)
-    begin
-      params.merge!(parse_list_options(options))
-      @network_pool_servers_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @network_pool_servers_interface.dry.list(params)
-        return
-      end
-      json_response = @network_pool_servers_interface.list(params)
-      network_pool_servers = json_response["networkPoolServers"]
-      if options[:json]
-        puts as_json(json_response, options, "networkPoolServers")
-        return 0
-      elsif options[:yaml]
-        puts as_yaml(json_response, options, "networkPoolServers")
-        return 0
-      elsif options[:csv]
-        puts records_as_csv(network_pool_servers, options)
-        return 0
-      end
-      title = "Morpheus Network Pool Servers"
-      subtitles = []
-      subtitles += parse_list_subtitles(options)
-      print_h1 title, subtitles
-      if network_pool_servers.empty?
-        print cyan,"No network pool servers found.",reset,"\n"
-      else
-        rows = network_pool_servers.collect {|network_pool_server| 
-          row = {
-            id: network_pool_server['id'],
-            name: network_pool_server['name'],
-            # description: network_pool_server['description'],
-            type: network_pool_server['type'] ? network_pool_server['type']['name'] : '',
-            pools: network_pool_server['pools'] ? network_pool_server['pools'].collect {|it| it['name'] }.uniq.join(', ') : '',
-          }
-          row
-        }
-        columns = [:id, :name, :type, :pools]
-        if options[:include_fields]
-          columns = options[:include_fields]
-        end
-        print cyan
-        print as_pretty_table(rows, columns, options)
-        print reset
-        print_results_pagination(json_response, {:label => "network pool server", :n_label => "network pool servers"})
-      end
-      print reset,"\n"
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
-    end
-  end
-
-  def get(args)
-    options = {}
-    optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[network-pool-server]")
-      build_common_options(opts, options, [:json, :yaml, :csv, :fields, :dry_run, :remote])
-      opts.footer = "Get details about a network pool server." + "\n" +
-                    "[network-pool-server] is required. This is the name or id of a network pool server."
-    end
-    optparse.parse!(args)
-    if args.count != 1
-      print_error Morpheus::Terminal.angry_prompt
-      puts_error  "#{command_name} missing argument: [network-pool-server]\n#{optparse}"
-      return 1
-    end
-    connect(options)
-    begin
-      @network_pool_servers_interface.setopts(options)
-      if options[:dry_run]
-        if args[0].to_s =~ /\A\d{1,}\Z/
-          print_dry_run @network_pool_servers_interface.dry.get(args[0].to_i)
-        else
-          print_dry_run @network_pool_servers_interface.dry.list({name:args[0]})
-        end
-        return
-      end
-      network_pool_server = find_network_pool_server_by_name_or_id(args[0])
-      return 1 if network_pool_server.nil?
-      json_response = {'networkPoolServer' => network_pool_server}  # skip redundant request
-      # json_response = @network_pool_servers_interface.get(network_pool_server['id'])
-      network_pool_server = json_response['networkPoolServer']
-      if options[:json]
-        puts as_json(json_response, options, 'networkPoolServer')
-        return 0
-      elsif options[:yaml]
-        puts as_yaml(json_response, options, 'networkPoolServer')
-        return 0
-      elsif options[:csv]
-        puts records_as_csv([network_pool_server], options)
-        return 0
-      end
-      print_h1 "Network Pool Server Details"
-      print cyan
-      description_cols = {
-        "ID" => 'id',
-        "Name" => lambda {|it| it['name'] },
-        "Type" => lambda {|it| it['type'] ? it['type']['name'] : '' },
-        # "Service URL" => lambda {|it| it['serviceUrl'] : '' },
-        "Pools" => lambda {|it| it['pools'] ? it['pools'].collect {|p| p['name'] }.uniq.join(', ') : '' },
-      }
-      print_description_list(description_cols, network_pool_server)
-      print reset,"\n"
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      return 1
-    end
-  end
-
   def add(args)
     options = {}
     ip_range_list = nil
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage()
+      opts.banner = subcommand_usage("[name]")
       opts.on('--name VALUE', String, "Name for this network pool server") do |val|
         options['name'] = val
       end
       opts.on('--type VALUE', String, "Type of network pool server") do |val|
         options['type'] = 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
       # ['name', 'serviceUsername', 'servicePassword', 'servicePort', 'serviceHost', 'serviceUrl', 'serviceMode', 'networkFilter', 'tenantMatch']
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
       opts.footer = "Create a new network pool server." + "\n" +
                     "[name] is required and can be passed as --name instead."
     end
     optparse.parse!(args)
-    if args.count > 1
-      print_error Morpheus::Terminal.angry_prompt
-      puts_error  "wrong number of arguments, expected 0-1 and got #{args.count}\n#{optparse}"
-      return 1
-    end
+    verify_args!(args:args, optparse:optparse, max: 1)
     connect(options)
     begin
       # merge -O options into normally parsed options
@@ -210,10 +83,11 @@ class Morpheus::Cli::NetworkPoolServersCommand
           return 1
         end
 
-        payload['networkPoolServer']['type'] = {'id' => network_type_id.to_i }
-
-        # prompt options
+        # prompt options by type
         network_pool_server_type = @network_pool_servers_interface.get_type(network_type_id.to_i)['networkPoolServerType']
+        # use type: "bluecat" instead of id
+        #payload['networkPoolServer']['type'] = {'id' => network_type_id.to_i }
+        payload['networkPoolServer']['type'] = network_pool_server_type['code']
         option_result = Morpheus::Cli::OptionTypes.prompt(network_pool_server_type['optionTypes'], options[:options].deep_merge({:context_map => {'networkPoolServer' => ''}}), @api_client, {}, options[:no_prompt], true)
         payload['networkPoolServer'].deep_merge!(option_result)
       end
@@ -230,7 +104,7 @@ class Morpheus::Cli::NetworkPoolServersCommand
       elsif !options[:quiet]
         network_pool_server = json_response['networkPoolServer']
         print_green_success "Added network pool server #{network_pool_server['name']}"
-        get([network_pool_server['id']])
+        _get(network_pool_server['id'], {}, options)
       end
       return 0
     rescue RestClient::Exception => e
@@ -247,8 +121,8 @@ class Morpheus::Cli::NetworkPoolServersCommand
       opts.on('--name VALUE', String, "Name for this network pool server") do |val|
         options['name'] = val
       end
-      opts.on('--type VALUE', String, "Type of network pool server") do |val|
-        options['description'] = val
+      opts.on('--enabled [on|off]', String, "Can be used to enable or disable it") do |val|
+        options[:options]['enabled'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s.empty?
       end
       # ['name', 'serviceUsername', 'servicePassword', 'servicePort', 'serviceHost', 'serviceUrl', 'serviceMode', 'networkFilter', 'tenantMatch']
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote])
@@ -256,11 +130,7 @@ class Morpheus::Cli::NetworkPoolServersCommand
                     "[network-pool-server] is required. This is the id of a network pool server."
     end
     optparse.parse!(args)
-    if args.count != 1
-      print_error Morpheus::Terminal.angry_prompt
-      puts_error  "wrong number of arguments, expected 1 and got #{args.count}\n#{optparse}"
-      return 1
-    end
+    verify_args!(args:args, optparse:optparse, count: 1)
     connect(options)
 
     begin
@@ -319,7 +189,7 @@ class Morpheus::Cli::NetworkPoolServersCommand
       else
         network_pool_server = json_response['networkPoolServer']
         print_green_success "Updated network pool server #{network_pool_server['name']}"
-        get([network_pool_server['id']])
+        _get(network_pool_server['id'], {}, options)
       end
       return 0
     rescue RestClient::Exception => e
@@ -337,13 +207,7 @@ class Morpheus::Cli::NetworkPoolServersCommand
                     "[network-pool-server] is required. This is the name or id of a network pool server."
     end
     optparse.parse!(args)
-
-    if args.count < 1
-      print_error Morpheus::Terminal.angry_prompt
-      puts_error  "#{command_name} missing argument: [network-pool-server]\n#{optparse}"
-      return 1
-    end
-
+    verify_args!(args:args, optparse:optparse, count: 1)
     connect(options)
     begin
       network_pool_server = find_network_pool_server_by_name_or_id(args[0])
@@ -374,6 +238,39 @@ class Morpheus::Cli::NetworkPoolServersCommand
 
   private
 
+  def render_response_for_get(json_response, options)
+    # load the type and show fields dynamically based on optionTypes
+    render_response(json_response, options, rest_object_key) do
+      type_record = rest_type_find_by_name_or_id(json_response[rest_object_key]['type']['id']) rescue nil
+      type_option_types = type_record ? (type_record['optionTypes'] || []) : []
+      record = json_response[rest_object_key]
+      print_h1 rest_label, [], options
+      print cyan
+      columns = rest_column_definitions(options)
+      if record['credential'] && record['credential']['type'] != 'local'
+        columns.delete("Username")
+        columns.delete("Password")
+      end
+      columns.delete("Throttle Rate") unless type_option_types.find {|it| it['fieldName'] == 'serviceThrottleRate' }
+      columns.delete("Disable SSL SNI") unless type_option_types.find {|it| it['fieldName'] == 'ignoreSsl' }
+      columns.delete("Network Filter") unless type_option_types.find {|it| it['fieldName'] == 'networkFilter' }
+      columns.delete("Zone Filter") unless type_option_types.find {|it| it['fieldName'] == 'zoneFilter' }
+      columns.delete("Tenant Match") unless type_option_types.find {|it| it['fieldName'] == 'tenantMatch' }
+      columns.delete("IP Mode") unless type_option_types.find {|it| it['fieldName'] == 'serviceMode' }
+      columns.delete("Extra Attributes") unless type_option_types.find {|it| it['fieldName'] == 'extraAttributes' }
+      columns.delete("App ID") unless type_option_types.find {|it| it['fieldName'] == 'appId' }
+      columns.delete("Inventory Existing") unless type_option_types.find {|it| it['fieldName'] == 'inventoryExisting' }
+      columns.delete("Enabled") if record['enabled'].nil? # was not always returned, so don't show false if not present..
+      print_description_list(columns, record, options)
+      # show Pools
+      pools = record['pools']
+      if pools && !pools.empty?
+        print_h2 "Network Pools"
+        print as_pretty_table(pools, [:id, :name], options)
+      end
+      print reset,"\n"
+    end
+  end
 
  def find_network_pool_server_by_name_or_id(val)
     if val.to_s =~ /\A\d{1,}\Z/

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

@@ -17,6 +17,7 @@ class Morpheus::Cli::NetworkPoolsCommand
     @api_client = establish_remote_appliance_connection(opts)
     @network_pools_interface = @api_client.network_pools
     @network_pool_ips_interface = @api_client.network_pool_ips
+    @network_pool_servers_interface = @api_client.network_pool_servers
     @clouds_interface = @api_client.clouds
     @options_interface = @api_client.options
   end
@@ -30,6 +31,9 @@ class Morpheus::Cli::NetworkPoolsCommand
     params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage()
+      opts.on('--pool-server SERVER', String, "Filter by Network Pool Server Name or ID") do |val|
+        options[:pool_server] = val
+      end
       build_common_options(opts, options, [:list, :json, :yaml, :csv, :fields, :dry_run, :remote])
       opts.footer = "List network pools."
     end
@@ -37,6 +41,14 @@ class Morpheus::Cli::NetworkPoolsCommand
     connect(options)
     begin
       params.merge!(parse_list_options(options))
+      if options[:pool_server]
+        record = find_by_name_or_id(:network_pool_server, options[:pool_server])
+        if record.nil?
+          exit 1 #return 1, "Network Pool Server not found by '#{val}'"
+        else 
+          params['poolServerId'] = record['id']
+        end
+      end
       @network_pools_interface.setopts(options)
       if options[:dry_run]
         print_dry_run @network_pools_interface.dry.list(params)
@@ -69,7 +81,7 @@ class Morpheus::Cli::NetworkPoolsCommand
             network: network_pool['name'], 
             # network: network_pool['network'] ? network_pool['network']['name'] : '',
             type: network_pool['type'] ? network_pool['type']['name'] : '',
-            ipRanges: network_pool['ipRanges'] ? network_pool['ipRanges'].collect {|it| it['startAddress'].to_s + " - " + it['endAddress'].to_s }.uniq.join(', ') : '',
+            ipRanges: build_ip_ranges(network_pool['ipRanges']).uniq.join(', '),
             total: ("#{network_pool['ipCount']}/#{network_pool['freeCount']}")
           }
           row
@@ -147,8 +159,8 @@ class Morpheus::Cli::NetworkPoolsCommand
       print_h2 "IP Ranges"
       print cyan
       if network_pool['ipRanges']
-        network_pool['ipRanges'].each do |r|
-          puts " * #{r['startAddress']} - #{r['endAddress']}"
+        build_ip_ranges(network_pool['ipRanges']).each do |r|
+          puts " * #{r}"
         end
       end
       print reset,"\n"
@@ -170,15 +182,11 @@ class Morpheus::Cli::NetworkPoolsCommand
       opts.on('--type VALUE', String, "Type of network pool") do |val|
         options['type'] = val
       end
-      opts.on('--ip-ranges LIST', Array, "IP Ranges, comma separated list IP ranges in the format start-end.") do |list|
+      opts.on('--ip-ranges LIST', Array, "IP Ranges, comma separated list IP ranges in the format start-end or an IPv6 CIDR") do |list|
         if list.size == 1 && list[0] == 'null' # hacky way to clear it
           ip_range_list = []
         else
-          ip_range_list = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
-          ip_range_list = ip_range_list.collect {|it|
-            range_parts = it.split("-")
-            {startAddress: range_parts[0].to_s.strip, endAddress: range_parts[1].to_s.strip}
-          }
+          ip_range_list = parse_ipv4_and_ipv6_ranges(list)
         end
       end
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
@@ -244,13 +252,8 @@ class Morpheus::Cli::NetworkPoolsCommand
         if ip_range_list
           payload['networkPool']['ipRanges'] = ip_range_list
         else
-          v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'ipRanges', 'fieldLabel' => 'IP Ranges', 'type' => 'text', 'required' => true, 'description' => 'IP Ranges in the pool, comma separated list of ranges in the format start-end.'}], options)
-          ip_range_list = v_prompt['ipRanges'].to_s.split(",").collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
-          ip_range_list = ip_range_list.collect {|it|
-            range_parts = it.split("-")
-            range = {startAddress: range_parts[0].to_s.strip, endAddress: range_parts[1].to_s.strip}
-            range
-          }
+          v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'ipRanges', 'fieldLabel' => 'IP Ranges', 'type' => 'text', 'required' => true, 'description' => 'IP Ranges in the pool, comma separated list of ranges in the format start-end or an IPv6 CIDR'}], options)
+          ip_range_list = parse_ipv4_and_ipv6_ranges(v_prompt['ipRanges'].to_s.split(","))
           payload['networkPool']['ipRanges'] = ip_range_list
         end
 
@@ -308,15 +311,11 @@ class Morpheus::Cli::NetworkPoolsCommand
       # poolEnabled
       # tftpServer
       # bootFile
-      opts.on('--ip-ranges LIST', Array, "IP Ranges, comma separated list IP ranges in the format start-end.") do |list|
+      opts.on('--ip-ranges LIST', Array, "IP Ranges, comma separated list IP ranges in the format start-end or an IPv6 CIDR") do |list|
         if list.size == 1 && list[0] == 'null' # hacky way to clear it
           ip_range_list = []
         else
-          ip_range_list = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
-          ip_range_list = ip_range_list.collect {|it|
-            range_parts = it.split("-")
-            {startAddress: range_parts[0].to_s.strip, endAddress: range_parts[1].to_s.strip}
-          }
+          ip_range_list = parse_ipv4_and_ipv6_ranges(list)
         end
       end
       build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote])
@@ -369,7 +368,7 @@ class Morpheus::Cli::NetworkPoolsCommand
             # ugh, need to allow changing an existing range by id too
             if network_pool['ipRanges']
               existing_range = network_pool['ipRanges'].find {|r|
-                range[:startAddress] == r['startAddress'] && range[:endAddress] == r['endAddress']
+                (range[:startAddress] == r['startAddress'] && range[:endAddress] == r['endAddress']) || range[:cidrIPv6] == r['cidrIPv6']
               }
               if existing_range
                 range[:id] = existing_range['id']
@@ -874,4 +873,31 @@ class Morpheus::Cli::NetworkPoolsCommand
     end
   end
 
+  def build_ip_ranges(ip_ranges)
+    if ip_ranges.empty?
+      return []
+    else
+      ranges = ip_ranges.collect do |it| 
+        if !it['cidrIPv6'].nil?
+          it['cidrIPv6'].to_s
+        else
+          it['startAddress'].to_s + " - " + it['endAddress'].to_s
+        end
+      end
+    end
+  end
+
+  def parse_ipv4_and_ipv6_ranges(range_string_list)
+    ip_range_list = range_string_list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
+    ip_range_list = ip_range_list.collect do |range_string|
+      if range_string.include?('-') 
+        range_parts = range_string.split("-")
+        {startAddress: range_parts[0].to_s.strip, endAddress: range_parts[1].to_s.strip}
+      elsif range_string.include?(':')
+        {cidrIPv6: range_string}
+      end
+    end
+    return ip_range_list
+  end
+
 end