AdminNoSyncInterval

(Weeks) - Interval for Weekly Admin to not synchronize backup sets that have only internal inconsistencies.

AdminSkipSync

Skip synchronization of backup sets during Weekly Admin if no database inconsistencies are detected.

AdminSyncOrder

Specifies the order in which backup sets will be synchronized during Weekly Admin. Possible values are:

AdminThreads

This parameter configures maximum number of synchronization threads during weekly admin.

DSCDBDumpPath

This parameter configures the Dump path for DS-Client Database during admin activities. This path can be local or a UNC path. UNC is recommended for Grid DS-Clients.

If not set, the default dump path will be the DS-Client Buffer.

CommunicationMethodDSS

Low-level communication method between DS-Client and DS-System.

CommunicationMethodMLR

Low-level communication method between DS-Client and DS-MLR / DS-Recovery Tools.

DSSystemAlternatePort

This parameter configures the alternate port to connect to DS-System. If DS-Client fails to connect to DS-System on the default port (4401) and an alternate port number has been configured in this parameter, DS-Client will attempt to connect using the alternative port number.

The value “0” means that DS-Client will not attempt to connect using an alternate port.

HessianAPIListenIP

IP Address to listen for Hessian API Connections.

Use '0.0.0.0' to listen on all interfaces.

Note: This parameter requires the DS-Client to restart before taking effect.

HessianAPIListenPort

Port on which to listen for Hessian API Connections

Note: This parameter requires the DS-Client to restart before taking effect.

HessianAPILogFile

Log file to use for the Hessian API Server

A valid value is any valid file name.

Note: This parameter requires the DS-Client to restart before taking effect.

HessianApiLogLevel

Log level to record in the Hessian API Server logging file

Note: This parameter requires the DS-Client to restart before taking effect.

HessianApiSSLFile

SSL certificate/key file to use for the Hessian API Server (PEM format)

Note: This parameter requires the DS-Client to restart before taking effect.

HessianApiSSLPassword

SSL certificate/key file passphrase

Enter a valid password / passphrase for the SSL certificate/key file specified in the HessianApiSSLFile parameter.

Note: This parameter requires the DS-Client to restart before taking effect.

LaptopCheckInterval

This parameter configures the interval at which the network connection with DS-System is checked regularly by DS-Client having schedule(s) configured with the option of verify network connection. This is particularly useful for DS-Client installed on portable devices.

MaxQueuedMessages

Maximum number of queued messages during communication with DS-System.

MinApiMsgTimeout

The minimum timeout period for API messages. You can increase this parameter if you encounter a large amount of “Timeout on receive message” errors.

RetryPrimary

Defines how often to retry the primary DS-System connection after switching to a secondary connection (in hours). A value of -1 means “never retry”, and a value of 0 means “retry immediately”.

TcpSocketBuffer

The value of this parameter is in Bytes. This value is used if it is bigger than the default TCPWindowSize.

Note: This parameter can be applied globally or to individual leaf nodes.

VSSKeepAliveTimeout

(seconds) Timeout period for DS-Client to receive a response for a VSS (Volume Shadow Copy) operation. The VSS operation will fail after the timeout period.

DS-UserAutoUpgrade

Determines which DS-User auto-upgrade packages this DS-Client will download from DS-System if they are available.

Disabled: DS-User auto-upgrade packages will not be automatically downloaded from the DS-System.

Cross-Platform DS-User Auto-Upgrade: DS-Client will download all DS-User auto-upgrade packages that exist on the DS-System to the DS-Client directory during Daily/Weekly Admin.

Compatible-Platform DS-User Auto-Upgrade: DS-Client will download only the DS-User upgrade packages which are compatible with the OS of the DS-Client.

SystemFiles

A list of file names that will be skipped by Windows DS-Client if encountered during backup.

The list is an alphanumeric text string of file names. Each file name is separated by \; (a backslash followed by a semi-colon). The end of the string is indicated by a second \; as in the following example of the default list: system.da0\;user.da0\;pagefile.sys\;win386.swp\;backout.tts\;btrieve.trn\;net$obj.sys\;net$val.sys\;net$prop.sys\;\;

Note: Each Windows computer can have additional files configured to be skipped in the local registry key “HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\BackupRestore\FilesNotToBackup”. DS-Client will skip these files when encountered during backup of regular shares or drives (but not for System State or Services Database items).

AllowAutoConfig

Allow DS-Client to apply Auto-configuration from the file “config-update.xml”.

AllowAutoUpgrade

Allow auto-upgrade of DS-Client from DS-System when their version does not match.

AllowLocal

If set to "YES", it allows the 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.

AllowScheduledBackupCheckSignature

Configures scheduled backups to use the verify signature for unchanged files feature.

By default, scheduled backups do not verify the signatures of unchanged files on the backup source. If this parameter is set to YES, then scheduled backups will verify the signatures of unchanged files on the backup source. Turning this option ON can have significant implications on the performance of the DS-Client.

BrowseCheckSQLInstances

Detect Microsoft SQL instances when browsing domains/workgroups

DBHighWaterMark

[DS-Clients using SQL Server 2005/2008 Express]

This parameter (in percent) sets the level at which the Daily Admin or Weekly Admin will automatically expand the DS-Client database to create a new, sequentially named “expand<nnnn>” database.

The percentage is calculated against the maximum allowed size for an individual database (4GB).

For SQL Server 2005/2008 Express, the maximum size of an individual database is 4GB.

DBLowWaterMark

[DS-Clients using SQL Server 2005/2008 Express]

If the current amount of space used in an “expand<nnnn>” database is less than this parameter (in percent), Daily Admin and Weekly Admin can move backup set tables into that database.

DBQueryDefaultTimeout

This parameter value (in seconds) sets the default database query timeout. A value of 0 means unlimited timeout.

DBQueryTimeout

This parameter only applies to time consuming Database queries known by the DS-Client. The value (in hours) sets the longest Database query timeout period. If a Database Query takes more time than this parameter value, it is aborted by the DS-Client.

A value of 0 means unlimited timeout.

DebugMessage

This parameter sets the detail level of error messages reported in the DS-Client Event Log.

Note: This parameter can be applied globally or to individual leaf nodes.

DefaultLocalTrashKeepDays

The default period to keep data in the Local-Only trash. This applies to all defined Local-Only paths for this DS-Client.

ExchangeMaxESERetries

(count) - Maximum number of attempts to read the first buffer from a file during Microsoft Exchange server backups.

ExchangeOnlineBackupBatchSize

This parameter allows you to perform batch downloading of Exchange data for Cloud (Microsoft Office 365) and Microsoft Exchange Server EWS backup sets during backup.

 

To specify the maximum number of items that a batch should contain, enter a value between 1 and 40. Batch downloading is enabled when this parameter is set to 2 or greater.

 

When this parameter is set to 1, DS-Client will download data from the source one item at a time.

 

When this parameter is set to 2 or greater, DS-Client will download data one batch at a time from the source as soon as one of the following occurs:

ExchangeOnlineBackupBatchTimeout

This parameter allows you to configure the duration before DS-Client must download a batch from a Cloud source during the backup of Exchange data for Cloud (Microsoft Office 365) and Microsoft Exchange Server EWS backup sets.

 

You can enter a value between 0 and 3600 in seconds.

ExchangeOnlineBackupExtendedMetadata

For Backup from the Cloud (Microsoft Office 365) Exchange Online backup sets.

Backups will include the extended metadata (e.g. “To”, “From”, “Cc”, “Bcc”) to be able to search the item list on Restore, Delete, etc. If this option is turned on, it will slow down the browse listing and the backup process.

ExchangeOnlineEnableLogs

For Backup from the Cloud (Microsoft Office 365) Exchange Online backup sets.

If yes, enables log for the Exchange Online plug-in (Microsoft Office 365 backup sets). The default path for this log is in <DS-Client Installation Path>\asigra_pluginlog

ExchangeOnlineExcludeGroupMailboxes

For Backup from the Cloud (Microsoft Office 365) Exchange Online backup sets.

If yes, DS-Client will verify each mailbox on listing to prevent display of Exchange Online group mailboxes. Group mailboxes are invalid backup items that will cause errors during backup if included in a backup set.

If this parameter is ON, the listing may be considerably slower since DS-Client must verify each mailbox before displaying the filtered result.

ExchangeOnlineFilterListingBySet

When set to Yes, improves the performance of incremental backups for Cloud (Microsoft Office 365) and Microsoft Exchange Server EWS backup sets by using the last successful backup date and time as the backup filter rather than the last modified date and time of an individual item.

 

To back up items that have been created or modified before the last successful backup (for example, after you have performed a selective delete), set this parameter to No.

ExchangeOnlineListingPageSize

Configures the number of items per listing page for Cloud (Microsoft Office 365) and Microsoft Exchange Server EWS backup sets.

ExchangeOnlineOutlookConnectionTimeout

Configures the timeout duration (in seconds) for the DS-Client’s connection attempt to Microsoft Outlook. This parameter takes effect during a restore activity that archives Microsoft Exchange data to a PST file on the DS-Client local disk. This parameter applies only to Backup from the Cloud (Microsoft Office 365) and Microsoft Exchange Server EWS backup sets.

ForceBackupCheckSignature

If yes, force all applicable backup sets to check signature for unchanged files. The check will be performed once during the next backup of each backup set. This setting applies only once. This means, as soon as you select Yes and apply, it will immediately take effect and the value is changed to No again.

GAppsBackupExtendedMetadata

Backup G Suite extended metadata for item list filtering. If yes, this may increase backup time significantly.

GAppsBackupReadTimeout

Minimum timeout for backup read requests.

GAppsMaxJavaPluginThreads

Maximum number of threads for the G Suite plug-in.

GAppsPartialDownload

Download large G Suite 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 with this parameter off.

GAppsRequestRetry

If one G Suite item fails to be backed up or restored, how many times to retry.

GAppsRestoreCompleteTimeout

Minimum timeout for restore of any single G Suite item. (Increases automatically for files over 100MB.)

LocalDriveAllowed

This parameter value will configure the Local Drive Filter Flag for Backup. By changing this parameter value you can control the drives available for backup in the New Backup Set Wizard (applicable only to File system & Permissions only backup sets).

 

The value that you enter in this parameter is converted from decimal to binary to determine if a drive is allowed (“1” means allowed, “0” means disabled).

For example, to allow only ‘C’ and ‘E’ drives, use the value “20”

... F E D C B A [drive letter map]

... . 1 0 1 0 0 [binary]

... . . . . 2 0 [decimal value]

The binary representation of “20” matches bit0 for 'A:' disabled, bit1 for 'B:' disabled, bit2 on - 'C:' allowed, etc.

A value of -1 allows all the available local drives.

Note: For Grid DS-Client, this parameter has no effect.

LogArchivePath

Path where the Detailed Log for activities on the DS-Client are stored.

Detailed Logs are located in this folder, under a sub-folder called “asigra_archivlog” where each backup set has its own numbered sub-folder.

Note: For Grid DS-Clients, enter a UNC path that is accessible from all nodes of the Grid. Doing so ensures that all detailed logs are located in a common and accessible location.

MaxErrors

This parameter sets the default “Stop on errors” value that appears when creating new backup sets (in the New Backup Set Wizard’s Options Tab).

MaxNonFullDumps

For all backup sets that define a database backup policy in the Set Properties > Options tab. For more information on Database Backup Policy options, see the Knowledge Base article in “Backup / Restore of Microsoft SQL Server (ALL VERSIONS)”.

Default maximum number of times a full dump of the database can be skipped in favor of a differential or incremental dump.

After this number is reached, the next backup will force a full dump of the database.

Multi-Tenant

Enables the multitenant feature.

Office365RequestRetry

Maximum number of retries when backing up or restoring Exchange or SharePoint data in a Cloud (Microsoft Office 365) backup set.

Office365RequestTimeout

API request timeout duration for Backup from the Cloud (Microsoft Office 365) backup sets.

PluginLogKeepDays

How many days to keep the Java plug-in log files for “Backup from the Cloud” backup sets (Salesforce.com, G Suite, and Microsoft Office 365).

ReadOnlyUpgradeInterval

If this DS-Client has started in “Read-Only” (Stand By) mode (no backup / restore allowed), this is the interval at which it will check for an upgrade package from DS-System.

RemoteExecutionTimeout

(Minutes) - This parameter configures the default timeout period of DS-Client for Remote Command Execution during Pre/Post Activities.

RestoreTargetProvision

Integration DLL for automatic restore target provisioning

Any valid path to the corresponding DLL file that the DS-Client can access.

Default: None

Note: This parameter requires the DS-Client to restart before taking effect.

ScheduleMiss

(Hours) - This is the period in which missed schedules will be triggered by the DS-Client, even after the actual scheduled time.

SecurityDll

Path to a third-party security DLL to secure the communication. By default, this path is empty.

Note: This parameter can be applied globally or to individual leaf nodes.

SharePointOnlineBackupBatchSize

This parameter allows you to perform batch downloading of SharePoint data for Cloud (Microsoft Office 365) during backup.

 

Specify the maximum number of items that a batch should contain.

 

When this parameter is set to 1, DS-Client will download data from the source one item at a time.

 

When this parameter is set to 2 or greater, DS-Client will download data one batch at a time from the source as soon as one of the following occurs:

SharePointOnlineBackupBatchTimeout

This parameter allows you to configure in minutes the timeout duration that is used by the DS-Client when downloading by batch from a Cloud source during the backup of SharePoint data for Cloud (Microsoft Office 365).

SharePointOnlineLargeFileRestoreThreshold

Configures the chunk size in MB for SharePoint Online uploads for Backup from the Cloud (Microsoft Office 365) backup sets. Files smaller than this value would be uploaded as a whole.

ShowPOSIX

When this parameter is set to YES, then in the New Backup Set Wizard (for File system & Permissions only backup sets) you can see the "Backup as POSIX" checkbox.

"Backup as POSIX" can only be selected when you create a new backup set. It cannot be configured from backup set properties.

SQLKeepDumpFile

Indicates if Microsoft SQL Server backup set database dumps are kept in the dump location after the backup has been performed. This only applies to the ‘classic’ Microsoft SQL Server backup set type (not the VSS-aware version).

StopOnRetrieveLSNFailed

For VSS-aware Microsoft SQL Server backup sets. Stops a differential backup if it failed to retrieve the LSN (Log Sequence Number) information of the previous full backup.

VMReplicationOpenListingTimeOut

Specifies the timeout duration (in seconds) for listing the vCenter Server destination folders when you are creating a VM replication set.

VMRExternalIP

Allows you to specify the external IP address that you want to use to communicate with replication services on machines that are outside of the network domain.

 

Leave the value blank to use 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.

VMRSourcePort

This parameter allows you to specify the port used by a DS-Client for VM replication processes. Ensure that this value matches the network configuration for the DS-Client.

 

This parameter 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.

 

 

Note: This parameter requires the DS-Client to restart before taking effect.

VMwareVADPBackupValidateSignature

This parameter allows you to select the Verify disks signature on next backup option in all the VMware VADP backup sets that have Changed Block Tracking (CBT) enabled. The setting is not permanent but enforces a one-time signature verification in the next immediate backup session of each applicable backup set.

VMwareVADPTransportMode

This applies only to VMware VADP backup sets. This does not apply to VM replication sets (VMware).

 

Select one of the following strings to set the transport mode. DS-Client requests the VMware libraries to use the selected transport mode to initialize a connection for data transfer.

For more information about the Transport Modes, see the Knowledge Base article in “VMware Transport Libraries”.

VSSContinueIfSnapshotCreatedWithWriterErrors

If Yes, the VSS-aware backup will continue even if there were writer errors, as long as the snapshot was created successfully. This will only occur after all configured retries have been attempted (VSSSnapshotRetries).

VSSSnapshotRetries

If a VSS-aware backup creates a snapshot with writer errors, the DS-Client will retry creating the snapshot without any errors. This is the number of times DS-Client will retry creating an ‘error-free’ snapshot.

VSSSnapshotRetryInterval

The retry interval for VSS snapshot retries (VSSSnapshotRetries).

VSSWaitSnapshotTimeout

Timeout while waiting for a VSS snapshot to be created. A longer period can prevent backup failures if different backup sets 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.)

WaitConfirmation

(Seconds) - This parameter value sets the time the DS-Client will wait for file confirmation from the DS-System if a backup activity is stopped.

DBEmergencyLevel

[Only works if DS-Client database is local. Ignored if using a remote DB.]

(0.01%) - Emergency warning level for the available space on the disks where the DS-Client database resides.

DBReserveSpace

[Only works if DS-Client database is local. Ignored if using a remote DB.]

This parameter value (in MB) configures the Minimum amount of free space reserved in the DS-Client Database. Low space checking will not count this reserved space as free space.

DBStopServiceLevel

[Only works if DS-Client database is local. Ignored if using a remote DB.]

(0.01%) - Stop service level for the available space on the disks where the DS-Client database resides.

DBWarningLevel

[Only works if DS-Client database is local. Ignored if using a remote DB.]

(0.01%) - Warning level for the available space on the disks where the DS-Client database resides.

EmergencyFrequency

This parameter value (in hours) configures the intervals at which regular Low Local Storage Emergency Warning Notifications will be issued by DS-Client.

MemEmergencyFreq

This parameter value (in hours) configures the interval at which regular Low Memory Emergency Warning Notifications will be issued by DS-Client.

MemEmergencyLevel

This parameter configures the Free Memory Emergency Level. If the DS-Client free memory falls to a level equal to or below this level, DS-Client will start issuing Low Memory Emergency Warning Notifications.

MemWarningFreq

This parameter value (in hours) configures the interval at which regular Low Memory Warning Notifications will be issued by DS-Client.

MemWarningLevel

This parameter configures the Free Memory Warning Level. If the DS-Client free memory falls to equal or below this level, DS-Client will start issuing Low Memory Warning Notifications.

OLEmergencyLevel

This parameter value (in %) sets the Emergency Warning level for DS-Client Local Storage root. If the DS-Client Local Storage free space falls to equal or below this level DS-Client will start issuing Emergency Warning Notifications.

OLWarningLevel

This parameter value (in %) sets the Warning level for DS-Client Local Storage root. If the DS-Client Local Storage free space falls equal or below this level DS-Client will start issuing Warning Notifications.

WarningFrequency

This parameter value (in hours) configures the interval at which regular Low Local Storage Warning Notifications will be issued by DS-Client.

AS400BlockSize

Defines the number of records in one block for System i Server (formerly AS/400) backup sets. The bigger the block size, the more efficient the delta algorithm, but more memory will be required during restore.

BigMasterSize

(MB) - If the file size is bigger than this value, DS-Client maintains additional meta-data during backup until a new generation is confirmed to have been saved on DS-System. This overhead is balanced by the benefit of reducing the chance of sending the next generation as a master in case the backup experiences unexpected failures.

CacheSQLiteFile

If this parameter is set to YES then the SQLite Database File is cached to improve the speed. By default this parameter is set to NO.

DBBulkOptions

Select one of the following:

The selection takes effect immediately.

DBConnections

This parameter configures the number of DS-Client database connections to be created when DS-Client service is started.

Note: This parameter requires the DS-Client to restart before taking effect.

Note: This parameter can be applied globally or to individual leaf nodes.

DefaultCompression

For ZLIB Compression only.

0 = no compression (faster)

9 = maximum compression (slower)

DeltaThreads

This parameter configures number of delta threads per backup thread. If set to 0, Delta backup is singled threaded. If set to 1, a single thread does compression/encryption but it is separated from I/O thread. If set to a value more than 1, then the Delta process is multi-threaded.

Note: This parameter can be applied globally or to individual leaf nodes.

DeltaThreadsFS

This parameter configures number of delta threads for file system backups. If you only back up big files, this can improve speed. For the backup of small files, the default DS-Client backup threads are usually sufficient.

Note: This parameter can be applied globally or to individual leaf nodes.

DSClientPerformCopyFromSnapshot

This parameter applies to Microsoft SQL Server (VSS-aware) backup sets with Nimble Storage integration. It allows you to specify how the copying of data from the snapshot to the destination is triggered:

EncryptedLocalData

Encrypt the data saved in the Local Storage Buffer for “Local Storage” and “Local-Only” backup sets. If enabled, the DS-Client’s Private Encryption Key will be used.

ExchangeOnlineRestoreBatchSize

This parameter allows you to configure buffering when DS-Client is restoring Exchange data for Cloud (Microsoft Office 365) or Microsoft Exchange Server EWS backup sets to a Cloud destination.

To specify the maximum number of items that can be cached to buffer, enter a value between 1 and 1000.

 

When this parameter is set to 1, DS-Client will upload data one item at a time to the Cloud destination.

 

When this parameter is set to 2 or greater, buffering is enabled. DS-Client will cache the data to buffer up to the number of items specified in this parameter and then upload the data to the Cloud destination.

FileReadBufferSize

The internal buffer size (in KB) allocated for reading a file during the backup process.

MasterGenerations

Used with the SendFullMaster parameter to determine when to send (backup) a full master to DS-System.

MaxCacheCopySessions

Maximum concurrent activities supported by DS-Client. Increase if hardware can support additional processing.

Note: This parameter can be applied globally or to individual leaf nodes.

MaxDeltaSize

(GB) - Maximum file size for delta algorithm to apply. The bigger it is, the more memory is needed for delta processing.

For a 32-bit operating system:

For a 64-bit operating system:

MaxPendingIOPerFile

The allowed maximum pending I/O requests for a single file (backup or restore). Increasing this value may improve backup / restore speed if the target storage has very good parallelism (ability to perform simultaneous I/O requests). This option is provided for high performance environments where you can test the disk I/O.

Important: Increasing this value too much can cause performance to slow.

MaxRestoreReadThreads

Maximum number of read threads on DS-System side for a restore process.

Note: This parameter can be applied globally or to individual leaf nodes.

MaxRestoreThreads

This parameter configures the maximum number of threads for a restore process.

Note: This parameter can be applied globally or to individual leaf nodes.

MaxSessionCheck

Determines when the MaxSessions parameter applies.

MaxSessions

This parameter configures the maximum concurrent activities supported by DS-Client. Increase the value of this parameter only if your hardware can support additional processing.

For Grid DS-Client this parameter also refers to the Task Limit as seen in DS-User: Grid Menu > Grid Status > List Tab for each Leaf/Node.

Note: This parameter can be applied globally or to individual leaf nodes.

MaxThreads

This parameter configures the maximum number of threads for each backup activity. Increase the value of this parameter only if your hardware can support additional processing.

Note: This parameter can be applied globally or to individual leaf nodes.

MaxThreadsMLR

Maximum number of threads for each DS-MLR backup activity. Increase if hardware can support additional processing.

Note: This parameter can be applied globally or to individual leaf nodes.

MinDeltaGen

The minimum number of online generations required to process files as deltas.

MinDeltaSize

(KB) - Minimum file size for delta algorithm to apply.

RestoreCacheBufferSize

(MB) - This parameter sets the internal buffer size for caching restore data. Increasing this value may improve the restore performance.

SalesforceExtractThreads

For Backup from the Cloud (Salesforce.com) backup sets only.

Defines the number of threads that are used to extract data from

Salesforce.com.

SalesforceRestoreSysTables

For Backup from the Cloud (Salesforce.com) backup sets only.

Whether to recover Salesforce system tables when performing restore.

SalesforceUseBulkApi

For Backup from the Cloud (Salesforce.com) backup sets only.

If ON, DS-Client will use the Salesforce “BULK API” protocol to retrieve applicable data. If OFF, records are read row-by-row, which may significantly increase the number of API calls used.

SendFullMaster

Sends a full master (instead of sending a delta and asking DS-System to reconstruct).

SkipCompressionOnCompressedFiles

If the value of this parameter is Yes, then DS-Client will skip compression on files identified as already being compressed. Files types identified as compressed are: pk, zip, gif, png, Microsoft Cabinet Files, gzip, win, jpeg & jfif.

SortMethod

Sort algorithm used to sort internal list.

SQLQueriesUseIndexHints

Applicable for SQL Server databases only. If the value of this parameter is Yes, DS-Client will use index hints in SQL queries to the DS-Client database.

StatisticalCpuUsage

(%) - Limits the DS-Client's consumption of the computer's CPU during statistical backups to this percentage.

DSCBuffer

This parameter only appears when a Grid DS-Client is used and Local Setting is selected among the Type options. It allows you configure the DS-Client buffer path for an individual leaf node of the Grid DS-Client.

 

Enter a local path on the selected leaf node. The DS-Client service account must have full privileges for the location.

 

The global value for the DS-Client buffer can be set from DS-User > Setup > Configuration > Parameters tab.

AutoSync Order

Specifies the order in which backup sets will be synchronized during Weekly Admin based on the estimated synchronization time:

Max AutoSync Number

The maximum number of synchronization activities that can run simultaneously during scheduled Weekly Admin.

Skip WeeklyAdmin Sync

Skip synchronizations during scheduled Weekly Admin if no database inconsistencies are detected:

System Port

This parameter configures the TCP/IP port(s) DS-Client uses to connect to DS-System. (Normally you should not change this setting unless instructed to by your service provider.)

Multiple ports can be configured by separating entries with a space, comma, semi-colon or pipe (|). Invalid configuration causes DS-Client to use 4401.

API Listen IP

IP Address to listen for API Connections.

Use '0.0.0.0' to listen on all interfaces.

API Key File

SSL certificate/key file to use for the API Server (PEM format)

API Key Password

SSL certificate/key file passphrase

Enter a valid password / passphrase for the SSL certificate/key file specified in the API Key File parameter.

API Log File

Log file to use for the API Server

Any valid file name is a valid value.

API Log Level

Log level to record in the API Server logging file

API Port

Port on which to listen for API Connections

AllowAutoConfig

Allow DS-Client to apply Auto-Configuration from the file "config-update.xml".

Auto Upgrade

Allow auto-upgrade of DS-Client from DS-System when their version does not match.

Config Keep Days

Number of days to retain old copies of the DS-Client configuration file.

DB2 Client Library Directory

[Linux DS-Clients only]

Specify the DB2 client library directory on the DS-Client machine. Ensure that the dynamic library <libdb2.so.1> resides in this directory.

Example: /opt/ibm/db2/v9.7/lib64/

Note: This parameter requires the DS-Client to restart before taking effect.

DefaultLocalTrashKeepDays

The default period to keep data in the Local-Only trash. This applies to all defined Local-Only paths for this DS-Client.

DS-UserAutoUpgrade

Determines which DS-User auto-upgrade packages this DS-Client will download from DS-System if they are available.

LogArchivePath

Path where the Detailed Log for activities on the DS-Client are stored.

Detailed Logs are located in this folder, where each backup set has its own numbered sub-folder.

Any valid path where the DS-Client can write data is a valid value.

Multi-Tenant

Enables the multitenant feature.

ReadOnlyUpgradeInterval

If this DS-Client has started in Read-Only (Stand By) mode (no backup / restore allowed), this is the interval at which it will check for an upgrade package from DS-System.

ScheduleMiss

(Hours) - This is the period in which missed schedules will be triggered by the DS-Client, even after the actual scheduled time.

Skip Compress

Skip compression on files identified as already being compressed. File types skipped are: lzop, zip, standard linux compression, gzip, bzip2, scocompress, bzip, jpeg, jfif, png, and gif.

Note: This parameter requires the DS-Client to restart before taking effect.

VMware Log Filter

[Linux DS-Clients only]

This string specifies a filter in Perl regular expression format. A regex search operation is performed and only matching lines are printed to the dsclient.out log file. This filter does not apply to the vmlibexe.out file.

Each regex is a search ‘for’ that string, with all occurrences printed to the log file.

VMware Log Level

[Linux DS-Clients only]

For debug purposes.

Varies the amount and type of logging information inside the /tmp/dsclient.out and /tmp/vmlibexec.out log files.

From the lowest to the highest level of logging:

VMware Path Escape

[Linux DS-Clients only]

Determines how DS-Client handles VMware data paths, since HTTP is used. URL paths may require ‘path escaping’ for special characters (e.g. use ‘%26’ instead of ‘&’).

Note: This parameter requires the DS-Client to restart before taking effect.

VMware SOAP Debug

[Linux DS-Clients only]

For debug purposes. Writes trace logs of any SOAP requests to /tmp on the DS-Client.

Note: This parameter requires the DS-Client to restart before taking effect.

VMware VADP TransportMode

This applies only to VMware VADP backup sets. This does not apply to VM replication sets (VMware).

 

Select one of the following strings to set the transport mode. DS-Client requests the VMware libraries to use the selected transport mode to initialize a connection for data transfer.

For more information about the Transport Modes, see the Knowledge Base article in “VMware Transport Libraries”.

VMware VADP Verify Disk Signature

This parameter allows you to select the Verify disks signature on next backup option in all the VMware VADP backup sets that have Changed Block Tracking (CBT) enabled. The setting is not permanent but enforces a one-time signature verification in the next immediate backup session of each applicable backup set.

VMware VixDiskLib Configfile Path

[Linux DS-Clients only]

This parameter allows you to configure the path to the VMware Virtual Disk Library configuration file for VMware-VIX backup set type only. Configuring this parameter is necessary only if you want to define your own configuration file and specify different settings. Refer to the VMware documentation for the specific parameters and file format.

Any valid file name is a valid value.

Note: This parameter requires the DS-Client to restart before taking effect.

Database Emergency Level

Emergency warning level for the available space on the disks where the DS-Client database resides.

Database Stop Level

Stop service level for the available space on the disks where the DS-Client database resides.

Database Warning Level

Warning level for the available space on the disks where the DS-Client database resides.

Local Storage Emergency Level

Available space emergency warning level for Storage root.

Local Storage Warning Level

Available space warning level for Local Storage root.

Memory Emergency Level

(in %) Free memory emergency warning level.

Memory Warning Level

(in %) Free memory warning level.

PM Emergency Frequency

(Hours) - Emergency warning notification interval when space is low (DS-Client DB / Local Storage / Use Buffer / Memory).

PM Warning Frequency

(Hours) - Warning notification interval when space is low (DS-Client DB / Local Storage / Use Buffer / Memory).

Use Buffer Emergency Level

Available space emergency warning level for Use Buffer root.

Use Buffer Warning Level

Available space warning level for Use Buffer root.

Compression Level

For ZLIB Compression only:

0 = no compression (faster)

9 = maximum compression (slower)

EncryptedLocalData

Encrypt the data saved in the Local Storage Buffer for Local Storage and Local-Only backup sets. If enabled, the DS-Client’s Private Encryption Key will be used.

Max DeltaSize

(GB) - Maximum file size for delta algorithm to apply. The bigger it is, the more memory is needed for delta processing.

For a 32-bit operating system:

For a 64-bit operating system:

MaxSession Check

Determines when the MaxSession Number parameter applies.

MaxSession Number

Maximum concurrent activities supported by DS-Client. Increase if hardware can support additional processing.

MaxThread Number

Maximum number of threads for each backup activity. Increase if hardware can support additional processing.

Note: This parameter requires the DS-Client to restart before taking effect.

Min DeltaSize

(KB) - Minimum file size for delta algorithm to apply.

MinDeltaGen

The minimum number of online generations required to process files as deltas.

Note: This parameter requires the DS-Client to restart before taking effect.

Restore Threads Count

This parameter configures the maximum number of threads for a restore process (VMware and File system backup sets only, not including NAS).

RetryPrimary

Defines how often to retry the primary DS-System connection after switching to a secondary connection (in hours). A value -1 means “never retry”, and a value of 0 means “retry immediately”.

Scan Shares Vacuum Frequency

Interval (in minutes) that must elapse before the Scan Shares activity will perform a database vacuum on the dslanfiles database. This only removes unnecessary data to make the database more compact. It does not affect the information gathered from the scan.

System i Connection Timeout

[Linux DS-Clients only]

Interval (in minutes) that must elapse without response before DS-Client considers the connection to a System i server to have timed out.

Note: The timeout is subject to change (upwards) during backup and restore, based on the size of the data being processed, however it will not be reset lower than this value.