comet_backup_ruby_sdk 2.40.0 → 2.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8de6d34a1a34e2fef7d5b970bfc33cc451106ca28c7a292060ebbee262bb7ed3
-  data.tar.gz: 9e0bde4efe6c21153d91881efbf6f8b74ea7b4881a21ff85cda2f7675297e516
+  metadata.gz: c972fed511fa56a76cf96c42f8559faddcc003fc4378616bb5b91ec0d45ef210
+  data.tar.gz: 945063cd41af3fb4b56728e2374e99c4463c18e7ca68ee6a916829d31c406959
 SHA512:
-  metadata.gz: c47886f036adebb1cd44c44e5bd371cefe470e3cd569925d451f0a8c5d4983a97d70db58afc6ec89d82cab2e34ce6cb2ac75a68394ac2440bd94a98bb47609bf
-  data.tar.gz: 2ce781adab00183ab1533cbf0f207cb976be7f590df60b2147fc54384670abe6bd6047067d78047f407bcc1137fb10eeb135934a4f47027aa40bddd5d2ea2e78
+  metadata.gz: 4d84b541b325ded6b7f1ee7b111a2ef8110b2774b3097c1e1aa26d282543ece740fc6ec5eefaa14a6393f737c3525f4bc316f65b9ddbd135a3b664b3d3890d56
+  data.tar.gz: d5e8829fe4a04d7f792f4a982f9fe2ae4296de440845d494ccae9d644c8c3743bf7300db0460ba7015355cc821b862b7a28de7ce75d124822923e77b5624cb42

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 2025-02-17 v2.41.0
+Update to 24.12.5
+
+- Based on Comet 24.12.5
+
 ## 2025-01-29 v2.40.0
 
 - Based on Comet 24.12.4

data/Gemfile.lock

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

data/lib/comet/comet_server.rb

@@ -1143,6 +1143,37 @@ module Comet
       ret
     end
 
