Application-Aware Settings (Server Mode)
This section describes application-aware settings of the backup job.
- General settings
- Microsoft SQL Server settings
- Oracle settings
- Microsoft SharePoint settings
- Custom script settings
- File indexing settings
Parent Tag | Parameter | Description |
---|---|---|
Applications | Parent tag that encapsulates information about application-aware settings. | |
| Enabled | Parameter describes if application-aware processing is enabled. Possible values:
|
| ProcessTransaction | Parameter describes how transaction logs must be processed. Possible values:
|
Parent Tag | Parameter | Description |
---|---|---|
Sql | Parent tag that encapsulates information about transaction logs settings for Microsoft SQL Server. | |
| Mode | Parameter describes how Veeam Agent for Microsoft Windows processes transaction logs for Microsoft SQL Server. Possible values:
NOTE! If you do not specify the Mode parameter but set the Enabled parameter in the Backup tag to True, transaction log backup will be enabled. |
Backup | This tag is used only if you set the Mode parameter to 3 (Veeam Agent for Microsoft Windows periodically backs up transaction logs). Parent tag encapsulating information about transaction logs backup settings for Microsoft SQL Server. | |
| Enabled | This parameter is used only if you set the Mode parameter to 3 (Veeam Agent for Microsoft Windows periodically backs up transaction logs). Parameter specifies if Veeam Agent for Microsoft Windows must back up transaction logs. Possible values:
NOTE! If you do not specify the Enabled parameter but set the Mode parameter to 3, transaction log backup will be enabled. |
| BackupMinutes | This parameter is used only if you set the Mode parameter to 3 (Veeam Agent for Microsoft Windows periodically backs up transaction logs). Periodicity with which Veeam Agent for Microsoft Windows must back up transaction logs (in minutes). By default, Veeam Agent for Microsoft Windows backs up transaction logs every 15 minutes. |
| Expirable | This parameter is used only if you set the Mode parameter to 3 (Veeam Agent for Microsoft Windows periodically backs up transaction logs). Retention policy settings for backed up transaction logs. Possible values:
|
| ExpireDays | This parameter is used only if you set the Mode parameter to 3 (Veeam Agent for Microsoft Windows periodically backs up transaction logs) and set the Expirable parameter to True (delete transaction log backups after <N> days). Retention policy settings for transaction log backups (in days). By default, Veeam Agent for Microsoft Windows removes from the backup target transaction log backups that are older than 15 days. |
Credentials | This tag is used only if you want to use impersonation and connect to the Microsoft SQL Server under the database administrator account. Parent tag that encapsulates information about credentials of a database administrator account. | |
| UserName | This parameter is used only if you want to use impersonation and connect to the Microsoft SQL Server under the database administrator account. User name of the database administrator account. The user name is specified as a text string encoded in the Base64 format. |
| Password | This parameter is used only if you want to use impersonation and connect to the Microsoft SQL Server under the database administrator account. Password of the database administrator account. The password is encrypted. For more information, see Encryption of User Credentials. |
Parent Tag | Parameter | Description |
---|---|---|
Oracle | Parent tag that encapsulates information about transaction logs settings for Oracle. | |
| Mode | Parameter describes how Veeam Agent for Microsoft Windows processes transaction logs for Oracle. Possible values:
|
| AccountType | This parameter is used only if you want Veeam Agent for Microsoft Windows to connect to an Oracle database under a specific account. Type of account you want to use. Possible values:
Together with the AccountType parameter, you must specify UserName and Password parameters in the Credentials tag. |
| LifetimeHours | This parameter is used if you set the Oracle parameter to 1 (Veeam Agent for Microsoft Windows truncates transaction logs that are older than <N> hours). Age of transaction logs that must be truncated (in hours). By default, Veeam Agent for Microsoft Windows truncates transaction logs that are older than 24 hours. |
| SizeGB | This parameter is used if you set the Oracle parameter to 2 (Veeam Agent for Microsoft Windows truncates transaction logs whose size is over <N> GB). Size of transaction logs that must be truncated (in GB). By default, Veeam Agent for Microsoft Windows truncates transaction logs whose size is over 10 GB. |
Backup | Parent tag that encapsulates information about transaction logs backup settings for Oracle. | |
| Enabled | Parameter specifies if Veeam Agent for Microsoft Windows must back up transaction logs. Possible values:
|
| BackupMinutes | Periodicity with which Veeam Agent for Microsoft Windows must back up transaction logs (in minutes). By default, Veeam Agent for Microsoft Windows backs up transaction logs every 15 minutes. |
| Expirable | Retention policy settings for backed up transaction logs. Possible values:
|
| ExpireDays | This parameter is used only if you set the Expirable parameter to True (delete transaction log backups after <N> days). Retention policy settings for transaction log backups (in days). By default, Veeam Agent for Microsoft Windows removes transaction log backups that are older than 15 days from the backup target. |
Credentials | This tag is used only if you want Veeam Agent for Microsoft Windows to connect to an Oracle database under a specific account. Parent tag that encapsulates information about credentials of the account used to connect to the Oracle database. | |
| UserName | This parameter is used only if you want Veeam Agent for Microsoft Windows to connect to an Oracle database under a specific account. User name of the account under which Veeam Agent for Microsoft Windows must connect to the Oracle database. The user name is specified as a text string encoded in the Base64 format. |
| Password | This parameter is used only if you want Veeam Agent for Microsoft Windows to connect to an Oracle database under a specific account. Password of the account under which Veeam Agent for Microsoft Windows must connect to the Oracle database. The password is encrypted. For more information, see Encryption of User Credentials. |
Parent Tag | Parameter | Description |
---|---|---|
SharePoint | Parent tag that encapsulates information about settings for Microsoft SharePoint Server. | |
Credentials | Parent tag that encapsulates information about credentials of the account used to connect to Microsoft SharePoint Server. | |
| UserName | User name of the account used to connect to Microsoft SharePoint Server. The user name is specified as a text string encoded in the Base64 format. |
| Password | Password of the account used to connect to Microsoft SharePoint Server. The password is encrypted. For more information, see Encryption of User Credentials. |
Parent Tag | Parameter | Description |
---|---|---|
Script | Parent tag that encapsulates information about custom script settings. | |
| Mode | Parameter describes if Veeam Agent for Microsoft Windows must run custom scripts and how it must process script execution results. Possible values:
If you set the Mode parameter to 1 or 2, you must specify the PreFreezePath or PostThawPath parameters. |
| PreFreezePath | This parameter is used if you set the Mode parameter to 1 or 2 (run a pre-freeze script). Path to a pre-freeze script, for example: C:\scripts\pre-freeze.cmd. |
| PostThawPath | This parameter is used if you set the Mode parameter to 1 or 2 (run a post-thaw script). Path to a post-thaw script, for example: C:\scripts\pre-freeze.cmd. |
Credentials | This tag is used only if you need to run custom scripts under a specific account, for example, an account that has Administrator permissions. Parent tag that encapsulates information about credentials of the account used to run custom scripts. | |
| UserName | This parameter is used only if you need to run custom scripts under a specific account. User name of the account under which custom scripts must be run. The user name is specified as a text string encoded in the Base64 format. |
| Password | This parameter is used only if you need to run custom scripts under a specific account. Password of the account under which custom scripts must be run. The password is encrypted. For more information, see Encryption of User Credentials. |
Parent Tag | Parameter | Description |
---|---|---|
Indexing | Parent tag that encapsulates information about file indexing settings. | |
| Type | Indexing mode. Possible values:
|
| Enabled | Parameter specifies if Veeam Agent for Microsoft Windows must index files and folders. Possible values:
|
IncludedFolders | This tag is used only if the Indexing parameter is set to 1 (Veeam Agent for Microsoft Windows indexes the content of folders included in the indexing scope). Parent tag that encapsulates information about folders included in the indexing scope. | |
| String value | This parameter is used only if the Indexing parameter is set to 1 (Veeam Agent for Microsoft Windows indexes the content of folders included in the indexing scope). Paths to folders whose content must be indexed, for example, C:\Documents. |
ExcludedFolders | This tag is used only if the Indexing parameter is set to 2 (Veeam Agent for Microsoft Windows does not index the content of folders excluded from the indexing scope). Parent tag that encapsulates information about folders excluded from the indexing scope. | |
| String value | This parameter is used only if the Indexing parameter is set to 2 (Veeam Agent for Microsoft Windows does not index the content of folders excluded from the indexing scope). Paths to folders whose content must not be indexed, for example, %TEMP%, %ProgramFiles%. You can use system environmental variables in this parameter. |
Example 1
You want the backup job to back up Microsoft SQL Server transaction logs every 15 minutes and retain transaction log backups in the backup target for 20 days. The input XML file will contain the following parameters:
<ExecutionResult> |
Example 2
You want the backup job to index files in D:\Folder1 and D:\Folder2 folders. The input XML file will contain the following parameters:
<ExecutionResult> |
Example 3
You want the backup job to run pre-freeze.cmd and post-thaw.cmd scripts, and want to ignore script errors. The input XML file will contain the following parameters:
<ExecutionResult> |