DiscoveryRule

Property

Type

Attributes

Description

instanceUid

String (uuid)

Read-only

UID assigned to a discovery rule.

name

String

Name of a discovery rule

masterAgentUid

String (uuid)

UID assigned to a master agent.

locationUid

String (uuid)

Read-only

UID assigned to a location for which a discovery rule is configured.

companyUid

String (uuid)

Read-only

UID assigned to a company for which a discovery rule is configured.

status

String

Current status of a discovery rule.

Possible values:

  • unknown
  • created
  • running
  • success
  • canceled
  • failed
  • cancellationRequested
  • cancellationRequestFailed

lastRun

String (date-time)

Read-only, nullable

Date and time of the latest discovery session.

Date and time string is formatted in accordance with RFC 3339.

filter

Subschema (DiscoveryRuleFilter)

Discovery filter.

notificationSettings

Subschema (DiscoveryRuleNotificationSettings)

Settings configured for email notifications about discovery results.

DiscoveryRuleFilter

Property

Type

Attributes

Description

exclusionMask

Array of strings

Array of applied exclusion masks.

ignoreInaccessibleMachine

Boolean

Indicates whether discovery is performed among accessible computers only.

osTypes

Array of strings

Nullable

OS types.

Possible values:

  • unknown
  • server
  • workstation

applications

Array of strings

Nullable

Applications that must run on discovered computers.

Possible values:

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

platforms

Array of strings

Nullable

Platforms on which discovered computers must run.

Possible values:

  • other
  • microsoftHyperVandVmWareVSpere
  • physical
  • microsoftAzure
  • amazonWebServices

DiscoveryRuleNotificationSettings

Property

Type

Attributes

Description

isEnabled

Boolean

Indicates whether notifications about discovery results are enabled.

scheduleType

String

Nullable

Notification frequency.

Possible values:

  • days
  • weeks

scheduleTime

String (time)

Time at which notifications must are sent.

scheduleDay

String

Nullable

Day at which notifications must are sent.

Possible values:

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

to

String

Email address at which notifications must be sent.

subject

String

Subject of a notification message.

I want to report a typo

There is a misspelling right here:

 

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