morpheus-cli 5.4.0 → 5.4.1

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

@@ -17,7 +17,8 @@ class Morpheus::Cli::Remote
 
   set_default_subcommand :list
 
-  set_subcommands_hidden :setup # this is going away too
+  set_subcommands_hidden :setup # moved to 'setup'
+  set_subcommands_hidden :view # moved to 'view'
 
   def initialize()
     @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
@@ -895,6 +896,7 @@ EOT
   end
 
   def view(args)
+    print_error "#{yellow}DEPRECATION WARNING: `remote view` has been deprecated and replaced with `view`. Please use `view` instead.#{reset}\n"
     options = {}
     path = "/"
     no_auth = false
@@ -903,7 +905,7 @@ EOT
       opts.on('--path PATH', String, "Specify a path to load. eg '/logs'" ) do |val|
         path = val
       end
-      opts.on('--no-auth PATH', String, "Do not attempt to login with access token." ) do |val|
+      opts.on('--no-auth', "Do not attempt to login with access token." ) do |val|
         no_auth = true
       end
       build_common_options(opts, options, [:dry_run])

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

@@ -20,7 +20,7 @@ class Morpheus::Cli::Roles
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
     @whoami_interface = @api_client.whoami
-    @users_interface = @api_client.users
+    @account_users_interface = @api_client.account_users
     @accounts_interface = @api_client.accounts
     @roles_interface = @api_client.roles
     @groups_interface = @api_client.groups

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

@@ -723,10 +723,10 @@ class Morpheus::Cli::Shell
       end
       if options[:show_pagination]
         if options[:phrase] || options[:sort] || options[:direction] || options[:offset]
-          print_results_pagination({:meta => history_result[:meta]})
+          print_results_pagination(history_result[:meta])
         else
           # default order is weird, it's the last page of results, 1-25 is misleading and showing the indexes is stranger
-          print_results_pagination({:meta => history_result[:meta]}, {:message =>"Viewing most recent %{size} of %{total} %{label}"})
+          print_results_pagination(history_result[:meta], {:message =>"Viewing most recent %{size} of %{total} %{label}"})
         end
         print reset, "\n"
       else

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

@@ -0,0 +1,50 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::StorageServerTypes
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::RestCommand
+  include Morpheus::Cli::StorageServersHelper
+
+  set_command_description "View storage server types"
+  set_command_name :'storage-server-types'
+  register_subcommands :list, :get
+
+  # register_interfaces :storage_server_types
+
+  protected
+
+  def storage_server_type_list_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Code" => 'code',
+      "Description" => 'description',
+    }
+  end
+
+  def storage_server_type_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Code" => 'code',
+      "Description" => 'description',
+      "Creatable" => lambda {|it| format_boolean(it['creatable']) },
+      "Create Namespaces" => lambda {|it| format_boolean(it['createNamespaces']) },
+      "Create Groups" => lambda {|it| format_boolean(it['createGroups']) },
+      "Create Hosts" => lambda {|it| format_boolean(it['createHosts']) },
+      "Create Disks" => lambda {|it| format_boolean(it['createDisks']) },
+      "Has Namespaces" => lambda {|it| format_boolean(it['hasNamespaces']) },
+      "Has Groups" => lambda {|it| format_boolean(it['hasGroups']) },
+      "Has Hosts" => lambda {|it| format_boolean(it['hasHosts']) },
+      "Has Disks" => lambda {|it| format_boolean(it['hasDisks']) },
+      "Has File Browser" => lambda {|it| format_boolean(it['hasFileBrowser']) },
+    }
+  end
+
+  # overridden to support name or code
+  def find_storage_server_type_by_name_or_id(name)
+    storage_server_type_for_name_or_id(name)
+  end
+
+end
+

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

