comet_backup_ruby_sdk 2.42.0 → 2.44.0

data/lib/comet/models/branding_options.rb

@@ -149,6 +149,18 @@ module Comet
     # @type [String] windows_code_sign_azure_tenant_id
     attr_accessor :windows_code_sign_azure_tenant_id
 
+    # URL of the SAS Relic server, with protocol (https://) and trailing slash
+    # @type [String] windows_code_sign_relic_server_url
+    attr_accessor :windows_code_sign_relic_server_url
+
+    # The SAS Relic client keypair in PEM format
+    # @type [String] windows_code_sign_relic_keypair_file
+    attr_accessor :windows_code_sign_relic_keypair_file
+
+    # The name of the key to select on the remote SAS Relic server
+    # @type [String] windows_code_sign_relic_key_name
+    attr_accessor :windows_code_sign_relic_key_name
+
     # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
     attr_accessor :mac_oscode_sign
 
@@ -198,6 +210,9 @@ module Comet
       @windows_code_sign_azure_app_secret_format = 0
       @windows_code_sign_azure_app_secret = ''
       @windows_code_sign_azure_tenant_id = ''
+      @windows_code_sign_relic_server_url = ''
+      @windows_code_sign_relic_keypair_file = ''
+      @windows_code_sign_relic_key_name = ''
       @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
       @unknown_json_fields = {}
     end
@@ -377,6 +392,18 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @windows_code_sign_azure_tenant_id = v
+        when 'WindowsCodeSignRelicServerURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_server_url = v
+        when 'WindowsCodeSignRelicKeypairFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_keypair_file = v
+        when 'WindowsCodeSignRelicKeyName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_key_name = v
         when 'MacOSCodeSign'
           @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
           @mac_oscode_sign.from_hash(v)
@@ -432,6 +459,9 @@ module Comet
       ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
       ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
       ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
+      ret['WindowsCodeSignRelicServerURL'] = @windows_code_sign_relic_server_url
+      ret['WindowsCodeSignRelicKeypairFile'] = @windows_code_sign_relic_keypair_file
+      ret['WindowsCodeSignRelicKeyName'] = @windows_code_sign_relic_key_name
       ret['MacOSCodeSign'] = @mac_oscode_sign
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/branding_properties.rb

@@ -126,6 +126,18 @@ module Comet
     # @type [String] windows_code_sign_azure_tenant_id
     attr_accessor :windows_code_sign_azure_tenant_id
 
+    # URL of the SAS Relic server, with protocol (https://) and trailing slash
+    # @type [String] windows_code_sign_relic_server_url
+    attr_accessor :windows_code_sign_relic_server_url
+
+    # The SAS Relic client keypair in PEM format
+    # @type [String] windows_code_sign_relic_keypair_file
+    attr_accessor :windows_code_sign_relic_keypair_file
+
+    # The name of the key to select on the remote SAS Relic server
+    # @type [String] windows_code_sign_relic_key_name
+    attr_accessor :windows_code_sign_relic_key_name
+
     # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
     attr_accessor :mac_oscode_sign
 
@@ -169,6 +181,9 @@ module Comet
       @windows_code_sign_azure_app_secret_format = 0
       @windows_code_sign_azure_app_secret = ''
       @windows_code_sign_azure_tenant_id = ''
+      @windows_code_sign_relic_server_url = ''
+      @windows_code_sign_relic_keypair_file = ''
+      @windows_code_sign_relic_key_name = ''
       @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
       @unknown_json_fields = {}
     end
@@ -322,6 +337,18 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @windows_code_sign_azure_tenant_id = v
+        when 'WindowsCodeSignRelicServerURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_server_url = v
+        when 'WindowsCodeSignRelicKeypairFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_keypair_file = v
+        when 'WindowsCodeSignRelicKeyName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_key_name = v
         when 'MacOSCodeSign'
           @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
           @mac_oscode_sign.from_hash(v)
