Class: Morpheus::Cli::TenantsCommand

Inherits:
Object
  • Object
show all
Includes:
AccountsHelper, CliCommand
Defined in:
lib/morpheus/cli/commands/tenants_command.rb

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from AccountsHelper

#account_column_definitions, #account_users_interface, #accounts_interface, #find_account_by_id, #find_account_by_name, #find_account_by_name_or_id, #find_account_from_options, #find_all_user_ids, #find_role_by_id, #find_role_by_name, #find_role_by_name_or_id, #find_user_by_id, #find_user_by_username, #find_user_by_username_or_id, #find_user_group_by_id, #find_user_group_by_name, #find_user_group_by_name_or_id, #format_access_string, #format_role_type, #format_user_role_names, #format_user_status, #get_access_color, #get_access_string, included, #list_account_column_definitions, #list_user_column_definitions, #list_user_group_column_definitions, #role_column_definitions, #roles_interface, #subtenant_role_column_definitions, #user_column_definitions, #user_group_column_definitions, #user_groups_interface

Methods included from CliCommand

#add_query_parameter, #apply_options, #build_common_options, #build_get_options, #build_list_options, #build_option_type_options, #build_standard_add_many_options, #build_standard_add_options, #build_standard_api_options, #build_standard_delete_options, #build_standard_get_options, #build_standard_list_options, #build_standard_post_options, #build_standard_put_options, #build_standard_remove_options, #build_standard_update_options, #command_description, #command_name, #confirm, #confirm!, #default_refresh_interval, #default_sigdig, #default_subcommand, #establish_remote_appliance_connection, #execute_api, #execute_api_payload, #execute_api_request, #find_all, #find_all_json, #find_by_id, #find_by_name, #find_by_name_or_id, #find_record, #find_record_json, #full_command_usage, #get_interface, #get_list_key, #get_object_key, #get_subcommand_description, #handle_each_payload, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_array, #parse_bytes_param, #parse_get_options!, #parse_id_list, #parse_labels, #parse_list_options, #parse_list_options!, #parse_list_subtitles, #parse_options, #parse_parameter_as_resource_id!, #parse_passed_options, #parse_payload, #parse_query_options, #print, #print_error, #println, #prog_name, #puts, #puts_error, #raise_args_error, #raise_command_error, #render_response, #run_command_for_each_arg, #subcommand_aliases, #subcommand_description, #subcommand_usage, #subcommands, #usage, #validate_outfile, #verify_args!, #visible_subcommands

Constructor Details

#initialize ⇒ TenantsCommand

Returns a new instance of TenantsCommand.



15
16
17
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 15

def initialize()
  @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
end

Instance Method Details

#_get(id, options = {}) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 121

def _get(id, options={})
  args = [id] # heh
  @accounts_interface.setopts(options)
  if options[:dry_run]
    if args[0].to_s =~ /\A\d{1,}\Z/
      print_dry_run @accounts_interface.dry.get(args[0].to_i)
    else
      print_dry_run @accounts_interface.dry.list({name:args[0]})
    end
    return
  end
   = (args[0])
  exit 1 if .nil?

  json_response = {'account' => }
  render_result = render_with_format(json_response, options, 'account')
  return 0 if render_result

  print_h1 "Tenant Details", [], options
  
  print_description_list(, , options)

  print reset,"\n"
  return 0
  
end

#account_groups(args) ⇒ Object 



30
31
32
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 30

def (args)
  Morpheus::Cli::AccountGroupsCommand.new.handle(args)
end

#add(args) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 149

def add(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_option_type_options(opts, options, )
    build_standard_add_options(opts, options)
    opts.footer = <<-EOT
Create a new tenant.
[name] is required. Name
[role] is required. Base Role name or ID
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:0, max:2)
  options[:options]['name'] = args[0] if args[0]
  #options[:options]['role'] = {'id' => args[1]} if args[1]
  connect(options)
  
  object_key = 'account' # 'tenant' someday
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({object_key => parse_passed_options(options)})
  else
    payload.deep_merge!({object_key => parse_passed_options(options)})
    v_prompt = Morpheus::Cli::OptionTypes.prompt(, options[:options], @api_client, options[:params])
    payload.deep_merge!({object_key => v_prompt})
  end
  @accounts_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @accounts_interface.dry.create(payload)
    return
  end
  json_response = @accounts_interface.create(payload)
  render_response(json_response, options, object_key) do
     = json_response[object_key]
    print_green_success "Tenant #{['name']} added"
    return _get(["id"], options)
  end
