morpheus-cli 9.0.1 → 9.1.0

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

@@ -5,6 +5,7 @@ class Morpheus::Cli::NetworksCommand
   include Morpheus::Cli::WhoamiHelper
   include Morpheus::Cli::InfrastructureHelper
   include Morpheus::Cli::ProvisioningHelper
+  include Morpheus::Cli::AccountsHelper
 
   set_command_name :networks
 
@@ -28,6 +29,8 @@ class Morpheus::Cli::NetworksCommand
     @groups_interface = @api_client.groups
     @clouds_interface = @api_client.clouds
     @options_interface = @api_client.options
+    @accounts_interface = @api_client.accounts
+    @account_users_interface = @api_client.account_users
   end
 
   def handle(args)
@@ -57,6 +60,13 @@ class Morpheus::Cli::NetworksCommand
       opts.on('--all-labels LABEL', String, "Filter by labels, must match all of the values") do |val|
         add_query_parameter(params, 'allLabels', parse_labels(val))
       end
+      opts.on('--include-tenants','--include-tenants', "Include sub tenant networks") do
+        options[:include_tenants] = true
+        params['includeTenants'] = true
+      end
+      opts.on('--tenant TENANT', String, "Tenant Name or ID" ) do |val|
+        options[:tenant] = val
+      end
       build_common_options(opts, options, [:list, :json, :yaml, :csv, :fields, :json, :dry_run, :remote])
       opts.footer = "List networks."
     end
@@ -73,6 +83,18 @@ class Morpheus::Cli::NetworksCommand
         return 1 if cloud.nil?
         params['zoneId'] = cloud['id']
       end
+      if options[:tenant]
+        if options[:tenant].to_s !~ /\A\d{1,}\Z/
+          account = find_account_by_name_or_id(options[:tenant])
+          if account.nil?
+            return 1, "Tenant not found by name: #{options[:tenant]}"
+          else
+            params['tenantId'] = account['id']
+          end
+        else
+          params['tenantId'] = options[:tenant]
+        end
+      end
       @networks_interface.setopts(options)
       if options[:dry_run]
         print_dry_run @networks_interface.dry.list(params)
@@ -109,6 +131,7 @@ class Morpheus::Cli::NetworksCommand
             type: network['type'] ? network['type']['name'] : '',
             group: network['group'] ? network['group']['name'] : 'Shared',
             cloud: network['zone'] ? network['zone']['name'] : '',
+            tenant: network['owner'] ? network['owner']['name'] : '',
             cidr: network['cidr'],
             pool: network['pool'] ? network['pool']['name'] : '',
             dhcp: network['dhcpServer'] ? 'Yes' : 'No',
@@ -128,6 +151,7 @@ class Morpheus::Cli::NetworksCommand
                 type: "Subnet",
                 group: network['group'] ? network['group']['name'] : 'Shared',
                 cloud: network['zone'] ? network['zone']['name'] : '',
+                tenant: network['owner'] ? network['owner']['name'] : '',
                 cidr: subnet['cidr'],
                 pool: subnet['pool'] ? subnet['pool']['name'] : '',
                 dhcp: subnet['dhcpServer'] ? 'Yes' : 'No',
@@ -139,9 +163,13 @@ class Morpheus::Cli::NetworksCommand
             end
           end
         end
-        columns = [:id, :name, :labels, :type, :group, :cloud, :cidr, :pool, :dhcp, :subnets, :active, :visibility, :tenants]
+        columns = [:id, :name, :labels, :type, :group, :cloud, :tenant, :cidr, :pool, :dhcp, :subnets, :active, :visibility, :tenants]
         if options[:include_fields]
           columns = options[:include_fields]
+        else
+          if !options[:include_tenants] && !options[:tenant]
+            columns.delete(:tenant)
+          end
         end
         print cyan
         print as_pretty_table(rows, columns, options)
@@ -160,6 +188,9 @@ class Morpheus::Cli::NetworksCommand
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[network]")
+      opts.on('--include-tenants','--include-tenants', "Include sub tenant networks when finding network by name") do
+        options[:include_tenants] = true
+      end
       build_common_options(opts, options, [:json, :yaml, :csv, :fields, :dry_run, :remote])
       opts.footer = "Get details about a network." + "\n" +
                     "[network] is required. This is the name or id of a network."
