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


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

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) 


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

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) 


204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/comet/comet_server.rb', line 204

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) 


240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/comet/comet_server.rb', line 240

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) 


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

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) 


286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/comet/comet_server.rb', line 286

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) 


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/comet/comet_server.rb', line 319

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) 


363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/comet/comet_server.rb', line 363

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) 


395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/comet/comet_server.rb', line 395

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:



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

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) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/comet/comet_server.rb', line 446

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:



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/comet/comet_server.rb', line 477

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) 


504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/comet/comet_server.rb', line 504

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/comet/comet_server.rb', line 646

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) 


678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/comet/comet_server.rb', line 678

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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:



846
847
848
849
850
851
852
853
 
# File 'lib/comet/comet_server.rb', line 846

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:



863
864
865
866
867
868
869
870
 
# File 'lib/comet/comet_server.rb', line 863

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:



881
882
883
884
885
886
887
888
 
# File 'lib/comet/comet_server.rb', line 881

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:



898
899
900
901
902
903
904
905
 
# File 'lib/comet/comet_server.rb', line 898

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) 


916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/comet/comet_server.rb', line 916

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) 


944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/comet/comet_server.rb', line 944

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) 


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

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) 


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

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) 


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

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) 


1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/comet/comet_server.rb', line 1061

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) 


1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/comet/comet_server.rb', line 1089

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) 


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/comet/comet_server.rb', line 1121

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) 


1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'lib/comet/comet_server.rb', line 1151

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) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/comet/comet_server.rb', line 1178

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) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'lib/comet/comet_server.rb', line 1211

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) 


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

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) 


1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/comet/comet_server.rb', line 1263

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:



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/comet/comet_server.rb', line 1286

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) 


1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/comet/comet_server.rb', line 1320

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) 


1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/comet/comet_server.rb', line 1347

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) 


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/comet/comet_server.rb', line 1374

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) 


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/comet/comet_server.rb', line 1399

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) 


1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/comet/comet_server.rb', line 1427

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) 


1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/comet/comet_server.rb', line 1455

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) 


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

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) 


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

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) 


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

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) 


1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/comet/comet_server.rb', line 1552

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) 


1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/comet/comet_server.rb', line 1580

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) 


1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
 
# File 'lib/comet/comet_server.rb', line 1608

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


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

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) 


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

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) 


1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
 
# File 'lib/comet/comet_server.rb', line 1687

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) 


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

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) 


1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/comet/comet_server.rb', line 1740

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) 


1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
 
# File 'lib/comet/comet_server.rb', line 1772

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) 


1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/comet/comet_server.rb', line 1812

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) 


1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
 
# File 'lib/comet/comet_server.rb', line 1840

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) 


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

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) 


1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'lib/comet/comet_server.rb', line 1899

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) 


1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/comet/comet_server.rb', line 1939

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

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

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

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

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

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

    submit_params['Paths'] = paths.to_json
  end

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

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

AdminDispatcherRunRestoreCustom

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

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

Parameters:

  • target_id (String) —

    The live connection GUID

  • source (String) —

    The Protected Item ID

  • destination (String) —

    The Storage Vault ID

  • options (Comet::RestoreJobAdvancedOptions) —

    Restore targets

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

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

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

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

Returns:

Raises:

  • (TypeError) 


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

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

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

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

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

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

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

    submit_params['Paths'] = paths.to_json
  end

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

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

AdminDispatcherUninstallSoftware

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

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

Parameters:

  • target_id (String) —

    The live connection GUID

  • remove_config_file (Boolean) —

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

Returns:

Raises:

  • (TypeError) 


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

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) 


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

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) 


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
 
# File 'lib/comet/comet_server.rb', line 2086

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) 


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
 
# File 'lib/comet/comet_server.rb', line 2117

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

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

    submit_params['SelfAddress'] = self_address
  end

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

#admin_get_job_log(job_id) ⇒ String

AdminGetJobLog

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

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

Parameters:

  • job_id (String) —

    Selected job ID

Returns:

  • (String)

Raises:

  • (TypeError) 


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

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) 


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
 
# File 'lib/comet/comet_server.rb', line 2167

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) 


2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'lib/comet/comet_server.rb', line 2207

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:



2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
 
# File 'lib/comet/comet_server.rb', line 2230

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) 


2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
 
# File 'lib/comet/comet_server.rb', line 2256

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) 


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

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) 


2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
 
# File 'lib/comet/comet_server.rb', line 2330

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:



2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
 
# File 'lib/comet/comet_server.rb', line 2360

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) 


2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/comet/comet_server.rb', line 2385

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) 


2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
 
# File 'lib/comet/comet_server.rb', line 2410

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) 


2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
 
# File 'lib/comet/comet_server.rb', line 2435

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

  submit_params['TargetUser'] = target_user

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

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

AdminJobCancel

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


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

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


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

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:



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
 
# File 'lib/comet/comet_server.rb', line 2512

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:



2536
2537
2538
2539
2540
2541
2542
2543
 
# File 'lib/comet/comet_server.rb', line 2536

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) 


2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
 
# File 'lib/comet/comet_server.rb', line 2555

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:



2577
2578
2579
2580
2581
2582
2583
2584
 
# File 'lib/comet/comet_server.rb', line 2577

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) 


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

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:



