Module: Comet

Defined in:: lib/comet/definitions.rb,
lib/comet/comet_server.rb,
lib/comet/models/osinfo.rb,
lib/comet/models/job_entry.rb,
lib/comet/models/partition.rb,
lib/comet/models/psaconfig.rb,
lib/comet/models/time_span.rb,
lib/comet/models/disk_drive.rb,
lib/comet/models/news_entry.rb,
lib/comet/models/oidc_claim.rb,
lib/comet/api_response_error.rb,
lib/comet/models/file_option.rb,
lib/comet/models/oidc_config.rb,
lib/comet/models/stat_result.rb,
lib/comet/models/user_policy.rb,
lib/comet/models/win_smbauth.rb,
lib/comet/models/edbfile_info.rb,
lib/comet/models/group_policy.rb,
lib/comet/models/organization.rb,
lib/comet/models/vsscomponent.rb,
lib/comet/models/device_config.rb,
lib/comet/models/email_options.rb,
lib/comet/models/install_creds.rb,
lib/comet/models/install_token.rb,
lib/comet/models/psagrouped_by.rb,
lib/comet/models/search_clause.rb,
lib/comet/models/source_config.rb,
lib/comet/models/sshconnection.rb,
lib/comet/models/stored_object.rb,
lib/comet/models/test_response.rb,
lib/comet/models/ratelimit_rule.rb,
lib/comet/models/replica_server.rb,
lib/comet/models/user_on_server.rb,
lib/comet/models/vault_snapshot.rb,
lib/comet/models/vsswriter_info.rb,
lib/comet/models/webhook_option.rb,
lib/comet/models/license_options.rb,
lib/comet/models/mssqlconnection.rb,
lib/comet/models/mssqllogin_args.rb,
lib/comet/models/retention_range.rb,
lib/comet/models/schedule_config.rb,
lib/comet/models/session_options.rb,
lib/comet/models/u2fsign_request.rb,
lib/comet/models/branding_options.rb,
lib/comet/models/my_sqlconnection.rb,
lib/comet/models/retention_policy.rb,
lib/comet/models/size_measurement.rb,
lib/comet/models/streamable_event.rb,
lib/comet/models/u2fsign_response.rb,
lib/comet/models/uninstall_config.rb,
lib/comet/models/backup_job_detail.rb,
lib/comet/models/browse_hvresponse.rb,
lib/comet/models/bucket_properties.rb,
lib/comet/models/bucket_usage_info.rb,
lib/comet/models/hour_sched_config.rb,
lib/comet/models/new_bucket_detail.rb,
lib/comet/models/ratelimit_options.rb,
lib/comet/models/source_basic_info.rb,
lib/comet/models/source_statistics.rb,
lib/comet/models/u2fregistered_key.rb,
lib/comet/models/vmware_connection.rb,
lib/comet/models/allowed_admin_user.rb,
lib/comet/models/available_download.rb,
lib/comet/models/backup_rule_config.rb,
lib/comet/models/browse_edbresponse.rb,
lib/comet/models/browse_vssresponse.rb,
lib/comet/models/destination_config.rb,
lib/comet/models/mongo_dbconnection.rb,
lib/comet/models/self_backup_target.rb,
lib/comet/models/user_server_config.rb,
lib/comet/models/vsphere_connection.rb,
lib/comet/models/admin_email_options.rb,
lib/comet/models/backup_job_progress.rb,
lib/comet/models/branding_properties.rb,
lib/comet/models/constellation_stats.rb,
lib/comet/models/content_measurement.rb,
lib/comet/models/count_jobs_response.rb,
lib/comet/models/days_of_week_config.rb,
lib/comet/models/email_report_config.rb,
lib/comet/models/hyper_vmachine_info.rb,
lib/comet/models/self_backup_options.rb,
lib/comet/models/single_field_source.rb,
lib/comet/models/u2fregister_request.rb,
lib/comet/models/user_profile_config.rb,
lib/comet/models/vmware_machine_info.rb,
lib/comet/models/b2storage_extra_info.rb,
lib/comet/models/b2transaction_totals.rb,
lib/comet/models/destination_location.rb,
lib/comet/models/extra_file_exclusion.rb,
lib/comet/models/live_user_connection.rb,
lib/comet/models/office_365connection.rb,
lib/comet/models/office_365credential.rb,
lib/comet/models/storage_role_options.rb,
lib/comet/models/web_authn_credential.rb,
lib/comet/models/admin_u2fregistration.rb,
lib/comet/models/httpconnector_options.rb,
lib/comet/models/office_365object_info.rb,
lib/comet/models/organization_response.rb,
lib/comet/models/remote_server_address.rb,
lib/comet/models/remote_storage_option.rb,
lib/comet/models/server_config_options.rb,
lib/comet/models/user_profile_fragment.rb,
lib/comet/models/web_authn_user_entity.rb,
lib/comet/models/admin_security_options.rb,
lib/comet/models/admin_user_permissions.rb,
lib/comet/models/b2destination_location.rb,
lib/comet/models/browse_vmware_response.rb,
lib/comet/models/destination_statistics.rb,
lib/comet/models/email_reporting_option.rb,
lib/comet/models/install_token_response.rb,
lib/comet/models/s3destination_location.rb,
lib/comet/models/self_backup_statistics.rb,
lib/comet/models/source_include_pattern.rb,
lib/comet/models/update_campaign_status.rb,
lib/comet/models/web_authn_sign_request.rb,
lib/comet/models/admin_resource_response.rb,
lib/comet/models/ftpdestination_location.rb,
lib/comet/models/global_override_options.rb,
lib/comet/models/local_storage_directory.rb,
lib/comet/models/search_result_file_info.rb,
lib/comet/models/storage_free_space_info.rb,
lib/comet/models/update_campaign_options.rb,
lib/comet/models/web_authn_sign_response.rb,
lib/comet/models/office_365custom_setting.rb,
lib/comet/models/server_meta_version_info.rb,
lib/comet/models/sftpdestination_location.rb,
lib/comet/models/browse_sqlserver_response.rb,
lib/comet/models/comet_apiresponse_message.rb,
lib/comet/models/get_group_policy_response.rb,
lib/comet/models/search_snapshots_response.rb,
lib/comet/models/totp_regenerated_response.rb,
lib/comet/models/vmdksnapshot_view_options.rb,
lib/comet/models/azure_destination_location.rb,
lib/comet/models/backup_rule_event_triggers.rb,
lib/comet/models/comet_destination_location.rb,
lib/comet/models/constellation_check_report.rb,
lib/comet/models/constellation_role_options.rb,
lib/comet/models/local_destination_location.rb,
lib/comet/models/mac_oscode_sign_properties.rb,
lib/comet/models/public_branding_properties.rb,
lib/comet/models/self_backup_export_options.rb,
lib/comet/models/spanned_storage_extra_info.rb,
lib/comet/models/storj_destination_location.rb,
lib/comet/models/swift_destination_location.rb,
lib/comet/models/update_campaign_properties.rb,
lib/comet/models/user_custom_email_settings.rb,
lib/comet/models/add_bucket_response_message.rb,
lib/comet/models/authentication_role_options.rb,
lib/comet/models/backup_job_advanced_options.rb,
lib/comet/models/browse_disk_drives_response.rb,
lib/comet/models/default_email_report_policy.rb,
lib/comet/models/office_365custom_setting_v2.rb,
lib/comet/models/private_branding_properties.rb,
lib/comet/models/software_build_role_options.rb,
lib/comet/models/web_authn_credential_entity.rb,
lib/comet/models/admin_web_authn_registration.rb,
lib/comet/models/create_group_policy_response.rb,
lib/comet/models/replicator_state_apiresponse.rb,
lib/comet/models/restore_job_advanced_options.rb,
lib/comet/models/spanned_destination_location.rb,
lib/comet/models/web_dav_destination_location.rb,
lib/comet/models/windows_code_sign_properties.rb,
lib/comet/models/content_measurement_component.rb,
lib/comet/models/custom_remote_bucket_settings.rb,
lib/comet/models/registration_lobby_connection.rb,
lib/comet/models/software_update_news_response.rb,
lib/comet/models/storage_vault_provider_policy.rb,
lib/comet/models/update_campaign_device_status.rb,
lib/comet/models/email_report_generated_preview.rb,
lib/comet/models/external_authentication_source.rb,
lib/comet/models/organization_login_urlresponse.rb,
lib/comet/models/s3generic_virtual_storage_role.rb,
lib/comet/models/web_authn_credential_assertion.rb,
lib/comet/models/web_authn_credential_parameter.rb,
lib/comet/models/web_authn_relying_party_entity.rb,
lib/comet/models/b2virtual_storage_role_settings.rb,
lib/comet/models/office_365mixed_virtual_account.rb,
lib/comet/models/server_meta_branding_properties.rb,
lib/comet/models/web_authn_credential_descriptor.rb,
lib/comet/models/constellation_status_apiresponse.rb,
lib/comet/models/session_key_regenerated_response.rb,
lib/comet/models/admin_account_properties_response.rb,
lib/comet/models/browse_office_365objects_response.rb,
lib/comet/models/default_source_with_osrestriction.rb,
lib/comet/models/dispatcher_admin_sources_response.rb,
lib/comet/models/get_profile_hash_response_message.rb,
lib/comet/models/protected_item_engine_type_policy.rb,
lib/comet/models/web_authn_authenticator_selection.rb,
lib/comet/models/web_interface_branding_properties.rb,
lib/comet/models/dispatcher_stored_objects_response.rb,
lib/comet/models/storj_virtual_storage_role_setting.rb,
lib/comet/models/u2fregistration_challenge_response.rb,
lib/comet/models/dispatcher_vault_snapshots_response.rb,
lib/comet/models/update_campaign_status_device_entry.rb,
lib/comet/models/dispatcher_windisk_snapshot_response.rb,
lib/comet/models/wasabi_virtual_storage_role_settings.rb,
lib/comet/models/get_profile_and_hash_response_message.rb,
lib/comet/models/external_authentication_source_display.rb,
lib/comet/models/request_storage_vault_response_message.rb,
lib/comet/models/amazon_awsvirtual_storage_role_settings.rb,
lib/comet/models/external_authentication_source_response.rb,
lib/comet/models/server_config_options_branding_fragment.rb,
lib/comet/models/external_ldapauthentication_source_server.rb,
lib/comet/models/web_authn_registration_challenge_response.rb,
lib/comet/models/register_office_application_begin_response.rb,
lib/comet/models/register_office_application_check_response.rb,
lib/comet/models/external_ldapauthentication_source_settings.rb,
lib/comet/models/browse_office_365list_virtual_accounts_response.rb,
lib/comet/models/web_authn_public_key_credential_request_options.rb,
lib/comet/models/web_authn_public_key_credential_creation_options.rb,
lib/comet/models/server_config_options_software_build_role_fragment.rb