@@ -0,0 +1,122 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::StorageServers
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::RestCommand
+  include Morpheus::Cli::StorageServersHelper
+
+  set_command_name :'storage-servers'
+  set_command_description "View and manage storage servers."
+  register_subcommands :list, :get, :add, :update, :remove
+
+  # RestCommand settings
+  register_interfaces :storage_servers, :storage_server_types
+  set_rest_has_type true
+  # set_rest_type :storage_server_types
+
+  def render_response_for_get(json_response, options)
+    render_response(json_response, options, rest_object_key) do
+      record = json_response[rest_object_key]
+      print_h1 rest_label, [], options
+      print cyan
+      print_description_list(rest_column_definitions(options), record, options)
+      # show Storage Server Configuration
+      config = record['config']
+      if config && !config.empty?
+        print_h2 "Configuration"
+        print_description_list(config.keys, config)
+      end
+      print reset,"\n"
+    end
+  end
+
+  protected
+
+  def storage_server_list_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Type" => lambda {|it| it['type'] ? it['type']['name'] : '' },
+      "Service URL" => lambda {|it| it['serviceUrl'] },
+      "Tenants" => lambda {|it| 
+        if it['tenants'] && !it['tenants'].empty?
+          it['tenants'].collect {|account| account['name'] }.join(', ')
+        else
+          it['owner'] ? it['owner']['name'] : (it['account'] ? it['account']['name'] : nil)
+        end
+      },
+      "Status" => lambda {|it| format_storage_server_status(it) },
+    }
+  end
+
+  def storage_server_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Description" => 'description',
+      "Type" => lambda {|it| it['type'] ? it['type']['name'] : '' },
+      "Service URL" => lambda {|it| it['serviceUrl'] },
+      "Service Username" => lambda {|it| it['serviceUsername'] },
+      "Tenants" => lambda {|it| it['tenants'].collect {|account| account['name'] }.join(', ') },
+      "Owner" => lambda {|it| it['owner'] ? it['owner']['name'] : (it['account'] ? it['account']['name'] : nil) },
+      "Enabled" => lambda {|it| format_boolean(it['enabled']) },
+      "Status" => lambda {|it| format_storage_server_status(it) },
+      "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+      "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) }
+    }
+  end
+
+  # overridden to work with name or code
+  # nope, api works with name=code now too
+  # def find_storage_server_type_by_name_or_id(name)
+  #   storage_server_type_for_name_or_id(name)
+  # end
+
+  def add_storage_server_option_types()
+    [
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true},
+      {'fieldName' => 'description', 'fieldLabel' => 'Description', 'type' => 'text', 'required' => false},
+      {'fieldName' => 'enabled', 'fieldLabel' => 'Enabled', 'type' => 'checkbox', 'required' => false, 'defaultValue' => true},
+#      {'fieldName' => 'type', 'fieldLabel' => 'Storage Server Type', 'type' => 'select', 'optionSource' => 'storageServerTypes', 'required' => true},
+    ]
+  end
+
+  def add_storage_server_advanced_option_types()
+    [
+      {'fieldName' => 'visibility', 'fieldLabel' => 'Visibility', 'fieldGroup' => 'Advanced', 'type' => 'select', 'selectOptions' => [{'name' => 'Private', 'value' => 'private'},{'name' => 'Public', 'value' => 'public'}], 'required' => false, 'description' => 'Visibility', 'category' => 'permissions'},
+      {'fieldName' => 'tenants', 'fieldLabel' => 'Tenants', 'fieldGroup' => 'Advanced', 'type' => 'multiSelect', 'optionSource' => lambda { |api_client, api_params| 
+        api_client.options.options_for_source("allTenants", {})['data']
+      }},
+    ]
+  end
+
+  def update_storage_server_option_types()
+    [
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text'},
+      {'fieldName' => 'description', 'fieldLabel' => 'Description', 'type' => 'text'},
+      {'fieldName' => 'enabled', 'fieldLabel' => 'Enabled', 'type' => 'checkbox'},
+    ]
+  end
+
+  def update_storage_server_advanced_option_types()
+    add_storage_server_advanced_option_types()
+  end
+
+  def format_storage_server_status(storage_server, return_color=cyan)
+    out = ""
+    status_string = storage_server['status']
+    if storage_server['enabled'] == false
+      out << "#{red}DISABLED#{return_color}"
+    elsif status_string.nil? || status_string.empty? || status_string == "unknown"
+      out << "#{white}UNKNOWN#{return_color}"
+    elsif status_string == 'ok'
+      out << "#{green}#{status_string.upcase}#{return_color}"
+    elsif status_string == 'syncing'
+      out << "#{yellow}#{status_string.upcase}#{return_color}"
+    else
+      out << "#{red}#{status_string ? status_string.upcase : 'N/A'}#{storage_server['statusMessage'] ? "#{return_color} - #{storage_server['statusMessage']}" : ''}#{return_color}"
+    end
+    out
+  end
+
+end

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

@@ -0,0 +1,50 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::StorageVolumeTypes
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::RestCommand
+  include Morpheus::Cli::StorageVolumesHelper
+
+  set_command_name :'storage-volume-types'
+  register_subcommands :list, :get
+
+  # register_interfaces :storage_volume_types
+
+  protected
+
+  def build_list_options(opts, options, params)
+    opts.on('--name VALUE', String, "Filter by name") do |val|
+      params['name'] = val
+    end
+    opts.on('--category VALUE', String, "Filter by category") do |val|
+      params['category'] = val
+    end
+    # build_standard_list_options(opts, options)
+    super
+  end
+
+  def storage_volume_type_list_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Code" => 'code',
+      "Description" => 'description',
+    }
+  end
+
+  def storage_volume_type_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Code" => 'code',
+      "Description" => 'description',
+    }
+  end
+
+  # overridden to support name or code
+  def find_storage_volume_type_by_name_or_id(name)
+    storage_volume_type_for_name_or_id(name)
+  end
+
+end
+

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

@@ -0,0 +1,103 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::StorageVolumes
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::RestCommand
+  include Morpheus::Cli::StorageVolumesHelper
+
+  set_command_name :'storage-volumes'
+  set_command_description "View and manage storage volumes."
+  register_subcommands %w{list get add remove}
+
+  # RestCommand settings
+  register_interfaces :storage_volumes, :storage_volume_types
+  set_rest_has_type true
+
+  protected
+
+  def build_list_options(opts, options, params)
+    opts.on('--storage-server VALUE', String, "Storage Server Name or ID") do |val|
+      options[:storage_server] = val
+    end
+    opts.on('-t', '--type TYPE', "Filter by type") do |val|
+      params['type'] = val
+    end
+    opts.on('--name VALUE', String, "Filter by name") do |val|
+      params['name'] = val
+    end
+    opts.on('--category VALUE', String, "Filter by category") do |val|
+      params['category'] = val
+    end
+    # build_standard_list_options(opts, options)
+    super
+  end
+
+  def parse_list_options!(args, options, params)
+    parse_parameter_as_resource_id!(:storage_server, options, params)
+    super
+  end
+
+  def storage_volume_list_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Type" => lambda {|it| it['type'] ? it['type']['name'] : '' },
+      "Source" => lambda {|it| format_storage_volume_source(it) },
+      "Storage" => lambda {|it| format_bytes(it['maxStorage']) },
+      "Status" => lambda {|it| format_storage_volume_status(it) },
+    }
+  end
+
+  def storage_volume_column_definitions(options)
+    {
+      "ID" => 'id',
+      "Name" => 'name',
+      "Description" => 'description',
+      "Type" => lambda {|it| it['type'] ? it['type']['name'] : '' },
+      "Owner" => lambda {|it| it['owner'] ? it['owner']['name'] : (it['account'] ? it['account']['name'] : nil) },
+      "Cloud" => lambda {|it| it['zone']['name'] rescue '' },
+      "Datastore" => lambda {|it| it['datastore']['name'] rescue '' },
+      "Storage Group" => lambda {|it| it['storageGroup']['name'] rescue '' },
+      "Storage Server" => lambda {|it| it['storageServer']['name'] rescue '' },
+      "Source" => lambda {|it| format_storage_volume_source(it) },
+      "Storage" => lambda {|it| format_bytes(it['maxStorage']) },
+      "Status" => lambda {|it| format_storage_volume_status(it) },
+    }
+  end
+
+  # overridden to work with name or code
+  # nope, api works with name=code now too
+  # def find_storage_volume_type_by_name_or_id(name)
+  #   storage_volume_type_for_name_or_id(name)
+  # end
+
+  def add_storage_volume_option_types()
+    [
+      {'fieldContext' => 'storageServer', 'fieldName' => 'id', 'fieldLabel' => 'Storage Server', 'type' => 'select', 'optionSource' => 'storageServers', 'optionParams' => {'createType' => 'block'}, 'required' => true},
+      {'fieldContext' => 'storageGroup', 'fieldName' => 'id', 'fieldLabel' => 'Storage Group', 'type' => 'select', 'optionSource' => 'storageGroups', 'required' => true},
+      {'shorthand' => '-t', 'fieldName' => 'type', 'fieldLabel' => 'Storage Volume Type', 'type' => 'select', 'optionSource' => 'storageVolumeTypes', 'required' => true},
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text', 'required' => true},
+    ]
+  end
+
+  def update_storage_volume_option_types()
+    [
+      {'fieldName' => 'name', 'fieldLabel' => 'Name', 'type' => 'text'},
+    ]
+  end
+
+  def load_option_types_for_storage_volume(type_record, parent_record)
+    storage_volume_type = type_record
+    option_types = storage_volume_type['optionTypes']
+    # ughhh, all this to change a label for API which uses bytes and not MB
+    if option_types
+      size_option_type = option_types.find {|it| it['fieldName'] == 'maxStorage' }
+      if size_option_type
+        #size_option_type['fieldLabel'] = "Volume Size (bytes)"
+        size_option_type['fieldAddOn'] = "bytes"
+      end
+    end
+    return option_types
+  end
+
+end

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