@@ -370,6 +397,9 @@ module Comet
       ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
       ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
       ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
+      ret['WindowsCodeSignRelicServerURL'] = @windows_code_sign_relic_server_url
+      ret['WindowsCodeSignRelicKeypairFile'] = @windows_code_sign_relic_keypair_file
+      ret['WindowsCodeSignRelicKeyName'] = @windows_code_sign_relic_key_name
       ret['MacOSCodeSign'] = @mac_oscode_sign
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/destination_config.rb

@@ -236,6 +236,11 @@ module Comet
     # @type [Number] storage_limit_bytes
     attr_accessor :storage_limit_bytes
 
+    # If set, use a shared Storage Vault quota from the Comet Management Console. The direct value of
+    # StorageLimitBytes is ignored.
+    # @type [String] storage_limit_id
+    attr_accessor :storage_limit_id
+
     # @type [Comet::DestinationStatistics] statistics
     attr_accessor :statistics
 
@@ -316,6 +321,7 @@ module Comet
       @encrypted_encryption_key = ''
       @repo_init_timestamp = 0
       @storage_limit_bytes = 0
+      @storage_limit_id = ''
       @statistics = Comet::DestinationStatistics.new
       @default_retention = Comet::RetentionPolicy.new
       @retention_error = ''
@@ -582,6 +588,10 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @storage_limit_bytes = v
+        when 'StorageLimitID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @storage_limit_id = v
         when 'Statistics'
           @statistics = Comet::DestinationStatistics.new
           @statistics.from_hash(v)
@@ -674,6 +684,7 @@ module Comet
       ret['RepoInitTimestamp'] = @repo_init_timestamp
       ret['StorageLimitEnabled'] = @storage_limit_enabled
       ret['StorageLimitBytes'] = @storage_limit_bytes
+      ret['StorageLimitID'] = @storage_limit_id
       unless @statistics.nil?
         ret['Statistics'] = @statistics
       end

data/lib/comet/models/{pverestore_selection.rb → dispatch_with_job_idresponse.rb}

@@ -9,17 +9,18 @@ require 'json'
 
 module Comet
 
-  # PVERestoreSelection is a typed class wrapper around the underlying Comet Server API data structure.
-  class PVERestoreSelection
+  # DispatchWithJobIDResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class DispatchWithJobIDResponse
 
-    # @type [String] id
-    attr_accessor :id
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
 
-    # @type [String] name
-    attr_accessor :name
+    # @type [String] message
+    attr_accessor :message
 
-    # @type [Comet::PVEVM] target_vm
-    attr_accessor :target_vm
+    # @type [String] job_id
+    attr_accessor :job_id
 
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
@@ -29,9 +30,9 @@ module Comet
     end
 
     def clear
-      @id = ''
-      @name = ''
-      @target_vm = Comet::PVEVM.new
+      @status = 0
+      @message = ''
+      @job_id = ''
       @unknown_json_fields = {}
     end
 
@@ -48,17 +49,18 @@ module Comet
 
       obj.each do |k, v|
         case k
-        when 'ID'
+        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
 
-          @id = v
-        when 'Name'
+          @message = v
+        when 'JobID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
-          @name = v
-        when 'TargetVM'
-          @target_vm = Comet::PVEVM.new
-          @target_vm.from_hash(v)
+          @job_id = v
         else
           @unknown_json_fields[k] = v
         end
@@ -68,13 +70,11 @@ module Comet
     # @return [Hash] The complete object as a Ruby hash
     def to_hash
       ret = {}
-      unless @id.nil?
-        ret['ID'] = @id
-      end
-      unless @name.nil?
-        ret['Name'] = @name
+      ret['Status'] = @status
+      ret['Message'] = @message
+      unless @job_id.nil?
+        ret['JobID'] = @job_id
       end
-      ret['TargetVM'] = @target_vm
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/get_shared_storage_quota_response.rb