2617
2618
2619
2620
2621
2622
2623
2624
 
# File 'lib/comet/comet_server.rb', line 2617

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) 


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

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:



2657
2658
2659
2660
2661
2662
2663
2664
 
# File 'lib/comet/comet_server.rb', line 2657

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) 


2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/comet/comet_server.rb', line 2675

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


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

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:



2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
 
# File 'lib/comet/comet_server.rb', line 2721

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) 


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

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:



2768
2769
2770
2771
2772
2773
2774
2775
 
# File 'lib/comet/comet_server.rb', line 2768

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) 


2787
2788
2789
 
# File 'lib/comet/comet_server.rb', line 2787

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) 


2802
2803
2804
2805
2806
2807
2808
2809
 
# File 'lib/comet/comet_server.rb', line 2802

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:



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

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) 


2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
 
# File 'lib/comet/comet_server.rb', line 2844

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

  submit_params['RemoteStorageOptions'] = remote_storage_options.to_json

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

#admin_meta_resource_get(hash) ⇒ String

AdminMetaResourceGet

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

You must supply administrator authentication credentials to use this API.

Parameters:

  • hash (String) —

    The resource identifier

Returns:

  • (String)

Raises:

  • (TypeError) 


2867
2868
2869
2870
2871
2872
2873
2874
 
# File 'lib/comet/comet_server.rb', line 2867

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) 


2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
 
# File 'lib/comet/comet_server.rb', line 2887

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:



2913
2914
2915
2916
2917
2918
2919
2920
 
# File 'lib/comet/comet_server.rb', line 2913

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) 


2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
 
# File 'lib/comet/comet_server.rb', line 2933

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) 


2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'lib/comet/comet_server.rb', line 2960

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:



2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/comet/comet_server.rb', line 2983

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


3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
 
# File 'lib/comet/comet_server.rb', line 3002

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) 


3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
 
# File 'lib/comet/comet_server.rb', line 3032

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:



3058
3059
3060
3061
3062
3063
3064
3065
 
# File 'lib/comet/comet_server.rb', line 3058

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:



3074
3075
3076
3077
3078
3079
3080
3081
 
# File 'lib/comet/comet_server.rb', line 3074

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:



3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
 
# File 'lib/comet/comet_server.rb', line 3092

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:



3119
3120
3121
3122
3123
3124
3125
3126
 
# File 'lib/comet/comet_server.rb', line 3119

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:



3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
 
# File 'lib/comet/comet_server.rb', line 3136

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) 


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
 
# File 'lib/comet/comet_server.rb', line 3162

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:



3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
 
# File 'lib/comet/comet_server.rb', line 3184

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) 


3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
 
# File 'lib/comet/comet_server.rb', line 3209

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) 


3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
 
# File 'lib/comet/comet_server.rb', line 3232

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:



3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
 
# File 'lib/comet/comet_server.rb', line 3258

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) 


3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/comet/comet_server.rb', line 3288

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:



3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
 
# File 'lib/comet/comet_server.rb', line 3310

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:



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

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) 


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

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) 


3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
 
# File 'lib/comet/comet_server.rb', line 3392

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


3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
 
# File 'lib/comet/comet_server.rb', line 3416

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:



3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
 
# File 'lib/comet/comet_server.rb', line 3450

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) 


3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
 
# File 'lib/comet/comet_server.rb', line 3482

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) 


3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
 
# File 'lib/comet/comet_server.rb', line 3509

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) 


3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/comet/comet_server.rb', line 3542

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:



3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
 
# File 'lib/comet/comet_server.rb', line 3572

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) 


3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
 
# File 'lib/comet/comet_server.rb', line 3602

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


3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
 
# File 'lib/comet/comet_server.rb', line 3635

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) 


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

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) 


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

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:



3729
3730
3731
3732
3733
3734
3735
3736
 
# File 'lib/comet/comet_server.rb', line 3729

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) 


3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
 
# File 'lib/comet/comet_server.rb', line 3748

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) 


3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
 
# File 'lib/comet/comet_server.rb', line 3778

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) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
 
# File 'lib/comet/comet_server.rb', line 3809

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) 


3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
 
# File 'lib/comet/comet_server.rb', line 3838

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:



3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
 
# File 'lib/comet/comet_server.rb', line 3863

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:



3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
 
# File 'lib/comet/comet_server.rb', line 3887

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

Parameters:

Returns:

Raises:

  • (TypeError) 


3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
 
# File 'lib/comet/comet_server.rb', line 3914

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:



3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
 
# File 'lib/comet/comet_server.rb', line 3942

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) 


3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
 
# File 'lib/comet/comet_server.rb', line 3984

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:



4008
4009
4010
4011
4012
4013
4014
4015
 
# File 'lib/comet/comet_server.rb', line 4008

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:



4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
 
# File 'lib/comet/comet_server.rb', line 4071

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:



4024
4025
4026
4027
4028
4029
4030
4031
 
# File 'lib/comet/comet_server.rb', line 4024

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



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

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



4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
 
# File 'lib/comet/comet_server.rb', line 4106

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:



4041
4042
4043
4044
4045
4046
4047
4048
 
# File 'lib/comet/comet_server.rb', line 4041

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:



4058
4059
4060
4061
4062
4063
4064
4065
 
# File 'lib/comet/comet_server.rb', line 4058

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