Overview

SPDX-License-Identifier: MIT

Defined Under Namespace

Constant Summary collapse

APPLICATION_VERSION =

'23.9.11'

APPLICATION_VERSION_MAJOR =

APPLICATION_VERSION_MINOR =

APPLICATION_VERSION_REVISION =

BACKUPJOBAUTORETENTION_AUTOMATIC = AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.

BACKUPJOBAUTORETENTION_IMMEDIATE = AutoRetentionLevel: The system will run a Retention Pass after every single backup job. This is more system-intensive, but is the most responsive at freeing storage space.

BACKUPJOBAUTORETENTION_MORE_OFTEN = AutoRetentionLevel: The system will follow the automatic ruleset for a ‘High Power’ device.

BACKUPJOBAUTORETENTION_LESS_OFTEN = AutoRetentionLevel: The system will follow the automatic ruleset for a ‘Low Power’ device.

BRANDINGSTYLETYPE_AUTO_LEGACY = If set, will be automatically replaced with one of the other BRANDINGSTYLETYPE_ constants after next server upgrade.

BRANDINGSTYLETYPE_DEFAULT = Use Comet company branding and colours for all web interface branding

BRANDINGSTYLETYPE_CUSTOM_TEXT = Use custom branding and colours, with text in the main logo area.

