This is an archive version of the document. To get the most up-to-date information, see the current version.

General

The following properties are present in all resources from the /discoveryRules collection:

Property

Type

Description

id

integer

System ID assigned to a discovery rule in the Veeam Service Provider Console REST API.

name

String

Name of a discovery rule configured in Veeam Service Provider Console.

companyId

integer

System ID of a company for which discovery rule was configured.

locationId

integer

System ID of a company location for which discovery rule was configured.

accountName

String

Account under which Veeam Service Provider Console connects to discovered computers.

instanceCount

integer

Number of discovered computers.

onlineInstanceCount

integer

Number of discovered computers currently online.

offlineInstanceCount

integer

Number of discovered computers currently offline.

state

String

Current status of a discovery rule.

Possible values:

  • Created
  • Running
  • Success
  • Canceled
  • Failed
  • CancellationRequested
  • CancellationRequestFailed

lastRun

String

Date and time when a discovery was last run.

Date and time string is formatted in accordance with ISO 8601.

type

String

Discovery method used.

Possible values:

  • NetworkBased
  • AD
  • CSVFile

exclusionMask

String

Mask for excluding computers from discovery scope.

Only present if the type property has value NetworkBased or AD.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).