WindowsNetworkBasedDiscoveryRuleInput

Property

Type

Attributes

Description

instanceUid

String (uuid)

Required

UID assigned to a network-based discovery rule.

name

String

Required

Name of a network-based discovery rule.

masterAgentUid

String (uuid)

Required

UID assigned to a master agent.

networks

Array of subschemas (DiscoveryRuleNetwork)

Required

Range of IP addresses.

accessAccount

Subschema (DomainCredentials)

Required

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

filter

Subschema (DiscoveryRuleFilter)

Optional

Discovery filter.

notificationSettings

Subschema (DiscoveryRuleNotificationSettings)

Optional

Settings configured for email notifications about discovery results.

deploymentSettings

Subschema (WindowsDiscoveryRuleDeploymentSettings)

Optional

Settings configured for Veeam backup agent deployment.

DiscoveryRuleNetwork

Property

Type

Attributes

Description

networkName

String

Required

Name of a network configured in Veeam Service Provider Console.

firstIp

String

Required

First IP-address in the range set for discovery.

lastIp

String

Required

Last IP-address in the range set for discovery.

DomainCredentials

Property

Type

Attributes

Description

userName

String

Required

Domain credentials user name.

password

String (password)

Required, nullable

Domain credentials password.

DiscoveryRuleFilter

Property

Type

Attributes

Description

exclusionMask

Array of strings

Optional

Array of applied exclusion masks.

ignoreInaccessibleMachine

Boolean

Optional

Indicates whether discovery is performed among accessible computers only.

osTypes

Array of strings

Optional, nullable

OS types.

Possible values:

  • unknown
  • server
  • workstation

applications

Array of strings

Optional, nullable

Applications that must run on discovered computers.

Possible values:

  • otherApp
  • microsoftExchangeServer
  • microsoftSqlServer
  • microsoftActiveDirectory
  • microsoftSharePoint
  • oracle

platforms

Array of strings

Optional, nullable

Platforms on which discovered computers must run.

Possible values:

  • other
  • microsoftHyperVandVmWareVSpere
  • physical
  • microsoftAzure
  • AmazonWebServices

DiscoveryRuleNotificationSettings

Property

Type

Attributes

Description

isEnabled

Boolean

Optional

Indicates whether notifications about discovery results are enabled.

scheduleType

String

Required, nullable

Notification frequency.

Possible values:

  • days
  • weeks

scheduleTime

String (time)

Required

Time at which notifications must are sent.

scheduleDay

String

Optional, nullable

Day at which notifications must are sent.

Possible values:

  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday

to

String

Required

Email address at which notifications must be sent.

subject

String

Required

Subject of a notification message.

WindowsDiscoveryRuleDeploymentSettings

Property

Type

Attributes

Description

isEnabled

Boolean

Optional

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

backupPolicyUid

String (uuid)

Optional, nullable

UID assigned to a backup policy.

setReadOnlyAccess

Boolean

Optional

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

backupAgentSettings

Subschema (BackupAgentSettings)

Optional

Veeam backup agent settings.

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.