BRANDINGSTYLETYPE_CUSTOM_LOGO = Use custom branding and colours, with a supplied image in the main logo area.

CLIENTBRANDINGBUILD_CUSTOM = ClientBrandingBuildMode: The software client will be custom-built by this Comet Server, allowing custom branding, default server URL, and codesigning.

CLIENTBRANDINGBUILD_PREBUILT = ClientBrandingBuildMode: A pre-built software client will be served, with Comet-branding, no server URL, and Comet codesigning.

COMPRESS_INVALID = CompressMode

COMPRESS_LVL_1 = CompressMode

COMPRESS_LVL_2 = CompressMode

COMPRESS_LVL_3 = CompressMode

COMPRESS_LVL_4 = CompressMode

COMPRESS_LVL_5 = CompressMode

COMPRESS_MAX = CompressMode

COMPRESS_LVL_5

COMPRESS_DEFAULT = CompressMode

COMPRESS_LVL_4

DEFAULT_LANGUAGE = LanguageCode

'en_US'

DEFAULT_TIMEZONE =

'UTC'

DESTINATION_SFTP_AUTHMODE_NATIVE = SftpAuthMode

DESTINATION_SFTP_AUTHMODE_PASSWORD = SftpAuthMode

DESTINATION_SFTP_AUTHMODE_PRIVATEKEY = SftpAuthMode

DESTINATIONTYPE___INVALID =

DESTINATIONTYPE_S3 = S3-compatible, or a specific S3 service such as AWS S3, Wasabi, or iDrive e2

DESTINATIONTYPE_SFTP = SFTP protocol

DESTINATIONTYPE_LOCALCOPY = Local Path

DESTINATIONTYPE_COMET = The Comet Server Storage Role protocol

DESTINATIONTYPE_FTP = FTP protocol

DESTINATIONTYPE_AZUREBLOB = Azure Blob Storage

DESTINATIONTYPE_SPANNED = Spanned

DESTINATIONTYPE_SWIFT = Openstack Swift

DESTINATIONTYPE_B2 = Backblaze B2 (Native API)

DESTINATIONTYPE_STORJ = Storj

DESTINATIONTYPE_WEBDAV =

DESTINATIONTYPE_LATEST = When defining a schedule via policy, use this option to dynamically select the Storage Vault that was created most recently.

DESTINATIONTYPE_ALL = When defining a schedule via policy, use this option to create a schedule for each Storage Vault in the user’s profile.

EMAIL_WORKER_STATE_NOT_STARTED = The Comet Server is still starting up and has not yet checked whether any email reports are due to be sent.

EMAIL_WORKER_STATE_STARTED = The Comet Server is still starting up and has not yet checked whether any email reports are due to be sent.

EMAIL_WORKER_STATE_CALCULATING = The Comet Server is currently searching through email report configuration, to determine when the next email report is due to be sent.

EMAIL_WORKER_STATE_WAITING = The Comet Server knows when the next scheduled email report is due to be sent, and is waiting until that time.

EMAIL_WORKER_STATE_SENDING = The Comet Server is currently sending a scheduled email report.

EMAIL_DELIVERY_INHERIT = EmailDeliveryType: If this is for the top-level Organization, email is disabled. If this is for an Organization, use the parent’s email settings.

''

EMAIL_DELIVERY_MX_DIRECT = EmailDeliveryType

'builtin'

EMAIL_DELIVERY_SMTP = EmailDeliveryType

'smtp'

EMAIL_DELIVERY_SMTP_SSL = EmailDeliveryType

'smtp-ssl'

EMAIL_DELIVERY_DISABLED = EmailDeliveryType

'disabled'

EMAIL_DELIVERY_BUILTIN = EmailDeliveryType: Legacy alias for EMAIL_DELIVERY_MX_DIRECT

EMAIL_DELIVERY_MX_DIRECT

EMAIL_DELIVERY_NONE =

Deprecated.

This const has been deprecated since Comet version 22.12.1

EmailDeliveryType: Legacy alias for EMAIL_DELIVERY_INHERIT

EMAIL_DELIVERY_INHERIT

EMAILREPORTTYPE_IMMEDIATE = EmailReportType

EMAILREPORTTYPE_SUMMARY = EmailReportType

EMAILREPORTTYPE_GROUPED_STATUS = EmailReportType

EMAILREPORTTYPE_RECENT_ACTIVITY = EmailReportType

ENCRYPTIONMETHOD_UNCONFIGURED =

ENGINE_BUILTIN_FILE = Files and Folders

'engine1/file'

ENGINE_BUILTIN_STDOUT = Program Output

'engine1/stdout'

ENGINE_BUILTIN_MYSQL = MySQL

'engine1/mysql'

ENGINE_BUILTIN_SYSTEMSTATE = Windows Server System State

'engine1/systemstate'

ENGINE_BUILTIN_MSSQL = Microsoft SQL Server

'engine1/mssql'

ENGINE_BUILTIN_WINDOWSSYSTEM = Windows System Backup

'engine1/windowssystem'

ENGINE_BUILTIN_EXCHANGEEDB = Microsoft Exchange Server

'engine1/exchangeedb'

ENGINE_BUILTIN_VSSWRITER = Application-Aware Writer

'engine1/vsswriter'

ENGINE_BUILTIN_HYPERV = Microsoft Hyper-V

'engine1/hyperv'

ENGINE_BUILTIN_WINDISK = Disk Image

'engine1/windisk'

ENGINE_BUILTIN_MONGODB = MongoDB

'engine1/mongodb'

ENGINE_BUILTIN_MSOFFICE = Office 365

'engine1/winmsofficemail'

ENGINE_BUILTIN_VMWARE = VMware

'engine1/vmware'