@@ -177,11 +208,11 @@ class Morpheus::Cli::NetworksCommand
         if args[0].to_s =~ /\A\d{1,}\Z/
           print_dry_run @networks_interface.dry.get(args[0].to_i)
         else
-          print_dry_run @networks_interface.dry.list({name:args[0]})
+          print_dry_run @networks_interface.dry.list({name:args[0]}, options[:include_tenants])
         end
         return
       end
-      network = find_network_by_name_or_id(args[0])
+      network = find_network_by_name_or_id(args[0], options[:include_tenants])
       return 1 if network.nil?
       json_response = {'network' => network}  # skip redundant request
       # json_response = @networks_interface.get(network['id'])
@@ -206,6 +237,7 @@ class Morpheus::Cli::NetworksCommand
         "Type" => lambda {|it| it['type'] ? it['type']['name'] : '' },
         "Group" => lambda {|it| it['group'] ? it['group']['name'] : 'Shared' },
         "Cloud" => lambda {|it| it['zone'] ? it['zone']['name'] : '' },
+        "Tenant" => lambda {|it| it['owner'] ? it['owner']['name'] : '' },
         "IPv4 Enabled" => 'ipv4Enabled',
         "IPv6 Enabled" => 'ipv6Enabled',
         "CIDR" => 'cidr',

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

