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.

Raises:

  • (TypeError) 


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

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.



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

def password
  @password
end

#server_address ⇒ Object

Returns the value of attribute server_address.



17
18
19
 
# File 'lib/comet/comet_server.rb', line 17

def server_address
  @server_address
end

#username ⇒ Object

Returns the value of attribute username.



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

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:



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

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:



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

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:



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

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

Returns:



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

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:

Raises:

  • (TypeError) 


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

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_session_upgrade(session_key) ⇒ Comet::CometAPIResponseMessage

AdminAccountSessionUpgrade

Upgrade a session key which is pending an MFA upgrade to a full session key.

You must supply administrator authentication credentials to use this API.

Parameters:

  • session_key (String) —

    The session key to upgrade

Returns:

Raises:

  • (TypeError) 


147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/comet/comet_server.rb', line 147

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

  submit_params['SessionKey'] = session_key

  body = perform_request('api/v1/admin/account/session-upgrade', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.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:

Raises:

  • (TypeError) 


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

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. Browser support for U2F is ending in February 2022. WebAuthn is backwards compatible with U2F keys, and Comet will automatically migrate existing U2F keys to allow their use with the WebAuthn endpoints.

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:

Raises:

  • (TypeError) 


197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/comet/comet_server.rb', line 197

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 = nil) ⇒ Comet::CometAPIResponseMessage

AdminAccountU2fSubmitChallengeResponse

Register a new FIDO U2F token. Browser support for U2F is ending in February 2022. WebAuthn is backwards compatible with U2F keys, and Comet will automatically migrate existing U2F keys to allow their use with the WebAuthn endpoints.

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) (defaults to: nil) —

    (Optional) Description of the token

Returns:

Raises:

  • (TypeError) 


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/comet/comet_server.rb', line 226

def (u2fchallenge_id, u2fclient_data, u2fregistration_data, u2fversion, description = nil)
  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
  unless description.nil?
    raise TypeError, "'description' expected String, got #{description.class}" unless description.is_a? String

    submit_params['Description'] = description
  end

  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:

Raises:

  • (TypeError) 


262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/comet/comet_server.rb', line 262

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_account_webauthn_request_registration_challenge(self_address) ⇒ Comet::WebAuthnRegistrationChallengeResponse

AdminAccountWebauthnRequestRegistrationChallenge

Register a new FIDO2 WebAuthn token.

You must supply administrator authentication credentials to use this API.

Parameters:

  • self_address (String) —

    External URL of this server, used as WebAuthn ID

Returns:

Raises:

  • (TypeError) 


284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/comet/comet_server.rb', line 284

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/webauthn/request-registration-challenge', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::WebAuthnRegistrationChallengeResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_account_webauthn_submit_challenge_response(self_address, challenge_id, credential) ⇒ Comet::CometAPIResponseMessage

AdminAccountWebauthnSubmitChallengeResponse

Register a new FIDO2 WebAuthn token.

You must supply administrator authentication credentials to use this API.

Parameters:

  • self_address (String) —

    External URL of this server, used as WebAuthn ID

  • challenge_id (String) —

    Associated value from AdminAccountWebAuthnRequestRegistrationChallenge API

  • credential (String) —

    JSON-encoded credential

Returns:

Raises:

  • (TypeError) 


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/comet/comet_server.rb', line 308

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

  submit_params['SelfAddress'] = self_address
  raise TypeError, "'challenge_id' expected String, got #{challenge_id.class}" unless challenge_id.is_a? String

  submit_params['ChallengeID'] = challenge_id
  raise TypeError, "'credential' expected String, got #{credential.class}" unless credential.is_a? String

  submit_params['Credential'] = credential

  body = perform_request('api/v1/admin/account/webauthn/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_add_user(target_user, target_password, store_recovery_code = nil, require_password_change = nil, target_organization = 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)

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

    (Optional) If present, create the user account on behalf of another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

Returns:

Raises:

  • (TypeError) 


341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/comet/comet_server.rb', line 341

def admin_add_user(target_user, target_password, store_recovery_code = nil, require_password_change = nil, target_organization = 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
  unless target_organization.nil?
    raise TypeError, "'target_organization' expected String, got #{target_organization.class}" unless target_organization.is_a? String

    submit_params['TargetOrganization'] = target_organization
  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, target_organization = nil) ⇒ 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:

  • target_user (String) —

    New account username

  • profile_data (Comet::UserProfileConfig) —

    New account profile

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

    (Optional) If present, create the user account on behalf of another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

Returns:

Raises:

  • (TypeError) 


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/comet/comet_server.rb', line 385

def admin_add_user_from_profile(target_user, profile_data, target_organization = 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, "'profile_data' expected Comet::UserProfileConfig, got #{profile_data.class}" unless profile_data.is_a? Comet::UserProfileConfig

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

    submit_params['TargetOrganization'] = target_organization
  end

  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 top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

  • target_user (String) —

    the username of the admin to be deleted

Returns:

Raises:

  • (TypeError) 


417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/comet/comet_server.rb', line 417

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 top-level administrator accounts, not for Tenant administrator accounts.

Returns:



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/comet/comet_server.rb', line 440

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 top-level administrator accounts, not for Tenant administrator accounts.

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:

Raises:

  • (TypeError) 


468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/comet/comet_server.rb', line 468

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:



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/comet/comet_server.rb', line 499

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)

Raises:

  • (TypeError) 


526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/comet/comet_server.rb', line 526

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) 


552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/comet/comet_server.rb', line 552

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_arm_64(self_address = nil) ⇒ String

AdminBrandingGenerateClientMacosArm64

Download software (macOS arm64 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) 


575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/comet/comet_server.rb', line 575

def admin_branding_generate_client_macos_arm_64(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-arm64', 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) 


598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/comet/comet_server.rb', line 598

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_spk_dsm_6(self_address = nil) ⇒ String

AdminBrandingGenerateClientSpkDsm6

Download software (Synology SPK for DSM 6).

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) 


