Parameter | Description |
|---|---|
AllowAutoConfig | Allows DS-Client to apply auto-configuration from the config-update.xml. • Yes = On (Default) • No = Off |
AllowAutoUpgrade | Allows auto-upgrade of DS-Client from DS-System when versions do not match. • Yes = On (Default) • No = Off Note: The automatic upgrade must be approved by the administrator using the DS-Operator. |
AllowLocal | If set to Yes, allows execution of local commands during Pre/Post activities. You must be an administrator and have this option enabled to enable the Pre/Post activities. If this parameter is changed, it takes effect next time the DS-User connects to DS-Client Service. • No = Off (Default) • Yes = On |
AllowScheduledBackupCheckSignature | Configures scheduled backups to use the Verify signature for unchanged files feature. By default, this option is turned off. If this parameter is set to Yes, scheduled backups will verify the signatures of unchanged files on the backup source. • No = Off (Default) • Yes = On Note: Turning this option on can have a significant impact on performance. |
BrowseCheckSQLInstances | Detects Microsoft SQL Server instances when browsing domains and workgroups. • No = Off (Default) • Yes = On |
DBQueryDefaultTimeout | Sets the default database query timeout (in seconds). A value of 0 means unlimited timeout. • Default: 500 • Range: 0 to 65535 |
DBQueryTimeout | Sets the longest database query timeout period (in hours). This only applies to time consuming database queries known by the DS-Client. If the database query takes longer than this value, it is aborted A value of 0 means unlimited timeout. • Default: 18 • Range: 0 to 19 |
DebugMessage | Sets the detail level of error messages reported in the DS-Client Event Log. • 0 = Standard level of error-message reporting. (Default) • 1 = Additional detailed log information is reported, such as database errors that are appended with the SQL statement. • 2 (or any higher number) = Same behavior as “1”, with additional debug information in a DS-Client debug log file (dsclient.exe.dbg.log located in the DS-Client installation directory). This option is meant for debug situations only. Note: For Grid DS-Clients, the parameter can be applied globally or to individual leaf nodes. |
DefaultLocalTrashKeepDays | Default period (in days) to keep data in the Local-only trash. This applies to all the local-only paths. • Default: 7 • Range: 1-999 |
ExchangeOnlineBackupBatchSize | Maximum number of items that a batch should contain during backup of Microsoft 365 (Exchange Online) and Microsoft Exchange Server EWS backups. When set to 1, DS-Client downloads data from the source one item at a time. When set to 2 or greater, batch downloading is enabled and DS-Client downloads data one batch at a time from the source if DS-Client fills up a batch to the number of items specified by this parameter or DS-Client reaches time out duration specified in the parameter ExchangeOnlineBackupBatchTimeout. This can occur if there are not enough items remaining on the source to back up. • Default: 32 • Range: 1-40 |
ExchangeOnlineBackupBatchTimeout | Wait time (in seconds) before DS-Client must download a batch from a source during the backup of Microsoft 365 (Exchange Online) and Microsoft Exchange Server EWS backups. • Default: 60 • Range: 0-3600 |
ExchangeOnlineBackupExtendedMetadata | Microsoft 365 (Exchange Online) backups will include the extended metadata (“To”, “From”, “Cc”, “Bcc”) to be able to search the item list on restore, delete, etc. If this is on, it will slow down the browse listing and the backup process. • No = Off (Default) • Yes = On |
ExchangeOnlineEnableLogs | Activates logging for the Microsoft 365 (Exchange Online) backup. • No = Off (Default) • Yes = On |
ExchangeOnlineExcludeGroupMailboxes | DS-Client verifies each mailbox on listing to prevent the display of Microsoft 365 (Exchange Online) group mailboxes. Group mailboxes are invalid backup items that will cause errors during backup if included in a Microsoft 365 (Exchange Online) backup. If on, the listing can be considerably slower because DS-Client must verify each mailbox before displaying filtered result. • No = Off (Default) • Yes = On |
ExchangeOnlineFilterListingBySet | When on, improves the performance of incremental backups for Microsoft 365 (Exchange Online) and Microsoft Exchange Server EWS backups by using the last successful backup date and time as the backup filter instead of the last modified date and time of individual item. To back up items that have been created or modified before the last successful backup, turn this parameter off. • No = Off (Default) • Yes = On |
ExchangeOnlineListingPageSize | Number of items per listing page for Microsoft 365 (Exchange Online) and Microsoft Exchange Server EWS backups. • Default: 1000 • Range: 100-1000 |
ExchangeOnlineOutlookConnectionTimeout | Timeout (in seconds) for the DS-Client connection attempt to Microsoft Outlook. This applies during a restore activity that archives Microsoft Exchange data to a PST file on the DS-Client local disk. It applies only to Microsoft 365 (Exchange Online) and Microsoft Exchange Server EWS backups. • Default: 120 • Range: 1-600 |
ForceBackupCheckSignature | Forces all applicable backups to check signature for unchanged files. The check will be performed once during the next backup of each backup. This setting applies only once. As soon as you select Yes, it will immediately take effect and the value is changed to No again. • No = Off (Default) • Yes = On |
GAppsBackupExtendedMetadata | Backs up Google Workspace extended metadata for item list filtering. If yes, this can increase backup time significantly. • No = Off (Default) • Yes = On |
GAppsBackupReadTimeout | Minimum timeout (in seconds) for backup read requests. • Default: 1 • Range: 0-4 |
GAppsPartialDownload | Downloads large Google Workspace drive files in smaller 1MB blocks to reduce memory usage on DS-Client. If On, the trade-off is 2-3 times slower performance than if this parameter off. • No = Off (Default) • Yes = On |
GAppsRequestRetry | Number of times to retry if a Google Workspace item fails to backup or restore. • Default: 7 • Range: 0-9 |
GAppsRestoreCompleteTimeout | Minimum timeout for restore of any Google Workspace item. Increases automatically for files over 100MB. • Default: 300 (seconds) • Range: 0-3600 |
InstantRecoverySyncCheckingInterval | Amount of time (in minutes) DS-Client waits after performing an instant recovery before performing internal synchronization of data in the instant recovery folder. This is also the delay time before retrying if the instant recovery synchronization process fails or is interrupted. • Default: 30 • Range: 1-1440 |
InstantRecoverySyncRetryTimes | Number of times DS-Client attempts an instant recovery synchronization based on the InstantRecoverySyncCheckingInterval parameter. • Default: 10 • Range: 0-1000 |
LocalDriveAllowed | Configures the Local Drive Filter Flag for backup, which controls the drives available for backup (applicable only to File system & Permissions only). The decimal value is converted to binary to determine if a drive is allowed (1 means allowed, 0 means disabled). For example, to allow selection of only drives ‘C’ and ‘E’, use the value ‘20’. ... . . . . 2 0 [decimal value] ... . 1 0 1 0 0 [binary] ... F E D C B A [drive letter map] The binary representation of 20 matches bit0 for 'A:' disabled, bit1 for 'B:' disabled, bit2 on - 'C:' allowed, etc. • Default: -1 (allows all available local drives) Note: For Grid DS-Client, this parameter has no effect. |
LogArchivePath | Path where detailed logs of DS-Client activities are stored as text files. Each backup has its own numbered sub-folder. Any path where the DS-Client can write data is valid. • Default: <DS-Client installation folder>\asigra_archivlog Note: For Grid DS-Clients, enter a UNC path that is accessible from all nodes of the Grid to ensure all detailed logs are located in a common accessible location. |
MaxErrors | Sets the default “Stop on errors” value that appears when you create a new backup. • Default: 0 (no limit) • Range: 0 to 9999 |
MaxNonFullDumps | Maximum number of times a full dump of the database can be skipped in favor of a differential or incremental dump. Once this number is reached, the next backup forces a full dump of the database. • Default: 120 • Range: 2 to 1000 |
MCRemoteManagement | Allows the DS-Client to be remotely managed from the Management Console without opening a port in the firewall on the DS-Client machine. • Enabled (Default) • Disabled |
Multi-Tenant | Enables the multitenant feature. • No = Off (Default) • Yes = On |
Office365RequestRetry | Maximum number of retries when backing up or restoring Microsoft 365 data. • Default: 9 • Range: 0-20 |
Office365RequestTimeout | API request timeout duration (in seconds) for Microsoft 365 backups. • Default: 600 • Range: 0-3,600 |
PluginLogKeepDays | Number of days to keep the log files for Google Workspace, Microsoft 365, and Salesforce backups. • Default: 7 • Range: 1-9999 |
ReadOnlyUpgradeInterval | Interval (in minutes) at which DS-Client checks for an upgrade package from DS-System if it is running in Read-Only mode (no backup or restore allowed). • Default: 5 • Range: 1-60 |
RemoteExecutionTimeout | Timeout period (in minutes) for Remote Command Execution during Pre/Post activities. • Default: 60 • Range: 1 to 1440 |
ResetInvalidLSRootPath | Specifies if the configured local storage path should be reset (Yes) or retained (No) if DS-Client detects the configured local storage path is invalid or is temporarily unavailable. • Yes = Reset (Default) • No = Retained |
RestoreTargetProvision | Path where the DS-Client can access the integration DLL file for automatic restore target provisioning. • Default: None Note: This parameter requires the DS-Client to restart before taking effect. |
ScheduleMiss | Number of hours after the start time of a missed schedule that DS-Client continues to attempt to trigger it. For example, if set to 6 and a schedule from 12:00 PM to 20:00 PM is missed, the schedule will be triggered as long as it is within 6 hours of the scheduled start time and end time. • Default: 6 • Range: 1 to 16 |
SecurityDll | Path to a third-party security DLL to secure the communication. • Default: None Note: For Grid DS-Clients, this parameter can be applied globally or to individual leaf nodes. |
SharePointOnlineBackupBatchSize | Maximum number of items a batch should contain during backup of Microsoft 365 (SharePoint Online) backups. When set to 1, DS-Client downloads data from the source one item at a time. When set to 2 or greater, DS-Client downloads data one batch at a time from the source if DS-Client fills up a batch to the number of items specified or DS-Client times out of the duration specified in the parameter SharePointOnlineBackupBatchTimeout. This can occur when the remaining number of items to be backed up on the source does not exceed the number specified in this parameter. • Default: 1 • Range: 1 to 10 |
SharePointOnlineBackupBatchTimeout | Timeout (in minutes) when batch downloading from a source during Microsoft 365 (SharePoint Online) backup. • Default: 720 • Range: 1 to 1440 |
SharePointOnlineLargeFileRestoreThreshold | Configures the chunk size (in MB) for Microsoft 365 (SharePoint Online) backups. Files smaller than this value are uploaded whole. • Default: 8 • Range: 1-2000 |
ShowPOSIX | Displays the Backup as POSIX check box for File System & Permissions Only backups. You can only select this option when creating a backup. • No = Off (Default) • Yes = On |
SQLKeepDumpFile | Retains Microsoft SQL Server backup database dumps in the dump location after backup. This only applies to the classic Microsoft SQL Server backup. • No = Off (Default) — Dump is deleted after backup has finished. • Yes = On — Dump is kept in the dump location and is overwritten during the next backup. Note the storage implications, since this affects all Microsoft SQL Server backups created on the DS-Client. |
SQLServerVDITimeout | Specifies the maximum wait time (in seconds) for a request to complete when backing up or restoring a Microsoft SQL Server backup using a Virtual Device Interface (VDI). • Default: 600 • Range: 60-86400 |
StopOnRetrieveLSNFailed | For Microsoft SQL Server (VSS-aware) backups. Stops a differential backup if it failed to retrieve the LSN (Log Sequence Number) information of the previous full backup. • Yes = On (Default) • No = Off |
VMReplicationOpenListingTimeOut | Timeout (in seconds) for listing the VMware vCenter Server destination folders when creating a VM replication set. • Default: 300 • Range: 0-3600 |
VMRExternalIP | Specifies an external IP address to use to communicate with replication services on machines outside the network domain. • Default: None — Uses the internal IP address to communicate with replication services on machines on the same network domain. |
VMRServiceStart | Start the VM Replication Service when DS-Client starts. • Yes = On (Default) — Allows you to create VM replication sets and run replication as long as DS-Client has sufficient VM Replication Capacity. • No = Off — The category DS-Client replication sets is hidden in the New Backup Set Wizard, and existing replication sets are inaccessible. |
VMRSourcePort | Allows you to specify the port used by a DS-Client for VM replication processes. Ensure this value matches the network configuration for the DS-Client. This is equivalent to the source DS-Client port number in DS-Operator. Changes made to this value through either DS-User or DS‑Operator are synchronized and will be shown in both interfaces. • Default: 8090 Note: This parameter requires the DS-Client to restart before taking effect. |
VMwareVADPBackupValidateSignature | Forces all VMware vCenter Server backups that have Changed Block Tracking (CBT) enabled to validate the disk signature of a protected virtual machine after a specified number of backups. The interval count starts from the first backup after the setting is enabled. If a disk signature mismatch is detected, a master generation is sent to the DS-System for the affected virtual disk (vmdk). Verification consumes more system resources and increases the backup time, especially if the signature verification fails and requires backup of a new master. • -1 = Disables disk signature validation for all affected backups. • 0 (Default) = Uses the disk signature validation setting configured for each backup. • 1 = Validates the disk signature after every backup for all affected backups. • 2 to 100 = Validates the disk signature after the specified number of backups for all affected backups. Note: The disk signature validation setting will be reset to 0 each time the setting is applied to all affected backups. |
VMwareVADPBackupValidateSignatureTime | Forces all VMware vCenter Server backups that have Changed Block Tracking (CBT) enabled to validate the disk signature of a protected virtual machine on specified days. If a disk signature mismatch is detected, a master generation is sent to the DS-System for the affected virtual disk (vmdk). Verification consumes more system resources and increases the backup time, especially if the signature verification fails and requires backup of a new master. • 0 (Default) = Disk signature validation is not performed on weekday. • 1 = Validates the disk signature on a Sunday. • 2 = Validates the disk signature on a Monday. • 4 = Validates the disk signature on a Tuesday. • 8 = Validates the disk signature on a Wednesday. • 16 = Validates the disk signature on a Thursday. • 32 = Validates the disk signature on a Friday. • 64 = Validates the disk signature on a Saturday. Note: To perform disk signature validation on multiple days, add the values together. For example, to validate the disk signature on Sunday (1), Tuesday (4), and Friday (32), specify 37. |
VMwareVADPTransportMode | Applies only to VMware vCenter Server backups. Transport mode that DS-Client requests from the VMware libraries when initializing a connection for data transfer to or from a data center. • Empty (Default) — Library automatically chooses the transport mode based on VMware priorities among the available transport modes. • nbd — Network block device transport mode. • nbdssl — Network block device SSL transport mode. • san — SAN transport mode. • hotadd — HotAdd transport mode. For more information about the transport modes, see “VMware vCenter Server backups (Windows or Linux)”. |
VSSContinueIfSnapshotCreatedWithWriterErrors | Continues a VSS-aware backup even if there are VSS writer errors, as long as the snapshot is successful. This only occurs after attempting all configured retries (VSSSnapshotRetries). • Yes = On (Default) • No = Off |
VSSFreeDiskSpace | Performs a VSS validation check to ensure there is enough free disk space prior to performing a File system or VSS-aware backup using the Volume Shadow Copy Service (VSS). If the free disk space is less than the configured percentage value, VSS validation will fail. • Default: 0 • Range: 0-100 Note: A value of 0 means the free disk space check is skipped. |
VSSSnapshotRetries | Number of times DS-Client attempts to create an ‘error-free’ snapshot during a VSS-aware backup. • Default: 3 • Range: 0-999, (0 means backup fails if snapshot encounters VSS writer errors) |
VSSSnapshotRetryInterval | The retry interval (in minutes) for VSS snapshot retries (VSSSnapshotRetries). • Default: 5 • Range: 1-99 |
VSSValidationCheck | Performs a VSS validation check prior to performing a File system or VSS-aware backup using the Volume Shadow Copy Service (VSS). • Yes = On • No = Off (Default) |
VSSWaitSnapshotTimeout | Timeout (in seconds) to wait for VSS snapshot creation. A longer period can prevent backup failures if different backups need to perform VSS backups of a common volume at nearly the same time. Only one VSS snapshot can be performed on a volume at a time. Since snapshots are fairly fast, a timeout of 5-15 minutes should ensure two different backups of the same volume can be successfully completed, even if they overlap. • Default: 60 • Range: 1-3600 |
WaitConfirmation | Time (in seconds) that DS-Client waits for confirmation from DS-System if stopping a backup. • Default: 60 • Range: 0 to 3600 |