@@ -18,7 +18,7 @@ class Morpheus::Cli::TenantsCommand
 
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
-    @users_interface = @api_client.users
+    @account_users_interface = @api_client.account_users
     @accounts_interface = @api_client.accounts
     @roles_interface = @api_client.roles
   end

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

@@ -12,7 +12,7 @@ class Morpheus::Cli::UserGroupsCommand
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
     @user_groups_interface = @api_client.user_groups
-    @users_interface = @api_client.users
+    @account_users_interface = @api_client.account_users
     @accounts_interface = @api_client.accounts
   end
 

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

@@ -17,7 +17,8 @@ class Morpheus::Cli::UserSettingsCommand
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
     @user_settings_interface = @api_client.user_settings
-    @users_interface = @api_client.users
+    @accounts_interface = @api_client.accounts
+    @account_users_interface = @api_client.account_users
   end
 
   def handle(args)

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

@@ -21,7 +21,7 @@ class Morpheus::Cli::UserSourcesCommand
     @api_client = establish_remote_appliance_connection(opts)
     @user_sources_interface = @api_client.user_sources
     @accounts_interface = @api_client.accounts
-    @users_interface = @api_client.users
+    @account_users_interface = @api_client.account_users
   end
 
   def handle(args)

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

@@ -15,7 +15,7 @@ class Morpheus::Cli::Users
 
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
-    @users_interface = @api_client.users
+    @account_users_interface = @api_client.account_users
     @accounts_interface = @api_client.accounts
     @roles_interface = @api_client.roles
   end
@@ -55,12 +55,12 @@ class Morpheus::Cli::Users
     account_id = account ? account['id'] : nil
     params['global'] = true if options[:global]
     params.merge!(parse_list_options(options))
-    @users_interface.setopts(options)
+    @account_users_interface.setopts(options)
     if options[:dry_run]
-      print_dry_run @users_interface.dry.list(account_id, params)
+      print_dry_run @account_users_interface.dry.list(account_id, params)
       return 0, nil
     end
-    json_response = @users_interface.list(account_id, params)
+    json_response = @account_users_interface.list(account_id, params)
     render_response(json_response, options, "users") do
       users = json_response['users']
       title = "Morpheus Users"
@@ -103,12 +103,12 @@ class Morpheus::Cli::Users
       account_id = account ? account['id'] : nil
       params['global'] = true if options[:global]
       params.merge!(parse_list_options(options))
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.list(account_id, params)
+        print_dry_run @account_users_interface.dry.list(account_id, params)
         return
       end
-      json_response = @users_interface.list(account_id, params)
+      json_response = @account_users_interface.list(account_id, params)
       # print number only
       if json_response['meta'] && json_response['meta']['total']
         print cyan, json_response['meta']['total'], reset, "\n"
@@ -195,12 +195,12 @@ EOT
     account = find_account_from_options(options)
     account_id = account ? account['id'] : nil
     params['global'] = true if options[:global]
-    @users_interface.setopts(options)
+    @account_users_interface.setopts(options)
     if options[:dry_run]
       if args[0].to_s =~ /\A\d{1,}\Z/
-        print_dry_run @users_interface.dry.get(account_id, args[0].to_i, params)
+        print_dry_run @account_users_interface.dry.get(account_id, args[0].to_i, params)
       else
-        print_dry_run @users_interface.dry.list(account_id, params.merge({username: args[0]}))
+        print_dry_run @account_users_interface.dry.list(account_id, params.merge({username: args[0]}))
       end
       return
     end
@@ -213,7 +213,7 @@ EOT
       user_id = user['id']
     end
     # always get by id, index does not return 'access'
-    json_response = @users_interface.get(account_id, user_id, params)
+    json_response = @account_users_interface.get(account_id, user_id, params)
     user = json_response['user']
     render_response(json_response, options, "user") do
       is_tenant_account = current_account['id'] != user['account']['id']
@@ -223,7 +223,7 @@ EOT
 
       # backward compatibility
       if user['access'].nil? && options[:include_features_access]
-        user_feature_permissions_json = @users_interface.feature_permissions(account_id, user['id'])
+        user_feature_permissions_json = @account_users_interface.feature_permissions(account_id, user['id'])
         user_feature_permissions = user_feature_permissions_json['permissions'] || user_feature_permissions_json['featurePermissions']
 
         if user_feature_permissions
@@ -308,15 +308,15 @@ EOT
       params['global'] = true if options[:global]
       user = find_user_by_username_or_id(account_id, args[0], params)
       return 1 if user.nil?
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.permissions(account_id, user['id'])
+        print_dry_run @account_users_interface.dry.permissions(account_id, user['id'])
         return
       end
 
       is_tenant_account = current_account['id'] != user['account']['id']
 
-      json_response = @users_interface.permissions(account_id, user['id'])
+      json_response = @account_users_interface.permissions(account_id, user['id'])
 
       # backward compatibility
       if !json_response['permissions'].nil?
@@ -460,12 +460,12 @@ EOT
         puts as_json(payload, options)
         return 0
       end
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.create(account_id, payload)
+        print_dry_run @account_users_interface.dry.create(account_id, payload)
         return
       end
-      json_response = @users_interface.create(account_id, payload)
+      json_response = @account_users_interface.create(account_id, payload)
       if options[:json]
         print JSON.pretty_generate(json_response)
         print "\n"
@@ -545,12 +545,12 @@ EOT
         end
       end
 
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.update(account_id, user['id'], payload)
+        print_dry_run @account_users_interface.dry.update(account_id, user['id'], payload)
         return
       end
-      json_response = @users_interface.update(account_id, user['id'], payload)
+      json_response = @account_users_interface.update(account_id, user['id'], payload)
       user = json_response['user']
       if options[:json]
         print JSON.pretty_generate(json_response)
@@ -645,12 +645,12 @@ EOT
       }
 
     end
-    @users_interface.setopts(options)
+    @account_users_interface.setopts(options)
     if options[:dry_run]
-      print_dry_run @users_interface.dry.update(account_id, user['id'], payload)
+      print_dry_run @account_users_interface.dry.update(account_id, user['id'], payload)
       return
     end
-    json_response = @users_interface.update(account_id, user['id'], payload)
+    json_response = @account_users_interface.update(account_id, user['id'], payload)
     render_response(json_response, optparse, "user") do
       print_green_success "Updated password for user #{user['username']}"
     end
@@ -684,12 +684,12 @@ EOT
       unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the user #{user['username']}?")
         exit 9, "arborted"
       end
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.destroy(account_id, user['id'])
+        print_dry_run @account_users_interface.dry.destroy(account_id, user['id'])
         return 0
       end
-      json_response = @users_interface.destroy(account_id, user['id'])
+      json_response = @account_users_interface.destroy(account_id, user['id'])
 
       if options[:json]
         print JSON.pretty_generate(json_response)
@@ -759,7 +759,7 @@ EOT
       end
     end
 
-    available_roles = @users_interface.available_roles(account_id, user_id)['roles']
+    available_roles = @account_users_interface.available_roles(account_id, user_id)['roles']
 
     if available_roles.empty?
       print_red_alert "No available roles found."