@@ -0,0 +1,110 @@
+# 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
+
+  # GetSharedStorageQuotaResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class GetSharedStorageQuotaResponse
+
+    # 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 [Comet::SharedStorageQuota] shared_storage_quota
+    attr_accessor :shared_storage_quota
+
+    # @type [String] shared_storage_quota_hash
+    attr_accessor :shared_storage_quota_hash
+
+    # Bytes
+    # @type [Number] current_usage
+    attr_accessor :current_usage
+
+    # @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 = ''
+      @shared_storage_quota = Comet::SharedStorageQuota.new
+      @shared_storage_quota_hash = ''
+      @current_usage = 0
+      @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 'SharedStorageQuota'
+          @shared_storage_quota = Comet::SharedStorageQuota.new
+          @shared_storage_quota.from_hash(v)
+        when 'SharedStorageQuotaHash'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @shared_storage_quota_hash = v
+        when 'CurrentUsage'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @current_usage = v
+        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['SharedStorageQuota'] = @shared_storage_quota
+      ret['SharedStorageQuotaHash'] = @shared_storage_quota_hash
+      ret['CurrentUsage'] = @current_usage
+      @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/list_shared_storage_quota_response.rb

@@ -0,0 +1,98 @@
+# 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
+
+  # ListSharedStorageQuotaResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class ListSharedStorageQuotaResponse
+
+    # 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 [Hash{String => Comet::SharedStorageQuota}] entries
+    attr_accessor :entries
+
+    # @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 = ''
+      @entries = {}
+      @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 'Entries'
+          @entries = {}
+          if v.nil?
+            @entries = {}
+          else
+            v.each do |k1, v1|
+              @entries[k1] = Comet::SharedStorageQuota.new
+              @entries[k1].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['Entries'] = @entries
+      @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/private_branding_properties.rb

@@ -93,6 +93,18 @@ module Comet
     # @type [String] windows_code_sign_azure_tenant_id
     attr_accessor :windows_code_sign_azure_tenant_id
 
+    # URL of the SAS Relic server, with protocol (https://) and trailing slash
+    # @type [String] windows_code_sign_relic_server_url
+    attr_accessor :windows_code_sign_relic_server_url
+
+    # The SAS Relic client keypair in PEM format
+    # @type [String] windows_code_sign_relic_keypair_file
+    attr_accessor :windows_code_sign_relic_keypair_file
+
+    # The name of the key to select on the remote SAS Relic server
+    # @type [String] windows_code_sign_relic_key_name
+    attr_accessor :windows_code_sign_relic_key_name
+
     # @type [Comet::MacOSCodeSignProperties] mac_oscode_sign
     attr_accessor :mac_oscode_sign
 
@@ -129,6 +141,9 @@ module Comet
       @windows_code_sign_azure_app_secret_format = 0
       @windows_code_sign_azure_app_secret = ''
       @windows_code_sign_azure_tenant_id = ''
+      @windows_code_sign_relic_server_url = ''
+      @windows_code_sign_relic_keypair_file = ''
+      @windows_code_sign_relic_key_name = ''
       @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
       @unknown_json_fields = {}
     end
@@ -246,6 +261,18 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @windows_code_sign_azure_tenant_id = v
+        when 'WindowsCodeSignRelicServerURL'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_server_url = v
+        when 'WindowsCodeSignRelicKeypairFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_keypair_file = v
+        when 'WindowsCodeSignRelicKeyName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @windows_code_sign_relic_key_name = v
         when 'MacOSCodeSign'
           @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
           @mac_oscode_sign.from_hash(v)
@@ -283,6 +310,9 @@ module Comet
       ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
       ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
       ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