@@ -0,0 +1,336 @@
+require 'morpheus/cli/cli_command'
+
+# CLI command Virtual Switch management
+# UI is Tools: Virtual Switches
+# API is /api/virtual-switches and returns virtualSwitches
+class Morpheus::Cli::VirtualSwitchesCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::OptionSourceHelper
+
+  set_command_name :'virtual-switches'
+  set_command_description "View and manage Virtual Switches"
+  set_command_hidden
+  register_subcommands :list, :get, :add, :update, :remove
+  
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @virtual_switches_interface = @api_client.virtual_switches
+    @clusters_interface = @api_client.clusters
+    @networks_interface = @api_client.networks
+    @options_interface = @api_client.options
+    
+  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]")
+      opts.on( '--enabled [on|off]', String, "Filter by enabled" ) do |val|
+        params['enabled'] = (val.to_s != 'false' && val.to_s != 'off')
+      end
+      build_standard_list_options(opts, options)
+      opts.footer = "List Virtual Switches."
+    end
+    optparse.parse!(args)
+    connect(options)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
+    params.merge!(parse_list_options(options))
+    @virtual_switches_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_switches_interface.dry.list(params)
+      return
+    end
+    json_response = @virtual_switches_interface.list(params)
+    render_response(json_response, options, virtual_switch_list_key) do
+      virtual_switches = json_response[virtual_switch_list_key]
+      print_h1 "Morpheus Virtual Switches", parse_list_subtitles(options), options
+      if virtual_switches.empty?
+        print cyan,"No Virtual Switches found.",reset,"\n"
+      else
+        columns = {
+          "ID" => 'id',
+          "Name" => 'name',
+          "Type" => lambda {|it| it['type']['name'] rescue it['baseType'] },
+          "NIC Count" => lambda {|it| it['nicCount'] },
+          "Network Count" => lambda {|it| it['networkCount'] },
+        }
+        print as_pretty_table(virtual_switches, columns.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("[switch]")
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a specific Virtual Switch.
+[switch] is required. This is the name or id of a Virtual Switch.
+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)
+    virtual_switch = nil
+    if id.to_s !~ /\A\d{1,}\Z/
+      virtual_switch = find_virtual_switch_by_name(id)
+      return 1, "Virtual Switch not found for #{id}" if virtual_switch.nil?
+      id = virtual_switch['id']
+    end
+    @virtual_switches_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_switches_interface.dry.get(id, params)
+      return
+    end
+    json_response = @virtual_switches_interface.get(id, params)
+    virtual_switch = json_response[virtual_switch_object_key]
+    render_response(json_response, options, virtual_switch_object_key) do
+      print_h1 "Virtual Switch Details", [], options
+      print cyan
+      columns = {
+        "ID" => 'id',
+        "Name" => 'name',
+        "Type" => lambda {|it| it['type']['name'] rescue it['baseType'] },
+        "NIC Count" => lambda {|it| it['nicCount'] },
+        "Network Count" => lambda {|it| it['networkCount'] },
+      }
+      print_description_list(columns, virtual_switch, options)
+
+
+      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_virtual_switch_option_types)
+      build_standard_add_options(opts, options)
+      opts.footer = <<-EOT
+Create a new Virtual Switch.
+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!({virtual_switch_object_key => parse_passed_options(options)})
+    else
+      params.deep_merge!(parse_passed_options(options))
+      # prompt for option types
+      option_types = add_virtual_switch_option_types
+      v_prompt = Morpheus::Cli::OptionTypes.prompt(option_types, options[:options], @api_client, options[:params])
+      params.deep_merge!(v_prompt)
+      # convert checkbox "on" and "off" to true and false
+      params.booleanize!
+      
+      # massage association params a bit
+      # params['apps'] = ...
+      payload.deep_merge!({virtual_switch_object_key => params})
+    end
+    @virtual_switches_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_switches_interface.dry.create(payload)
+      return 0, nil
+    end
+    json_response = @virtual_switches_interface.create(payload)
+    virtual_switch = json_response[virtual_switch_object_key]
+    render_response(json_response, options, virtual_switch_object_key) do
+      print_green_success "Added virtual switch #{virtual_switch['name']}"
+      return _get(virtual_switch["id"], {}, options)
+    end
+    return 0, nil
+  end
+
+  def update(args)
+    options = {}
+    params = {}
+    payload = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[switch] [options]")
+      build_option_type_options(opts, options, update_virtual_switch_option_types)
+      build_standard_update_options(opts, options)
+      opts.footer = <<-EOT
+Update a virtual switch.
+[switch] is required. This is the name or id of a virtual switch.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    if options[:options]['logo']
+      options[:options]['iconPath'] = 'custom'
+    end
+    connect(options)
+    virtual_switch = find_virtual_switch_by_name_or_id(args[0])
+    return 1 if virtual_switch.nil?
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!({virtual_switch_object_key => parse_passed_options(options)})
+    else
+      params.deep_merge!(parse_passed_options(options))
+      # do not prompt on update
+      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_virtual_switch_option_types, options[:options], @api_client, options[:params])
+      v_prompt.deep_compact!
+      params.deep_merge!(v_prompt)
+      # convert checkbox "on" and "off" to true and false
+      params.booleanize!
+      # massage association params a bit
+      
+      # params['apps'] = ...
+      payload.deep_merge!({virtual_switch_object_key => params})
+      if payload[virtual_switch_object_key].empty? # || options[:no_prompt]
+        raise_command_error "Specify at least one option to update.\n#{optparse}"
+      end
+    end
+    @virtual_switches_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_switches_interface.dry.update(virtual_switch['id'], payload)
+      return
+    end
+    json_response = @virtual_switches_interface.update(virtual_switch['id'], payload)
+    virtual_switch = json_response[virtual_switch_object_key]
+    render_response(json_response, options, virtual_switch_object_key) do
+      print_green_success "Updated virtual switch #{virtual_switch['name']}"
+      return _get(virtual_switch["id"], {}, options)
+    end
+    return 0, nil
+  end
+
+  def remove(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[switch] [options]")
+      build_standard_remove_options(opts, options)
+      opts.footer = <<-EOT
+Delete a virtual switch.
+[switch] is required. This is the name or id of a virtual switch.
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    virtual_switch = find_virtual_switch_by_name_or_id(args[0])
+    return 1 if virtual_switch.nil?
+    @virtual_switches_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @virtual_switches_interface.dry.destroy(virtual_switch['id'], params)
+      return
+    end
+    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the virtual switch #{virtual_switch['name']}?")
+      return 9, "aborted command"
+    end
+    json_response = @virtual_switches_interface.destroy(virtual_switch['id'], params)
+    render_response(json_response, options) do
+      print_green_success "Removed virtual switch #{virtual_switch['name']}"
+    end
+    return 0, nil
+  end
+
+  private
+  
+  def add_virtual_switch_option_types
+    [
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true, 'description' => 'Choose a unique name for the Virtual Switch'},
+      #{'fieldName' => 'description', 'fieldLabel' => 'Description', 'type' => 'text', 'description' => 'Description'},
+      {'switch' => '-t', 'fieldName' => 'type', 'fieldLabel' => 'Type', 'type' => 'select', 'description' => 'Type of virtual switch', 'selectOptions' => [{'name' => 'VM Network', 'value' => 'general'}, {'name' => 'ISCSI', 'value' => 'iscsi'}, {'name' => 'NFS', 'value' => 'nfs'}, {'name' => 'Live Migration', 'value' => 'live_migration'}, {'name' => 'SDN', 'value' => 'sdn'}], 'required' => true},
+    ]
+  end
+
+  def update_virtual_switch_option_types
+    list = add_virtual_switch_option_types.collect {|it|
+      it.delete('required')
+      it.delete('defaultValue')
+      it
+    }
+    list = list.reject {|it| ["type"].include? it['fieldName'] }
+    list
+  end
+
+  def find_virtual_switch_by_name_or_id(val)
+    if val.to_s =~ /\A\d{1,}\Z/
+      return find_virtual_switch_by_id(val)
+    else
+      return find_virtual_switch_by_name(val)
+    end
+  end
+
+  def find_virtual_switch_by_id(id)
+    begin
+      json_response = virtual_switches_interface.get(id.to_i)
+      return json_response[virtual_switch_object_key]
+    rescue RestClient::Exception => e
+      if e.response && e.response.code == 404
+        print_red_alert "Virtual Switch not found by id '#{id}'"
+      else
+        raise e
+      end
+    end
+  end
+
+  def find_virtual_switch_by_name(name)
+    json_response = virtual_switches_interface.list({name: name.to_s})
+    virtual_switches = json_response[virtual_switch_list_key]
+    if virtual_switches.empty?
+      print_red_alert "Virtual Switch not found by name '#{name}'"
+      return nil
+    elsif virtual_switches.size > 1
+      print_red_alert "#{virtual_switches.size} Virtual Switches found by name '#{name}'"
+      print_error "\n"
+      puts_error as_pretty_table(virtual_switches, [:id, :name], {color:red})
+      print_red_alert "Try using ID instead"
+      print_error reset,"\n"
+      return nil
+    else
+      return virtual_switches[0]
+    end
+  end
+
+  def format_virtual_switch_status(virtual_switch, return_color=cyan)
+    out = ""
+    status_string = virtual_switch['status'].to_s.downcase
+    if status_string
+      if ['available','ok'].include?(status_string)
+        out << "#{green}#{status_string.upcase}"
+      elsif ['unavailable','error'].include?(status_string)
+        out << "#{red}#{status_string.upcase}"
+      else
+        out << "#{return_color}#{status_string.upcase}"
+      end
+    end
+    out + return_color
+  end
+
+
+end

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

