comet_backup_ruby_sdk 2.35.0 → 2.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5515ec0d67e0e3f5933187f1b9abd01390de257f15acebbac6b02f1f6b323eda
-  data.tar.gz: f73f2bbcbcdacbf88dbc5f22d09eec1e15305dd88cdafeedbed3cba80394da1b
+  metadata.gz: 1c01a7f3572cedb42436655e3c78edad5a23839bf1a761e7f05cb498d0af549b
+  data.tar.gz: c878557323cd9c3c7af6079b1c926af9f50612bbdc3d3d1993db474c7b0325be
 SHA512:
-  metadata.gz: 64170e8dc7026e1ab4f50e3fa2f435d222e2502223d690ae57357b647b3c91c0ab7f3d7324c4de198423930e8d7379709fd9ceb905663374633e48ca4b54a242
-  data.tar.gz: dddc00508aae6f6543337f6157b586a6086173e5fe690823462625256b332e73fc084eb74a93002ecebb927df9b526efbad91701978cc5b5eb6a28b495e7d625
+  metadata.gz: ea48fbee3a53dde34f0093288a1ad9d0fef767baef9bf40b8133d26a2c4e738529e7276da17acb1c66c27ac997a292f97ecb717d2e37626dd18d5d1afb2883b3
+  data.tar.gz: 9d2527444570ecaf3b04c1b289def0d50f687930c77166cfed0df8e2b2e935a671529cfdbd10173aeea5496821dfd8c442f034c2c55a33e43b0fc936f053f182

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## 2024-10-29 v2.37.0
+
+- Based on Comet 24.9.6
+- New API AdminDispatcherTestSmbAuth to instruct a device to test Windows SMB credentials
+- New RESTORETYPE_WINDISK_VHDX to restore Disk Image backup as Hyper-V VHDX format
+- BackupJobDetail supports ConflictingJobID field to indicate conflicting job if a lock error occurred
+- BackupJobProgress can report the total number of items for progress visualization
+- DiskDrive adds information about parent disks on Linux
+
+## 2024-09-17 v2.36.0
+
+- Based on Comet 24.9.1
+- Added Hyper-V Guest limits per user
+- Added VMware Guest limits per user
+- Added protected item type (engine) to protected item class
+- Added Force Overwrite Restore permissions
+
 ## 2024-08-01 v2.35.0
 
 - Based on Comet 24.6.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (2.35.0)