+    # AdminDispatcherBrowseVirtualMachines
+    #
+    # Browse virtual machines in target snapshot.
+    #
+    # 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 [String] destination_id The Storage Vault GUID
+    # @param [String] snapshot_id Snapshot to search
+    # @return [Comet::DispatcherListSnapshotVirtualMachinesResponse]
+    def admin_dispatcher_browse_virtual_machines(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/browse-virtual-machines', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::DispatcherListSnapshotVirtualMachinesResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherDeepverifyStorageVault
     #
     # Instruct a live connected device to deeply verify Storage Vault content.
@@ -1746,6 +1777,130 @@ module Comet
       ret
     end
 
+    # AdminDispatcherRequestBrowseVmwareDatacenters
+    #
+    # Request a list of VMware vSphere Datacenters on a VMware vSphere connection.
+    # 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.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Comet::VMwareConnection] credentials The VMware vSphere connection settings
+    # @return [Comet::BrowseVMwareDatacentersResponse]
+    def admin_dispatcher_request_browse_vmware_datacenters(target_id, credentials)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'credentials' expected Comet::VMwareConnection, got #{credentials.class}" unless credentials.is_a? Comet::VMwareConnection
+
+      submit_params['Credentials'] = credentials.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-vmware/datacenters', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseVMwareDatacentersResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseVmwareDatastores
+    #
+    # Request a list of VMware vSphere Datastores on a VMware vSphere connection, for a specified VMware Datacenter.
+    # 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.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Comet::VMwareConnection] credentials The VMware vSphere connection settings
+    # @param [String] filter The name of the target VMware Datacenter
+    # @return [Comet::BrowseVMwareDatastoresResponse]
+    def admin_dispatcher_request_browse_vmware_datastores(target_id, credentials, filter)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'credentials' expected Comet::VMwareConnection, got #{credentials.class}" unless credentials.is_a? Comet::VMwareConnection
+
+      submit_params['Credentials'] = credentials.to_json
+      raise TypeError, "'filter' expected String, got #{filter.class}" unless filter.is_a? String
+
+      submit_params['Filter'] = filter
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-vmware/datastores', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseVMwareDatastoresResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseVmwareHosts
+    #
+    # Request a list of VMware vSphere Hosts on a VMware vSphere connection, for a specified VMware Datacenter.
+    # 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.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Comet::VMwareConnection] credentials The VMware vSphere connection settings
+    # @param [String] filter The name of the target VMware Datacenter
+    # @return [Comet::BrowseVMwareHostsResponse]
+    def admin_dispatcher_request_browse_vmware_hosts(target_id, credentials, filter)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'credentials' expected Comet::VMwareConnection, got #{credentials.class}" unless credentials.is_a? Comet::VMwareConnection
+
+      submit_params['Credentials'] = credentials.to_json
+      raise TypeError, "'filter' expected String, got #{filter.class}" unless filter.is_a? String
+
+      submit_params['Filter'] = filter
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-vmware/hosts', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseVMwareHostsResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseVmwareNetworks
+    #
+    # Request a list of VMware vSphere Networks on a VMware vSphere connection, for a specified VMware Datacenter.
+    # 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.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Comet::VMwareConnection] credentials The VMware vSphere connection settings
+    # @param [String] filter The name of the target VMware Datacenter
+    # @return [Comet::BrowseVMwareNetworksResponse]
+    def admin_dispatcher_request_browse_vmware_networks(target_id, credentials, filter)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'credentials' expected Comet::VMwareConnection, got #{credentials.class}" unless credentials.is_a? Comet::VMwareConnection
+
+      submit_params['Credentials'] = credentials.to_json
+      raise TypeError, "'filter' expected String, got #{filter.class}" unless filter.is_a? String
+
+      submit_params['Filter'] = filter
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-vmware/networks', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseVMwareNetworksResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRequestBrowseVssAaw
     #
     # Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device.
@@ -3976,8 +4131,9 @@ module Comet
     # @param [String] policy_id The policy ID to update or create
     # @param [Comet::GroupPolicy] policy The policy data
     # @param [String] check_policy_hash (Optional) An atomic verification hash as supplied by the AdminPoliciesGet API
+    # @param [Comet::PolicyOptions] options (Optional) An array of PolicySourceID that will be explicitly deleted.
     # @return [Comet::CometAPIResponseMessage]
-    def admin_policies_set(policy_id, policy, check_policy_hash = nil)
+    def admin_policies_set(policy_id, policy, check_policy_hash = nil, options = nil)
       submit_params = {}
       raise TypeError, "'policy_id' expected String, got #{policy_id.class}" unless policy_id.is_a? String
 
@@ -3990,6 +4146,11 @@ module Comet
 
         submit_params['CheckPolicyHash'] = check_policy_hash
       end
+      unless options.nil?
+        raise TypeError, "'options' expected Comet::PolicyOptions, got #{options.class}" unless options.is_a? Comet::PolicyOptions
+
+        submit_params['Options'] = options.to_json
+      end
 
       body = perform_request('api/v1/admin/policies/set', submit_params)
       json_body = JSON.parse body
@@ -4251,8 +4412,9 @@ module Comet
     # @param [String] target_user Selected account username
     # @param [Comet::UserProfileConfig] profile_data Modified user profile
     # @param [String] require_hash Previous hash parameter
+    # @param [Comet::AdminOptions] admin_options (Optional) Instructions for modifying user profile
     # @return [Comet::CometAPIResponseMessage]
-    def admin_set_user_profile_hash(target_user, profile_data, require_hash)
+    def admin_set_user_profile_hash(target_user, profile_data, require_hash, admin_options = nil)
       submit_params = {}
       raise TypeError, "'target_user' expected String, got #{target_user.class}" unless target_user.is_a? String
 
@@ -4263,6 +4425,11 @@ module Comet
       raise TypeError, "'require_hash' expected String, got #{require_hash.class}" unless require_hash.is_a? String
 
       submit_params['RequireHash'] = require_hash
+      unless admin_options.nil?
+        raise TypeError, "'admin_options' expected Comet::AdminOptions, got #{admin_options.class}" unless admin_options.is_a? Comet::AdminOptions
+
+        submit_params['AdminOptions'] = admin_options.to_json
+      end
 
       body = perform_request('api/v1/admin/set-user-profile-hash', submit_params)
       json_body = JSON.parse body

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '24.12.4'
+  APPLICATION_VERSION = '24.12.5'
 
   APPLICATION_VERSION_MAJOR = 24
 
   APPLICATION_VERSION_MINOR = 12
 
-  APPLICATION_VERSION_REVISION = 4
+  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
@@ -597,6 +597,10 @@ New code should explicitly use OBJECT_LOCK_ON / OBJECT_LOCK_OFF instead.
   # RestoreType: Restore disk image backup as Hyper-V-compatible virtual disks (.vhdx format)
   RESTORETYPE_WINDISK_VHDX = 13
 
+  # RestoreType: Restore virtual machines directly to hypervisor
+  # This const is available in Comet 24.12.x and later.
+  RESTORETYPE_VMHOST = 14
+
   # 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/admin_options.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # AdminOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class AdminOptions
+
+    # @type [Comet::PolicyOptions] policy
+    attr_accessor :policy
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @policy = Comet::PolicyOptions.new
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Policy'
+          @policy = Comet::PolicyOptions.new
+          @policy.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Policy'] = @policy
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_vmware_datacenters_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseVMwareDatacentersResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareDatacentersResponse contains a list of VMware Datacenters when remotely browsing a
+# VMware vSphere connection.
+  class BrowseVMwareDatacentersResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::VMwareDatacenterInfo>] datacenters
+    attr_accessor :datacenters
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @datacenters = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Datacenters'
+          if v.nil?
+            @datacenters = []
+          else
+            @datacenters = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @datacenters[i1] = Comet::VMwareDatacenterInfo.new
+              @datacenters[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Datacenters'] = @datacenters
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_vmware_datastores_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseVMwareDatastoresResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareHostsResponse contains a list of VMware Datastores for a specific VMware Datacenter,
+# when remotely browsing a VMware vSphere connection.
+  class BrowseVMwareDatastoresResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::VMwareDatastoreInfo>] datastores
+    attr_accessor :datastores
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @datastores = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Datastores'
+          if v.nil?
+            @datastores = []
+          else
+            @datastores = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @datastores[i1] = Comet::VMwareDatastoreInfo.new
+              @datastores[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Datastores'] = @datastores
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_vmware_hosts_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseVMwareHostsResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareHostsResponse contains a list of VMware Hosts for a specific VMware Datacenter, when
+# remotely browsing a VMware vSphere connection.
+  class BrowseVMwareHostsResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::VMwareHostInfo>] hosts
+    attr_accessor :hosts
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @hosts = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Hosts'
+          if v.nil?
+            @hosts = []
+          else
+            @hosts = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @hosts[i1] = Comet::VMwareHostInfo.new
+              @hosts[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Hosts'] = @hosts
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end