@@ -0,0 +1,118 @@
+require 'morpheus/cli/mixins/print_helper'
+
+# Mixin for Morpheus::Cli command classes
+# Single source of truth for affinity group / host-vm group enums and formatting.
+#
+# Keep this in sync with morpheus-ui and the OpenAPI shared affinity-type schema.
+# Defining these values here (rather than inline in each command) prevents the
+# definitions from drifting apart between cluster-scoped, cloud-scoped and
+# top-level flat-by-ID commands.
+module Morpheus::Cli::AffinityHelper
+
+  def self.included(klass)
+    klass.send :include, Morpheus::Cli::PrintHelper
+  end
+
+  # All affinity types supported by the API.
+  # The _MUST variants are mandatory placement constraints and are what the
+  # violations endpoint reports on.
+  AFFINITY_TYPES = [
+    {'name' => 'Keep Together (Should)', 'value' => 'KEEP_TOGETHER'},
+    {'name' => 'Keep Separate (Should)', 'value' => 'KEEP_SEPARATE'},
+    {'name' => 'Keep Together (Must)',   'value' => 'KEEP_TOGETHER_MUST'},
+    {'name' => 'Keep Separate (Must)',   'value' => 'KEEP_SEPARATE_MUST'},
+  ].freeze
+
+  # Group types, per HostVmGroup.HostVmGroupType (morpheus-ui rc-9.1.0,
+  # morpheus-domains/grails-app/domain/com/morpheus/HostVmGroup.groovy).
+  # SITE_GROUP exists in the enum but is not valid on either side of a combined
+  # VM-to-Host rule -- AffinityGroupService.applyRuleShapeFields rejects it.
+  HOST_VM_GROUP_TYPES = [
+    {'name' => 'Site Group', 'value' => 'SITE_GROUP'},
+    {'name' => 'Host Group', 'value' => 'HOST_GROUP'},
+    {'name' => 'VM Group',   'value' => 'VM_GROUP'},
+  ].freeze
+
+  def affinity_type_select_options
+    AFFINITY_TYPES.map {|it| it.dup }
+  end
+
+  def host_vm_group_type_select_options
+    HOST_VM_GROUP_TYPES.map {|it| it.dup }
+  end
+
+  # affinityType is editable on update as well as create.
+  # AffinityGroupService.updateAffinityGroup applies params.affinityGroup.affinityType,
+  # so callers may switch between MUST and non-MUST behaviour during an edit.
+  def affinity_type_option_type(required: false, default: nil)
+    opt = {
+      'fieldName'     => 'affinityType',
+      'fieldLabel'    => 'Type',
+      'type'          => 'select',
+      'selectOptions' => affinity_type_select_options,
+      'description'   => 'Affinity type. The _MUST variants are mandatory placement constraints.',
+    }
+    opt['required']     = true    if required
+    opt['defaultValue'] = default if default
+    opt
+  end
+
+  def host_vm_group_type_option_type(required: false, default: nil)
+    opt = {
+      'fieldName'     => 'type',
+      'fieldLabel'    => 'Group Type',
+      'type'          => 'select',
+      'selectOptions' => host_vm_group_type_select_options,
+      'description'   => 'Choose group type.',
+    }
+    opt['required']     = true    if required
+    opt['defaultValue'] = default if default
+    opt
+  end
+
+  def format_affinity_type(affinity_type)
+    found = AFFINITY_TYPES.find {|it| it['value'] == affinity_type.to_s }
+    found ? found['name'].sub(' (Should)', '') : affinity_type.to_s
+  end
+
+  def format_host_vm_group_type(type)
+    found = HOST_VM_GROUP_TYPES.find {|it| it['value'] == type.to_s }
+    found ? found['name'] : type.to_s
+  end
+
+  # Groups carry poolId; keep only those in the chosen cluster.
+  def filter_by_pool(rows, pool_id)
+    return rows if pool_id.nil?
+    rows.select {|r| r['poolId'].nil? || r['poolId'].to_s == pool_id.to_s }
+  end
+
+  # Surface the server's own error text for affinity failures.
+  #
+  # The API returns {success:false, msg:"<human text>", errors:{<field>:"<i18n key>"}}
+  # -- there is no top-level errorCode. AffinityGroupService and
+  # VmwareComputeService.combinedRuleGroupSyncGuard already compose actionable
+  # messages (cross-cluster group refs, groups not yet synced to vSphere, rule
+  # shape violations), so print them verbatim rather than restating them here.
+  def handle_affinity_rest_exception(e, options)
+    if e.respond_to?(:response) && e.response
+      begin
+        body = JSON.parse(e.response.to_s)
+        if body.is_a?(Hash) && (body['msg'] || body['errors'])
+          print_red_alert body['msg'] if body['msg']
+          errors = body['errors']
+          if errors.is_a?(Hash) && !errors.empty?
+            # Same stream as print_red_alert, so msg and field detail stay together.
+            errors.each do |field, message|
+              $stderr.print "#{red}  #{field}: #{message}#{reset}\n"
+            end
+          end
+          return
+        end
+      rescue TypeError, JSON::ParserError
+        # fall through to the generic handler
+      end
+    end
+    print_rest_exception(e, options)
+  end
+
+end