FTPS_MODE_PLAINTEXT = FtpsModeType: Use plain FTP, do not use FTPS.

FTPS_MODE_IMPLICIT = FtpsModeType: Use implicit FTPS, immediately creating a secure SSL/TLS channel before any data is sent. This usually requires a different port on the FTP server. It is generally advised to use explicit mode instead.

FTPS_MODE_EXPLICIT = FtpsModeType: Use explicit FTPS, first creating an insecure connection and then upgrading to SSL/TLS using AUTH TLS (like STARTTLS).

HYPERV_METHOD_VSS = Back up Hyper-V virtual machines using VSS mode. This includes all previous snapshots.

'vss'

HYPERV_METHOD_WMI_COPY = 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.

'copy'

HYPERV_METHOD_WMI_CBT = 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.

'wmi'

JOB_CLASSIFICATION__MIN = JobClassification: All BackupJobDetail.Classification fields will fall in the 4xxx range.

JOB_CLASSIFICATION_UNKNOWN = JobClassification

JOB_CLASSIFICATION_BACKUP = JobClassification: This is a backup job.

JOB_CLASSIFICATION_RESTORE = JobClassification: This is a restore job.

JOB_CLASSIFICATION_RETENTION = JobClassification: Automatic or manual retention cleaning pass.

JOB_CLASSIFICATION_UNLOCK = JobClassification: Another process needed exclusive Vault access (e.g. for retention) but the process died. This task cleans up exclusive lockfiles.

JOB_CLASSIFICATION_DELETE_CUSTOM = JobClassification: A specific snapshot has been deleted via the Restore wizard.

JOB_CLASSIFICATION_REMEASURE = JobClassification: Explicitly re-measuring the size of a Vault (right-click > Advanced menu).

JOB_CLASSIFICATION_UPDATE = JobClassification: Software update

JOB_CLASSIFICATION_IMPORT = JobClassification: Importing settings from another installed product

JOB_CLASSIFICATION_REINDEX = JobClassification: Repair indexes

JOB_CLASSIFICATION_DEEPVERIFY = JobClassification: Deep Verify

JOB_CLASSIFICATION_UNINSTALL = JobClassification: Software uninstall

JOB_CLASSIFICATION__MAX = JobClassification

JOB_STATUS_STOP_SUCCESS__MIN = JobStatus: If the BackupJobDetail.Status field is a 5xxx code, the job has stopped for a successful reason.

JOB_STATUS_STOP_SUCCESS = JobStatus: The job is complete and was successful.

JOB_STATUS_STOP_SUCCESS__MAX = JobStatus

JOB_STATUS_RUNNING__MIN = JobStatus: If the BackupJobDetail.Status field is a 6xxx code, the job is still running.

JOB_STATUS_RUNNING_INDETERMINATE = JobStatus: Unused

JOB_STATUS_RUNNING_ACTIVE = JobStatus: The last information the server received from the device is that the job is currently running.

JOB_STATUS_RUNNING_REVIVED = JobStatus: The job was thought to have been in an Abandoned state but updated the Comet Server with a running status.

JOB_STATUS_RUNNING__MAX = JobStatus

JOB_STATUS_FAILED__MIN = JobStatus: If the BackupJobDetail.Status field is a 7xxx code, the job has stopped for an unsuccessful reason.

JOB_STATUS_FAILED_TIMEOUT = JobStatus

JOB_STATUS_FAILED_WARNING = JobStatus: The job is complete but there was a problem that may have resulted in issues with the expected result.

JOB_STATUS_FAILED_ERROR = JobStatus: There was an error during the job and it did not fully complete.

JOB_STATUS_FAILED_QUOTA = JobStatus: During a backup job either the “All protected items” quota or “Storage Vault” quota was exceeded.

JOB_STATUS_FAILED_SCHEDULEMISSED = JobStatus: The job did not start at its scheduled time.

JOB_STATUS_FAILED_CANCELLED = JobStatus: The job was cancelled manually, a device shutdown was detected, or the backup time limit was reached.

JOB_STATUS_FAILED_SKIPALREADYRUNNING = JobStatus: The backup job was skipped as there was already a backup running and the “Skip if already running” option was enabled.

JOB_STATUS_FAILED_ABANDONED = JobStatus: The job has stopped unexpectedly or has been manually marked as abandoned by an admin.

JOB_STATUS_FAILED__MAX = JobStatus

LDAPSECURITYMETHOD_PLAIN = LDAPSecurityMethod

'plain'

LDAPSECURITYMETHOD_LDAPS = LDAPSecurityMethod

'ldaps'

LDAPSECURITYMETHOD_STARTTLS = LDAPSecurityMethod

'starttls'

MACOSCODESIGN_LEVEL_SIGN = MacOSCodesignLevel: Sign only

MACOSCODESIGN_LEVEL_SIGN_NOTARISE = MacOSCodesignLevel: Sign and notarize

MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = MacOSCodesignLevel: Sign, notarize, and staple

MIXED_VIRTUAL_ACCOUNT_TYPE_USER =

MIXED_VIRTUAL_ACCOUNT_TYPE_GROUP =

MIXED_VIRTUAL_ACCOUNT_TYPE_TEAM_GROUP =

MIXED_VIRTUAL_ACCOUNT_TYPE_SHAREPOINT_ONLY =

MONGODB_DEFAULT_PORT =

27_017

MSSQL_AUTH_WINDOWS = MSSQLAuthMode

'windows'

MSSQL_AUTH_NATIVE = MSSQLAuthMode

'native'

MSSQL_METHOD_OLEDB_NATIVE = MSSQLMethod: On Windows x86_64, use the native x86_64 driver.

'OLEDB_NATIVE'

MSSQL_METHOD_OLEDB_32 = MSSQLMethod: On Windows x86_64, use an x86_32 OLEDB driver.

'OLEDB_32'

MSSQL_RESTORE_RECOVERY = MSSQLRestoreOpt

'RECOVERY'

MSSQL_RESTORE_NORECOVERY = MSSQLRestoreOpt