621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/comet/comet_server.rb', line 621

def admin_branding_generate_client_spk_dsm_6(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/spk-dsm6', submit_params)
end

#admin_branding_generate_client_spk_dsm_7(self_address = nil) ⇒ String

AdminBrandingGenerateClientSpkDsm7

Download software (Synology SPK for DSM 7).

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) 


644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/comet/comet_server.rb', line 644

def admin_branding_generate_client_spk_dsm_7(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/spk-dsm7', 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:

Raises:

  • (TypeError) 


668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/comet/comet_server.rb', line 668

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) 


700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/comet/comet_server.rb', line 700

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) 


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

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) 


748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/comet/comet_server.rb', line 748

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) 


772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/comet/comet_server.rb', line 772

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) 


796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/comet/comet_server.rb', line 796

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) 


820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/comet/comet_server.rb', line 820

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:

Raises:

  • (TypeError) 


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

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 requires the Constellation Role to be enabled.

Returns:



868
869
870
871
872
873
874
875
 
# File 'lib/comet/comet_server.rb', line 868

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 requires the Constellation Role to be enabled.

Returns:



885
886
887
888
889
890
891
892
 
# File 'lib/comet/comet_server.rb', line 885

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 top-level administrator accounts, not for Tenant administrator accounts. This API requires the Constellation Role to be enabled.

Returns:



903
904
905
906
907
908
909
910
 
# File 'lib/comet/comet_server.rb', line 903

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 requires the Constellation Role to be enabled.

Returns:



920
921
922
923
924
925
926
927
 
# File 'lib/comet/comet_server.rb', line 920

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_count_jobs_for_custom_search(query) ⇒ Comet::CountJobsResponse

AdminCountJobsForCustomSearch

Count jobs (for custom search).

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

Parameters:

Returns:

Raises:

  • (TypeError) 


938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/comet/comet_server.rb', line 938

def admin_count_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/count-jobs-for-custom-search', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CountJobsResponse.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. Currently only supported for Windows & macOS only Provide the installation token to silently install the client on windows ‘install.exe /TOKEN=<installtoken>` Provide the installation token to silently install the client on Mac OS `sudo launchctl setenv BACKUP_APP_TOKEN “installtoken” && sudo /usr/sbin/installer -allowUntrusted -pkg “Comet Backup.pkg” -target /`

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:

Raises:

  • (TypeError) 


966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/comet/comet_server.rb', line 966

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 This also removes all job history for 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:

Raises:

  • (TypeError) 


1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/comet/comet_server.rb', line 1002

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:

Raises:

  • (TypeError) 


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

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:

Raises:

  • (TypeError) 


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

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:

Raises:

  • (TypeError) 


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

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:

Raises:

  • (TypeError) 


1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/comet/comet_server.rb', line 1111

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_delete_snapshots(target_id, destination_id, snapshot_ids) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherDeleteSnapshots

Instruct a live connected device to delete multiple stored snapshots. The target device must be running Comet 20.9.10 or later.

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_ids (Array<String>) —

    The backup job snapshot IDs to delete

Returns:

Raises:

  • (TypeError) 


1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/comet/comet_server.rb', line 1143