+    comet_backup_ruby_sdk (2.37.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.35.0'
+  spec.version       = '2.37.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -2169,6 +2169,33 @@ module Comet
       ret
     end
 
+    # AdminDispatcherTestSmbAuth
+    #
+    # Test a set of Windows SMB credentials.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Comet::WinSMBAuth] wsa The target credentials to test
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_test_smb_auth(target_id, wsa)
+      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, "'wsa' expected Comet::WinSMBAuth, got #{wsa.class}" unless wsa.is_a? Comet::WinSMBAuth
+
+      submit_params['Wsa'] = wsa.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/test-smb-auth', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherUninstallSoftware
     #
     # Instruct a live connected device to self-uninstall the software.

data/lib/comet/definitions.rb

@@ -7,11 +7,11 @@
 
 module Comet
 
-  APPLICATION_VERSION = '24.6.6'
+  APPLICATION_VERSION = '24.9.6'
 
   APPLICATION_VERSION_MAJOR = 24
 
-  APPLICATION_VERSION_MINOR = 6
+  APPLICATION_VERSION_MINOR = 9
 
   APPLICATION_VERSION_REVISION = 6
 
@@ -585,6 +585,9 @@ New code should explicitly use OBJECT_LOCK_ON / OBJECT_LOCK_OFF instead.
   # RestoreType: Restore disk image backup as VMware-compatible virtual disks
   RESTORETYPE_WINDISK_ESXI = 12
 
+  # RestoreType: Restore disk image backup as Hyper-V-compatible virtual disks (.vhdx format)
+  RESTORETYPE_WINDISK_VHDX = 13
+
   # 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
 

data/lib/comet/models/backup_job_detail.rb

@@ -99,6 +99,12 @@ module Comet
     # @type [Number] total_unlicensed_mails_count
     attr_accessor :total_unlicensed_mails_count
 
+    # If this field is present, this job did not perform some work because the Storage Vault is
+    # currently busy.
+    # This field is available in Comet 24.9.2 and later.
+    # @type [String] conflicting_job_id
+    attr_accessor :conflicting_job_id
+
     # If this field is present, it is possible to request cancellation of this job via the API.
     # @type [String] cancellation_id
     attr_accessor :cancellation_id
@@ -149,6 +155,7 @@ module Comet
       @total_accounts_count = 0
       @total_licensed_mails_count = 0
       @total_unlicensed_mails_count = 0
+      @conflicting_job_id = ''
       @cancellation_id = ''
       @progress = Comet::BackupJobProgress.new
       @destination_size_start = Comet::SizeMeasurement.new
@@ -269,6 +276,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @total_unlicensed_mails_count = v
+        when 'ConflictingJobID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @conflicting_job_id = v
         when 'CancellationID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -332,6 +343,9 @@ module Comet
       unless @total_unlicensed_mails_count.nil?
         ret['TotalUnlicensedMailsCount'] = @total_unlicensed_mails_count
       end
+      unless @conflicting_job_id.nil?
+        ret['ConflictingJobID'] = @conflicting_job_id
+      end
       unless @cancellation_id.nil?
         ret['CancellationID'] = @cancellation_id
       end

data/lib/comet/models/backup_job_progress.rb

@@ -31,6 +31,9 @@ module Comet
     # @type [Number] items_done
     attr_accessor :items_done
 
+    # @type [Number] items_total
+    attr_accessor :items_total
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -44,6 +47,7 @@ module Comet
       @recieved_time = 0
       @bytes_done = 0
       @items_done = 0
+      @items_total = 0
       @unknown_json_fields = {}
     end
 
@@ -80,6 +84,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @items_done = v
+        when 'ItemsTotal'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @items_total = v
         else
           @unknown_json_fields[k] = v
         end
@@ -94,6 +102,7 @@ module Comet
       ret['RecievedTime'] = @recieved_time
       ret['BytesDone'] = @bytes_done
       ret['ItemsDone'] = @items_done
+      ret['ItemsTotal'] = @items_total
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/disk_drive.rb

@@ -27,22 +27,33 @@ module Comet
     # @type [String] serial_number
     attr_accessor :serial_number
 
+    # Bytes
     # @type [Number] size
     attr_accessor :size
 
     # @type [Array<Comet::Partition>] partitions
     attr_accessor :partitions
 
+    # For physical disks, this array will be empty. For virtual disks, RAID devices or Linux DM devices,
+    # this array may contain the DeviceName of the parent device.
+    # This field is available in Comet 24.6.x and later.
+    # @type [Array<String>] device_parents
+    attr_accessor :device_parents
+
+    # See WINDISKFLAG_ constants
     # @type [Number] flags
     attr_accessor :flags
 
     # @type [Number] cylinders
+    # @deprecated This member has been deprecated since Comet version 24.6.x This value is reported from the disk driver if available. Otherwise emulates a value based on modern LBA addressing. The field value is not used.
     attr_accessor :cylinders
 
     # @type [Number] heads
+    # @deprecated This member has been deprecated since Comet version 24.6.x This value is reported from the disk driver if available. Otherwise emulates a value based on modern LBA addressing. The field value is not used.
     attr_accessor :heads
 
     # @type [Number] sectors
+    # @deprecated This member has been deprecated since Comet version 24.6.x This value is reported from the disk driver if available. Otherwise emulates a value based on modern LBA addressing. The field value is not used.
     attr_accessor :sectors
 
     # @type [Number] sector_size
@@ -63,6 +74,7 @@ module Comet
       @serial_number = ''
       @size = 0
       @partitions = []
+      @device_parents = []
       @flags = 0
       @cylinders = 0
       @heads = 0
@@ -118,6 +130,17 @@ module Comet
               @partitions[i1].from_hash(v1)
             end
           end
+        when 'DeviceParents'
+          if v.nil?
+            @device_parents = []
+          else
+            @device_parents = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @device_parents[i1] = v1
+            end
+          end
         when 'Flags'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -154,6 +177,7 @@ module Comet
       ret['SerialNumber'] = @serial_number
       ret['Size'] = @size
       ret['Partitions'] = @partitions
+      ret['DeviceParents'] = @device_parents
       ret['Flags'] = @flags
       ret['Cylinders'] = @cylinders
       ret['Heads'] = @heads

data/lib/comet/models/restore_job_advanced_options.rb

@@ -28,6 +28,11 @@ module Comet
     # @type [Boolean] overwrite_if_different_content
     attr_accessor :overwrite_if_different_content
 
+    # For RESTORETYPE_FILE. If set, OverwriteExistingFiles must be true. This can be set in combination
+    # with other OverwriteIf options.
+    # @type [Boolean] overwrite_force_permissions
+    attr_accessor :overwrite_force_permissions
+
     # For RESTORETYPE_FILE. If set, DestPath must be blank
     # @type [Boolean] dest_is_original_location
     attr_accessor :dest_is_original_location
@@ -149,6 +154,8 @@ module Comet
           @overwrite_if_newer = v
         when 'OverwriteIfDifferentContent'
           @overwrite_if_different_content = v
+        when 'OverwriteForcePermissions'
+          @overwrite_force_permissions = v
         when 'DestIsOriginalLocation'
           @dest_is_original_location = v
         when 'DestPath'
@@ -225,6 +232,7 @@ module Comet
       ret['OverwriteExistingFiles'] = @overwrite_existing_files
       ret['OverwriteIfNewer'] = @overwrite_if_newer
       ret['OverwriteIfDifferentContent'] = @overwrite_if_different_content
+      ret['OverwriteForcePermissions'] = @overwrite_force_permissions
       ret['DestIsOriginalLocation'] = @dest_is_original_location
       ret['DestPath'] = @dest_path
       ret['ExactDestPaths'] = @exact_dest_paths

data/lib/comet/models/source_basic_info.rb

@@ -14,12 +14,18 @@ module Comet
 # Protected Items, in order to safely perform retention passes on their behalf.
   class SourceBasicInfo
 
+    # @type [String] engine
+    attr_accessor :engine
+
     # @type [String] description
     attr_accessor :description
 
     # @type [Number] o365account_count
     attr_accessor :o365account_count
 
+    # @type [Number] total_vm_count
+    attr_accessor :total_vm_count
+
     # Bytes
     # @type [Number] size
     attr_accessor :size
@@ -35,8 +41,10 @@ module Comet
     end
 
     def clear
+      @engine = ''
       @description = ''
       @o365account_count = 0
+      @total_vm_count = 0
       @size = 0
       @override_destination_retention = {}
       @unknown_json_fields = {}
@@ -55,6 +63,10 @@ module Comet
 
       obj.each do |k, v|
         case k
+        when 'Engine'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @engine = v
         when 'Description'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -63,6 +75,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @o365account_count = v
+        when 'TotalVmCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_vm_count = v
         when 'Size'
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
@@ -86,8 +102,10 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
+      ret['Engine'] = @engine
       ret['Description'] = @description
       ret['O365AccountCount'] = @o365account_count
+      ret['TotalVmCount'] = @total_vm_count
       ret['Size'] = @size
       unless @override_destination_retention.nil?
         ret['OverrideDestinationRetention'] = @override_destination_retention

data/lib/comet/models/user_profile_config.rb

@@ -101,6 +101,16 @@ module Comet
     # @type [Number] quota_office_365protected_accounts
     attr_accessor :quota_office_365protected_accounts
 
+    # A limit on the total number of Hyper-V guests across all Hyper-V Protected Items in this account.
+    # Set to zero to allow unlimited Office 365 Protected Accounts.
+    # @type [Number] quota_hyper_vguests
+    attr_accessor :quota_hyper_vguests
+
+    # A limit on the total number of VMware guests across all VMware Protected Items in this account.
+    # Set to zero to allow unlimited Office 365 Protected Accounts.
+    # @type [Number] quota_vmware_guests
+    attr_accessor :quota_vmware_guests
+
     # If the PolicyID field is set to a non-empty string, the Comet Server will enforce the contents of
     # the Policy field based on the matching server's policy. Otherwise if the PolicyID field is set to
     # an empty string, the administrator may configure any custom values in the Policy field.
@@ -182,6 +192,8 @@ module Comet
       @all_protected_items_quota_bytes = 0
       @maximum_devices = 0
       @quota_office_365protected_accounts = 0
+      @quota_hyper_vguests = 0
+      @quota_vmware_guests = 0
       @policy_id = ''
       @policy = Comet::UserPolicy.new
       @password_format = 0
@@ -311,6 +323,14 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @quota_office_365protected_accounts = v
+        when 'QuotaHyperVGuests'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @quota_hyper_vguests = v
+        when 'QuotaVMwareGuests'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @quota_vmware_guests = v
         when 'PolicyID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -386,6 +406,8 @@ module Comet
       ret['AllProtectedItemsQuotaBytes'] = @all_protected_items_quota_bytes
       ret['MaximumDevices'] = @maximum_devices
       ret['QuotaOffice365ProtectedAccounts'] = @quota_office_365protected_accounts
+      ret['QuotaHyperVGuests'] = @quota_hyper_vguests
+      ret['QuotaVMwareGuests'] = @quota_vmware_guests
       ret['PolicyID'] = @policy_id
       ret['Policy'] = @policy
       ret['PasswordFormat'] = @password_format

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.35.0
+  version: 2.37.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler