DeploymentConfiguraion

Property

Type

Attributes

Description

backupPolicyUid

String (uuid)

Optional, nullable

UID assigned to a backup policy that is applied after agent activation.

allowAutoRebootIfNeeded

Boolean

Optional

Indicates whether system reboot is allowed.

setReadOnlyAccess

Boolean

Optional

Indicates whether read-only access is enabled for agents.

installCbtDriver

Boolean

Optional

Indicates whether CBT driver is installed during agent deployment.

credentials

Subschema (DomainCredentials)

Optional

Credentials for accessing discovered computers.

backupAgentSettings

Subschema (BackupAgentSettings)

Optional

Veeam backup agent global settings.

DomainCredentials

Property

Type

Attributes

Description

userName

String

Required

Domain credentials user name.

password

String (password)

Required, nullable

Domain credentials password.

BackupAgentSettings

Property

Type

Attributes

Description

backupAgentUid

String (uuid)

Read-only

UID assigned to a Veeam backup agent.

disableScheduledBackups

Boolean

Required

Indicates whether a Veeam backup agent job schedule is disabled.

disableControlPanelNotification

Boolean

Required

Indicates whether Control Panel notifications.

disableBackupOverMeteredConnection

Boolean

Required

Indicates whether backup over metered connections is disabled.

disableScheduleWakeup

Boolean

Required

Indicates whether a scheduled wake up timer is disabled.

throttleBackupActivity

Boolean

Required

Indicates whether Veeam backup agent throttles backup activities when system is busy.

restrictVpnConnections

Boolean

Required

Indicates whether backup over VPN connections is disabled.

limitBandwidthConsumption

Boolean

Optional

Indicates whether bandwidth consumption for backup jobs is limited.

Default value is false.

bandwidthSpeedLimit

Integer (int32)

Optional, nullable

Value of maximum speed for transferring backed-up data.

bandwidthSpeedLimitUnit

String

Optional, nullable

Measurement units of maximum speed for transferring backed-up data.

Possible values:

  • mbitPerSec
  • kbytePerSec
  • mbytePerSec

flrWithoutAdminPrivilegesAllowed

Boolean

Required

Indicates whether file-level restore is available to users that do not have administrative privileges.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.