def admin_dispatcher_delete_snapshots(target_id, destination_id, snapshot_ids)
  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_ids' expected Array, got #{snapshot_ids.class}" unless snapshot_ids.is_a? Array

  submit_params['SnapshotIDs'] = snapshot_ids.to_json

  body = perform_request('api/v1/admin/dispatcher/delete-snapshots', 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:

Raises:

  • (TypeError) 


1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'lib/comet/comet_server.rb', line 1173

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_email_preview(target_id, snapshot, destination, path) ⇒ Comet::EmailReportGeneratedPreview

AdminDispatcherEmailPreview

Request HTML content of an email. The remote device must have given consent for an MSP to browse their mail

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

  • snapshot (String) —

    where the email belongs to

  • destination (String) —

    The Storage Vault ID

  • path (String) —

    of the email to view

Returns:

Raises:

  • (TypeError) 


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

def admin_dispatcher_email_preview(target_id, snapshot, destination, path)
  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, "'snapshot' expected String, got #{snapshot.class}" unless snapshot.is_a? String

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

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

  submit_params['Path'] = path

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

#admin_dispatcher_get_default_login_url(organization_id) ⇒ Comet::OrganizationLoginURLResponse

AdminDispatcherGetDefaultLoginUrl

Get the default login URL for a tenant.

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

Parameters:

  • organization_id (String) —

    Target organization

Returns:

Raises:

  • (TypeError) 


1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/comet/comet_server.rb', line 1233

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

  submit_params['OrganizationID'] = organization_id

  body = perform_request('api/v1/admin/dispatcher/get-default-login-url', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::OrganizationLoginURLResponse.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:

Raises:

  • (TypeError) 


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'lib/comet/comet_server.rb', line 1258

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:

Raises:

  • (TypeError) 


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/comet/comet_server.rb', line 1285

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(user_name_filter = nil) ⇒ 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.

Parameters:

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

    (Optional) User name filter string

Returns:



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
 
# File 'lib/comet/comet_server.rb', line 1308

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

    submit_params['UserNameFilter'] = user_name_filter
  end

  body = perform_request('api/v1/admin/dispatcher/list-active', 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::LiveUserConnection.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_dispatcher_office_365list_virtual_accounts(target_id, credentials) ⇒ Comet::BrowseOffice365ListVirtualAccountsResponse

AdminDispatcherOffice365ListVirtualAccounts

Request a list of Office365 Resources (groups, sites, teams groups and users). 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:

Returns:

Raises:

  • (TypeError) 


1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/comet/comet_server.rb', line 1342

def admin_dispatcher_office_365list_virtual_accounts(target_id, credentials)
  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, "'credentials' expected Comet::Office365Credential, got #{credentials.class}" unless credentials.is_a? Comet::Office365Credential

  submit_params['Credentials'] = credentials.to_json

  body = perform_request('api/v1/admin/dispatcher/office365-list-virtual-accounts', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BrowseOffice365ListVirtualAccountsResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_ping_destination(target_id, extra_data) ⇒ Comet::CometAPIResponseMessage

AdminDispatcherPingDestination

Test the connection to the storage bucket.

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

Parameters:

Returns:

Raises:

  • (TypeError) 


1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
 
# File 'lib/comet/comet_server.rb', line 1369

def admin_dispatcher_ping_destination(target_id, extra_data)
  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, "'extra_data' expected Comet::DestinationLocation, got #{extra_data.class}" unless extra_data.is_a? Comet::DestinationLocation

  submit_params['ExtraData'] = extra_data.to_json

  body = perform_request('api/v1/admin/dispatcher/ping-destination', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  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:

Raises:

  • (TypeError) 


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/comet/comet_server.rb', line 1396

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_register_office_application_begin(target_id, email_address) ⇒ Comet::RegisterOfficeApplicationBeginResponse

AdminDispatcherRegisterOfficeApplicationBegin

Begin the process of registering a new Azure AD application that can access Office 365 for backup. After calling this API, you should supply the login details to the end-user, and then begin polling the AdminDispatcherRegisterOfficeApplicationCheck with the supplied “Continuation” parameter to check on the registration process.

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

  • email_address (String) —

    The email address of the Azure AD administrator

Returns:

Raises:

  • (TypeError) 


1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'lib/comet/comet_server.rb', line 1421

def admin_dispatcher_register_office_application_begin(target_id, email_address)
  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, "'email_address' expected String, got #{email_address.class}" unless email_address.is_a? String

  submit_params['EmailAddress'] = email_address

  body = perform_request('api/v1/admin/dispatcher/register-office-application/begin', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::RegisterOfficeApplicationBeginResponse.new
  ret.from_hash(json_body)
  ret
end

#admin_dispatcher_register_office_application_check(target_id, continuation) ⇒ Comet::RegisterOfficeApplicationCheckResponse

AdminDispatcherRegisterOfficeApplicationCheck

Check the process of registering a new Azure AD application that can access Office 365 for backup. You should begin the process by calling AdminDispatcherRegisterOfficeApplicationBegin and asking the end-user to complete the Azure authentication steps.

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

  • continuation (String) —

    The ID returned from the AdminDispatcherRegisterOfficeApplicationBegin endpoint

Returns:

Raises:

  • (TypeError) 


1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'lib/comet/comet_server.rb', line 1449

def admin_dispatcher_register_office_application_check(target_id, continuation)
  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, "'continuation' expected String, got #{continuation.class}" unless continuation.is_a? String

  submit_params['Continuation'] = continuation

  body = perform_request('api/v1/admin/dispatcher/register-office-application/check', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::RegisterOfficeApplicationCheckResponse.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:

Raises:

  • (TypeError) 


1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/comet/comet_server.rb', line 1477

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:

Raises:

  • (TypeError) 


1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/comet/comet_server.rb', line 1503

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:

Raises:

  • (TypeError) 


1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/comet/comet_server.rb', line 1526

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:

Raises:

  • (TypeError) 


1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/comet/comet_server.rb', line 1549

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_mongodb(target_id, credentials) ⇒ Comet::BrowseSQLServerResponse

AdminDispatcherRequestBrowseMongodb

Request a list of tables in MongoDB database. 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

  • credentials (Comet::MongoDBConnection) —

    The Mongo database authentication settings

Returns:

Raises:

  • (TypeError) 


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

def admin_dispatcher_request_browse_mongodb(target_id, credentials)
  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, "'credentials' expected Comet::MongoDBConnection, got #{credentials.class}" unless credentials.is_a? Comet::MongoDBConnection

  submit_params['Credentials'] = credentials.to_json

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

#admin_dispatcher_request_browse_mssql(target_id, credentials) ⇒ Comet::BrowseSQLServerResponse

AdminDispatcherRequestBrowseMssql

Request a list of tables in MSSQL database. 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

  • credentials (Comet::MSSQLConnection) —

    The MSSQL database authentication settings

Returns:

Raises:

  • (TypeError) 


1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'lib/comet/comet_server.rb', line 1602

def admin_dispatcher_request_browse_mssql(target_id, credentials)
  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, "'credentials' expected Comet::MSSQLConnection, got #{credentials.class}" unless credentials.is_a? Comet::MSSQLConnection

  submit_params['Credentials'] = credentials.to_json

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

#admin_dispatcher_request_browse_mysql(target_id, credentials) ⇒ Comet::BrowseSQLServerResponse

AdminDispatcherRequestBrowseMysql

Request a list of tables in MySQL database. 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

  • credentials (Comet::MySQLConnection) —

    The MySQL database authentication settings

Returns:

Raises:

  • (TypeError) 


1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
 
# File 'lib/comet/comet_server.rb', line 1630

def admin_dispatcher_request_browse_mysql(target_id, credentials)
  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, "'credentials' expected Comet::MySQLConnection, got #{credentials.class}" unless credentials.is_a? Comet::MySQLConnection

  submit_params['Credentials'] = credentials.to_json

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

#admin_dispatcher_request_browse_vmware(target_id, credentials) ⇒ Comet::BrowseVMwareResponse

AdminDispatcherRequestBrowseVmware

Request a list of VMware vSphere virtual machines. 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

  • credentials (Comet::VMwareConnection) —

    The VMware vSphere connection settings

Returns:

Raises:

  • (TypeError) 


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
 
# File 'lib/comet/comet_server.rb', line 1658

def admin_dispatcher_request_browse_vmware(target_id, credentials)
  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, "'credentials' expected Comet::VMwareConnection, got #{credentials.class}" unless credentials.is_a? Comet::VMwareConnection

  submit_params['Credentials'] = credentials.to_json

  body = perform_request('api/v1/admin/dispatcher/request-browse-vmware', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::BrowseVMwareResponse.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:

Raises:

  • (TypeError) 


1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
 
# File 'lib/comet/comet_server.rb', line 1684

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) ⇒ Comet::DispatcherStoredObjectsResponse

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:

Raises:

  • (TypeError) 


1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
 
# File 'lib/comet/comet_server.rb', line 1709

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
  ret = Comet::DispatcherStoredObjectsResponse.new
  ret.from_hash(json_body)
  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:

Raises:

  • (TypeError) 


1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/comet/comet_server.rb', line 1737

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_office_365accounts(target_id, credentials) ⇒ Comet::BrowseOffice365ObjectsResponse

AdminDispatcherRequestOffice365Accounts

Request a list of Office365 mailbox accounts. 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:

Returns:

Raises:

  • (TypeError) 


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
 
# File 'lib/comet/comet_server.rb', line 1762

def admin_dispatcher_request_office_365accounts(target_id, credentials)
  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, "'credentials' expected Comet::Office365Credential, got #{credentials.class}" unless credentials.is_a? Comet::Office365Credential

  submit_params['Credentials'] = credentials.to_json

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

#admin_dispatcher_request_office_365sites(target_id, credentials) ⇒ Comet::BrowseOffice365ObjectsResponse

AdminDispatcherRequestOffice365Sites

Request a list of Office365 sites. 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:

Returns:

Raises:

  • (TypeError) 


1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
 
# File 'lib/comet/comet_server.rb', line 1790

def admin_dispatcher_request_office_365sites(target_id, credentials)
  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, "'credentials' expected Comet::Office365Credential, got #{credentials.class}" unless credentials.is_a? Comet::Office365Credential

  submit_params['Credentials'] = credentials.to_json

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

#admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil, options = 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. To service this request, the remote device must connect to the Storage Vault and load index data. There may be a small delay. If the remote device is running Comet 20.12.0 or later, the necessary index data is cached when this API is first called, for 15 minutes after the last repeated call. This can improve performance for interactively browsing an entire tree of stored objects.

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. If it is for VMDK single file restore, it should be the disk image’s subtree ID.

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

    (Optional) Request a list of stored objects in vmdk file

Returns:

Raises:

  • (TypeError) 


1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
 
# File 'lib/comet/comet_server.rb', line 1822

def admin_dispatcher_request_stored_objects(target_id, destination, snapshot_id, tree_id = nil, 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, "'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
  unless options.nil?
    raise TypeError, "'options' expected Comet::VMDKSnapshotViewOptions, got #{options.class}" unless options.is_a? Comet::VMDKSnapshotViewOptions

    submit_params['Options'] = options.to_json
  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:

Raises:

  • (TypeError) 


1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
 
# File 'lib/comet/comet_server.rb', line 1862

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_request_windisk_snapshot(target_id, destination, snapshot_id) ⇒ Comet::DispatcherWindiskSnapshotResponse

AdminDispatcherRequestWindiskSnapshot

Request a Disk Image snapshot with the windiskbrowse-style 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

  • snapshot_id (String) —

    The Snapshot ID

Returns:

Raises:

  • (TypeError) 


1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/comet/comet_server.rb', line 1890

def admin_dispatcher_request_windisk_snapshot(target_id, destination, 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' 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

  body = perform_request('api/v1/admin/dispatcher/request-windisk-snapshot', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::DispatcherWindiskSnapshotResponse.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:

Raises:

  • (TypeError) 


1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
 
# File 'lib/comet/comet_server.rb', line 1920

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:

Raises:

  • (TypeError) 


1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
 
# File 'lib/comet/comet_server.rb', line 1949

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:

Raises:

  • (TypeError) 


1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/comet/comet_server.rb', line 1989

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, known_file_count = nil, known_byte_count = nil, known_dir_count = 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

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

    (Optional) The number of files to restore, if known. Supplying this means we don’t need to walk the entire tree just to find the file count and will speed up the restoration process.

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

    (Optional) The total size in bytes of files to restore, if known. Supplying this means we don’t need to walk the entire tree just to find the total file size and will speed up the restoration process.

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

    (Optional) The number of directories to restore, if known. Supplying this means we don’t need to walk the entire tree just to find the number of directories and will speed up the restoration process.

Returns:

Raises:

  • (TypeError) 


2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
 
# File 'lib/comet/comet_server.rb', line 2040

def admin_dispatcher_run_restore_custom(target_id, source, destination, options, snapshot = nil, paths = nil, known_file_count = nil, known_byte_count = nil, known_dir_count = 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
  unless known_file_count.nil?
    raise TypeError, "'known_file_count' expected Numeric, got #{known_file_count.class}" unless known_file_count.is_a? Numeric

    submit_params['KnownFileCount'] = known_file_count
  end
  unless known_byte_count.nil?
    raise TypeError, "'known_byte_count' expected Numeric, got #{known_byte_count.class}" unless known_byte_count.is_a? Numeric

    submit_params['KnownByteCount'] = known_byte_count
  end
  unless known_dir_count.nil?
    raise TypeError, "'known_dir_count' expected Numeric, got #{known_dir_count.class}" unless known_dir_count.is_a? Numeric

    submit_params['KnownDirCount'] = known_dir_count
  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_search_snapshots(target_id, destination_id, snapshot_ids, filter) ⇒ Comet::SearchSnapshotsResponse

AdminDispatcherSearchSnapshots

Search storage vault snapshots.

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_ids (Array<String>) —

    Snapshots to search

  • filter (Comet::SearchClause) —

    The search filter

Returns:

Raises:

  • (TypeError) 


2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/comet/comet_server.rb', line 2100

def admin_dispatcher_search_snapshots(target_id, destination_id, snapshot_ids, filter)
  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_ids' expected Array, got #{snapshot_ids.class}" unless snapshot_ids.is_a? Array

  submit_params['SnapshotIDs'] = snapshot_ids.to_json
  raise TypeError, "'filter' expected Comet::SearchClause, got #{filter.class}" unless filter.is_a? Comet::SearchClause

  submit_params['Filter'] = filter.to_json

  body = perform_request('api/v1/admin/dispatcher/search-snapshots', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::SearchSnapshotsResponse.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:

Raises:

  • (TypeError) 


2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
 
# File 'lib/comet/comet_server.rb', line 2133

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:

Raises:

  • (TypeError) 


2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/comet/comet_server.rb', line 2160

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, force = nil) ⇒ 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

  • force (Boolean) (defaults to: nil) —

    (Optional) No checks will be done using previous URL

Returns:

Raises:

  • (TypeError) 


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

def (target_id, new_url, force = 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, "'new_url' expected String, got #{new_url.class}" unless new_url.is_a? String

  submit_params['NewURL'] = new_url
  unless force.nil?
    submit_params['Force'] = (force ? 1 : 0)
  end

  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:

Raises:

  • (TypeError) 


2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
 
# File 'lib/comet/comet_server.rb', line 2220

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_external_auth_sources_delete(source_id) ⇒ Comet::CometAPIResponseMessage

AdminExternalAuthSourcesDelete

Delete an external admin authentication source.

You must supply administrator authentication credentials to use this API.

Parameters:

  • source_id (String) —

    (No description available)

Returns:

Raises:

  • (TypeError) 


2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
 
# File 'lib/comet/comet_server.rb', line 2249

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

  submit_params['SourceID'] = source_id

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

#admin_external_auth_sources_get ⇒ Hash{String => Comet::ExternalAuthenticationSource}

AdminExternalAuthSourcesGet

Get a map of all external admin authentication sources.

You must supply administrator authentication credentials to use this API.

Returns:



2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
 
# File 'lib/comet/comet_server.rb', line 2270

def admin_external_auth_sources_get
  body = perform_request('api/v1/admin/external-auth-sources/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::ExternalAuthenticationSource.new
      ret[k].from_hash(v)
    end
  end
  ret
end

#admin_external_auth_sources_new(source, source_id = nil) ⇒ Comet::ExternalAuthenticationSourceResponse

AdminExternalAuthSourcesNew

Create an external admin authentication source.

You must supply administrator authentication credentials to use this API.

Parameters:

Returns:

Raises:

  • (TypeError) 


2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
 
# File 'lib/comet/comet_server.rb', line 2295

def admin_external_auth_sources_new(source, source_id = nil)
  submit_params = {}
  raise TypeError, "'source' expected Comet::ExternalAuthenticationSource, got #{source.class}" unless source.is_a? Comet::ExternalAuthenticationSource

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

    submit_params['SourceID'] = source_id
  end

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

#admin_external_auth_sources_set(sources) ⇒ Comet::CometAPIResponseMessage

AdminExternalAuthSourcesSet

Updates the current tenant’s external admin authentication sources. This will set all. sources for the tenant; none will be preserved.

You must supply administrator authentication credentials to use this API.

Parameters:

Returns:

Raises:

  • (TypeError) 


2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
 
# File 'lib/comet/comet_server.rb', line 2323

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

  submit_params['Sources'] = sources.to_json

  body = perform_request('api/v1/admin/external-auth-sources/set', 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)

Raises:

  • (TypeError) 


2346
2347
2348
2349
2350
2351
2352
2353
 
# File 'lib/comet/comet_server.rb', line 2346

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, min_severity = nil, message_contains = nil) ⇒ 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

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

    (Optional) Return only job log entries with equal or higher severity

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

    (Optional) Return only job log entries that contain exact string

Returns:

Raises:

  • (TypeError) 


2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
 
# File 'lib/comet/comet_server.rb', line 2366

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

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

    submit_params['MinSeverity'] = min_severity
  end
  unless message_contains.nil?
    raise TypeError, "'message_contains' expected String, got #{message_contains.class}" unless message_contains.is_a? String

    submit_params['MessageContains'] = message_contains
  end

  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:

Raises:

  • (TypeError) 


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
 
# File 'lib/comet/comet_server.rb', line 2406

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:



2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
 
# File 'lib/comet/comet_server.rb', line 2429

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:

Raises:

  • (TypeError) 


2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
 
# File 'lib/comet/comet_server.rb', line 2455

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 only incomplete jobs by setting both `Start` and `End` to `0`.

Prior to Comet Server 22.6.0, additional Incomplete jobs may have been returned if you specified non-zero arguments for both ‘Start` and `End`.

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:

Raises:

  • (TypeError) 


2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
 
# File 'lib/comet/comet_server.rb', line 2495

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:

Raises:

  • (TypeError) 


2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
 
# File 'lib/comet/comet_server.rb', line 2529

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:



2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
 
# File 'lib/comet/comet_server.rb', line 2559

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:

Raises:

  • (TypeError) 


2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
 
# File 'lib/comet/comet_server.rb', line 2584

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:

Raises:

  • (TypeError) 


2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
 
# File 'lib/comet/comet_server.rb', line 2609

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:

Raises:

  • (TypeError) 


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
 
# File 'lib/comet/comet_server.rb', line 2634

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_installation_dispatch_drop_connection(device_id) ⇒ Comet::CometAPIResponseMessage

AdminInstallationDispatchDropConnection

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:

  • device_id (String) —

    The live connection Device GUID

Returns:

Raises:

  • (TypeError) 


2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
 
# File 'lib/comet/comet_server.rb', line 2658

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

  submit_params['DeviceID'] = device_id

  body = perform_request('api/v1/admin/installation/dispatch/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_installation_dispatch_register_device(device_id, target_user, target_password, target_totpcode = nil) ⇒ String

AdminInstallationDispatchRegisterDevice

Instruct an unregistered device to authenticate with a given user.

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

Parameters:

  • device_id (String) —

    The live connection Device GUID

  • target_user (String) —

    Selected account username

  • target_password (String) —

    Selected account password

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

    (Optional) Selected account TOTP code

Returns:

  • (String)

Raises:

  • (TypeError) 


2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
 
# File 'lib/comet/comet_server.rb', line 2684

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

  submit_params['DeviceID'] = device_id
  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_totpcode.nil?
    raise TypeError, "'target_totpcode' expected String, got #{target_totpcode.class}" unless target_totpcode.is_a? String

    submit_params['TargetTOTPCode'] = target_totpcode
  end

  body = perform_request('api/v1/admin/installation/dispatch/register-device', submit_params)
  json_body = JSON.parse body
  check_status json_body
  raise TypeError, "'json_body' expected String, got #{json_body.class}" unless json_body.is_a? String

  ret = json_body
  ret
end

#admin_installation_list_active ⇒ Hash{String => Comet::RegistrationLobbyConnection}

AdminInstallationListActive

List live connected devices in lobby mode.

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

Returns:



2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
 
# File 'lib/comet/comet_server.rb', line 2718

def admin_installation_list_active
  body = perform_request('api/v1/admin/installation/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::RegistrationLobbyConnection.new
      ret[k].from_hash(v)
    end
  end
  ret
end

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

AdminJobAbandon

Mark a running job as abandoned. This will change the status of a running job to abandoned. This is intended to be used on jobs which are definitely no longer running but are stuck in the running state; it will not attempt to cancel the job. If the job is detected to still be running after being marked as abandoned, it will be revived.

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:

Raises:

  • (TypeError) 


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
 
# File 'lib/comet/comet_server.rb', line 2746

def admin_job_abandon(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/abandon', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.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. If the device is running Comet 21.9.5 or later, this API will wait up to ten seconds for a confirmation from the client.

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:

Raises:

  • (TypeError) 


2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
 
# File 'lib/comet/comet_server.rb', line 2776

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>) 


2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
 
# File 'lib/comet/comet_server.rb', line 2801

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:



2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/comet/comet_server.rb', line 2826

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:



2850
2851
2852
2853
2854
2855
2856
2857
 
# File 'lib/comet/comet_server.rb', line 2850

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:

Raises:

  • (TypeError) 


2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
 
# File 'lib/comet/comet_server.rb', line 2869

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:



2891
2892
2893
2894
2895
2896
2897
2898
 
# File 'lib/comet/comet_server.rb', line 2891

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:

Raises:

  • (TypeError) 


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

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_constellation_config_get ⇒ Comet::ConstellationRoleOptions

AdminMetaConstellationConfigGet

Get Constellation configuration for the current organization.

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

Returns:



2931
2932
2933
2934
2935
2936
2937
2938
 
# File 'lib/comet/comet_server.rb', line 2931

def admin_meta_constellation_config_get
  body = perform_request('api/v1/admin/meta/constellation/config/get')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::ConstellationRoleOptions.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_constellation_config_set(constellation_role_options) ⇒ Comet::CometAPIResponseMessage

AdminMetaConstellationConfigSet

Set Constellation configuration for the current organization.

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

Parameters:

Returns:

Raises:

  • (TypeError) 


2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
 
# File 'lib/comet/comet_server.rb', line 2949

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

  submit_params['ConstellationRoleOptions'] = constellation_role_options.to_json

  body = perform_request('api/v1/admin/meta/constellation/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_email_options_get ⇒ Comet::EmailOptions

AdminMetaEmailOptionsGet

Get the email options.

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

Returns:



2971
2972
2973
2974
2975
2976
2977
2978
 
# File 'lib/comet/comet_server.rb', line 2971

def admin_meta_email_options_get
  body = perform_request('api/v1/admin/meta/email-options/get')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::EmailOptions.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_email_options_set(email_options) ⇒ Comet::CometAPIResponseMessage

AdminMetaEmailOptionsSet

Set the email 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:

Raises:

  • (TypeError) 


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
 
# File 'lib/comet/comet_server.rb', line 2989

def admin_meta_email_options_set(email_options)
  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

  body = perform_request('api/v1/admin/meta/email-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_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 top-level administrator accounts, not for Tenant administrator accounts.

Returns:

  • (Array<Number>) 


3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
 
# File 'lib/comet/comet_server.rb', line 3011

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_psa_config_list_get ⇒ Array<Comet::PSAConfig>

AdminMetaPsaConfigListGet

Get the server PSA configuration.

You must supply administrator authentication credentials to use this API.

Returns:



3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
 
# File 'lib/comet/comet_server.rb', line 3035

def admin_meta_psa_config_list_get
  body = perform_request('api/v1/admin/meta/psa-config-list/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::PSAConfig.new
      ret[i].from_hash(v)
    end
  end
  ret
end

#admin_meta_psa_config_list_set(psaconfig_list) ⇒ Comet::CometAPIResponseMessage

AdminMetaPsaConfigListSet

Update the server PSA configuration.

You must supply administrator authentication credentials to use this API.

Parameters:

  • psaconfig_list (Array<Comet::PSAConfig>) —

    The replacement PSA configuration list

Returns:

Raises:

  • (TypeError) 


3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'lib/comet/comet_server.rb', line 3059

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

  submit_params['PSAConfigList'] = psaconfig_list.to_json

  body = perform_request('api/v1/admin/meta/psa-config-list/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_psa_config_list_sync_now ⇒ Comet::CometAPIResponseMessage

AdminMetaPsaConfigListSyncNow

Synchronize all PSA services now. This API applies to the current Organization’s PSAConfig’s only.

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

Returns:



3082
3083
3084
3085
3086
3087
3088
3089
 
# File 'lib/comet/comet_server.rb', line 3082

def admin_meta_psa_config_list_sync_now
  body = perform_request('api/v1/admin/meta/psa-config-list/sync-now')
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_meta_read_all_logs ⇒ String

AdminMetaReadAllLogs

Get a ZIP file of all of the server’s log files. 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 top-level administrator accounts, not for Tenant administrator accounts.

Returns:

  • (String) 


3101
3102
3103
 
# File 'lib/comet/comet_server.rb', line 3101

def admin_meta_read_all_logs
  perform_request('api/v1/admin/meta/read-all-logs')
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 top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

  • log (Number) —

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

Returns:

  • (String)

Raises:

  • (TypeError) 


3116
3117
3118
3119
3120
3121
3122
3123
 
# File 'lib/comet/comet_server.rb', line 3116

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:



3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
 
# File 'lib/comet/comet_server.rb', line 3133

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 Storage template 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:

Raises:

  • (TypeError) 


3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
 
# File 'lib/comet/comet_server.rb', line 3158

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_remote_storage_vault_test(template_options) ⇒ Comet::CometAPIResponseMessage

AdminMetaRemoteStorageVaultTest

Test the connection to the storage template.

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

Parameters:

Returns:

Raises:

  • (TypeError) 


3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'lib/comet/comet_server.rb', line 3181

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

  submit_params['TemplateOptions'] = template_options.to_json

  body = perform_request('api/v1/admin/meta/remote-storage-vault/test', 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)

Raises:

  • (TypeError) 


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

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_resource_new(upload) ⇒ Comet::AdminResourceResponse

AdminMetaResourceNew

Upload a resource file. Resources are used to upload files within the server configuration. The resulting resource ID is autogenerated. The lifespan of an uploaded resource is undefined. Resources may be deleted automatically, but it should remain available until the next call to AdminMetaServerConfigSet, and will remain available for as long as it is referenced by the server configuration.

You must supply administrator authentication credentials to use this API.

Parameters:

  • upload (String) —

    The uploaded file contents, as a multipart/form-data part.

Returns:

Raises:

  • (TypeError) 


3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
 
# File 'lib/comet/comet_server.rb', line 3224

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

  submit_params['upload'] = upload

  body = perform_request_multipart('api/v1/admin/meta/resource/new', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::AdminResourceResponse.new
  ret.from_hash(json_body)
  ret
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 top-level administrator accounts, not for Tenant administrator accounts. Access to this API may be prevented on a per-administrator basis.

Returns:



3250
3251
3252
3253
3254
3255
3256
3257
 
# File 'lib/comet/comet_server.rb', line 3250

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. 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:

Raises:

  • (TypeError) 


3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
 
# File 'lib/comet/comet_server.rb', line 3270

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_send_test_report(email_reporting_option) ⇒ Comet::CometAPIResponseMessage

AdminMetaSendTestReport

Send a test admin email report. This allows a user to send a test email report

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

Parameters:

Returns:

Raises:

  • (TypeError) 


3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
 
# File 'lib/comet/comet_server.rb', line 3297

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

  submit_params['EmailReportingOption'] = email_reporting_option.to_json

  body = perform_request('api/v1/admin/meta/send-test-report', 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 top-level administrator accounts, not for Tenant administrator accounts.

Returns:



3320
3321
3322
3323
3324
3325
3326
3327
 
# File 'lib/comet/comet_server.rb', line 3320

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 top-level administrator accounts, not for Tenant administrator accounts.

Returns:

  • (Array<String>) 


3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
 
# File 'lib/comet/comet_server.rb', line 3339

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 top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

Returns:

Raises:

  • (TypeError) 


3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
 
# File 'lib/comet/comet_server.rb', line 3369

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 top-level administrator accounts, not for Tenant administrator accounts. Access to this API may be prevented on a per-administrator basis.

Returns:



3395
3396
3397
3398
3399
3400
3401
3402
 
# File 'lib/comet/comet_server.rb', line 3395

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:



3411
3412
3413
3414
3415
3416
3417
3418
 
# File 'lib/comet/comet_server.rb', line 3411

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:



3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
 
# File 'lib/comet/comet_server.rb', line 3429

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:



3456
3457
3458
3459
3460
3461
3462
3463
 
# File 'lib/comet/comet_server.rb', line 3456

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. Access to this API may be prevented on a per-administrator basis.

Returns:



3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
 
# File 'lib/comet/comet_server.rb', line 3473

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. Access to this API may be prevented on a per-administrator basis.

Parameters:

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

    The replacement webhook target options.

Returns:

Raises:

  • (TypeError) 


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
 
# File 'lib/comet/comet_server.rb', line 3499

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:



3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
 
# File 'lib/comet/comet_server.rb', line 3521

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:

Raises:

  • (TypeError) 


3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
 
# File 'lib/comet/comet_server.rb', line 3546

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:

Raises:

  • (TypeError) 


3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
 
# File 'lib/comet/comet_server.rb', line 3569

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::CometAPIResponseMessage

AdminOrganizationDelete

Delete an organization and all related users.

Prior to Comet 22.6.0, this API was documented as returning the OrganizationResponse type. However, it always has returned only a CometAPIResponseMessage.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

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

    (Optional) (No description available)

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

    (Optional) Uninstall software configuration

Returns:



3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
 
# File 'lib/comet/comet_server.rb', line 3595

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::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  ret
end

#admin_organization_export(options) ⇒ Comet::CometAPIResponseMessage

AdminOrganizationExport

Run self-backup for a specific tenant.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

Returns:

Raises:

  • (TypeError) 


3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
 
# File 'lib/comet/comet_server.rb', line 3625

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

  submit_params['Options'] = options.to_json

  body = perform_request('api/v1/admin/organization/export', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.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 top-level administrator accounts, not for Tenant administrator accounts.

Returns:



3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
 
# File 'lib/comet/comet_server.rb', line 3647

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.

Prior to Comet 22.6.0, the ‘ID’ and ‘Organization’ fields were not present in the response.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

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

    (Optional) (No description available)

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

    (Optional) (No description available)

Returns:



3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
 
# File 'lib/comet/comet_server.rb', line 3675

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:

Raises:

  • (TypeError) 


3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
 
# File 'lib/comet/comet_server.rb', line 3705

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:

Raises:

  • (TypeError) 


3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
 
# File 'lib/comet/comet_server.rb', line 3729

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(target_organization = nil) ⇒ Hash{String => String}

AdminPoliciesList

List all policy object names. For the top-level organization, the API result includes all policies for all organizations, unless the TargetOrganization parameter is present.

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

Parameters:

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

    (Optional) If present, list the policies belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

Returns:

  • (Hash{String => String}) 


3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
 
# File 'lib/comet/comet_server.rb', line 3753

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

    submit_params['TargetOrganization'] = target_organization
  end

  body = perform_request('api/v1/admin/policies/list', submit_params)
  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(target_organization = nil) ⇒ Hash{String => Comet::GroupPolicy}

AdminPoliciesListFull

Get all policy objects. For the top-level organization, the API result includes all policies for all organizations, unless the TargetOrganization parameter is present.

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

Parameters:

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

    (Optional) If present, list the policies belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

Returns:



3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
 
# File 'lib/comet/comet_server.rb', line 3787

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

    submit_params['TargetOrganization'] = target_organization
  end

  body = perform_request('api/v1/admin/policies/list-full', 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::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:

Raises:

  • (TypeError) 


3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
 
# File 'lib/comet/comet_server.rb', line 3819

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:

Raises:

  • (TypeError) 


3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
 
# File 'lib/comet/comet_server.rb', line 3846

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:

Raises:

  • (TypeError) 


3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
 
# File 'lib/comet/comet_server.rb', line 3879

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 top-level administrator accounts, not for Tenant administrator accounts.

Returns:



3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
 
# File 'lib/comet/comet_server.rb', line 3909

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). The StorageProvider must exist for the target user account’s organization.

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 storage template destination

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

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

Returns:

Raises:

  • (TypeError) 


3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
 
# File 'lib/comet/comet_server.rb', line 3939

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(target_organization = nil) ⇒ 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.

Parameters:

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

    (Optional) If present, list the storage template options belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

Returns:

  • (Hash{String => String}) 


3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
 
# File 'lib/comet/comet_server.rb', line 3972

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

    submit_params['TargetOrganization'] = target_organization
  end

  body = perform_request('api/v1/admin/request-storage-vault-providers', submit_params)
  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 = nil) ⇒ 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) (defaults to: nil) —

    (Optional) Old account password. Required if no recovery code is present for the user account.

Returns:

Raises:

  • (TypeError) 


4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
 
# File 'lib/comet/comet_server.rb', line 4008

def admin_reset_user_password(target_user, new_password, old_password = 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, "'new_password' expected String, got #{new_password.class}" unless new_password.is_a? String

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

    submit_params['OldPassword'] = old_password
  end

  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:

Raises:

  • (TypeError) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
 
# File 'lib/comet/comet_server.rb', line 4041

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_self_backup_start ⇒ Comet::CometAPIResponseMessage

AdminSelfBackupStart

Run self-backup on all targets.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

Returns:



4066
4067
4068
4069
4070
4071
4072
4073
 
# File 'lib/comet/comet_server.rb', line 4066

def admin_self_backup_start
  body = perform_request('api/v1/admin/self-backup/start')
  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:

Raises:

  • (TypeError) 


4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
 
# File 'lib/comet/comet_server.rb', line 4085

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:

Raises:

  • (TypeError) 


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
 
# File 'lib/comet/comet_server.rb', line 4115

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:

Raises:

  • (TypeError) 


4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
 
# File 'lib/comet/comet_server.rb', line 4146

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:

Raises:

  • (TypeError) 


4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
 
# File 'lib/comet/comet_server.rb', line 4175

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 top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

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

    (Optional) (This parameter is not used)

Returns:



4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
 
# File 'lib/comet/comet_server.rb', line 4200

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:



4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
 
# File 'lib/comet/comet_server.rb', line 4224

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_ping_destination(extra_data) ⇒ Comet::CometAPIResponseMessage

AdminStoragePingDestination

Ping a storage destination.

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 top-level administrator accounts, not for Tenant administrator accounts.

Parameters:

Returns:

Raises:

  • (TypeError) 


4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
 
# File 'lib/comet/comet_server.rb', line 4250

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

  submit_params['ExtraData'] = extra_data.to_json

  body = perform_request('api/v1/admin/storage/ping-destination', submit_params)
  json_body = JSON.parse body
  check_status json_body
  ret = Comet::CometAPIResponseMessage.new
  ret.from_hash(json_body)
  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:



4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
 
# File 'lib/comet/comet_server.rb', line 4278

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 top-level administrator accounts, not for Tenant administrator accounts. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameters:

Returns:

Raises:

  • (TypeError) 


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
 
# File 'lib/comet/comet_server.rb', line 4320

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 top-level administrator accounts, not for Tenant administrator accounts. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Returns:



4344
4345
4346
4347
4348
4349
4350
4351
 
# File 'lib/comet/comet_server.rb', line 4344

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:



4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
 
# File 'lib/comet/comet_server.rb', line 4407

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:



4360
4361
4362
4363
4364
4365
4366
4367
 
# File 'lib/comet/comet_server.rb', line 4360

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



4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
 
# File 'lib/comet/comet_server.rb', line 4423

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

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

Perform a synchronous HTTP request, using multipart/form-data.

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



4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
 
# File 'lib/comet/comet_server.rb', line 4442

def perform_request_multipart(endpoint, params = {})
  full_uri = URI(@server_address + endpoint)

  req = Net::HTTP::Post.new(full_uri)
  req['X-Comet-Admin-Username'] = @username
  req['X-Comet-Admin-AuthType'] = 'Password'
  req['X-Comet-Admin-Password'] = @password

  form_params = []
  params.each do |k, v|
    form_params.append [k, v, {:filename => k}]
  end
  req.set_form(form_params, 'multipart/form-data')

  http = Net::HTTP.new(full_uri.hostname, full_uri.port)
  res = http.request(req)

  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:



4377
4378
4379
4380
4381
4382
4383
4384
 
# File 'lib/comet/comet_server.rb', line 4377

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:



4394
4395
4396
4397
4398
4399
4400
4401
 
# File 'lib/comet/comet_server.rb', line 4394

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