'NO_RECOVERY'

OBJECT_LOCK_LEGACY =

OBJECT_LOCK_ON =

OBJECT_LOCK_OFF =

OFFICE365_REGION_PUBLIC =

'GlobalPublicCloud'

OFFICE365_REGION_CHINA =

'ChinaCloud'

OFFICE365_REGION_GERMANY =

'GermanCloud'

OFFICE365_REGION_US_GOVT =

'USGovtGccCloud'

OFFICE365_REGION_US_DOD =

'USGovtGccDoDCloud'

OS_ANY = ExtraFileExclusionOSRestriction: Applies to any device

OS_ONLY_WINDOWS = ExtraFileExclusionOSRestriction: Applies to all Windows devices, regardless of CPU type

OS_ONLY_WINDOWS_X8632 = ExtraFileExclusionOSRestriction: Applies to Windows devices with x86_32 CPU

OS_ONLY_WINDOWS_X8664 = ExtraFileExclusionOSRestriction: Applies to Windows devices with x86_64 CPU

OS_ONLY_MACOS = ExtraFileExclusionOSRestriction: Applies to macOS devices, regardless of CPU type

OS_ONLY_LINUX = ExtraFileExclusionOSRestriction: Applies to Linux devices (including Synology DSM), regardless of CPU type

PASSWORD_FORMAT_PLAINTEXT = When resetting a password with the API, set the PasswordFormat to this value. The Comet Server will re-hash the credential automatically.

PROVIDER_GENERIC = OidcProvider

'oidc'

PROVIDER_AZUREADV2 = OidcProvider

'azure-ad-v2'

PROVIDER_GOOGLE = OidcProvider

'google'

PROVIDER_DASHBOARD = OidcProvider

'dashboard'

PSA_TYPE_GENERIC = PSAType

PSA_TYPE_GRADIENT = PSAType

PSA_TYPE_SYNCRO = PSAType

RELEASE_CODENAME =

'Voyager'

REMOTESERVER_COMET = RemoteServerType

'comet'

REMOTESERVER_COMET_STORAGE = RemoteServerType

'cometstorage'

REMOTESERVER_LDAP = RemoteServerType

'ldap'

REMOTESERVER_OIDC = RemoteServerType

'oidc'

REMOTESERVER_B2 = RemoteServerType

'b2'

REMOTESERVER_WASABI = RemoteServerType

'wasabi'

REMOTESERVER_CUSTOM = RemoteServerType

'custom'

REMOTESERVER_S3_GENERIC = RemoteServerType

's3'

REMOTESERVER_AWS = RemoteServerType

'aws'

REMOTESERVER_STORJ = RemoteServerType

'storj'

REMOTESERVER_IDRIVEE2 = RemoteServerType

'idrivee2'

REPLICATOR_STATE_NONE = ReplicatorState

REPLICATOR_STATE_FILE_LIST_WORKER_STARTED = ReplicatorState

REPLICATOR_STATE_FILE_LIST_SYNC_RUNNING = ReplicatorState

REPLICATOR_STATE_FILE_LIST_SYNC_FINISHED = ReplicatorState

REPLICATOR_STATE_WORKERS_STARTED = ReplicatorState

REPLICATOR_DISPLAYCLASS_STORAGE = ReplicatorDisplayClass

REPLICATOR_DISPLAYCLASS_USER = ReplicatorDisplayClass

RESTOREARCHIVEFORMAT_TAR = RestoreArchiveFormat: Tar file format

RESTOREARCHIVEFORMAT_TARGZ = RestoreArchiveFormat: Compressed Tar.gz (.tgz) file format

RESTOREARCHIVEFORMAT_ZIP = RestoreArchiveFormat: Zip file format

RESTOREARCHIVEFORMAT_SQFS = RestoreArchiveFormat: SquashFS container

RESTOREARCHIVEFORMAT_TARZSTD = RestoreArchiveFormat: Compressed Tar.zstd (.tzst) file format

RESTORETYPE_INVALID = RestoreType

-1

RESTORETYPE_FILE = RestoreType: Restore as files and folders

RESTORETYPE_NULL = RestoreType: Download and reconstruct files, but do not save them (for test purposes)

RESTORETYPE_PROCESS_PERFILE = RestoreType: Stream each restored file into the target command stdin. The target command may be executed multiple times, once for each restored file.

RESTORETYPE_PROCESS_ARCHIVE = RestoreType: Stream an archive of each restored file into the target command stdin. The target command will be executed only once.

RESTORETYPE_WINDISK = RestoreType: Restore partitions back to the physical disk

RESTORETYPE_FILE_ARCHIVE = RestoreType: Restore selected files and folders as a single compressed archive

RESTORETYPE_OFFICE365_CLOUD = RestoreType: Restore selected Office 365 emails, contacts, calendars, and SharePoint/OneDrive data directly to the Office 365 cloud service

RESTORETYPE_VMDK_FILE = RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup

RESTORETYPE_VMDK_FILE_NULL = RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup, downloading and reconstructing files, but without saving them (for test purposes)

RESTORETYPE_VMDK_FILE_ARCHIVE = RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup, creating an archive file of all selected files

RESTORETYPE_MYSQL = RestoreType: Stream restore as SQL statements into a target MySQL server

RESTORETYPE_MSSQL = RestoreType: Stream restore as T-SQL BACKUP output into a target Microsoft SQL Server

RESTORETYPE_WINDISK_ESXI = RestoreType: Restore disk image backup as VMware-compatible virtual disks

RESTORETYPE_PROCESS_TARBALL = RestoreType: Legacy name alias - Prefer to use RESTORETYPE_PROCESS_ARCHIVE since multiple archive file formats are supported within this single RESTORETYPE_

RETENTIONMODE_KEEP_EVERYTHING = RetentionMode: If this mode is set in a RetentionPolicy, then RetentionPolicy.Ranges should be ignored.

RETENTIONMODE_DELETE_EXCEPT = RetentionMode: Delete everything except for jobs matching the ranges in RetentionPolicy.Ranges.

RETENTIONRANGE__LOWEST = RetentionRangeType

RETENTIONRANGE_MOST_RECENT_X_JOBS = RetentionRangeType: Uses Jobs

RETENTIONRANGE_NEWER_THAN_X = RetentionRangeType: Uses Timestamp

RETENTIONRANGE_JOBS_SINCE = RetentionRangeType: Uses Days, Weeks, Months

RETENTIONRANGE_FIRST_JOB_FOR_EACH_LAST_X_DAYS = RetentionRangeType: Uses Days

RETENTIONRANGE__RESERVED904 =

Deprecated.

This const has been deprecated since Comet version 17.2.0

RetentionRangeType

RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_MONTHS = RetentionRangeType: Uses Months, MonthOffset

RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_WEEKS = RetentionRangeType: Uses Weeks, WeekOffset

RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_DAY = RetentionRangeType: Uses Jobs

RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_WEEK = RetentionRangeType: Uses Jobs

RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_MONTH = RetentionRangeType: Uses Jobs

RETENTIONRANGE__HIGHEST = RetentionRangeType

RETENTIONRANGE_MAXINT =

1_125_899_906_842_624

SCHEDULE_FREQUENCY_LOWEST =

SCHEDULE_FREQUENCY_ONCEONLY = SecondsPast should be a Unix timestamp, in seconds

SCHEDULE_FREQUENCY_DAILY = SecondsPast is the number of seconds past 00:00, in the device’s local timezone.

SCHEDULE_FREQUENCY_HOURLY = SecondsPast is the number of seconds past *:00, in the device’s local timezone.

SCHEDULE_FREQUENCY_WEEKLY = SecondsPast is the number of seconds past 00:00 Sunday, in the device’s local timezone.

SCHEDULE_FREQUENCY_MONTHLY = SecondsPast is the number of seconds past 00:00 1st, in the device’s local timezone.

SCHEDULE_FREQUENCY_PERIODIC = SecondsPast is the number of seconds per period. Offset: Shunt seconds after unix epoch

SCHEDULE_FREQUENCY_HIGHEST =

SCHEDULE_MAX_RANDOM_DELAY_SECS = Maximum random delay (5 hours)

18_000

SCHEDULE_MAXINT =

1_125_899_906_842_624

SEARCHCLAUSE_RULE = SearchClauseType: The search clause is an explicit rule

''

SEARCHCLAUSE_AND = SearchClauseType: All of the ClauseChildren must match

'and'

SEARCHCLAUSE_OR = SearchClauseType: At least one of the ClauseChildren must match

'or'

SEARCHCLAUSE_NOT_AND = SearchClauseType

'not_and'

SEARCHCLAUSE_NOT_OR = SearchClauseType

'not_or'

SEARCHOPERATOR_STRING_EQ = String equals (case sensitive)

'str_eq'

SEARCHOPERATOR_STRING_NEQ = String does not equal (case sensitive)

'str_neq'

SEARCHOPERATOR_STRING_CONTAINS = String contains anywhere (case sensitive)

'str_contains'

SEARCHOPERATOR_STRING_NCONTAINS = String does not contain anywhere (case sensitive)

'str_ncontains'

SEARCHOPERATOR_STRING_STARTSWITH = String starts with prefix (case sensitive)

'str_startswith'

SEARCHOPERATOR_STRING_NSTARTSWITH = String does not start with prefix (case sensitive)

'str_nstartswith'

SEARCHOPERATOR_STRING_ENDSWITH = String ends with suffix (case sensitive)

'str_endswith'

SEARCHOPERATOR_STRING_NENDSWITH = String does not end with suffix (case sensitive)

'str_nendswith'

SEARCHOPERATOR_STRING_EQ_CI = String equals (case insensitive)

'str_eq_ci'

SEARCHOPERATOR_STRING_NEQ_CI = String does not equal (case insensitive)

'str_neq_ci'

SEARCHOPERATOR_STRING_CONTAINS_CI = String contains anywhere (case sensitive)

'str_contains_ci'

SEARCHOPERATOR_STRING_NCONTAINS_CI = String does not contain anywhere (case sensitive)

'str_ncontains_ci'

SEARCHOPERATOR_STRING_STARTSWITH_CI = String starts with prefix (case sensitive)

'str_startswith_ci'

SEARCHOPERATOR_STRING_NSTARTSWITH_CI = String does not start with (case sensitive)

'str_nstartswith_ci'

SEARCHOPERATOR_STRING_ENDSWITH_CI = String ends with suffix (case sensitive)

'str_endswith_ci'

SEARCHOPERATOR_STRING_NENDSWITH_CI = String does not end with suffix (case sensitive)

'str_nendswith_ci'

SEARCHOPERATOR_STRING_REGEXMATCH = String matches provided regular expression (using Go regex syntax)

'str_regexmatch'

SEARCHOPERATOR_STRING_NREGEXMATCH = String does not match provided regular expression (using Go regex syntax)

'str_nregexmatch'

SEARCHOPERATOR_INT_EQ = Integer field is equal to value

'int_eq'

SEARCHOPERATOR_INT_NEQ = Integer field is not equal to value

'int_neq'

SEARCHOPERATOR_INT_GT = Integer field is greater than value

'int_gt'

SEARCHOPERATOR_INT_GTE = Integer field is greater than or equal to value

'int_gte'

SEARCHOPERATOR_INT_LT = Integer field is less than value

'int_lt'

SEARCHOPERATOR_INT_LTE = Integer field is less than or equal to value

'int_lte'

SEARCHOPERATOR_BOOL_IS = Boolean field matches value

'bool_is'

SEARCHOPERATOR_BOOL_NIS = Boolean field does not match value

'bool_nis'

SERVICE_CALENDAR = 0000 0001. If this value is present in the bitset, then the Calendar service is selected for backup.

SERVICE_CONTACT = 0000 0010. If this value is present in the bitset, then the Contact service is selected for backup.

SERVICE_MAIL = 0000 0100. If this value is present in the bitset, then the Mail service is selected for backup.

SERVICE_SHAREPOINT = 0000 1000. If this value is present in the bitset, then the SharePoint service is selected for backup.

SERVICE_ONEDRIVE = 0001 0000. If this value is present in the bitset, then the OneDrive service is selected for backup.

SETTING_SYSTEM_DEFAULT = DefaultSettingMode

SETTING_OPTIONAL_DEFAULT_ON = DefaultSettingMode

SETTING_OPTIONAL_DEFAULT_OFF = DefaultSettingMode

SETTING_ENFORCED_ON = DefaultSettingMode

SETTING_ENFORCED_OFF = DefaultSettingMode

SEVERITY_INFO = Severity

'I'

SEVERITY_WARNING = Severity

'W'

SEVERITY_ERROR = Severity

'E'

SEVT__MIN = StreamableEventType

SEVT_META_HELLO = StreamableEventType: New event stream connection. Data is typically ServerMetaVersionInfo

SEVT_ACCOUNT_NEW = StreamableEventType: User created. Data is the profile object

SEVT_ACCOUNT_REMOVED = StreamableEventType: User deleted

SEVT_ACCOUNT_UPDATED = StreamableEventType: User updated. Data is the profile object

SEVT_ACCOUNT_LOGIN = StreamableEventType: User authentication succeeded. Only emitted for non-session requests. Resource is the requested path

SEVT_ACCOUNT_LOGIN_FAILED = StreamableEventType: User authentication failed. Only emitted if the user exists. Resource is the requested path

SEVT_ACCOUNT_SESSION_START = StreamableEventType: User session token created. Data is the session object

SEVT_ACCOUNT_SESSION_REVOKE = StreamableEventType: User session token deleted

SEVT_ACCOUNT_SESSION_EXPIRE = StreamableEventType: User session token expired

SEVT_ACCOUNT_ADMIN_NEW = StreamableEventType: Admin created. Data is the profile object

SEVT_ACCOUNT_ADMIN_REMOVED = StreamableEventType: Admin deleted

SEVT_ACCOUNT_ADMIN_UPDATED = StreamableEventType: Admin updated

SEVT_ACCOUNT_ADMIN_LOGIN = StreamableEventType: Admin authentication succeeded. Only emitted for non-session requests. Resource is the requested path

SEVT_ACCOUNT_ADMIN_LOGIN_FAILED = StreamableEventType: Admin authentication failed. Only emitted if the admin exists. Resource is the request path

SEVT_ACCOUNT_ADMIN_SESSION_START = StreamableEventType: Admin session token created. Data is the session object

SEVT_ACCOUNT_ADMIN_SESSION_REVOKE = StreamableEventType: Admin session token deleted

SEVT_ACCOUNT_ADMIN_SESSION_EXPIRE = StreamableEventType: Admin session token expired

SEVT_JOB_NEW = StreamableEventType: New backup job started. Data is the job object

SEVT_JOB_COMPLETED = StreamableEventType: Backup job completed. Data is the job object

SEVT_BUCKET_NEW = StreamableEventType: New bucket created

SEVT_BUCKET_REMOVED = StreamableEventType: Bucket deleted

SEVT_SERVER_STARTED = StreamableEventType: Server started

SEVT_SERVER_RESTARTED = StreamableEventType: Server restarting (pending)

SEVT_SERVER_SHUTDOWN = StreamableEventType: Server shutting down (pending)

SEVT_SERVER_UPDATED = StreamableEventType: Server configuration has been updated. Data is the server config object

SEVT_TENANT_NEW = StreamableEventType: Tenant created. Data is the tenant object

SEVT_TENANT_REMOVED = StreamableEventType: Tenant deleted

SEVT_TENANT_UPDATED = StreamableEventType: Tenant updated. Data is the tenant object

SEVT_POLICY_NEW = StreamableEventType: Policy created. Data is the policy object

SEVT_POLICY_REMOVED = StreamableEventType: Policy deleted

SEVT_POLICY_UPDATED = StreamableEventType: Policy updated. Data is the policy object

SEVT_DEVICE_NEW = StreamableEventType: Device created. Data is device object

SEVT_DEVICE_REMOVED = StreamableEventType: Device deleted

SEVT_DEVICE_LIVE_CONNECT = StreamableEventType: Device live connection started

SEVT_DEVICE_LIVE_DISCONNECT = StreamableEventType: Device live connection ended

SEVT_DEVICE_LOBBY_CONNECT = StreamableEventType: Device connected to registration lobby

SEVT_DEVICE_LOBBY_DISCONNECT = StreamableEventType: Device disconnected from registration lobby

SEVT__MAX = StreamableEventType

SSHCONNECTION_AUTHMODE__INVALID = SSHAuthMode

SSHCONNECTION_AUTHMODE_PASSWORD = SSHAuthMode

SSHCONNECTION_AUTHMODE_PRIVATEKEY = SSHAuthMode

STOREDOBJECTTYPE_FILE = StoredObjectType

'file'

STOREDOBJECTTYPE_DIRECTORY = StoredObjectType

'dir'

STOREDOBJECTTYPE_SYMLINK = StoredObjectType

'symlink'

STOREDOBJECTTYPE_UNIXBLOCKDEVICE = StoredObjectType

'dev'

STOREDOBJECTTYPE_UNIXCHARDEVICE = StoredObjectType

'chardev'

STOREDOBJECTTYPE_UNIXFIFO = StoredObjectType

'fifo'

STOREDOBJECTTYPE_UNIXSOCKET = StoredObjectType

'socket'

STOREDOBJECTTYPE_WINEFS = StoredObjectType

'winefs'

STOREDOBJECTTYPE_EMAILMESSAGE = StoredObjectType

'emailmessage'

STOREDOBJECTTYPE_EMAILFOLDER = StoredObjectType

'mailfolder'

STOREDOBJECTTYPE_OFFICECONTACT = StoredObjectType

'contact'

STOREDOBJECTTYPE_OFFICECONTACTFOLDER = StoredObjectType

