WindowsDiscoveryRule

Property

Type

Attributes

Description

instanceUid

String (uuid)

Read-only

UID assigned to a discovery rule.

method

String

Read-only

Discovery method.

Possible values:

  • unknown
  • networkBased
  • ad
  • manual

accessAccount

Subschema (DomainCredentials)

Credentials of an account with local Administrator permissions on discovered computers.

deploymentSettings

Subschema (WindowsDiscoveryRuleDeploymentSettings)

Settings configured for Veeam backup agent deployment.

DomainCredentials

Property

Type

Attributes

Description

userName

String

Domain credentials user name.

password

String (password)

Nullable

Domain credentials password.

WindowsDiscoveryRuleDeploymentSettings

Property

Type

Attributes

Description

isEnabled

Boolean

Indicates whether Veeam backup agent is automatically installed on computers as part of discovery.

backupPolicyUid

String (uuid)

Nullable

UID assigned to a backup policy.

setReadOnlyAccess

Boolean

Indicates whether read-only access mode is enabled for Veeam backup agents as part of discovery.

backupAgentSettings

Subschema (BackupAgentSettings)

Veeam backup agent settings.

BackupAgentSettings

Property

Type

Attributes

Description

backupAgentUid

String (uuid)

Read-only

UID assigned to a Veeam backup agent.

disableScheduledBackups

Boolean

Indicates whether a Veeam backup agent job schedule is disabled.

disableControlPanelNotification

Boolean

Indicates whether Control Panel notifications.

disableBackupOverMeteredConnection

Boolean

Indicates whether backup over metered connections is disabled.

disableScheduleWakeup

Boolean

Indicates whether a scheduled wake up timer is disabled.

throttleBackupActivity

Boolean

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

restrictVpnConnections

Boolean

Indicates whether backup over VPN connections is disabled.

limitBandwidthConsumption

Boolean

Indicates whether bandwidth consumption for backup jobs is limited.

Default value is false.

bandwidthSpeedLimit

Integer (int32)

Nullable

Value of maximum speed for transferring backed-up data.

bandwidthSpeedLimitUnit

String

Nullable

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

Possible values:

  • mbitPerSec
  • kbytePerSec
  • mbytePerSec

flrWithoutAdminPrivilegesAllowed

Boolean

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.