Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Veeam PowerShell Enumerations

Veeam PowerShell uses the following enumerations:

VBRAzureModelType

Microsoft Azure subscription type.

Member

Description

ResourceManager

Microsoft Azure Resource Manager subscription type

Classic

Microsoft Azure Classic subscription type

VBRBackupToTapePolicyType

Job schedule settings.

Member

Description

AfterJob

Job starts after a selected job.

AfterNewBackup

Job starts when a new backup appear.

Daily

Job starts on selected days of week.

Monthly

Job starts on selected days of month.

VBRCloudInfrastructureState

The state of the cloud infrastructure.

Member

Description

Active

Cloud infrastructure is in working state.

Maintenance

Cloud infrastructure is in maintenance mode.

VBRConfigurationBackupScheduleType

Configuration backup job schedule type.

Member

Description

Daily

Job starts on selected days of week.

Monthly

Job starts on selected days of month.

VBRDailyOptionsType

Daily basis job schedule type.

Member

Description

Everyday

Job runs everyday.

WeekDays

Job runs Monday to Friday.

SelectedDays

Job runs on selected days.

VBRDayNumberInMonth

Day in month in job schedule, for example, "the first" (Sunday).

Member

Description

First

Job runs every first day of month.

Second

Job runs every second day of month.

Third

Job runs every third day of month.

Fourth

Job runs every forth day of month.

Last

Job runs every last day of month.

OnDay

Job runs on selected day of month.

VBREPPermissionType

User access permissions to repositories for Endpoint backups.

Member

Description

Everyone

Everyone has permission.

NoOne

No one has permission.

OnlySelectedUsers

Selected users have permission.

VBRFailoverPlanType

Failover plan type.

Member

Description

Local

Non-cloud failover plan

Cloud

Cloud failover plan on cloud user side

Tenant

Cloud failover plan of a tenant on cloud provider side

VBRFileToTapeBackupPolicyType

File to tape job schedule type.

Member

Description

Daily

Job starts on selected days of week.

Monthly

Job starts on selected days of month.

VBRFullBackupToTapePolicyType

Virtual full backup schedule type.

Member

Description

Monthly

Virtual full is created on selected days of month.

WeeklyOnDays

Virtual full is created on selected days of week.

VBRGatewayNetworkMode

Network mode for cloud gateways. The network mode defines how the cloud gateway communicates with the Veeam backup server on the tenant side.

Member

Description

Direct

Direct network mode.

NAT

NAT network mode.

VBRGFSMonthlyKind

Monthly basis job schedule type.

Member

Description

DayOfWeek

Job runs on a selected day in month, for example, the first Sunday of month.

DayOfMonth

Job runs on a selected date, for example, on the 1st (of January).

VBRGuestOsType

Oracle database guest OS type.

Member

Description

Unknown

Oracle database runs on VM with unknown OS.

Windows

Oracle database runs on Windows-based VM.

Linux

Oracle database runs on Linux-based VM.

Other

Oracle database runs on VM with other OS.

VBRJobType

Job type.

Member

Description

Backup

Backup job.

BackupSync

Backup copy job.

BackupToTape

Backup to tape job.

ConfigurationBackup

Configuration backup job.

EndpointBackup

Endpoint backup job.

FileToTape

File to tape job.

TapeCatalog

Tape cataloging.

TapeEject

Tape ejecting.

TapeErase

Tape erasing.

TapeExport

Tape exporting.

TapeImport

Tape importing.

TapeInventory

Tape inventorying.

TapeRescan

Tape rescanning.

VBRLogStatus

Log entry status.

Member

Description

None

Job session status not applicable.

Success

Job session finished with success.

Warning

Job session finished with warning.

Failed

Job session failed.

VBROracleDatabaseRecoveryModel

Oracle database recovery mode.

Member

Description

ArchiveLog

ARCHIVELOG mode is enabled for the Oracle database.

NoArchiveLog

ARCHIVELOG mode is not enabled for the Oracle database.

VBRPeriodicityType

Script run mode.

Member

Description

Cycles

Script runs after a set number of job runs (for example, every second job run).

Days

Script runs on selected days.

VBRPlatform:

Virtualization platform.

Member

Description

VMware

VMware virtualization platform.

Hyper-V

Hyper-V virtualization platform.

VBRRepositoryExtentStatus

Scale-out backup repository status.

Member

Description

Unknown

Extent is not added to any scale-out repository.

Normal

Extent is in working mode.

Pending

Extent is in process of switching to maintenance mode.

Maintenance

Extent is in maintenance mode.

Evacuate

Extent is in maintenance mode and is evacuating backups.

VBRRestorePointType

Restore point type.

Member

Description

Full

Restore point is a VBK file (full backup).

Rollback

Restore point is a VRB file (reverse incremental backup).

Increment

Restore point is a VIB file (forward incremental backup).

Different

Restore point is not identified.

Snapshot

Restore point is a snapshot.

VBRScaleOutBackupRepositoryPolicyType

Scale-out backup repository policy.

Member

Description

DataLocality

Data locality policy.

Performance

Performance policy.

VBRSessionResult

Session result. Indicates the state with which a job run or a task session finished.

Member

Description

None

The result is N/A.

Success

The session finished successfully.

Warning

The session finished with warnings.

Failed

The session failed.

VBRSessionState

Job or task current state.

Member

Description

Idle

The job is idle. The job is in idle state between the scheduled job runs.

Pausing

The job is pausing.

Postprocessing

The job performs post processing tasks.

Resuming

The job resumes after a pause.

Starting

The job is starting

Stopped

The job is stopped manually.

Stopping

The job is stopping.

WaitingRepository

The job is waiting for the repository to become available.

WaitingTape

The job is waiting for tape (tape jobs).

Working

The job is running.

VBRTapeDriveState

Tape drive state.

Member

Description

Loaded

Tape drive is loaded.

Empty

Tape drive is empty.

VBRTapeLibraryState

Tape library state.

Member

Description

Online

Tape library is online.

Offline

Tape library is offline.

VBRTapeLibraryType

Tape library type.

Member

Description

Automated

Tape library is automated tape device.

StandaloneDrive

Tape library is standalone tape drive.

VBRTapeMediaPoolRetentionType

Tape retention period type.

Member

Description

Never

Data on tape is never overwritten.

Periodic

Data on tape is protected for selected period of time.

Cyclic

Data on tape is not protected.

VBRTapeMediaPoolType

Media pool type.

Member

Description

Unrecognized

Unrecognized media pool.

Free

Free media pool.

Retired

Retired media pool.

Custom

Simple media pool.

Imported

Imported media pool.

Gfs

GFS media pool.

VBRTapeMediaPooPeriod

Tape retention measure unit.

Member

Description

None

Tape data is not protected.

Days

Tape data retention period is measured in days.

Weeks

Tape data retention period is measured in weeks.

Months

Tape data retention period is measured in months.

VBRViNetworkInfoType

Network type.

Member

Description

Cloud

Cloud network.

Hv

Hyper-V network.

ViDVS

VMware network connected to distributed virtual switch (DVS).

ViSimple

VMware network connected to standard switch.

VBRVirtualSwitchType

Virtual switch type.

Member

Description

DVS

Distributed virtual switch (DVS).

Simple

Standard switch.

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation