Cache Settings

This section describes settings for local backup cache.

Parent Tag

Parameter

Description

CacheInfo

Parent tag that encapsulates information about local backup cache settings.

 

Enabled

Parameter specifies if local backup cache is used. Possible values:

  • True — local backup cache is used.
  • False — local backup cache is not used.

 

SizeGB

This parameter is used only if you plan to use local backup cache.

Size of local backup cache specified in GB. If the size of local backup cache is 1024-fold, Veeam Agent for Microsoft Windows automatically converts the value to TB.

 

StopJobsIfNeeded

This tag is used only if you plan to use local backup cache.

If you need to update settings for the backup job for which local backup cache settings are already configured, you must first disable the backup job. To do this, you can use StopJobsIfNeeded parameter. With this parameter set to True, Veeam Agent Configurator disables the backup job, updates the job settings and re-enables the job after that.

Possible values:

  • True — backup job is disabled before backup job settings are updated, and re-enabled after the backup job settings are updated.
  • False — backup job is not disabled before backup job settings are updated.

Location

 

This tag is used only if you plan to use local backup cache.

Parent tag that encapsulates information about local backup cache location.

 

Type

This parameter is used only if you plan to use local backup cache.

Type of storage for local backup cache. Possible values:

  • 1 — folder on the local computer disk.

 

DriveName

This parameter is used only if you plan to use local backup cache.

Name of a volume where local backup cache must be stored, for example: D:\.

 

VolumeID

This parameter is used only if you plan to use local backup cache.

GUID path of a volume where local backup cache must be stores, for example: {26a37f5a-c4a6-4ae4-b724-4a36df814334}.

Note: The VolumeID parameter is not available in the output XML file. However, you can use it in the input XML file.

 

RelativePath

This parameter is used only if you plan to use local backup cache.

Path to a folder where local backup cache must be stored, for example: Cache\

Example

You want store local backup cache in the D:\Cache folder, and the cache size is 10 GB. The input XML file will contain the following parameters:

<ExecutionResult>
 <JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
   <CacheInfo Enabled="True" SizeGB="10">
     <Location Type="1" RelativePath="Cache" DriveName="D:\"/>
   </CacheInfo>
 </JobInfo>
</ExecutionResult>