end

#connect(opts) ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 19

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @account_users_interface = @api_client.
  @accounts_interface = @api_client.accounts
  @roles_interface = @api_client.roles
end

#count(args) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 72

def count(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[options]")
    build_common_options(opts, options, [:query, :remote, :dry_run])
    opts.footer = "Get the number of tenants."
  end
  optparse.parse!(args)
  connect(options)
  begin
    params = {}
    params.merge!(parse_list_options(options))
    @accounts_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @accounts_interface.dry.list(params)
      return
    end
    json_response = @accounts_interface.list(params)
    # print number only
    if json_response['meta'] && json_response['meta']['total']
      print cyan, json_response['meta']['total'], reset, "\n"
    else
      print yellow, "unknown", reset, "\n"
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#get(args) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 102

def get(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[tenant]")
    build_standard_get_options(opts, options)
    opts.footer = <<-EOT
Get details about a tenant (account).
[tenant] is required. This is the name or id of a tenant. Supports 1-N arguments.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:1)
  connect(options)
  id_list = parse_id_list(args)
  return run_command_for_each_arg(id_list) do |arg|
    _get(arg, options)
  end
end

#handle(args) ⇒ Object 



26
27
28
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 26

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 34

def list(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[search phrase]")
    build_standard_list_options(opts, options)
    opts.footer = "List tenants."
  end
  optparse.parse!(args)
  # verify_args!(args:args, optparse:optparse, count:0)
  options[:phrase] = args.join(" ") if args.count > 0
  connect(options)

  params = {}
  params.merge!(parse_list_options(options))
  @accounts_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @accounts_interface.dry.list(params)
    return 0, nil
  end
  json_response = @accounts_interface.list(params)
  render_response(json_response, options, "accounts") do
    accounts = json_response['accounts']
    title = "Morpheus Tenants"
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 title, subtitles
    if accounts.empty?
      print cyan,"No tenants found.",reset,"\n"
    else
      print cyan
      print as_pretty_table(accounts, , options)
      print_results_pagination(json_response)
    end
    print reset,"\n"
  end
  return 0, nil
end

#remove(args) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 243

def remove(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[tenant]")
    opts.on('--remove-resources [on|off]', ['on','off'], "Remove Associated Instances. Default is off.") do |val|
      params[:removeResources] = val.nil? ? 'on' : val
    end
    build_standard_remove_options(opts, options)
    opts.footer = <<-EOT
Delete a tenant.
[tenant] is required. This is the name or id of a tenant.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  optparse.parse!(args)
  connect(options)
  begin
    # allow finding by ID since name is not unique!
     = (args[0])
    return 1, "tenant not found" if .nil?
    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the tenant #{['name']}?")
      return 9, "aborted command"
    end
    @accounts_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @accounts_interface.dry.destroy(['id'], params)
      return
    end
    json_response = @accounts_interface.destroy(['id'], params)
    render_response(json_response, options) do
      print_green_success "Tenant #{['name']} removed"
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#update(args) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/morpheus/cli/commands/tenants_command.rb', line 191

def update(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[tenant]")
    build_option_type_options(opts, options, )
    opts.on('--active [on|off]', String, "Can be used to disable a tenant") do |val|
      options[:options]['active'] = val.to_s.empty? || val.to_s == 'on' || val.to_s == 'true'
    end
    build_standard_update_options(opts, options)
    opts.footer = <<-EOT
Update an existing tenant.
[tenant] is required. Tenant name or ID
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)

   = (args[0])
  return [1, "account not found"] if .nil?
  object_key = 'account' # 'tenant' someday
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({object_key => parse_passed_options(options)})
  else
    payload.deep_merge!({object_key => parse_passed_options(options)})
    v_prompt = Morpheus::Cli::OptionTypes.prompt(, options[:options].merge(:no_prompt => true), @api_client, options[:params])
    payload.deep_merge!({object_key => v_prompt})
    # remove empty role object.. todo: prompt() or deep_compact! needs to  handle this! 
    if payload[object_key]['role'] && payload[object_key]['role'].empty?
      payload[object_key].delete('role')
    end
    if payload[object_key].empty?
      raise_command_error "Specify at least one option to update.\n#{optparse}"
    end
  end
  @accounts_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @accounts_interface.dry.update(['id'], payload)
    return
  end
  json_response = @accounts_interface.update(['id'], payload)
  render_response(json_response, options, object_key) do
     = json_response[object_key]
    print_green_success "Tenant #{['name']} updated"
    return _get(["id"], options)
  end
end