Guest Processing - RESTful API Reference
Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Guest Processing

The /BackupPolicies/{ID} resource can have the following properties representing guest processing settings:

Property

Type

Description

processingEnabled

boolean

Indicates whether application-aware processing is enabled for the backup job.

processingType

string

Defines how the backup policy handles transaction logs.

Possible values:

  • CopyOnly
  • ProcessLogs

Only present if the processingEnabled property has value true.

sqlOptions

SqlOptions

Indicates Microsoft SQL Server processing settings.

oracleOptions

OracleOptions

Indicates Oracle Database processing settings.

sharePointOptions

SharePointOptions

Indicates SharePoint processing settings.

scriptOptions

ScriptOptions

Indicates script execution settings.

SqlOptions

Property

Type

Description

credentials

Credentials

Credentials of an account to connect to Microsoft SQL Server.

truncationMode

string

Indicates how the backup policy processes Microsoft SQL Server transaction logs.

Possible values:

  • NotTruncate
  • Truncate
  • BackupPeriodically

Only present if the processingType property has value ProcessLogs.

backupOptions

BackupOptions

Indicates how SQL logs are backed up.

Only present if the truncationMode property has value BackupPeriodically.

OracleOptions

Property

Type

Description

accountType

string

Type of account used to connect to Oracle database.

Possible values:

  • Oracle
  • Windows

credentials

Credentials

Credentials of an account to connect to Oracle database.

archivalMode

string

Indicates retention policy for archived logs.

Possible values:

  • NotDelete
  • DeleteOld
  • DeleteBig

deleteOlderThan

integer

Maximum lifetime of archived logs.

Only present if the archivalMode property has value DeleteOld.

deleteOlderThanUnits

string

Measurement units for maximum lifetime of archived logs. Has the constant value hours.

deleteBiggerThan

integer

Maximum size of archived logs.

Only present if the archivalMode property has value DeleteBig.

deleteBiggerThanUnits

string

Measurement units for maximum size of archived logs. Has the constant value GB.

backupOptions

backupOptions

Indicates how Oracle logs are backed up.

SharePointOptions

Property

Type

Description

credentials

Credentials

Credentials of an account to connect to SharePoint.

ScriptOptions

Property

Type

Description

executionMode

string

Script processing mode.

Possible values:

  • Disabled
  • IgnoreFailures
  • RequireSuccess

prefreezeCommand

string

Location of a file with a pre-freeze script.

Only present if the executionMode property has value IgnoreFailures or RequireSuccess.

postThawCommand

string

Location of a file with a post-thaw script.

Only present if the executionMode property has value IgnoreFailures or RequireSuccess.

credentials

Credentials

Credentials of an admin account to execute scripts.

Only present if the executionMode property has value IgnoreFailures or RequireSuccess.

Credentials

Property

Type

Description

credentialsEnabled

boolean

Indicates whether credentials are enabled for an account.

userName

string

Indicates a user name.

Only present if the credentialsEnabled property has value true.

password

string

Indicates a password.

Only present if the credentialsEnabled property has value true.

BackupOptions

Property

Type

Description

backupOptionsEnabled

boolean

Indicates if backup options are enabled for log transaction.

backupInterval

integer

Backup interval.

The minimum value is 5. The maximum value is 480.

Only present if the backupOptionsEnabled property has value true.

backupIntervalUnits

string

Measurement units for backup interval. Has the constant value mins.

Only present if the backupOptionsEnabled property has value true.

retentionType

string

Retention policy for transaction or archived logs.

Possible values:

  • PertainWithMachineBackup
  • RetentionInterval

Only present if the backupOptionsEnabled property has value true.

retentionInterval

integer

Period to keep transaction or archived logs.

Only present if the backupOptionsEnabled property has value true and the retentionType property has value RetentionInterval.

retentionIntervalUnits

string

Measurement units for a period to keep transaction or archived logs. Has the constant value days.

Only present if the backupOptionsEnabled property has value true and the retentionType property has value RetentionInterval.

 

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference