Veeam PowerShell Enumerations

In this section you can find enumerations used by Veeam PowerShell.

EVmssState

Mount state.

Member

Description

0

Mounting

1

Mounted

2

Mount Failed

3

Unmounting

4

Unmount Failed

5

Unmounted

VBRAmazonRegionType

Type of Amazon region.

Member

Description

Global

Global region.

Government

Government region.

China

China region.

VBRAmazonServiceType

Type of Amazon object storage.

Member

Description

ExternalRepository

External repository.

CapacityTier

Capacity tier, object storage repository.

ArchiveTier

Archive tier

VBRArchiveExtentStatus

Status of archive extent.

Member

Description

0

Normal

1

Pending

2

Maintenance

8

Sealed

VBRArchiveObjectStorageRepositoryType

Member

Description

AzureArchive

Microsoft Azure Archive Storage.

AmazonS3Glacier

Amazon S3 Glacier Storage

S3GlacierCompatible

S3 compatible Glacier Storage

VBRActivitySeverity

Malware states.

Member

Description

Clean

Clean

Suspicious

Suspicious

Infected

Infected

VBRActivityState

Malware status.

Member

Description

Created

Clean

FalsePositive

False positive event

VBRAzureBlobRegionType

Type of Azure regions.

Member

Description

Global

Global region

China

China region

Government

Government region

VBRAzureDiskType

Azure disk type.

Member

Description

StandardHDD

Standard HDD

StandardSSD

Standard SSD

PremiumSSD

Premium SSD

VBRAzureModelType

Microsoft Azure subscription type.

Member

Description

ResourceManager

Microsoft Azure Resource Manager subscription type

Classic

Microsoft Azure Classic subscription type

VBRAzureServiceType

Member

Description

ExternalRepository

External repository

CapacityTier

Capacity tier, object storage repository

ArchiveTier

Archive tier

VBRAgentLicenseMode

Agent license mode.

Member

Description

Workstation

Workstation mode

Server

Server mode

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.

VBRCapacityExtentStatus

The status of a capacity extent in the scale-out backup repository.

Member

Description

0

Normal

1

Pending

2

Maintenance

4

Evacuating

8

Sealed

16

ResyncRequired

32

TenantEvacuating

VBRCloudConnectedLicenseMode

Cloud Connect license options.

Member

Description

Enabled

Cloud Connect license enabled.

Disabled

Cloud Connect license disabled.

Enterprise

Cloud Connect for the Enterprise

VBRCloudGatewaySelectionType

Type of gateway for the tenant.

Member

Description

StandaloneGateways

A gateway that is not added to a gateway pool.

GatewayPool

A gateway that is added to a gateway pool.

VBRCloudInfrastructureState

The state of the cloud infrastructure.

Member

Description

Active

Cloud infrastructure is in working state.

Maintenance

Cloud infrastructure is in Maintenance mode.

VBRCompressionLevel

The level of compression.

Member

Description

None

Compression is disabled.

Dedupe-friendly

The dedupe-friendly compression level.

Optimal

The optimal compression level.

High

The high compression level.

Extreme

The extreme compression level.

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 fourth 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 Veeam Agent for Microsoft Windows backups.

Member

Description

Everyone

Everyone has permission.

NoOne

No one has permission.

OnlySelectedUsers

Selected users have permission.

VBREpThrottlingAgentType

Member

Description

Workstations

Throttle Veeam Agent on workstations.

Servers

Throttle Veeam Agent on servers

AllHosts

Throttle Veeam Agent on all computers.

VBRExportRetentionPeriod

A retention period of exported backup files.

Member

Description

Never

Veeam Backup & Replication never deletes exported backup files.

In1Month

Veeam Backup & Replication will delete exported backup files in 1 month.

In3Months

Veeam Backup & Replication will delete exported backup files in 3 months.

In6Months

Veeam Backup & Replication will delete exported backup files in 6 months.

In1Year

Veeam Backup & Replication will delete exported backup files in 1 year.

In2Years

Veeam Backup & Replication will delete exported backup files in 2 years.

In3Years

Veeam Backup & Replication will delete exported backup files in 3 years.

In5Years

Veeam Backup & Replication will delete exported backup files in 5 years.

In7Years

Veeam Backup & Replication will delete exported backup files in 7 years.

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.

VBRGatewayMode

Member

Description

Automatic

Automatic gateway selection.

SelectedGateway

Manual gateway selection.

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).

VBRGoogleCloudComputeDiskType

Google Cloud compute engine disk type.

Member

Description

BalancedPersistent

Balanced persistent disk type for Google Cloud Compute Engine VM.

SSDPersistent

SSD persistent disk type for Google Cloud Compute Engine VM.

StandardPersistent

Standard persistent disk type for Google Cloud Compute Engine VM.

VBRGoogleCloudComputeVirusDetectionAction

Action that Veeam Backup & Replication will perform if detecting a virus when scanning the VM with antivirus software before restoring it to Google Compute Engine.

Member

Description

ConnectToIsolatedNetwork

Restore the VM to an isolated Google Cloud network.

AbortRecovery

Cancel the VM restore session.

VBRGoogleCloudServiceType

Type of the Google Cloud object storage repository added to the backup infrastructure.

Member

Description

ExternalRepository

External repository.

CapacityTier

Extent of the capacity tier.

ArchiveTier

Extent of the archive tier.

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.

VBRInfrastructureValidationErrorType

Validation errors.

Member

Description

AddedByIPAddress

Contains IPv4.

HasIPv6Config

Contains IPv6.

VBRInstanceLicenseObjectType

Types of instance licensed workloads.

Member

Description

VM

Protected VM.

Server

Protected server.

Workstation

Protected workstation.

Application

Protected software.

AHVVM

Protected VMs that reside on Nutanix AHV clusters.

CloudMachine

Protected machine.

CloudConnectBackupVM

Protected Cloud Connect VMs  

CloudConnectBackupWorkstation

Protected Cloud Connect Workstations.

CloudConnectBackupServer

Protected Cloud Connect Servers.

CloudConnectReplicationVM

Protected Cloud Connect Replicas.

FileShare

Protected file share.

UnlicensedAgent

Protected non-licensed Veeam Agents.

VBRJobType

Job type.

Member

Description

Backup

Backup job.

BackupSync

Backup copy job.

BackupToTape

Backup to tape job.

ConfigurationBackup

Configuration backup job.

EndpointBackup

Veeam Agent for Microsoft Windows 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.

VBRLicenseEdition

License edition.

Member

Description

Community

Community edition.

Standard

Standard edition.

Enterprise

Enterprise edition.

EnterprisePlus

EnterprisePlus edition.

Unspecified

Not specified edition.

VBRLicenseUsageReportType

Type of a report file.

Member

Description

HTML

HTML type.

PDF

PDF type.

JSON

JSON type.

VBRLicenseStatus

License status.

Member

Description

Valid

Valid.

Expired

Expired.

Invalid

Invalid.

VBRLicenseType

License type.

Member

Description

Rental

Rental type.

Perpetual

Perpetual type.

Subscription

Subscription type.

Evaluation

Evaluation type.

Free

Free type.

Empty

Empty type.

NFR

NFR type.

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.

VBRObjectStorageRepositoryType

Types of object storage repositories.

Member

Description

AmazonS3

Amazon S3.

AmazonS3Compatible

S3 compatible

AzureBlob

Azure Blob

AzureDataBox

Azure Data Box

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.

VBROrganizationvDCAllocationModel

Allocation model.

Member

Description

PayAsYouGo

Pay-as-you-go allocation model.

AllocationPool

Allocation pool allocation model.

ReservationPool

Reservation pool allocation model.

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.

VBRRansomwareScanningSensitivity

Malware index settings.

Member

Description

Low

Low

BetweenLowAndNormal

Between low and normal

Normal

Normal

BetweenNormalAndExtreme

Between normal and extreme

Extreme

Extreme

VBRReplicaStatus

Status of replica VM.

Member

Description

Ready

Ready

Processing

Processing

SureBackup

SureBackup

Failover

Failover

FailedFailover

Failed failover

PermanentFailover

Permanent failover

Failback

Failback

VBRRepositoryConnectionType

Connection type to object storage repository.

Member

Description

Direct

Direct connection using proxy.

Gateway

Connection using gateway server.

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

ActionRequired

[For move or copy backups operation]

The job is stopped with an error and requires an action (for example, job retry or undo).

Idle

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

Pausing

The job is pausing.

Pending

The job is pending.

Postprocessing

The job performs post processing tasks.

Resuming

The job resumes after a pause.

Starting

The job is starting.

Stopped

The job is stopped.

Note: This state displays for any type of the stopped job and does not depend on the way the job was stopped (manually, according to a schedule, and so on).

Stopping

The job got a command to stop and currently is stopping.

WaitingRepository

The job is waiting for the repository to become available.

WaitingSlot

[ Used for offload sessions to capacity tier ]

The job is waiting for backup repository resources.

WaitingTape

The job is waiting for tape (tape jobs).

Working

The job is running.

VBRSocketLicenseObjectType

Types of socket licensed workloads.

Member

Description

HyperV      

Protected HyperV workloads.

vSphere

Protected vSphere workloads.

Nutanix

Protected Nutanix workloads.

Universal

Protected VUL workloads.

Unlicensed

Unlicensed workloads.

VBRSpeedUnit

Member

Description

MbitPerSec

Megabit per second unit.

MbytePerSec

Megabyte per second unit.

KbytePerSec

Kilobyte per second unit.

VBRS3CompatibleAccessControlPolicyType

Member

Description

AllowAll

Direct access insecure.

VBRManaged

Access using gateway server.

S3CompatibleManaged

Direct access using token.

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

Standard media pool.

Imported

Imported media pool.

Gfs

GFS media pool.

VBRTapeMediaPoolPeriod

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.

VBRTapeMediaSetCreationPolicyType

Policy for creating media sets.

Member

Description

Never

New media sets are not created.

Always

New media set is created for each tape job session.

Daily

New media set is created on particular days.

Monthly

Not supported.

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.