BackupServerJob

Property

Type

Attributes

Description

instanceUid

String (uuid)

Read-only

UID assigned to a job configured on a client Veeam Backup & Replication server.

name

String

Read-only

Name of a job configured on a client Veeam Backup & Replication server.

backupServerUid

String (uuid)

Read-only

UID assigned to a client Veeam Backup & Replication server.

organizationUid

String (uuid)

Read-only

UID assigned to an organization.

status

String

Status of the latest job session. Can be changed to Running or Stopping using the PATCH endpoint.

Possible values:

  • unknown
  • none
  • idle
  • success
  • warning
  • failed
  • running
  • starting
  • stopping
  • enabling
  • disabling
  • waitingTape
  • waitingRepository

type

String

Read-only

Type of a job configured on a client Veeam Backup & Replication server.

Possible values:

  • unknown
  • backupVm
  • replicationVM
  • copyVm
  • copyFile
  • fileToTape
  • backupToTape
  • backupCopy
  • immediatelyBackupCopy
  • sqlLogBackup
  • oracleLogBackup
  • sureBackup
  • agentPolicy
  • agentBackupJob
  • backupFile
  • backupFileCopy

lastRun

String (date-time)

Read-only, nullable

Date and time when the latest job session started.

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

lastEndTime

String (date-time)

Read-only, nullable

Date and time when the latest job session ended.

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

lastDuration

Integer (int32)

Read-only, nullable

Duration of the latest job session, in seconds.

processingRate

Number (float)

Read-only, nullable

Rate at which VM data was processed during the latest job session.

avgDuration

Integer (int32)

Read-only, nullable

Average time a job session takes to complete, in seconds.

transferredData

Integer (int64)

Read-only, nullable

Total amount of data that was transferred to target during the latest job session, in bytes.

bottleneck

String

Read-only

Bottleneck in the process of transferring the data from source to target.

Possible values:

  • unknown
  • network
  • none
  • proxy
  • source
  • sourceWanAccelerator
  • target
  • targetWanAccelerator

isEnabled

Boolean

Indicates whether a job schedule is enabled.

scheduleType

String

Read-only

Type of a schedule configured for a job.

Possible values:

  • unknown
  • notScheduled
  • daily
  • monthly
  • periodically
  • continuously
  • backupWindow
  • chained

failureMessage

String

Read-only, nullable

Message that is displayed in case a backup job fails.

Every line break is represented by \r\n control characters.

targetType

String

Read-only

Type of a target backup location.

Possible values:

  • unknown
  • local
  • cloud

destination

String

Read-only, nullable

Name of a target backup location.

I want to report a typo

There is a misspelling right here:

 

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