Class: Comet::CometServer

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/comet_server.rb

Overview

The CometServer class enables making network requests to the Comet Server API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(server_address, username, password) ⇒ CometServer

Initialize a new CometServer class instance.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/comet/comet_server.rb', line 28

def initialize(server_address, username, password)
  raise TypeError "'server_address' expected String, got #{server_address.class}" unless server_address.is_a? String

  raise TypeError "'username' expected String, got #{username.class}" unless username.is_a? String

  raise TypeError "'password' expected String, got #{password.class}" unless password.is_a? String

  @server_address = server_address
  @username = username
  @password = password

  # Ensure Comet Server URL has a trailing slash
  @server_address += '/' unless server_address.end_with?('/')
end

Instance Attribute Details

#password ⇒ Object

Returns the value of attribute password.



25
26
27
 
# File 'lib/comet/comet_server.rb', line 25

def password
  @password
end

#server_address ⇒ Object

Returns the value of attribute server_address.



19
20
21
 
# File 'lib/comet/comet_server.rb', line 19

def server_address
  @server_address
end

#username ⇒ Object

Returns the value of attribute username.



22
23
24
 
# File 'lib/comet/comet_server.rb', line 22

def username
  @username
end

Instance Method Details

#admin_account_properties ⇒ Comet::AdminAccountPropertiesResponse

AdminAccountProperties

Retrieve properties about the current admin account. Some key parameters are obscured, but the obscured values are safely recognised by the corresponding AdminAccountSetProperties API.

You must supply administrator authentication credentials to use this API.

Returns:



51
52
53
54
55
56
57
58
 
# File 'lib/comet/comet_server.rb', line 51

def 
  body = perform_request('api/v1/admin/account/properties')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::AdminAccountPropertiesResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_account_regenerate_totp ⇒ Comet::TotpRegeneratedResponse

AdminAccountRegenerateTotp

Generate a new TOTP secret. The secret is returned as a ‘data-uri` image of a QR code. The new secret is immediately applied to the current admin account.

You must supply administrator authentication credentials to use this API.

Returns:



68
69
70
71
72
73
74
75
 
# File 'lib/comet/comet_server.rb', line 68

def 
  body = perform_request('api/v1/admin/account/regenerate-totp')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::TotpRegeneratedResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_account_session_revoke ⇒ Comet::CometAPIResponseMessage

AdminAccountSessionRevoke

Revoke a session key (log out).

You must supply administrator authentication credentials to use this API.

Returns:



84
85
86
87
88
89
90
91
 
# File 'lib/comet/comet_server.rb', line 84

def 
  body = perform_request('api/v1/admin/account/session-revoke')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_account_session_start(self_address = nil) ⇒ Comet::SessionKeyRegeneratedResponse

AdminAccountSessionStart

Generate a session key (log in).

You must supply administrator authentication credentials to use this API.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) External URL of this server (used for U2F AppID)

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/comet/comet_server.rb', line 101

def (self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  body = perform_request('api/v1/admin/account/session-start', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::SessionKeyRegeneratedResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_account_session_start_as_user(target_user) ⇒ Comet::SessionKeyRegeneratedResponse

AdminAccountSessionStartAsUser

Generate a session key for an end-user (log in as end-user).

You must supply administrator authentication credentials to use this API.

Parameters:

  • target_user (String) —

    Target account username

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/comet/comet_server.rb', line 127

def (target_user)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user

  body = perform_request('api/v1/admin/account/session-start-as-user', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::SessionKeyRegeneratedResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_account_set_properties(security) ⇒ Comet::CometAPIResponseMessage

AdminAccountSetProperties

Update settings for your own admin account. Updating your account password requires you to supply your current password. To set a new plaintext password, use a password format of 0 (PASSWORD_FORMAT_PLAINTEXT). This API does not currently allow you to modify your TOTP secret or IP whitelist.

You must supply administrator authentication credentials to use this API.

Parameters:

Returns:



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/comet/comet_server.rb', line 152

def (security)
  submit_params = {}
  raise TypeError "'security' expected Comet::AdminSecurityOptions, got #{security.class}" unless security.is_a? Comet::AdminSecurityOptions

  submit_params['Security'] = security.to_json

  body = perform_request('api/v1/admin/account/set-properties', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_account_u2f_request_registration_challenge(self_address) ⇒ Comet::U2FRegistrationChallengeResponse

AdminAccountU2fRequestRegistrationChallenge

Register a new FIDO U2F token.

You must supply administrator authentication credentials to use this API.

Parameters:

  • self_address (String) —

    External URL of this server, used as U2F AppID and Facet

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/comet/comet_server.rb', line 174

def (self_address)
  submit_params = {}
  raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

  submit_params['SelfAddress'] = self_address

  body = perform_request('api/v1/admin/account/u2f/request-registration-challenge', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::U2FRegistrationChallengeResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_account_u2f_submit_challenge_response(u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description) ⇒ Comet::CometAPIResponseMessage

AdminAccountU2fSubmitChallengeResponse

Register a new FIDO U2F token.

You must supply administrator authentication credentials to use this API.

Parameters:

  • u2fchallenge_id (String) —

    Associated value from AdminAccountU2fRequestRegistrationChallenge API

  • u2fclient_data (String) —

    U2F response data supplied by hardware token

  • u2fregistration_data (String) —

    U2F response data supplied by hardware token

  • u2fversion (String) —

    U2F response data supplied by hardware token

  • description (String) —

    Optional description of the token

Returns:



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
 
# File 'lib/comet/comet_server.rb', line 200

def (u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description)
  submit_params = {}
  raise TypeError "'u2fchallenge_id' expected String, got #{u2fchallenge_id.class}" unless u2fchallenge_id.is_a? String

  submit_params['U2FChallengeID'] = u2fchallenge_id
  raise TypeError "'u2fclient_data' expected String, got #{u2fclient_data.class}" unless u2fclient_data.is_a? String

  submit_params['U2FClientData'] = u2fclient_data
  raise TypeError "'u2fregistration_data' expected String, got #{u2fregistration_data.class}" unless u2fregistration_data.is_a? String

  submit_params['U2FRegistrationData'] = u2fregistration_data
  raise TypeError "'u2fversion' expected String, got #{u2fversion.class}" unless u2fversion.is_a? String

  submit_params['U2FVersion'] = u2fversion
  raise TypeError "'description' expected String, got #{description.class}" unless description.is_a? String

  submit_params['Description'] = description

  body = perform_request('api/v1/admin/account/u2f/submit-challenge-response', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_account_validate_totp(totpcode) ⇒ Comet::CometAPIResponseMessage

AdminAccountValidateTotp

Validate the TOTP code before turning 2fa(TOTP) on.

You must supply administrator authentication credentials to use this API.

Parameters:

  • totpcode (String) —

    Six-digit code after scanning barcode image

Returns:



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/comet/comet_server.rb', line 234

def (totpcode)
  submit_params = {}
  raise TypeError "'totpcode' expected String, got #{totpcode.class}" unless totpcode.is_a? String

  submit_params['TOTPCode'] = totpcode

  body = perform_request('api/v1/admin/account/validate-totp', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_add_user(target_user, target_password, store_recovery_code = nil, require_password_change = nil) ⇒ Comet::CometAPIResponseMessage

AdminAddUser

Add a new user account.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    New account username

  • target_password (String) —

    New account password

  • store_recovery_code (Number) (defaults to: nil) —

    (Optional) If set to 1, store and keep a password recovery code for the generated user (>= 18.3.9)

  • require_password_change (Number) (defaults to: nil) —

    (Optional) If set to 1, require to reset password at the first login for the generated user (>= 20.3.4)

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/comet/comet_server.rb', line 260

def admin_add_user(target_user, target_password, store_recovery_code = nil, require_password_change = nil)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'target_password' expected String, got #{target_password.class}" unless target_password.is_a? String

  submit_params['TargetPassword'] = target_password
  unless store_recovery_code.nil?
    raise TypeError "'store_recovery_code' expected Numeric, got #{store_recovery_code.class}" unless store_recovery_code.is_a? Numeric

    submit_params['StoreRecoveryCode'] = store_recovery_code
  end
  unless require_password_change.nil?
    raise TypeError "'require_password_change' expected Numeric, got #{require_password_change.class}" unless require_password_change.is_a? Numeric

    submit_params['RequirePasswordChange'] = require_password_change
  end

  body = perform_request('api/v1/admin/add-user', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_add_user_from_profile(target_user, profile_data) ⇒ Comet::CometAPIResponseMessage

AdminAddUserFromProfile

Add a new user account (with all information). This allows you to create a new account and set all its properties at once (e.g. during account replication). Developers creating a signup form may find it simpler to use the AdminAddUser and AdminGetUserProfile / AdminSetUserProfile APIs separately.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/comet/comet_server.rb', line 298

def admin_add_user_from_profile(target_user, profile_data)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'profile_data' expected Comet::UserProfileConfig, got #{profile_data.class}" unless profile_data.is_a? Comet::UserProfileConfig

  submit_params['ProfileData'] = profile_data.to_json

  body = perform_request('api/v1/admin/add-user-from-profile', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_admin_user_delete(target_user) ⇒ Comet::CometAPIResponseMessage

AdminAdminUserDelete

Delete an administrator.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Parameters:

  • target_user (String) —

    the username of the admin to be deleted

Returns:



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/comet/comet_server.rb', line 325

def admin_admin_user_delete(target_user)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user

  body = perform_request('api/v1/admin/admin-user/delete', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_admin_user_list ⇒ Array<Comet::AllowedAdminUser>

AdminAdminUserList

List administrators.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Returns:

  • (Array<Comet::AllowedAdminUser>) 


348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/comet/comet_server.rb', line 348

def admin_admin_user_list
  body = perform_request('api/v1/admin/admin-user/list')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::AllowedAdminUser.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_admin_user_new(target_user, target_password, target_org_id = nil) ⇒ Comet::CometAPIResponseMessage

AdminAdminUserNew

Add a new administrator.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Parameters:

  • target_user (String) —

    the username for this new admin

  • target_password (String) —

    the password for this new admin user

  • target_org_id (String) (defaults to: nil) —

    (Optional) provide the organization ID for this user, it will default to the org of the authenticating user otherwise

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/comet/comet_server.rb', line 376

def admin_admin_user_new(target_user, target_password, target_org_id = nil)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'target_password' expected String, got #{target_password.class}" unless target_password.is_a? String

  submit_params['TargetPassword'] = target_password
  unless target_org_id.nil?
    raise TypeError "'target_org_id' expected String, got #{target_org_id.class}" unless target_org_id.is_a? String

    submit_params['TargetOrgID'] = target_org_id
  end

  body = perform_request('api/v1/admin/admin-user/new', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_branding_available_platforms ⇒ Hash{Number => Comet::AvailableDownload}

AdminBrandingAvailablePlatforms

List available software download platforms.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Returns:



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/comet/comet_server.rb', line 407

def admin_branding_available_platforms
  body = perform_request('api/v1/admin/branding/available-platforms')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::AvailableDownload.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_branding_generate_client_by_platform(platform, self_address = nil) ⇒ String

AdminBrandingGenerateClientByPlatform

Download software.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • platform (Number) —

    The selected download platform, from the AdminBrandingAvailablePlatforms API

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/comet/comet_server.rb', line 434

def admin_branding_generate_client_by_platform(platform, self_address = nil)
  submit_params = {}
  raise TypeError "'platform' expected Numeric, got #{platform.class}" unless platform.is_a? Numeric

  submit_params['Platform'] = platform
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/by-platform', submit_params)
end

#admin_branding_generate_client_linuxgeneric(self_address = nil) ⇒ String

AdminBrandingGenerateClientLinuxgeneric

Download software (Linux Server .run).

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/comet/comet_server.rb', line 460

def admin_branding_generate_client_linuxgeneric(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/linuxgeneric', submit_params)
end

#admin_branding_generate_client_macos_x8664(self_address = nil) ⇒ String

AdminBrandingGenerateClientMacosX8664

Download software (macOS x86_64 pkg).

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/comet/comet_server.rb', line 483

def admin_branding_generate_client_macos_x8664(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/macos-x86_64', submit_params)
end

#admin_branding_generate_client_test(platform, self_address = nil) ⇒ Comet::CometAPIResponseMessage

AdminBrandingGenerateClientTest

Check if a software download is available.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • platform (Number) —

    The selected download platform, from the AdminBrandingAvailablePlatforms API

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/comet/comet_server.rb', line 507

def admin_branding_generate_client_test(platform, self_address = nil)
  submit_params = {}
  raise TypeError "'platform' expected Numeric, got #{platform.class}" unless platform.is_a? Numeric

  submit_params['Platform'] = platform
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  body = perform_request('api/v1/admin/branding/generate-client/test', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_branding_generate_client_windows_anycpu_exe(self_address = nil) ⇒ String

AdminBrandingGenerateClientWindowsAnycpuExe

Download software update (Windows AnyCPU exe). The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/comet/comet_server.rb', line 539

def admin_branding_generate_client_windows_anycpu_exe(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/windows-anycpu-exe', submit_params)
end

#admin_branding_generate_client_windows_anycpu_zip(self_address = nil) ⇒ String

AdminBrandingGenerateClientWindowsAnycpuZip

Download software (Windows AnyCPU zip). The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/comet/comet_server.rb', line 563

def admin_branding_generate_client_windows_anycpu_zip(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/windows-anycpu-zip', submit_params)
end

#admin_branding_generate_client_windows_x8632exe(self_address = nil) ⇒ String

AdminBrandingGenerateClientWindowsX8632Exe

Download software update (Windows x86_32 exe). The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/comet/comet_server.rb', line 587

def admin_branding_generate_client_windows_x8632exe(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/windows-x86_32-exe', submit_params)
end

#admin_branding_generate_client_windows_x8632zip(self_address = nil) ⇒ String

AdminBrandingGenerateClientWindowsX8632Zip

Download software (Windows x86_32 zip). The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/comet/comet_server.rb', line 611

def admin_branding_generate_client_windows_x8632zip(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/windows-x86_32-zip', submit_params)
end

#admin_branding_generate_client_windows_x8664exe(self_address = nil) ⇒ String

AdminBrandingGenerateClientWindowsX8664Exe

Download software update (Windows x86_64 exe). The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/comet/comet_server.rb', line 635

def admin_branding_generate_client_windows_x8664exe(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/windows-x86_64-exe', submit_params)
end

#admin_branding_generate_client_windows_x8664zip(self_address = nil) ⇒ String

AdminBrandingGenerateClientWindowsX8664Zip

Download software (Windows x86_64 zip). The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts

Returns:

  • (String) 


659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/comet/comet_server.rb', line 659

def admin_branding_generate_client_windows_x8664zip(self_address = nil)
  submit_params = {}
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  perform_request('api/v1/admin/branding/generate-client/windows-x86_64-zip', submit_params)
end

#admin_bulletin_submit(subject, content) ⇒ Comet::CometAPIResponseMessage

AdminBulletinSubmit

Send an email bulletin to all users.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • subject (String) —

    Bulletin subject line

  • content (String) —

    Bulletin message content

Returns:



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/comet/comet_server.rb', line 682

def admin_bulletin_submit(subject, content)
  submit_params = {}
  raise TypeError "'subject' expected String, got #{subject.class}" unless subject.is_a? String

  submit_params['Subject'] = subject
  raise TypeError "'content' expected String, got #{content.class}" unless content.is_a? String

  submit_params['Content'] = content

  body = perform_request('api/v1/admin/bulletin/submit', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_constellation_last_report ⇒ Comet::ConstellationCheckReport

AdminConstellationLastReport

Get Constellation bucket usage report (cached).

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. This API requires the Constellation Role to be enabled.

Returns:



708
709
710
711
712
713
714
715
 
# File 'lib/comet/comet_server.rb', line 708

def admin_constellation_last_report
  body = perform_request('api/v1/admin/constellation/last-report')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ConstellationCheckReport.new
  ret.from_hash(json_body)
  ret
end

#admin_constellation_new_report ⇒ Comet::ConstellationCheckReport

AdminConstellationNewReport

Get Constellation bucket usage report (regenerate).

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. This API requires the Constellation Role to be enabled.

Returns:



726
727
728
729
730
731
732
733
 
# File 'lib/comet/comet_server.rb', line 726

def admin_constellation_new_report
  body = perform_request('api/v1/admin/constellation/new-report')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ConstellationCheckReport.new
  ret.from_hash(json_body)
  ret
end

#admin_constellation_prune_now ⇒ Comet::CometAPIResponseMessage

AdminConstellationPruneNow

Prune unused buckets.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. This API requires the Constellation Role to be enabled.

Returns:



744
745
746
747
748
749
750
751
 
# File 'lib/comet/comet_server.rb', line 744

def admin_constellation_prune_now
  body = perform_request('api/v1/admin/constellation/prune-now')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_constellation_status ⇒ Comet::ConstellationStatusAPIResponse

AdminConstellationStatus

Get Constellation status.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. This API requires the Constellation Role to be enabled.

Returns:



762
763
764
765
766
767
768
769
 
# File 'lib/comet/comet_server.rb', line 762

def admin_constellation_status
  body = perform_request('api/v1/admin/constellation/status')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ConstellationStatusAPIResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_create_install_token(target_user, target_password, server = nil) ⇒ Comet::InstallTokenResponse

AdminCreateInstallToken

Create token for silent installation (Windows only). Provide the installation token to silently install the client on windows ‘install.exe /TOKEN=<installtoken>`

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

  • target_password (String) —

    Selected account password

  • server (String) (defaults to: nil) —

    (Optional) External URL of the authentication server that is different from the current server

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/comet/comet_server.rb', line 783

