comet_backup_ruby_sdk 2.13.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd580d387bff734854661ad2a96745a0687538a2fc1597ca3fa193a37451bc1c
-  data.tar.gz: d64c702fbd3f7aabd58a4653f6753374b1e54faad802eb184b5e9804bc59c54d
+  metadata.gz: 262330318e772731adda8873518301dcc352e8d558fdd9b884ba5b6a51294caa
+  data.tar.gz: 2e2f507f7491f7588d45d4227cdd39cf4dc2ac5291dd49175fa2c1e6f966ab24
 SHA512:
-  metadata.gz: e1a4cb81494020fb4fba9c5c0d524ec22f01afe605eb87568a0f6d4b91b9c7327e79ac8b8970cde56c70f6ee2bb343e3c7cfea325b88ec92db5c3c6c6fa94817
-  data.tar.gz: d76d0ce3aa82f4d986271ef1568271937edb3e397bd289e7e206c559dd8007a62eff01d073e91aad83d8d357c3bd63e4b56d037e21bea72c745cf7e8ce097789
+  metadata.gz: 20ab7b575bd8b2154021882e424aa95f9793f297a6f1d8562d8f94c89d9b3ba38ffb6ddfdcd239f8d2e5ab45c70c57c57a3c920c69a51f5444161aa3fdc551b2
+  data.tar.gz: c5e28a689ee9fe9d34eb558c2cd8d3f25704728fb88996e3a2b3a230cb3f776bcb3903d7848fbd9854d4e9b0e802c27afbfced381c9c64d367d893d0f41b878c

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## 2023-10-12 v2.15.0
+
+- Based on Comet 23.9.5
+- Add new field `LogLevel` to control job log verbosity
+- Add new `RESTORETYPE_WINDISK_ESXI` for restoring to VMware-compatible
+virtual disks
+
+## 2023-09-19 v2.14.0
+
+- Based on Comet 23.9.2
+- 'UseObjectLock' for S3 compatible storage settings deprecated. Replaced by 'ObjectLockMode'
+- New Streamable event SEVT_DEVICE_LOBBY_CONNECT and SEVT_DEVICE_LOBBY_DISCONNECT
+- Added 'TOTPCode' to 'InstallCreds' used for device registration.
+- 'GroupedBy' added to 'PSAConfig' for grouping statistics.
+- New APIs
+	- AdminInstallationDispatchDropConnection
+	- AdminInstallationDispatchRegisterDevice
+	- AdminInstallationListActive
+	- AdminJobAbandon
+
 ## 2023-08-29 v2.13.0
 
 - Based on Comet 23.8.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.13.0)
+    comet_backup_ruby_sdk (2.15.0)
 
 GEM
   remote: https://rubygems.org/

data/comet_backup_ruby_sdk.gemspec

@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'comet_backup_ruby_sdk'
-  spec.version       = '2.13.0'
+  spec.version       = '2.15.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -2617,6 +2617,121 @@ module Comet
       ret
     end
 