'contactfolder'

STOREDOBJECTTYPE_OFFICECALENDAREVENT = StoredObjectType

'calendarevent'

STOREDOBJECTTYPE_OFFICECALENDAR = StoredObjectType

'calendar'

STOREDOBJECTTYPE_MSSITE = StoredObjectType

'mssite'

STOREDOBJECTTYPE_MSSITE_TEAM = StoredObjectType

'mssiteteam'

STOREDOBJECTTYPE_MSSITELISTENTITY = StoredObjectType

'mssitelistentity'

STOREDOBJECTTYPE_MSSITEITEMENTITY = StoredObjectType

'mssiteitementity'

STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY = StoredObjectType

'mssitelistdriveentity'

STOREDOBJECTTYPE_VMDK_FILE = StoredObjectType

'vmdkfile'

STOREDOBJECTTYPE_VMDK_DIRECTORY = StoredObjectType

'vmdkdir'

STOREDOBJECTTYPE_VMDK_WINEFS = StoredObjectType

'vmdkwinefs'

STOREDOBJECTTYPE_VMDK_SYMLINK = StoredObjectType

'vmdksymlink'

STOREDOBJECTTYPE_VIRTUALIMAGE_DISK = StoredObjectType

'virtualimagedisk'

STOREDOBJECTTYPE_VHDX_GPT_PARTITION = StoredObjectType

'vhdxpartitiongpt'

STOREDOBJECTTYPE_VHDX_MBR_PARTITION = StoredObjectType

'vhdxpartitionmbr'

STREAM_LEVEL_FULL = StreamLevel: Event data contains full data types

'full'

STREAM_LEVEL_NONE = StreamLevel: Event data contains nothing

'none'

STREAMER_TYPE_INTERNAL = StreamerType

'internal'

STREAMER_TYPE_WEBHOOK = StreamerType

'webhook'

STREAMER_TYPE_WEBSOCKET = StreamerType

'websocket'

STREAMER_TYPE_FILE = StreamerType

'file'

TOTPREQUIRED_ERROR = If an API response returns in failure, but it includes this value in the CometAPIResponseMessage->Message parameter, it indicates that your supplied authentication was insufficient, and you must supply additional two-factor authentication credentials.

'ERR_TOTP_REQUIRED'

UPDATESTATUS_NOT_SEEN = UpdateStatus

UPDATESTATUS_INELIGIBLE = UpdateStatus: The selected device does not meet the filter criteria from the Bulk Update Campaign’s configuration.

UPDATESTATUS_PENDING = UpdateStatus

UPDATESTATUS_REQUEST_MADE = UpdateStatus: The device has made a live connection and it meets the filter criteria. A live connection message has been sent asking it to perform the software upgrade.

UPDATESTATUS_UPDATE_FAILED = UpdateStatus: An update signal was sent to the device, but when it reconnected, it did not advertise the target software version. It’s likely that the update failed - please check the device’s Update log for more information.

UPDATESTATUS_UPDATE_CONFIRMED = UpdateStatus: The device has successfully updated to the target version.

USERNAME_MAX_LENGTH =

UNKNOWN_DEVICE_ERROR = 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.

'ERR_UNKNOWN_DEVICE'

UNSUPPORT_VHDX_FILE_SYSTEM =

'ERR_UNSUPPORT_VHDX_FILE_SYSTEM'

UNSUPPORT_VMDK_FILE_SYSTEM =

'ERR_UNSUPPORT_VMDK_FILE_SYSTEM'

VMWARE_CONNECTION_SSH =

Deprecated.

This const has been deprecated since Comet version 23.9.11

VMwareConnectionType

'ssh'

VMWARE_CONNECTION_VSPHERE = VMwareConnectionType

'vsphere'

VMWARE_SNAPSHOT_FAST = VmwareSnapshotType

''

VMWARE_SNAPSHOT_QUIESCE = VmwareSnapshotType

'quiesce'

VMWARE_SNAPSHOT_MEMORY = VmwareSnapshotType

'memory'

VMWARE_BACKUP_FULL = VmwareBackupType

'full'

VMWARE_BACKUP_CBT = VmwareBackupType

'cbt'

VMWARE_BACKUP_COPY =

Deprecated.

This const has been deprecated since Comet version 23.9.11

VmwareBackupType

'copy'

VHDX_PARTITON_READ_ERR_MSG =

'ERR_VHDX_PARTITION'

WEBAUTHN_DEVICE_TYPE__UNKNOWN = WebAuthnDeviceType

WEBAUTHN_DEVICE_TYPE__HARDWARE_TOKEN = WebAuthnDeviceType

WEBAUTHN_DEVICE_TYPE__ANDROID = WebAuthnDeviceType

WEBAUTHN_DEVICE_TYPE__APPLE = WebAuthnDeviceType

WEBAUTHN_DEVICE_TYPE__TPM_GENERIC = WebAuthnDeviceType

WEBAUTHN_DEVICE_TYPE__TPM_WINDOWS = WebAuthnDeviceType

WEBAUTHN_DEVICE_TYPE__TPM_LINUX = WebAuthnDeviceType

WINDOWSCODESIGN_METHOD_AUTO =

Deprecated.

This const has been deprecated since Comet version 23.3.0

WindowsCodesignMethod: When upgrading from a version of Comet Server prior to 23.3.0, this option will be automatically converted to a more specific type.

WINDOWSCODESIGN_METHOD_DISABLED = WindowsCodesignMethod: Do not perform Authenticode codesigning

WINDOWSCODESIGN_METHOD_PKCS12FILE = WindowsCodesignMethod: Use a configured PKCS#12 key file for Authenticode codesigning

WINDOWSCODESIGN_METHOD_PKCS11HSM = WindowsCodesignMethod: Use a configured PKCS#11 hardware security module (HSM) for Authenticode codesigning

WINDOWSCODESIGN_METHOD_AZUREKEYVAULT = WindowsCodesignMethod: Use a configured Azure Key Vault for Authenticode codesigning