+      ret['WindowsCodeSignRelicServerURL'] = @windows_code_sign_relic_server_url
+      ret['WindowsCodeSignRelicKeypairFile'] = @windows_code_sign_relic_keypair_file
+      ret['WindowsCodeSignRelicKeyName'] = @windows_code_sign_relic_key_name
       ret['MacOSCodeSign'] = @mac_oscode_sign
       @unknown_json_fields.each do |k, v|
         ret[k] = v

data/lib/comet/models/protected_item_with_backup_rules_response.rb

@@ -0,0 +1,119 @@
+# 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
+
+  # ProtectedItemWithBackupRulesResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class ProtectedItemWithBackupRulesResponse
+
+    # 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
+
+    # The Protected Item configuration
+    # @type [Comet::SourceConfig] source
+    attr_accessor :source
+
+    # All backup rules for the Protected Item
+    # @type [Hash{String => Comet::BackupRuleConfig}] backup_rules
+    attr_accessor :backup_rules
+
+    # @type [String] profile_hash
+    attr_accessor :profile_hash
+
+    # @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 = ''
+      @source = Comet::SourceConfig.new
+      @backup_rules = {}
+      @profile_hash = ''
+      @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 'Source'
+          @source = Comet::SourceConfig.new
+          @source.from_hash(v)
+        when 'BackupRules'
+          @backup_rules = {}
+          if v.nil?
+            @backup_rules = {}
+          else
+            v.each do |k1, v1|
+              @backup_rules[k1] = Comet::BackupRuleConfig.new
+              @backup_rules[k1].from_hash(v1)
+            end
+          end
+        when 'ProfileHash'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @profile_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['Status'] = @status
+      ret['Message'] = @message
+      ret['Source'] = @source
+      unless @backup_rules.nil?
+        ret['BackupRules'] = @backup_rules
+      end
+      ret['ProfileHash'] = @profile_hash
+      @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/pvebackup_disk.rb

@@ -10,11 +10,17 @@ require 'json'
 module Comet
 
   # PVEBackupDisk is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is used in the EngineProps for an "engine1/proxmox" Protected Item. It represents the
+# selection state for a single disk attached to a single Proxmox VM or LXC Container. It is expected
+# to be user-configurable.
+  # This type is available in Comet 25.8.0 and later.
   class PVEBackupDisk
 
+    # For a disk "scsi0", this field should contain: "scsi"
     # @type [String] device
     attr_accessor :device
 
+    # For a disk "scsi0", this field should contain: 0
     # @type [Number] device_num
     attr_accessor :device_num
 

data/lib/comet/models/pvebackup_node.rb

@@ -10,11 +10,16 @@ require 'json'
 module Comet
 
   # PVEBackupNode is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is used in the EngineProps for an "engine1/proxmox" Protected Item. It represents the
+# selection state for a single Proxmox VE node. It is expected to be user-configurable.
+  # This type is available in Comet 25.8.0 and later.
   class PVEBackupNode
 
     # @type [Array<Comet::PVEBackupVM>] included_vms
     attr_accessor :included_vms
 
+    # Used as a cache if the device is offline when editing the Protected Item; not considered as part
+    # of the selection
     # @type [String] name
     attr_accessor :name
 

data/lib/comet/models/pvebackup_vm.rb

@@ -10,17 +10,23 @@ require 'json'
 module Comet
 
   # PVEBackupVM is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is used in the EngineProps for an "engine1/proxmox" Protected Item. It represents the
+# selection state for a single Proxmox VM or LXC Container. It is expected to be user-configurable.
+  # This type is available in Comet 25.8.0 and later.
   class PVEBackupVM
 
     # @type [Array<Comet::PVEBackupDisk>] included_disks
     attr_accessor :included_disks
 
+    # Used as a cache if the device is offline when editing the Protected Item; not considered as part
+    # of the selection
     # @type [String] name
     attr_accessor :name
 
     # @type [Boolean] selected
     attr_accessor :selected
 
+    # One of the PROXMOX_TYPE_ constants
     # @type [String] type
     attr_accessor :type