def admin_create_install_token(target_user, target_password, server = nil)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'target_password' expected String, got #{target_password.class}" unless target_password.is_a? String

  submit_params['TargetPassword'] = target_password
  unless server.nil?
    raise TypeError "'server' expected String, got #{server.class}" unless server.is_a? String

    submit_params['Server'] = server
  end

  body = perform_request('api/v1/admin/create-install-token', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::InstallTokenResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_delete_user(target_user, uninstall_config = nil) ⇒ Comet::CometAPIResponseMessage

AdminDeleteUser

Delete user account. This does not remove any storage buckets. Unused storage buckets will be cleaned up by the Constellation Role. Any stored data can not be decrypted without the user profile. Misuse can cause data loss! This also allows to uninstall software from active devices under the user account

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

  • uninstall_config (Comet::UninstallConfig) (defaults to: nil) —

    (Optional) Uninstall software configuration (>= 20.3.5)

Returns:



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/comet/comet_server.rb', line 818

def admin_delete_user(target_user, uninstall_config = nil)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  unless uninstall_config.nil?
    raise TypeError "'uninstall_config' expected Comet::UninstallConfig, got #{uninstall_config.class}" unless uninstall_config.is_a? Comet::UninstallConfig

    submit_params['UninstallConfig'] = uninstall_config.to_json
  end

  body = perform_request('api/v1/admin/delete-user', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_disable_user_totp(target_user) ⇒ Comet::CometAPIResponseMessage

AdminDisableUserTotp

Disable user account 2FA(TOTP) authentication.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

Returns:



846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/comet/comet_server.rb', line 846

def admin_disable_user_totp(target_user)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user

  body = perform_request('api/v1/admin/disable-user-totp', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_apply_retention_rules(target_id, destination) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherApplyRetentionRules

Instruct a live connected device to apply retention rules now. This command is understood by Comet Backup 17.6.9 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • destination (String) —

    The Storage Vault GUID

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/comet/comet_server.rb', line 871

def admin_dispatcher_apply_retention_rules(target_id, destination)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination

  body = perform_request('api/v1/admin/dispatcher/apply-retention-rules', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_deepverify_storage_vault(target_id, destination) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherDeepverifyStorageVault

Instruct a live connected device to deeply verify Storage Vault content. This command is understood by Comet Backup 18.8.2 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • destination (String) —

    The Storage Vault GUID

Returns:



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/comet/comet_server.rb', line 899

def admin_dispatcher_deepverify_storage_vault(target_id, destination)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination

  body = perform_request('api/v1/admin/dispatcher/deepverify-storage-vault', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_delete_snapshot(target_id, destination_id, snapshot_id) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherDeleteSnapshot

Instruct a live connected device to delete a stored snapshot.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • destination_id (String) —

    The Storage Vault GUID

  • snapshot_id (String) —

    The backup job snapshot ID to delete

Returns:



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/comet/comet_server.rb', line 927

def admin_dispatcher_delete_snapshot(target_id, destination_id, snapshot_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'destination_id' expected String, got #{destination_id.class}" unless destination_id.is_a? String

  submit_params['DestinationID'] = destination_id
  raise TypeError "'snapshot_id' expected String, got #{snapshot_id.class}" unless snapshot_id.is_a? String

  submit_params['SnapshotID'] = snapshot_id

  body = perform_request('api/v1/admin/dispatcher/delete-snapshot', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_drop_connection(target_id) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherDropConnection

Disconnect a live connected device. The device will almost certainly attempt to reconnect.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/comet/comet_server.rb', line 957

def admin_dispatcher_drop_connection(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/drop-connection', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_import_apply(target_id, import_source_id) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherImportApply

Instruct a live connected device to import settings from an installed product. This command is understood by Comet Backup 17.12.0 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • import_source_id (String) —

    The selected import source, as found by the AdminDispatcherRequestImportSources API

Returns:



982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/comet/comet_server.rb', line 982

def admin_dispatcher_import_apply(target_id, import_source_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'import_source_id' expected String, got #{import_source_id.class}" unless import_source_id.is_a? String

  submit_params['ImportSourceID'] = import_source_id

  body = perform_request('api/v1/admin/dispatcher/import-apply', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_kill_process(target_id) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherKillProcess

Instruct a live connected device to disconnect. The device will terminate its live-connection process and will not reconnect.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/comet/comet_server.rb', line 1009

def admin_dispatcher_kill_process(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/kill-process', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_list_active ⇒ Hash{String => Comet::LiveUserConnection}

AdminDispatcherListActive

List live connected devices.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/comet/comet_server.rb', line 1031

def admin_dispatcher_list_active
  body = perform_request('api/v1/admin/dispatcher/list-active')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::LiveUserConnection.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_dispatcher_refetch_profile(target_id) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherRefetchProfile

Instruct a live connected device to refresh their profile. This command is understood by Comet Backup 17.12.0 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/comet/comet_server.rb', line 1057

def admin_dispatcher_refetch_profile(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/refetch-profile', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_reindex_storage_vault(target_id, destination) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherReindexStorageVault

Instruct a live connected device to rebuild Storage Vault indexes now. This command is understood by Comet Backup 18.6.9 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • destination (String) —

    The Storage Vault GUID

Returns:



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/comet/comet_server.rb', line 1082

def admin_dispatcher_reindex_storage_vault(target_id, destination)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination

  body = perform_request('api/v1/admin/dispatcher/reindex-storage-vault', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_request_browse_disk_drives(target_id) ⇒ Comet::BrowseDiskDrivesResponse

AdminDispatcherRequestBrowseDiskDrives

Request a list of physical disk drive information from a live connected device.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/comet/comet_server.rb', line 1108

def admin_dispatcher_request_browse_disk_drives(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/request-browse-disk-drives', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BrowseDiskDrivesResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_request_browse_exchange_edb(target_id) ⇒ Comet::BrowseEDBResponse

AdminDispatcherRequestBrowseExchangeEdb

Request a list of Exchange EDB databases from a live connected device.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/comet/comet_server.rb', line 1131

def admin_dispatcher_request_browse_exchange_edb(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/request-browse-exchange-edb', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BrowseEDBResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_request_browse_hyperv(target_id) ⇒ Comet::BrowseHVResponse

AdminDispatcherRequestBrowseHyperv

Request a list of Hyper-V virtual machines from a live connected device.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/comet/comet_server.rb', line 1154

def admin_dispatcher_request_browse_hyperv(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/request-browse-hyperv', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BrowseHVResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_request_browse_vss_aaw(target_id) ⇒ Comet::BrowseVSSResponse

AdminDispatcherRequestBrowseVssAaw

Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/comet/comet_server.rb', line 1177

def admin_dispatcher_request_browse_vss_aaw(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/request-browse-vss-aaw', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BrowseVSSResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_request_filesystem_objects(target_id, path = nil) ⇒ Array<Comet::StoredObject>

AdminDispatcherRequestFilesystemObjects

Request a list of filesystem objects from a live connected device. The device must have granted the administrator permission to view its filenames.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • path (String) (defaults to: nil) —

    (Optional) Browse objects inside this path. If empty or not present, returns the top-level device paths

Returns:



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/comet/comet_server.rb', line 1202

def admin_dispatcher_request_filesystem_objects(target_id, path = nil)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  unless path.nil?
    raise TypeError "'path' expected String, got #{path.class}" unless path.is_a? String

    submit_params['Path'] = path
  end

  body = perform_request('api/v1/admin/dispatcher/request-filesystem-objects', submit_params)
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::StoredObject.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_dispatcher_request_import_sources(target_id) ⇒ Comet::DispatcherAdminSourcesResponse

AdminDispatcherRequestImportSources

Request a list of import sources from a live connected device.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

Returns:



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/comet/comet_server.rb', line 1237

def admin_dispatcher_request_import_sources(target_id)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id

  body = perform_request('api/v1/admin/dispatcher/request-import-sources', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::DispatcherAdminSourcesResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil) ⇒ Comet::DispatcherStoredObjectsResponse

AdminDispatcherRequestStoredObjects

Request a list of stored objects inside an existing backup job. The remote device must have given consent for an MSP to browse their files.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • destination (String) —

    The Storage Vault ID

  • snapshot_id (String) —

    The selected backup job snapshot

  • tree_id (String) (defaults to: nil) —

    (Optional) Browse objects inside subdirectory of backup snapshot

Returns:



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
 
# File 'lib/comet/comet_server.rb', line 1264

def admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination
  raise TypeError "'snapshot_id' expected String, got #{snapshot_id.class}" unless snapshot_id.is_a? String

  submit_params['SnapshotID'] = snapshot_id
  unless tree_id.nil?
    raise TypeError "'tree_id' expected String, got #{tree_id.class}" unless tree_id.is_a? String

    submit_params['TreeID'] = tree_id
  end

  body = perform_request('api/v1/admin/dispatcher/request-stored-objects', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::DispatcherStoredObjectsResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_request_vault_snapshots(target_id, destination) ⇒ Comet::DispatcherVaultSnapshotsResponse

AdminDispatcherRequestVaultSnapshots

Request a list of Storage Vault snapshots from a live connected device.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • destination (String) —

    The Storage Vault ID

Returns:



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/comet/comet_server.rb', line 1299

def admin_dispatcher_request_vault_snapshots(target_id, destination)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination

  body = perform_request('api/v1/admin/dispatcher/request-vault-snapshots', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::DispatcherVaultSnapshotsResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_run_backup(target_id, backup_rule) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherRunBackup

Instruct a live connected device to run a scheduled backup.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • backup_rule (String) —

    The schedule GUID

Returns:



1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/comet/comet_server.rb', line 1326

def admin_dispatcher_run_backup(target_id, backup_rule)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'backup_rule' expected String, got #{backup_rule.class}" unless backup_rule.is_a? String

  submit_params['BackupRule'] = backup_rule

  body = perform_request('api/v1/admin/dispatcher/run-backup', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_run_backup_custom(target_id, source, destination, options = nil) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherRunBackupCustom

Instruct a live connected device to run a backup.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • source (String) —

    The Protected Item GUID

  • destination (String) —

    The Storage Vault GUID

  • options (Comet::BackupJobAdvancedOptions) (defaults to: nil) —

    (Optional) Extra job parameters (>= 19.3.6)

Returns:



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/comet/comet_server.rb', line 1355

def admin_dispatcher_run_backup_custom(target_id, source, destination, options = nil)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'source' expected String, got #{source.class}" unless source.is_a? String

  submit_params['Source'] = source
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination
  unless options.nil?
    raise TypeError "'options' expected Comet::BackupJobAdvancedOptions, got #{options.class}" unless options.is_a? Comet::BackupJobAdvancedOptions

    submit_params['Options'] = options.to_json
  end

  body = perform_request('api/v1/admin/dispatcher/run-backup-custom', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_run_restore(target_id, path, source, destination, snapshot = nil, paths = nil) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherRunRestore

Instruct a live connected device to perform a local restore. This command is understood by Comet Backup 17.9.3 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • path (String) —

    The local path to restore to

  • source (String) —

    The Protected Item ID

  • destination (String) —

    The Storage Vault ID

  • snapshot (String) (defaults to: nil) —

    (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair

  • paths (Array<String>) (defaults to: nil) —

    (Optional) If present, restore these paths only. Otherwise, restore all data (>= 19.3.0)

Returns:



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
 
# File 'lib/comet/comet_server.rb', line 1395

def admin_dispatcher_run_restore(target_id, path, source, destination, snapshot = nil, paths = nil)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'path' expected String, got #{path.class}" unless path.is_a? String

  submit_params['Path'] = path
  raise TypeError "'source' expected String, got #{source.class}" unless source.is_a? String

  submit_params['Source'] = source
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination
  unless snapshot.nil?
    raise TypeError "'snapshot' expected String, got #{snapshot.class}" unless snapshot.is_a? String

    submit_params['Snapshot'] = snapshot
  end
  unless paths.nil?
    raise TypeError "'paths' expected Array, got #{paths.class}" unless paths.is_a? Array

    submit_params['Paths'] = paths.to_json
  end

  body = perform_request('api/v1/admin/dispatcher/run-restore', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_run_restore_custom(target_id, source, destination, options, snapshot = nil, paths = nil) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherRunRestoreCustom

Instruct a live connected device to perform a local restore. This command is understood by Comet Backup 18.6.0 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • source (String) —

    The Protected Item ID

  • destination (String) —

    The Storage Vault ID

  • options (Comet::RestoreJobAdvancedOptions) —

    Restore targets

  • snapshot (String) (defaults to: nil) —

    (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair

  • paths (Array<String>) (defaults to: nil) —

    (Optional) If present, restore these paths only. Otherwise, restore all data

Returns:



1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/comet/comet_server.rb', line 1443

def admin_dispatcher_run_restore_custom(target_id, source, destination, options, snapshot = nil, paths = nil)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'source' expected String, got #{source.class}" unless source.is_a? String

  submit_params['Source'] = source
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination
  raise TypeError "'options' expected Comet::RestoreJobAdvancedOptions, got #{options.class}" unless options.is_a? Comet::RestoreJobAdvancedOptions

  submit_params['Options'] = options.to_json
  unless snapshot.nil?
    raise TypeError "'snapshot' expected String, got #{snapshot.class}" unless snapshot.is_a? String

    submit_params['Snapshot'] = snapshot
  end
  unless paths.nil?
    raise TypeError "'paths' expected Array, got #{paths.class}" unless paths.is_a? Array

    submit_params['Paths'] = paths.to_json
  end

  body = perform_request('api/v1/admin/dispatcher/run-restore-custom', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_uninstall_software(target_id, remove_config_file) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherUninstallSoftware

Instruct a live connected device to self-uninstall the software.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • remove_config_file (Boolean) —

    Determine if the config.dat file will be deleted at the same time

Returns:



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/comet/comet_server.rb', line 1486

def admin_dispatcher_uninstall_software(target_id, remove_config_file)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  submit_params['RemoveConfigFile'] = (remove_config_file ? 1 : 0)

  body = perform_request('api/v1/admin/dispatcher/uninstall-software', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_unlock(target_id, destination) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherUnlock

Instruct a live connected device to remove lock files from a Storage Vault. Misuse can cause data loss! This command is understood by Comet Backup 17.9.4 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • destination (String) —

    The Storage Vault GUID

Returns:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/comet/comet_server.rb', line 1513

def admin_dispatcher_unlock(target_id, destination)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'destination' expected String, got #{destination.class}" unless destination.is_a? String

  submit_params['Destination'] = destination

  body = perform_request('api/v1/admin/dispatcher/unlock', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_update_login_url(target_id, new_url) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherUpdateLoginUrl

Instruct a live connected device to update its login server URL. The device will attempt to connect to the new Auth Role Comet Server using its current username and password. If the test connection succeeds, the device migrates its saved connection settings and live connections to the new server. If the device is not registered on the new URL, or if the credentials are incorrect, the device remains on the current Auth Role server.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • new_url (String) —

    The new external URL of this server

Returns:



1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'lib/comet/comet_server.rb', line 1541

def (target_id, new_url)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  raise TypeError "'new_url' expected String, got #{new_url.class}" unless new_url.is_a? String

  submit_params['NewURL'] = new_url

  body = perform_request('api/v1/admin/dispatcher/update-login-url', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_update_software(target_id, self_address = nil) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherUpdateSoftware

Instruct a live connected device to download a software update.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled. This API requires the Software Build Role to be enabled.

Parameters:

  • target_id (String) —

    The live connection GUID

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL of this server, used to resolve conflicts (>= 19.3.11)

Returns:



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
 
# File 'lib/comet/comet_server.rb', line 1569

def admin_dispatcher_update_software(target_id, self_address = nil)
  submit_params = {}
  raise TypeError "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String

  submit_params['TargetID'] = target_id
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  body = perform_request('api/v1/admin/dispatcher/update-software', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_get_job_log(job_id) ⇒ String

AdminGetJobLog

Get the report log entries for a single job, in plaintext format.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • job_id (String) —

    Selected job ID

Returns:

  • (String) 


1599
1600
1601
1602
1603
1604
1605
1606
 
# File 'lib/comet/comet_server.rb', line 1599

def admin_get_job_log(job_id)
  submit_params = {}
  raise TypeError "'job_id' expected String, got #{job_id.class}" unless job_id.is_a? String

  submit_params['JobID'] = job_id

  perform_request('api/v1/admin/get-job-log', submit_params)
end

#admin_get_job_log_entries(job_id) ⇒ Array<Comet::JobEntry>

AdminGetJobLogEntries

Get the report log entries for a single job.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • job_id (String) —

    Selected job ID

Returns:



1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/comet/comet_server.rb', line 1617

def admin_get_job_log_entries(job_id)
  submit_params = {}
  raise TypeError "'job_id' expected String, got #{job_id.class}" unless job_id.is_a? String

  submit_params['JobID'] = job_id

  body = perform_request('api/v1/admin/get-job-log-entries', submit_params)
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::JobEntry.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_get_job_properties(job_id) ⇒ Comet::BackupJobDetail

AdminGetJobProperties

Get properties of a single job.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • job_id (String) —

    Selected job ID

Returns:



1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
 
# File 'lib/comet/comet_server.rb', line 1647

def admin_get_job_properties(job_id)
  submit_params = {}
  raise TypeError "'job_id' expected String, got #{job_id.class}" unless job_id.is_a? String

  submit_params['JobID'] = job_id

  body = perform_request('api/v1/admin/get-job-properties', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BackupJobDetail.new
  ret.from_hash(json_body)
  ret
end

#admin_get_jobs_all ⇒ Array<Comet::BackupJobDetail>

AdminGetJobsAll

Get jobs (All). The jobs are returned in an unspecified order.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
 
# File 'lib/comet/comet_server.rb', line 1670

def admin_get_jobs_all
  body = perform_request('api/v1/admin/get-jobs-all')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::BackupJobDetail.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_get_jobs_for_custom_search(query) ⇒ Array<Comet::BackupJobDetail>

AdminGetJobsForCustomSearch

Get jobs (for custom search). The jobs are returned in an unspecified order.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

Returns:



1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
 
# File 'lib/comet/comet_server.rb', line 1696

def admin_get_jobs_for_custom_search(query)
  submit_params = {}
  raise TypeError "'query' expected Comet::SearchClause, got #{query.class}" unless query.is_a? Comet::SearchClause

  submit_params['Query'] = query.to_json

  body = perform_request('api/v1/admin/get-jobs-for-custom-search', submit_params)
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::BackupJobDetail.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_get_jobs_for_date_range(start_value, end_value) ⇒ Array<Comet::BackupJobDetail>

AdminGetJobsForDateRange

Get jobs (for date range). The jobs are returned in an unspecified order.

If the ‘Start` parameter is later than `End`, they will be swapped.

This API will return all jobs that either started or ended within the supplied range.

Incomplete jobs have an end time of ‘0`. You can use this API to find incomplete jobs by setting both `Start` and `End` to `0`.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • start_value (Number) —

    Timestamp (Unix)

  • end_value (Number) —

    Timestamp (Unix)

Returns:



1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'lib/comet/comet_server.rb', line 1734

def admin_get_jobs_for_date_range(start_value, end_value)
  submit_params = {}
  raise TypeError "'start_value' expected Numeric, got #{start_value.class}" unless start_value.is_a? Numeric

  submit_params['Start'] = start_value
  raise TypeError "'end_value' expected Numeric, got #{end_value.class}" unless end_value.is_a? Numeric

  submit_params['End'] = end_value

  body = perform_request('api/v1/admin/get-jobs-for-date-range', submit_params)
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::BackupJobDetail.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_get_jobs_for_user(target_user) ⇒ Array<Comet::BackupJobDetail>

AdminGetJobsForUser

Get jobs (for user). The jobs are returned in an unspecified order.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected username

Returns:



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/comet/comet_server.rb', line 1768

def admin_get_jobs_for_user(target_user)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user

  body = perform_request('api/v1/admin/get-jobs-for-user', submit_params)
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::BackupJobDetail.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_get_jobs_recent ⇒ Array<Comet::BackupJobDetail>

AdminGetJobsRecent

Get jobs (Recent and incomplete). The jobs are returned in an unspecified order.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
 
# File 'lib/comet/comet_server.rb', line 1798

def admin_get_jobs_recent
  body = perform_request('api/v1/admin/get-jobs-recent')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::BackupJobDetail.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_get_user_profile(target_user) ⇒ Comet::UserProfileConfig

AdminGetUserProfile

Get user account profile.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

Returns:



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
 
# File 'lib/comet/comet_server.rb', line 1823

def (target_user)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user

  body = perform_request('api/v1/admin/get-user-profile', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::UserProfileConfig.new
  ret.from_hash(json_body)
  ret
end

#admin_get_user_profile_and_hash(target_user) ⇒ Comet::GetProfileAndHashResponseMessage

AdminGetUserProfileAndHash

Get user account profile (atomic). The resulting hash parameter can be passed to the corresponding update API, to atomically ensure that no changes occur between get/set operations. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

Returns:



1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
 
# File 'lib/comet/comet_server.rb', line 1848

def (target_user)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user

  body = perform_request('api/v1/admin/get-user-profile-and-hash', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::GetProfileAndHashResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_get_user_profile_hash(target_user) ⇒ Comet::GetProfileHashResponseMessage

AdminGetUserProfileHash

Get user account profile (hash). The profile hash can be used to determine if a user account profile has changed. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

Returns:



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/comet/comet_server.rb', line 1873

def (target_user)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user

  body = perform_request('api/v1/admin/get-user-profile-hash', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::GetProfileHashResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_job_cancel(target_user, job_id) ⇒ Comet::CometAPIResponseMessage

AdminJobCancel

Cancel a running job. A request is sent to the live-connected device, asking it to cancel the operation. This may fail if there is no live-connection. Only jobs from Comet 18.3.5 or newer can be cancelled. A job can only be cancelled if it has a non-empty CancellationID field in its properties.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Username

  • job_id (String) —

    Job ID

Returns:



1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
 
# File 'lib/comet/comet_server.rb', line 1899

def admin_job_cancel(target_user, job_id)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'job_id' expected String, got #{job_id.class}" unless job_id.is_a? String

  submit_params['JobID'] = job_id

  body = perform_request('api/v1/admin/job/cancel', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_list_users ⇒ Array<String>

AdminListUsers

List all user accounts.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:

  • (Array<String>) 


1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
 
# File 'lib/comet/comet_server.rb', line 1924

def admin_list_users
  body = perform_request('api/v1/admin/list-users')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      ret[i] = v
    end
  end
  ret
end

#admin_list_users_full ⇒ Hash{String => Comet::UserProfileConfig}

AdminListUsersFull

List all user account profiles.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:



1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
 
# File 'lib/comet/comet_server.rb', line 1949

def admin_list_users_full
  body = perform_request('api/v1/admin/list-users-full')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::UserProfileConfig.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_meta_branding_config_get ⇒ Comet::ServerConfigOptionsBrandingFragment

AdminMetaBrandingConfigGet

Get Branding configuration.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

Returns:



1973
1974
1975
1976
1977
1978
1979
1980
 
# File 'lib/comet/comet_server.rb', line 1973

def admin_meta_branding_config_get
  body = perform_request('api/v1/admin/meta/branding-config/get')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ServerConfigOptionsBrandingFragment.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_branding_config_set(branding_config) ⇒ Comet::CometAPIResponseMessage

AdminMetaBrandingConfigSet

Set Branding configuration. Note that file resources must be provided using a resource URI I.E ‘“resource://05ba0b90ee66bda433169581188aba8d29faa938f9464cccd651a02fdf2e5b57”`. See AdminMetaResourceNew for the API documentation to create new file resources.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

Parameters:

Returns:



1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
 
# File 'lib/comet/comet_server.rb', line 1992

def admin_meta_branding_config_set(branding_config)
  submit_params = {}
  raise TypeError "'branding_config' expected Comet::BrandingOptions, got #{branding_config.class}" unless branding_config.is_a? Comet::BrandingOptions

  submit_params['BrandingConfig'] = branding_config.to_json

  body = perform_request('api/v1/admin/meta/branding-config/set', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_build_config_get ⇒ Comet::ServerConfigOptionsSoftwareBuildRoleFragment

AdminMetaBuildConfigGet

Get Software Build Role configuration.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

Returns:



2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/comet/comet_server.rb', line 2014

def admin_meta_build_config_get
  body = perform_request('api/v1/admin/meta/build-config/get')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ServerConfigOptionsSoftwareBuildRoleFragment.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_build_config_set(software_build_role_config) ⇒ Comet::CometAPIResponseMessage

AdminMetaBuildConfigSet

Set Build Role configuration.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

Parameters:

Returns:



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'lib/comet/comet_server.rb', line 2032

def admin_meta_build_config_set(software_build_role_config)
  submit_params = {}
  raise TypeError "'software_build_role_config' expected Comet::SoftwareBuildRoleOptions, got #{software_build_role_config.class}" unless software_build_role_config.is_a? Comet::SoftwareBuildRoleOptions

  submit_params['SoftwareBuildRoleConfig'] = software_build_role_config.to_json

  body = perform_request('api/v1/admin/meta/build-config/set', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_list_available_log_days ⇒ Array<Number>

AdminMetaListAvailableLogDays

Get log files.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Returns:

  • (Array<Number>) 


2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
 
# File 'lib/comet/comet_server.rb', line 2054

def admin_meta_list_available_log_days
  body = perform_request('api/v1/admin/meta/list-available-log-days')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      raise TypeError "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      ret[i] = v
    end
  end
  ret
end

#admin_meta_read_logs(log) ⇒ String

AdminMetaReadLogs

Get log file content. On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2. This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Parameters:

  • log (Number) —

    A log day, selected from the options returned by the Get Log Files API

Returns:

  • (String) 


2082
2083
2084
2085
2086
2087
2088
2089
 
# File 'lib/comet/comet_server.rb', line 2082

def admin_meta_read_logs(log)
  submit_params = {}
  raise TypeError "'log' expected Numeric, got #{log.class}" unless log.is_a? Numeric

  submit_params['Log'] = log

  perform_request('api/v1/admin/meta/read-logs', submit_params)
end

#admin_meta_remote_storage_vault_get ⇒ Array<Comet::RemoteStorageOption>

AdminMetaRemoteStorageVaultGet

Get Requesting Remote Storage Vault Config.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

Returns:



2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
 
# File 'lib/comet/comet_server.rb', line 2099

def admin_meta_remote_storage_vault_get
  body = perform_request('api/v1/admin/meta/remote-storage-vault/get')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::RemoteStorageOption.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_meta_remote_storage_vault_set(remote_storage_options) ⇒ Comet::CometAPIResponseMessage

AdminMetaRemoteStorageVaultSet

Set Requestable Remote Storage Vault options.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

Parameters:

Returns:



2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
 
# File 'lib/comet/comet_server.rb', line 2124

def admin_meta_remote_storage_vault_set(remote_storage_options)
  submit_params = {}
  raise TypeError "'remote_storage_options' expected Array, got #{remote_storage_options.class}" unless remote_storage_options.is_a? Array

  submit_params['RemoteStorageOptions'] = remote_storage_options.to_json

  body = perform_request('api/v1/admin/meta/remote-storage-vault/set', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_resource_get(hash) ⇒ String

AdminMetaResourceGet

Get a resource file. Resources are used to upload files within the server configuration.

You must supply administrator authentication credentials to use this API.

Parameters:

  • hash (String) —

    The resource identifier

Returns:

  • (String) 


2147
2148
2149
2150
2151
2152
2153
2154
 
# File 'lib/comet/comet_server.rb', line 2147

def admin_meta_resource_get(hash)
  submit_params = {}
  raise TypeError "'hash' expected String, got #{hash.class}" unless hash.is_a? String

  submit_params['Hash'] = hash

  perform_request('api/v1/admin/meta/resource/get', submit_params)
end

#admin_meta_restart_service ⇒ Comet::CometAPIResponseMessage

AdminMetaRestartService

Restart server. The Comet Server process will exit. The service manager should restart the server automatically.

Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.

Returns:



2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/comet/comet_server.rb', line 2168

def admin_meta_restart_service
  body = perform_request('api/v1/admin/meta/restart-service')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_send_test_email(email_options, recipient) ⇒ Comet::CometAPIResponseMessage

AdminMetaSendTestEmail

Send a test email message. This allows the Comet Server web interface to support testing different email credentials during setup.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.

Parameters:

  • email_options (Comet::EmailOptions) —

    Updated configuration content

  • recipient (String) —

    Target email address to send test email

Returns:



2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/comet/comet_server.rb', line 2189

def admin_meta_send_test_email(email_options, recipient)
  submit_params = {}
  raise TypeError "'email_options' expected Comet::EmailOptions, got #{email_options.class}" unless email_options.is_a? Comet::EmailOptions

  submit_params['EmailOptions'] = email_options.to_json
  raise TypeError "'recipient' expected String, got #{recipient.class}" unless recipient.is_a? String

  submit_params['Recipient'] = recipient

  body = perform_request('api/v1/admin/meta/send-test-email', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_server_config_get ⇒ Comet::ServerConfigOptions

AdminMetaServerConfigGet

Get server configuration.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Returns:

  • (Comet::ServerConfigOptions) 


2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'lib/comet/comet_server.rb', line 2215

def admin_meta_server_config_get
  body = perform_request('api/v1/admin/meta/server-config/get')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ServerConfigOptions.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_server_config_network_interfaces ⇒ Array<String>

AdminMetaServerConfigNetworkInterfaces

List the available network interfaces on the PC running Comet Server. Any IPv6 addresses are listed in compressed form without square-brackets.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Returns:

  • (Array<String>) 


2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
 
# File 'lib/comet/comet_server.rb', line 2234

def admin_meta_server_config_network_interfaces
  body = perform_request('api/v1/admin/meta/server-config/network-interfaces')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      ret[i] = v
    end
  end
  ret
end

#admin_meta_server_config_set(config) ⇒ Comet::CometAPIResponseMessage

AdminMetaServerConfigSet

Set server configuration. The Comet Server process will exit. The service manager should restart the server automatically.

Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Parameters:

  • config (Comet::ServerConfigOptions) —

    Updated configuration content

Returns:



2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'lib/comet/comet_server.rb', line 2264

def admin_meta_server_config_set(config)
  submit_params = {}
  raise TypeError "'config' expected Comet::ServerConfigOptions, got #{config.class}" unless config.is_a? Comet::ServerConfigOptions

  submit_params['Config'] = config.to_json

  body = perform_request('api/v1/admin/meta/server-config/set', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_shutdown_service ⇒ Comet::CometAPIResponseMessage

AdminMetaShutdownService

Shut down server. The Comet Server process will exit.

Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.

Returns:



2290
2291
2292
2293
2294
2295
2296
2297
 
# File 'lib/comet/comet_server.rb', line 2290

def admin_meta_shutdown_service
  body = perform_request('api/v1/admin/meta/shutdown-service')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_software_update_news ⇒ Comet::SoftwareUpdateNewsResponse

AdminMetaSoftwareUpdateNews

Get software update news from the software provider.

You must supply administrator authentication credentials to use this API.

Returns:



2306
2307
2308
2309
2310
2311
2312
2313
 
# File 'lib/comet/comet_server.rb', line 2306

def admin_meta_software_update_news
  body = perform_request('api/v1/admin/meta/software-update-news')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::SoftwareUpdateNewsResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_stats(simple) ⇒ Hash{Number => Comet::StatResult}

AdminMetaStats

Get Comet Server historical statistics. The returned key-value map is not necessarily ordered. Client-side code should sort the result before display.

You must supply administrator authentication credentials to use this API.

Parameters:

  • simple (Boolean) —

    Remove redundant statistics

Returns:



2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
 
# File 'lib/comet/comet_server.rb', line 2324

def admin_meta_stats(simple)
  submit_params = {}
  submit_params['Simple'] = (simple ? 1 : 0)

  body = perform_request('api/v1/admin/meta/stats', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::StatResult.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_meta_version ⇒ Comet::ServerMetaVersionInfo

AdminMetaVersion

Get server properties. Retrieve the version number and basic properties about the server.

You must supply administrator authentication credentials to use this API.

Returns:



2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/comet/comet_server.rb', line 2351

def admin_meta_version
  body = perform_request('api/v1/admin/meta/version')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ServerMetaVersionInfo.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_webhook_options_get ⇒ Hash{String => Comet::WebhookOption}

AdminMetaWebhookOptionsGet

Get the server webhook configuration.

You must supply administrator authentication credentials to use this API.

Returns:



2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
 
# File 'lib/comet/comet_server.rb', line 2367

def admin_meta_webhook_options_get
  body = perform_request('api/v1/admin/meta/webhook-options/get')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::WebhookOption.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_meta_webhook_options_set(webhook_options) ⇒ Comet::CometAPIResponseMessage

AdminMetaWebhookOptionsSet

Update the server webhook configuration. Calling this endpoint will interrupt any messages currently queued for existing webhook destinations.

You must supply administrator authentication credentials to use this API.

Parameters:

  • webhook_options (Hash{String => Comet::WebhookOption}) —

    The replacement webhook target options.

Returns:



2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
 
# File 'lib/comet/comet_server.rb', line 2392

def admin_meta_webhook_options_set(webhook_options)
  submit_params = {}
  raise TypeError "'webhook_options' expected Hash, got #{webhook_options.class}" unless webhook_options.is_a? Hash

  submit_params['WebhookOptions'] = webhook_options.to_json

  body = perform_request('api/v1/admin/meta/webhook-options/set', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_news_get_all ⇒ Hash{String => Comet::NewsEntry}

AdminNewsGetAll

Get News entries (Admin).

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:



2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
 
# File 'lib/comet/comet_server.rb', line 2414

def admin_news_get_all
  body = perform_request('api/v1/admin/news/get-all')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::NewsEntry.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_news_remove(news_item) ⇒ Comet::CometAPIResponseMessage

AdminNewsRemove

Remove news item.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • news_item (String) —

    Selected news item GUID

Returns:



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
 
# File 'lib/comet/comet_server.rb', line 2439

def admin_news_remove(news_item)
  submit_params = {}
  raise TypeError "'news_item' expected String, got #{news_item.class}" unless news_item.is_a? String

  submit_params['NewsItem'] = news_item

  body = perform_request('api/v1/admin/news/remove', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_news_submit(news_content) ⇒ Comet::CometAPIResponseMessage

AdminNewsSubmit

Submit news item.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • news_content (String) —

    Content of news item

Returns:



2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
 
# File 'lib/comet/comet_server.rb', line 2462

def admin_news_submit(news_content)
  submit_params = {}
  raise TypeError "'news_content' expected String, got #{news_content.class}" unless news_content.is_a? String

  submit_params['NewsContent'] = news_content

  body = perform_request('api/v1/admin/news/submit', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_organization_delete(organization_id = nil, uninstall_config = nil) ⇒ Comet::OrganizationResponse

AdminOrganizationDelete

Delete an organization and all related users.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Parameters:

  • organization_id (String) (defaults to: nil) —

    (Optional) (No description available)

  • uninstall_config (Comet::UninstallConfig) (defaults to: nil) —

    (Optional) Uninstall software configuration

Returns:



2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/comet/comet_server.rb', line 2486

def admin_organization_delete(organization_id = nil, uninstall_config = nil)
  submit_params = {}
  unless organization_id.nil?
    raise TypeError "'organization_id' expected String, got #{organization_id.class}" unless organization_id.is_a? String

    submit_params['OrganizationID'] = organization_id
  end
  unless uninstall_config.nil?
    raise TypeError "'uninstall_config' expected Comet::UninstallConfig, got #{uninstall_config.class}" unless uninstall_config.is_a? Comet::UninstallConfig

    submit_params['UninstallConfig'] = uninstall_config.to_json
  end

  body = perform_request('api/v1/admin/organization/delete', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::OrganizationResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_organization_list ⇒ Hash{String => Comet::Organization}

AdminOrganizationList

List Organizations.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Returns:



2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
 
# File 'lib/comet/comet_server.rb', line 2515

def admin_organization_list
  body = perform_request('api/v1/admin/organization/list')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::Organization.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_organization_set(organization_id = nil, organization = nil) ⇒ Comet::OrganizationResponse

AdminOrganizationSet

Create or Update an Organization.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Parameters:

  • organization_id (String) (defaults to: nil) —

    (Optional) (No description available)

  • organization (Comet::Organization) (defaults to: nil) —

    (Optional) (No description available)

Returns:



2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
 
# File 'lib/comet/comet_server.rb', line 2541

def admin_organization_set(organization_id = nil, organization = nil)
  submit_params = {}
  unless organization_id.nil?
    raise TypeError "'organization_id' expected String, got #{organization_id.class}" unless organization_id.is_a? String

    submit_params['OrganizationID'] = organization_id
  end
  unless organization.nil?
    raise TypeError "'organization' expected Comet::Organization, got #{organization.class}" unless organization.is_a? Comet::Organization

    submit_params['Organization'] = organization.to_json
  end

  body = perform_request('api/v1/admin/organization/set', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::OrganizationResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_policies_delete(policy_id) ⇒ Comet::CometAPIResponseMessage

AdminPoliciesDelete

Delete an existing policy object.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • policy_id (String) —

    The policy ID to update or create

Returns:



2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
 
# File 'lib/comet/comet_server.rb', line 2571

def admin_policies_delete(policy_id)
  submit_params = {}
  raise TypeError "'policy_id' expected String, got #{policy_id.class}" unless policy_id.is_a? String

  submit_params['PolicyID'] = policy_id

  body = perform_request('api/v1/admin/policies/delete', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_policies_get(policy_id) ⇒ Comet::GetGroupPolicyResponse

AdminPoliciesGet

Retrieve a single policy object. A hash is also returned, to allow atomic modification operations.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • policy_id (String) —

    The policy ID to retrieve

Returns:



2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
 
# File 'lib/comet/comet_server.rb', line 2595

def admin_policies_get(policy_id)
  submit_params = {}
  raise TypeError "'policy_id' expected String, got #{policy_id.class}" unless policy_id.is_a? String

  submit_params['PolicyID'] = policy_id

  body = perform_request('api/v1/admin/policies/get', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::GetGroupPolicyResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_policies_list ⇒ Hash{String => String}

AdminPoliciesList

List all policy object names.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:

  • (Hash{String => String}) 


2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
 
# File 'lib/comet/comet_server.rb', line 2617

def admin_policies_list
  body = perform_request('api/v1/admin/policies/list')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      ret[k] = v
    end
  end
  ret
end

#admin_policies_list_full ⇒ Hash{String => Comet::GroupPolicy}

AdminPoliciesListFull

Get all policy objects.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:



2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
 
# File 'lib/comet/comet_server.rb', line 2642

def admin_policies_list_full
  body = perform_request('api/v1/admin/policies/list-full')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::GroupPolicy.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_policies_new(policy) ⇒ Comet::CreateGroupPolicyResponse

AdminPoliciesNew

Create a new policy object.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

Returns:



2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'lib/comet/comet_server.rb', line 2667

def admin_policies_new(policy)
  submit_params = {}
  raise TypeError "'policy' expected Comet::GroupPolicy, got #{policy.class}" unless policy.is_a? Comet::GroupPolicy

  submit_params['Policy'] = policy.to_json

  body = perform_request('api/v1/admin/policies/new', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CreateGroupPolicyResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_policies_set(policy_id, policy, check_policy_hash = nil) ⇒ Comet::CometAPIResponseMessage

AdminPoliciesSet

Update an existing policy object. An optional hash may be used, to ensure the modification was atomic. This API can also be used to create a new policy object with a specific hash.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • policy_id (String) —

    The policy ID to update or create

  • policy (Comet::GroupPolicy) —

    The policy data

  • check_policy_hash (String) (defaults to: nil) —

    (Optional) An atomic verification hash as supplied by the AdminPoliciesGet API

Returns:



2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
 
# File 'lib/comet/comet_server.rb', line 2694

def admin_policies_set(policy_id, policy, check_policy_hash = nil)
  submit_params = {}
  raise TypeError "'policy_id' expected String, got #{policy_id.class}" unless policy_id.is_a? String

  submit_params['PolicyID'] = policy_id
  raise TypeError "'policy' expected Comet::GroupPolicy, got #{policy.class}" unless policy.is_a? Comet::GroupPolicy

  submit_params['Policy'] = policy.to_json
  unless check_policy_hash.nil?
    raise TypeError "'check_policy_hash' expected String, got #{check_policy_hash.class}" unless check_policy_hash.is_a? String

    submit_params['CheckPolicyHash'] = check_policy_hash
  end

  body = perform_request('api/v1/admin/policies/set', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_preview_user_email_report(target_user, email_report_config, email_address = nil) ⇒ Comet::EmailReportGeneratedPreview

AdminPreviewUserEmailReport

Preview an email report for a customer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

  • email_report_config (Comet::EmailReportConfig) —

    Email report configuration to preview

  • email_address (String) (defaults to: nil) —

    (Optional) Email address that may be included in the report body (>= 20.3.3)

Returns:



2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
 
# File 'lib/comet/comet_server.rb', line 2727

def admin_preview_user_email_report(target_user, email_report_config, email_address = nil)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'email_report_config' expected Comet::EmailReportConfig, got #{email_report_config.class}" unless email_report_config.is_a? Comet::EmailReportConfig

  submit_params['EmailReportConfig'] = email_report_config.to_json
  unless email_address.nil?
    raise TypeError "'email_address' expected String, got #{email_address.class}" unless email_address.is_a? String

    submit_params['EmailAddress'] = email_address
  end

  body = perform_request('api/v1/admin/preview-user-email-report', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::EmailReportGeneratedPreview.new
  ret.from_hash(json_body)
  ret
end

#admin_replication_state ⇒ Array<Comet::ReplicatorStateAPIResponse>

AdminReplicationState

Get Replication status.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Returns:



2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
 
# File 'lib/comet/comet_server.rb', line 2757

def admin_replication_state
  body = perform_request('api/v1/admin/replication/state')
  json_body = JSON.parse body
  check_status json_body
  if json_body.nil?
    ret = []
  else
    ret = Array.new(json_body.length)
    json_body.each_with_index do |v, i|
      ret[i] = Comet::ReplicatorStateAPIResponse.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_request_storage_vault(target_user, storage_provider, self_address = nil) ⇒ Comet::RequestStorageVaultResponseMessage

AdminRequestStorageVault

Request a new Storage Vault on behalf of a user. This action does not respect the “Prevent creating new Storage Vaults (via Request)” policy setting. New Storage Vaults can be requested regardless of the policy setting. Prior to Comet 19.8.0, the response type was CometAPIResponseMessage (i.e. no DestinationID field in response).

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    The user to receive the new Storage Vault

  • storage_provider (String) —

    ID for the Requestable destination

  • self_address (String) (defaults to: nil) —

    (Optional) The external URL for this server. Used to resolve conflicts

Returns:



2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
 
# File 'lib/comet/comet_server.rb', line 2786

def admin_request_storage_vault(target_user, storage_provider, self_address = nil)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'storage_provider' expected String, got #{storage_provider.class}" unless storage_provider.is_a? String

  submit_params['StorageProvider'] = storage_provider
  if self_address.nil?
    submit_params['SelfAddress'] = @server_address
  else
    raise TypeError "'self_address' expected String, got #{self_address.class}" unless self_address.is_a? String

    submit_params['SelfAddress'] = self_address
  end

  body = perform_request('api/v1/admin/request-storage-vault', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::RequestStorageVaultResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_request_storage_vault_providers ⇒ Hash{String => String}

AdminRequestStorageVaultProviders

Get the available options for Requesting a Storage Vault.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Returns:

  • (Hash{String => String}) 


2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
 
# File 'lib/comet/comet_server.rb', line 2818

def admin_request_storage_vault_providers
  body = perform_request('api/v1/admin/request-storage-vault-providers')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      ret[k] = v
    end
  end
  ret
end

#admin_reset_user_password(target_user, new_password, old_password) ⇒ Comet::CometAPIResponseMessage

AdminResetUserPassword

Reset user account password. The user account must have a recovery code present. A new replacement recovery code will be generated automatically.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

  • new_password (String) —

    New account password

  • old_password (String) —

    Old account password (optional)

Returns:



2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
 
# File 'lib/comet/comet_server.rb', line 2847

def admin_reset_user_password(target_user, new_password, old_password)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'new_password' expected String, got #{new_password.class}" unless new_password.is_a? String

  submit_params['NewPassword'] = new_password
  raise TypeError "'old_password' expected String, got #{old_password.class}" unless old_password.is_a? String

  submit_params['OldPassword'] = old_password

  body = perform_request('api/v1/admin/reset-user-password', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_revoke_device(target_user, target_device) ⇒ Comet::CometAPIResponseMessage

AdminRevokeDevice

Revoke device from user account. It’s possible to simply remove the Device section from the user’s profile, however, using this dedicated API will also gracefully handle live connections.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

  • target_device (String) —

    Selected Device ID

Returns:



2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
 
# File 'lib/comet/comet_server.rb', line 2878

def admin_revoke_device(target_user, target_device)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'target_device' expected String, got #{target_device.class}" unless target_device.is_a? String

  submit_params['TargetDevice'] = target_device

  body = perform_request('api/v1/admin/revoke-device', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_set_user_profile(target_user, profile_data) ⇒ Comet::CometAPIResponseMessage

AdminSetUserProfile

Modify user account profile.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

Returns:



2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
 
# File 'lib/comet/comet_server.rb', line 2905

def (target_user, profile_data)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'profile_data' expected Comet::UserProfileConfig, got #{profile_data.class}" unless profile_data.is_a? Comet::UserProfileConfig

  submit_params['ProfileData'] = profile_data.to_json

  body = perform_request('api/v1/admin/set-user-profile', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_set_user_profile_hash(target_user, profile_data, require_hash) ⇒ Comet::CometAPIResponseMessage

AdminSetUserProfileHash

Modify user account profile (atomic). The hash parameter can be determined from the corresponding API, to atomically ensure that no changes occur between get/set operations. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameters:

  • target_user (String) —

    Selected account username

  • profile_data (Comet::UserProfileConfig) —

    Modified user profile

  • require_hash (String) —

    Previous hash parameter

Returns:



2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
 
# File 'lib/comet/comet_server.rb', line 2935

def (target_user, profile_data, require_hash)
  submit_params = {}
  raise TypeError "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String

  submit_params['TargetUser'] = target_user
  raise TypeError "'profile_data' expected Comet::UserProfileConfig, got #{profile_data.class}" unless profile_data.is_a? Comet::UserProfileConfig

  submit_params['ProfileData'] = profile_data.to_json
  raise TypeError "'require_hash' expected String, got #{require_hash.class}" unless require_hash.is_a? String

  submit_params['RequireHash'] = require_hash

  body = perform_request('api/v1/admin/set-user-profile-hash', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_storage_bucket_properties(bucket_id, after_timestamp = nil) ⇒ Comet::BucketProperties

AdminStorageBucketProperties

Retrieve properties for a single bucket. This API can also be used to refresh the size measurement for a single bucket by passing a valid AfterTimestamp parameter.

You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.

Parameters:

  • bucket_id (String) —

    Bucket ID

  • after_timestamp (Number) (defaults to: nil) —

    (Optional) Allow a stale size measurement if it is at least as new as the supplied Unix timestamp. Timestamps in the future may produce a result clamped down to the Comet Server’s current time. If not present, the size measurement may be arbitrarily stale.

Returns:



2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
 
# File 'lib/comet/comet_server.rb', line 2966

def admin_storage_bucket_properties(bucket_id, after_timestamp = nil)
  submit_params = {}
  raise TypeError "'bucket_id' expected String, got #{bucket_id.class}" unless bucket_id.is_a? String

  submit_params['BucketID'] = bucket_id
  unless after_timestamp.nil?
    raise TypeError "'after_timestamp' expected Numeric, got #{after_timestamp.class}" unless after_timestamp.is_a? Numeric

    submit_params['AfterTimestamp'] = after_timestamp
  end

  body = perform_request('api/v1/admin/storage/bucket-properties', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BucketProperties.new
  ret.from_hash(json_body)
  ret
end

#admin_storage_delete_bucket(bucket_id) ⇒ Comet::CometAPIResponseMessage

AdminStorageDeleteBucket

Delete a bucket. All data will be removed from the server. Misuse can cause data loss!

You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.

Parameters:

  • bucket_id (String) —

    Selected bucket name

Returns:



2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
 
# File 'lib/comet/comet_server.rb', line 2995

def admin_storage_delete_bucket(bucket_id)
  submit_params = {}
  raise TypeError "'bucket_id' expected String, got #{bucket_id.class}" unless bucket_id.is_a? String

  submit_params['BucketID'] = bucket_id

  body = perform_request('api/v1/admin/storage/delete-bucket', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_storage_free_space(bucket_id = nil) ⇒ Comet::StorageFreeSpaceInfo

AdminStorageFreeSpace

Retrieve available space metrics.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API requires the Storage Role to be enabled. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

Parameters:

  • bucket_id (String) (defaults to: nil) —

    (Optional) (This parameter is not used)

Returns:



3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
 
# File 'lib/comet/comet_server.rb', line 3020

def admin_storage_free_space(bucket_id = nil)
  submit_params = {}
  unless bucket_id.nil?
    raise TypeError "'bucket_id' expected String, got #{bucket_id.class}" unless bucket_id.is_a? String

    submit_params['BucketID'] = bucket_id
  end

  body = perform_request('api/v1/admin/storage/free-space', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::StorageFreeSpaceInfo.new
  ret.from_hash(json_body)
  ret
end

#admin_storage_list_buckets ⇒ Hash{String => Comet::BucketProperties}

AdminStorageListBuckets

List all buckets.

You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.

Returns:



3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
 
# File 'lib/comet/comet_server.rb', line 3044

def admin_storage_list_buckets
  body = perform_request('api/v1/admin/storage/list-buckets')
  json_body = JSON.parse body
  check_status json_body
  ret = {}
  if json_body.nil?
    ret = {}
  else
    json_body.each do |k, v|
      ret[k] = Comet::BucketProperties.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_storage_register_bucket(set_bucket_value = nil, set_key_hash_format = nil, set_key_hash_value = nil, set_organization_id = nil) ⇒ Comet::AddBucketResponseMessage

AdminStorageRegisterBucket

Create a new bucket. Leave the Set* parameters blank to generate a bucket with random credentials, or, supply a pre-hashed password for zero-knowledge operations. Any auto-generated credentials are returned in the response message.

You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.

Parameters:

  • set_bucket_value (String) (defaults to: nil) —

    (Optional) Bucket ID

  • set_key_hash_format (String) (defaults to: nil) —

    (Optional) Bucket key hashing format

  • set_key_hash_value (String) (defaults to: nil) —

    (Optional) Bucket key hash

  • set_organization_id (String) (defaults to: nil) —

    (Optional) Target organization ID (>= 20.9.0)

Returns:



3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
 
# File 'lib/comet/comet_server.rb', line 3074

def admin_storage_register_bucket(set_bucket_value = nil, set_key_hash_format = nil, set_key_hash_value = nil, set_organization_id = nil)
  submit_params = {}
  unless set_bucket_value.nil?
    raise TypeError "'set_bucket_value' expected String, got #{set_bucket_value.class}" unless set_bucket_value.is_a? String

    submit_params['SetBucketValue'] = set_bucket_value
  end
  unless set_key_hash_format.nil?
    raise TypeError "'set_key_hash_format' expected String, got #{set_key_hash_format.class}" unless set_key_hash_format.is_a? String

    submit_params['SetKeyHashFormat'] = set_key_hash_format
  end
  unless set_key_hash_value.nil?
    raise TypeError "'set_key_hash_value' expected String, got #{set_key_hash_value.class}" unless set_key_hash_value.is_a? String

    submit_params['SetKeyHashValue'] = set_key_hash_value
  end
  unless set_organization_id.nil?
    raise TypeError "'set_organization_id' expected String, got #{set_organization_id.class}" unless set_organization_id.is_a? String

    submit_params['SetOrganizationID'] = set_organization_id
  end

  body = perform_request('api/v1/admin/storage/register-bucket', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::AddBucketResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_update_campaign_start(options) ⇒ Comet::CometAPIResponseMessage

AdminUpdateCampaignStart

Start a new software update campaign.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

Returns:



3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
 
# File 'lib/comet/comet_server.rb', line 3116

def admin_update_campaign_start(options)
  submit_params = {}
  raise TypeError "'options' expected Comet::UpdateCampaignOptions, got #{options.class}" unless options.is_a? Comet::UpdateCampaignOptions

  submit_params['Options'] = options.to_json

  body = perform_request('api/v1/admin/update-campaign/start', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_update_campaign_status ⇒ Comet::UpdateCampaignStatus

AdminUpdateCampaignStatus

Get current campaign status.

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Returns:



3140
3141
3142
3143
3144
3145
3146
3147
 
# File 'lib/comet/comet_server.rb', line 3140

def admin_update_campaign_status
  body = perform_request('api/v1/admin/update-campaign/status')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::UpdateCampaignStatus.new
  ret.from_hash(json_body)
  ret
end

#check_status(obj) ⇒ Object

If the supplied object represents an unsuccessful CometAPIResponseMessage, raise it as an error.

Parameters:

  • obj (Hash)

Raises:



3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
 
# File 'lib/comet/comet_server.rb', line 3203

def check_status(obj)
  return unless obj.is_a? Hash
  return unless obj.key?('Status')
  return unless obj.key?('Message')
  return unless obj['Status'] != 200 && obj['Status'] != 201

  ret_error = Comet::CometAPIResponseMessage.new
  ret_error.from_hash(obj)
  raise Comet::APIResponseError.new(ret_error)
end

#hybrid_session_start ⇒ Comet::SessionKeyRegeneratedResponse

HybridSessionStart

Generate a session key (log in). This hybrid API allows you to log in to the Comet Server as either an administrator or end-user account. This API behaves like either AdminAccountSessionStart or UserWebSessionStart, depending on what the supplied credentials were valid for.

Returns:



3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'lib/comet/comet_server.rb', line 3156

def hybrid_session_start
  body = perform_request('api/v1/hybrid/session/start')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::SessionKeyRegeneratedResponse.new
  ret.from_hash(json_body)
  ret
end

#perform_request(endpoint, params = {}) ⇒ String

Perform a synchronous HTTP request.

Parameters:

  • endpoint (String) —

    The URL suffix

  • params (Hash<String,String>) (defaults to: {}) —

    Form post parameters to submit to the target API

Returns:

  • (String) —

    Response body



3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
 
# File 'lib/comet/comet_server.rb', line 3219

def perform_request(endpoint, params = {})
  full_uri = URI(@server_address + endpoint)
  params['Username'] = @username
  params['AuthType'] = 'Password'
  params['Password'] = @password

  res = Net::HTTP.post_form(full_uri, params)
  unless res.is_a?(Net::HTTPSuccess)
    raise res
  end

  res.body
end

#user_web_session_revoke ⇒ Comet::CometAPIResponseMessage

UserWebSessionRevoke

Revoke a session key (log out).

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

Returns:



3173
3174
3175
3176
3177
3178
3179
3180
 
# File 'lib/comet/comet_server.rb', line 3173

def user_web_session_revoke
  body = perform_request('api/v1/user/web/session/revoke')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#user_web_session_start ⇒ Comet::SessionKeyRegeneratedResponse

UserWebSessionStart

Generate a session key (log in).

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

Returns:



3190
3191
3192
3193
3194
3195
3196
3197
 
# File 'lib/comet/comet_server.rb', line 3190

def user_web_session_start
  body = perform_request('api/v1/user/web/session/start')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::SessionKeyRegeneratedResponse.new
  ret.from_hash(json_body)
  ret
end