+    # AdminInstallationDispatchDropConnection
+    #
+    # Instruct a live connected device to disconnect.
+    # The device will terminate its live-connection process and will not reconnect.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] device_id The live connection Device GUID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_installation_dispatch_drop_connection(device_id)
+      submit_params = {}
+      raise TypeError, "'device_id' expected String, got #{device_id.class}" unless device_id.is_a? String
+
+      submit_params['DeviceID'] = device_id
+
+      body = perform_request('api/v1/admin/installation/dispatch/drop-connection', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminInstallationDispatchRegisterDevice
+    #
+    # Instruct an unregistered device to authenticate with a given user.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] device_id The live connection Device GUID
+    # @param [String] target_user Selected account username
+    # @param [String] target_password Selected account password
+    # @param [String] target_totpcode (Optional) Selected account TOTP code
+    # @return [String]
+    def admin_installation_dispatch_register_device(device_id, target_user, target_password, target_totpcode = nil)
+      submit_params = {}
+      raise TypeError, "'device_id' expected String, got #{device_id.class}" unless device_id.is_a? String
+
+      submit_params['DeviceID'] = device_id
+      raise TypeError, "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError, "'target_password' expected String, got #{target_password.class}" unless target_password.is_a? String
+
+      submit_params['TargetPassword'] = target_password
+      unless target_totpcode.nil?
+        raise TypeError, "'target_totpcode' expected String, got #{target_totpcode.class}" unless target_totpcode.is_a? String
+
+        submit_params['TargetTOTPCode'] = target_totpcode
+      end
+
+      body = perform_request('api/v1/admin/installation/dispatch/register-device', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      raise TypeError, "'json_body' expected String, got #{json_body.class}" unless json_body.is_a? String
+
+      ret = json_body
+      ret
+    end
+
+    # AdminInstallationListActive
+    #
+    # List live connected devices in lobby mode.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @return [Hash{String => Comet::RegistrationLobbyConnection}]
+    def admin_installation_list_active
+      body = perform_request('api/v1/admin/installation/list-active')
+      json_body = JSON.parse body
+      check_status json_body
+      ret = {}
+      if json_body.nil?
+        ret = {}
+      else
+        json_body.each do |k, v|
+          ret[k] = Comet::RegistrationLobbyConnection.new
+          ret[k].from_hash(v)
+        end
+      end
+      ret
+    end
+
+    # AdminJobAbandon
+    #
+    # Mark a running job as abandoned.
+    # This will change the status of a running job to abandoned.
+    # This is intended to be used on jobs which are definitely no longer running but are stuck in the running state; it will not attempt to cancel the job. If the job is detected to still be running after being marked as abandoned, it will be revived.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_user Username
+    # @param [String] job_id Job ID
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_job_abandon(target_user, job_id)
+      submit_params = {}
+      raise TypeError, "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
+
+      submit_params['TargetUser'] = target_user
+      raise TypeError, "'job_id' expected String, got #{job_id.class}" unless job_id.is_a? String
+
+      submit_params['JobID'] = job_id
+
+      body = perform_request('api/v1/admin/job/abandon', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminJobCancel
     #
     # Cancel a running job.

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '23.8.0'
+  APPLICATION_VERSION = '23.9.5'
 
   APPLICATION_VERSION_MAJOR = 23
 
-  APPLICATION_VERSION_MINOR = 8
+  APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 0
+  APPLICATION_VERSION_REVISION = 5
 
   # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
   BACKUPJOBAUTORETENTION_AUTOMATIC = 0
@@ -361,6 +361,12 @@ module Comet
   # MSSQLRestoreOpt
   MSSQL_RESTORE_NORECOVERY = 'NO_RECOVERY'
 
+  OBJECT_LOCK_LEGACY = 0
+
+  OBJECT_LOCK_ON = 1
+
+  OBJECT_LOCK_OFF = 2
+
   OFFICE365_REGION_PUBLIC = 'GlobalPublicCloud'
 
   OFFICE365_REGION_CHINA = 'ChinaCloud'
@@ -407,7 +413,7 @@ module Comet
   # PSAType
   PSA_TYPE_GRADIENT = 1
 
-  RELEASE_CODENAME = 'Adrastea'
+  RELEASE_CODENAME = 'Voyager'
 
   # RemoteServerType
   REMOTESERVER_COMET = 'comet'
@@ -514,6 +520,9 @@ module Comet
   # RestoreType: Stream restore as T-SQL BACKUP output into a target Microsoft SQL Server
   RESTORETYPE_MSSQL = 11
 
+  # RestoreType: Restore disk image backup as VMware-compatible virtual disks
+  RESTORETYPE_WINDISK_ESXI = 12
+
   # RestoreType: Legacy name alias - Prefer to use RESTORETYPE_PROCESS_ARCHIVE since multiple archive file formats are supported within this single RESTORETYPE_
   RESTORETYPE_PROCESS_TARBALL = 3
 
@@ -724,7 +733,7 @@ module Comet
   # StreamableEventType
   SEVT__MIN = 4000
 
-  # StreamableEventType: New websocket connection. Data is typically ServerMetaVersionInfo
+  # StreamableEventType: New event stream connection. Data is typically ServerMetaVersionInfo
   SEVT_META_HELLO = 4000
 
   # StreamableEventType: User created. Data is the profile object
@@ -760,7 +769,7 @@ module Comet
   # StreamableEventType: Admin updated
   SEVT_ACCOUNT_ADMIN_UPDATED = 4152
 
-  # StreamableEventType: Admin authentication suceeded. Only emitted for non-session requests. Resource is the requested path
+  # StreamableEventType: Admin authentication succeeded. Only emitted for non-session requests. Resource is the requested path
   SEVT_ACCOUNT_ADMIN_LOGIN = 4153
 
   # StreamableEventType: Admin authentication failed. Only emitted if the admin exists. Resource is the request path
@@ -829,6 +838,12 @@ module Comet
   # StreamableEventType: Device live connection ended
   SEVT_DEVICE_LIVE_DISCONNECT = 4703
 
+  # StreamableEventType: Device connected to registration lobby
+  SEVT_DEVICE_LOBBY_CONNECT = 4704
+
+  # StreamableEventType: Device disconnected from registration lobby
+  SEVT_DEVICE_LOBBY_DISCONNECT = 4705
+
   # StreamableEventType
   SEVT__MAX = 4999
 
@@ -958,6 +973,8 @@ module Comet
   # UpdateStatus: The device has successfully updated to the target version.
   UPDATESTATUS_UPDATE_CONFIRMED = 5
 
+  USERNAME_MAX_LENGTH = 255
+
   # If an API response returns in failure, but it includes this value in the CometAPIResponseMessage->Message parameter, it indicates that the specified Device ID was invalid or not found.
   UNKNOWN_DEVICE_ERROR = 'ERR_UNKNOWN_DEVICE'
 

data/lib/comet/models/amazon_awsvirtual_storage_role_settings.rb

@@ -21,8 +21,11 @@ module Comet
     # @type [String] secret_key
     attr_accessor :secret_key
 
-    # @type [Boolean] use_object_lock
-    attr_accessor :use_object_lock
+    # @type [Boolean] use_object_lock__legacy__do_not_use
+    attr_accessor :use_object_lock__legacy__do_not_use
+
+    # @type [Number] object_lock_mode
+    attr_accessor :object_lock_mode
 
     # @type [Number] object_lock_days
     attr_accessor :object_lock_days
@@ -41,6 +44,7 @@ module Comet
       @master_bucket = ''
       @access_key = ''
       @secret_key = ''
+      @object_lock_mode = 0
       @object_lock_days = 0
       @unknown_json_fields = {}
     end
@@ -71,7 +75,11 @@ module Comet
 
           @secret_key = v
         when 'UseObjectLock'
-          @use_object_lock = v
+          @use_object_lock__legacy__do_not_use = v
+        when 'ObjectLockMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @object_lock_mode = v
         when 'ObjectLockDays'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -90,7 +98,8 @@ module Comet
       ret['MasterBucket'] = @master_bucket
       ret['AccessKey'] = @access_key
       ret['SecretKey'] = @secret_key
-      ret['UseObjectLock'] = @use_object_lock
+      ret['UseObjectLock'] = @use_object_lock__legacy__do_not_use
+      ret['ObjectLockMode'] = @object_lock_mode
       ret['ObjectLockDays'] = @object_lock_days
       ret['RemoveDeleted'] = @remove_deleted
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/backup_job_advanced_options.rb

@@ -42,6 +42,9 @@ module Comet
     # @type [Number] auto_retention_level
     attr_accessor :auto_retention_level
 
+    # @type [String] log_level
+    attr_accessor :log_level
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -53,6 +56,7 @@ module Comet
       @stop_after = 0
       @limit_vault_speed_bps = 0
       @auto_retention_level = 0
+      @log_level = ''
       @unknown_json_fields = {}
     end
 
@@ -89,6 +93,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @auto_retention_level = v
+        when 'LogLevel'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @log_level = v
         else
           @unknown_json_fields[k] = v
         end
@@ -105,6 +113,7 @@ module Comet
       ret['UseOnDiskIndexes'] = @use_on_disk_indexes
       ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
       ret['AutoRetentionLevel'] = @auto_retention_level
+      ret['LogLevel'] = @log_level
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/backup_rule_config.rb

@@ -72,6 +72,9 @@ module Comet
     # @type [Number] auto_retention_level
     attr_accessor :auto_retention_level
 
+    # @type [String] log_level
+    attr_accessor :log_level
+
     # Scheduled start times
     # @type [Array<Comet::ScheduleConfig>] schedules
     attr_accessor :schedules
@@ -99,6 +102,7 @@ module Comet
       @stop_after = 0
       @limit_vault_speed_bps = 0
       @auto_retention_level = 0
+      @log_level = ''
       @schedules = []
       @event_triggers = Comet::BackupRuleEventTriggers.new
       @unknown_json_fields = {}
@@ -190,6 +194,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @auto_retention_level = v
+        when 'LogLevel'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @log_level = v
         when 'Schedules'
           if v.nil?
             @schedules = []
@@ -227,6 +235,7 @@ module Comet
       ret['UseOnDiskIndexes'] = @use_on_disk_indexes
       ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
       ret['AutoRetentionLevel'] = @auto_retention_level
+      ret['LogLevel'] = @log_level
       ret['Schedules'] = @schedules
       ret['EventTriggers'] = @event_triggers
       @unknown_json_fields.each do |k, v|

data/lib/comet/models/destination_config.rb

@@ -77,6 +77,9 @@ module Comet
     # @type [Boolean] s3remove_deleted
     attr_accessor :s3remove_deleted
 
+    # @type [Number] s3object_lock_mode
+    attr_accessor :s3object_lock_mode
+
     # @type [Number] s3object_lock_days
     attr_accessor :s3object_lock_days
 
@@ -264,6 +267,7 @@ module Comet
       @s3bucket_name = ''
       @s3subdir = ''
       @s3custom_region = ''
+      @s3object_lock_mode = 0
       @s3object_lock_days = 0
       @sftpserver = ''
       @sftpusername = ''
@@ -406,6 +410,10 @@ module Comet
           @s3uses_v2signing = v
         when 'S3RemoveDeleted'
           @s3remove_deleted = v
+        when 'S3ObjectLockMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @s3object_lock_mode = v
         when 'S3ObjectLockDays'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -586,6 +594,7 @@ module Comet
       ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
       ret['S3RemoveDeleted'] = @s3remove_deleted
+      ret['S3ObjectLockMode'] = @s3object_lock_mode
       ret['S3ObjectLockDays'] = @s3object_lock_days
       ret['SFTPServer'] = @sftpserver
       ret['SFTPUsername'] = @sftpusername

data/lib/comet/models/destination_location.rb

@@ -57,6 +57,9 @@ module Comet
     # @type [Boolean] s3remove_deleted
     attr_accessor :s3remove_deleted
 
+    # @type [Number] s3object_lock_mode
+    attr_accessor :s3object_lock_mode
+
     # @type [Number] s3object_lock_days
     attr_accessor :s3object_lock_days
 
@@ -205,6 +208,7 @@ module Comet
       @s3bucket_name = ''
       @s3subdir = ''
       @s3custom_region = ''
+      @s3object_lock_mode = 0
       @s3object_lock_days = 0
       @sftpserver = ''
       @sftpusername = ''
@@ -296,6 +300,10 @@ module Comet
           @s3uses_v2signing = v
         when 'S3RemoveDeleted'
           @s3remove_deleted = v
+        when 'S3ObjectLockMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @s3object_lock_mode = v
         when 'S3ObjectLockDays'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -444,6 +452,7 @@ module Comet
       ret['S3CustomRegion'] = @s3custom_region
       ret['S3UsesV2Signing'] = @s3uses_v2signing
       ret['S3RemoveDeleted'] = @s3remove_deleted
+      ret['S3ObjectLockMode'] = @s3object_lock_mode
       ret['S3ObjectLockDays'] = @s3object_lock_days
       ret['SFTPServer'] = @sftpserver
       ret['SFTPUsername'] = @sftpusername