comet_backup_ruby_sdk 2.17.0 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e51f22f14215859b506d05275dcde39118daf741417c1f880f43db0da77787c6
-  data.tar.gz: 0275fccf0713fc1432ee81528e310d34aaa650470b3ef5022425a1d1fe25834c
+  metadata.gz: c1edfdb3a130d9f6c3f4a1ff2624a05271b02fd3c2de3ab7520236f849968448
+  data.tar.gz: 94779eead6804de0c7ced5b7d45ecaa89e64109ff35a117c5577e970e7733442
 SHA512:
-  metadata.gz: 80c7480afd626944a232ebfd1eb50c6015f513c7e75d309bb7559c4b2d706a90ffaad8caaa4cfd752b2d4662c60e351db0eee88cbd44143d406d5d27df64c122
-  data.tar.gz: 4bf992dbfd18847c2456ffcaf42ed1a26ef8dc798f9860e49b78c3c2aa7014c73c6c652441a1abf3a46c3c20377cd633472345baaa4a5b3c59573d88d397982f
+  metadata.gz: 27737e45d384a3d8016990a253cd4aa538f62b355a13630a0e9011db4ed1d11d15293fb3e26805b89c6350e6b59b8e22e2cd0b51241c5f76a95f4219777615d2
+  data.tar.gz: 88474756f8934567f4a117d9aad8c44e93b135b9f88a87ec93fc67f7610b988bc3f2950f1c4fc4edc8fcf0a45733b68a930341deb08331bfce83aa61d20cdd27

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 2023-10-25 v2.18.0
+
+- Based on Comet 23.9.7
+- Add VMware support
+
 ## 2023-10-18 v2.16.0
 
 - Based on Comet 23.9.6

data/Gemfile.lock

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

data/lib/comet/comet_server.rb

@@ -1644,6 +1644,34 @@ module Comet
       ret
     end
 
+    # AdminDispatcherRequestBrowseVmware
+    #
+    # Request a list of VMware vSphere virtual machines.
+    # The remote device must have given consent for an MSP to browse their files.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [Comet::VMwareConnection] credentials The VMware vSphere connection settings
+    # @return [Comet::BrowseVMwareResponse]
+    def admin_dispatcher_request_browse_vmware(target_id, credentials)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'credentials' expected Comet::VMwareConnection, got #{credentials.class}" unless credentials.is_a? Comet::VMwareConnection
+
+      submit_params['Credentials'] = credentials.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-vmware', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseVMwareResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRequestBrowseVssAaw
     #
     # Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device.

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '23.9.6'
+  APPLICATION_VERSION = '23.9.7'
 
   APPLICATION_VERSION_MAJOR = 23
 
   APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 6
+  APPLICATION_VERSION_REVISION = 7
 
   # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
   BACKUPJOBAUTORETENTION_AUTOMATIC = 0
@@ -210,6 +210,9 @@ module Comet
   # Office 365
   ENGINE_BUILTIN_MSOFFICE = 'engine1/winmsofficemail'
 
+  # VMware
+  ENGINE_BUILTIN_VMWARE = 'engine1/vmware'
+
   # FtpsModeType: Use plain FTP, do not use FTPS.
   FTPS_MODE_PLAINTEXT = 0
 
@@ -219,6 +222,17 @@ module Comet
   # FtpsModeType: Use explicit FTPS, first creating an insecure connection and then upgrading to SSL/TLS using AUTH TLS (like STARTTLS).
   FTPS_MODE_EXPLICIT = 2
 
+  # Back up Hyper-V virtual machines using VSS mode. This includes all previous snapshots.
+  HYPERV_METHOD_VSS = 'vss'
+
+  # Back up Hyper-V virtual machines using WMI mode. This includes the latest snapshot data only.
+  # This const is available in Comet 23.9.8 and later.
+  HYPERV_METHOD_WMI_COPY = 'copy'
+
+  # Back up Hyper-V virtual machines using WMI mode with RCT acceleration. This includes the latest snapshot data only.
+  # This const is available in Comet 23.9.8 and later.
+  HYPERV_METHOD_WMI_CBT = 'wmi'
+
   # JobClassification: All BackupJobDetail.Classification fields will fall in the 4xxx range.
   JOB_CLASSIFICATION__MIN = 4000
 
@@ -985,6 +999,30 @@ module Comet
 
   UNSUPPORT_VMDK_FILE_SYSTEM = 'ERR_UNSUPPORT_VMDK_FILE_SYSTEM'
 
+  # VMwareConnectionType
+  VMWARE_CONNECTION_SSH = 'ssh'
+
+  # VMwareConnectionType
+  VMWARE_CONNECTION_VSPHERE = 'vsphere'
+
+  # VmwareSnapshotType
+  VMWARE_SNAPSHOT_FAST = ''
+
+  # VmwareSnapshotType
+  VMWARE_SNAPSHOT_QUIESCE = 'quiesce'
+
+  # VmwareSnapshotType
+  VMWARE_SNAPSHOT_MEMORY = 'memory'
+
+  # VmwareBackupType
+  VMWARE_BACKUP_FULL = 'full'
+
+  # VmwareBackupType
+  VMWARE_BACKUP_CBT = 'cbt'
+
+  # VmwareBackupType
+  VMWARE_BACKUP_COPY = 'copy'
+
   VHDX_PARTITON_READ_ERR_MSG = 'ERR_VHDX_PARTITION'
 
   # WebAuthnDeviceType

data/lib/comet/models/browse_vmware_response.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2023 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseVMwareResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseVMwareResponse
+
+    # 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::VMwareMachineInfo>] virtual_machines
+    attr_accessor :virtual_machines
+
+    # @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 = ''
+      @virtual_machines = []
+      @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 'VirtualMachines'
+          if v.nil?
+            @virtual_machines = []
+          else
+            @virtual_machines = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @virtual_machines[i1] = Comet::VMwareMachineInfo.new
+              @virtual_machines[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['VirtualMachines'] = @virtual_machines
+      @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