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

Veeam PowerShell Licensing

On this page, you can check which Veeam cmdlets are available under each of Veeam product edition.

Note that Get-VBRCommand or Get-Help do not filter the Veeam PowerShell cmdlets by licenses.

Veeam PowerShell Licensing Important!

Cmdlets that are not available under a license do not show warnings immediately, but may cause your scripts to fail. Check the availability of the cmdlets on this page or in the Applies to section in the cmdlets descriptions.

See the topics below to check availability of the cmdlets:

Connecting to Veeam Backup Server

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Connect-VBRServer

Disconnect-VBRServer

Get-VBRServerSession

Backup Infrastructure

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRESX

Add-VBRESXi

Add-VBRHvCluster

Add-VBRHvHost

Add-VBRHvScvmm

Add-VBRLinux

Add-VBRSmbV3Cluster

Add-VBRSmbV3Host

Add-VBRvCenter

Add-VBRWinServer

Find-VBRHvEntity

Find-VBRViDatastore

Find-VBRViDatastoreCluster

Find-VBRViEntity

Find-VBRViFolder

Find-VBRViResourcePool

Find-VBRViStoragePolicy

Get-VBRHvServerNetworkInfo

Get-VBRLocalhost

Get-VBRServer

Get-VBRViServerNetworkInfo

Remove-VBRServer

Rescan-VBREntity

Set-VBRESX

Set-VBRESXi

Set-VBRvCenter

Proxy Servers

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRHvProxy

Add-VBRViProxy

Disable-VBRHvProxy

Disable-VBRViProxy

Enable-VBRHvProxy

Enable-VBRViProxy

Get-VBRHvProxy

Get-VBRJobProxy

Get-VBRViProxy

Remove-VBRHvProxy

Remove-VBRViProxy

Set-VBRJobProxy

Set-VBRViProxy

Backup Repositories

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRBackupRepository

Get-VBRBackupRepository

Set-VBRBackupRepository

Remove-VBRBackupRepository

Sync-VBRBackupRepository

Scale-Out Backup Repositories

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRScaleOutBackupRepository

Limited: 3 extents maximum

Get-VBRRepositoryExtent

Set-VBRRepositoryExtent

Set-VBRScaleOutBackupRepository

Enable-VBRRepositoryExtentMaintenanceMode

Disable-VBRRepositoryExtentMaintenanceMode

Start-VBRRepositoryExtentBackupEvacuation

WAN Accelerators

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRWANAccelerator

Get-VBRWANAccelerator

Remove-VBRWANAccelerator

Clear-VBRWANCache

Backup and Replication Jobs

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRHvBackupJob

Add-VBRHvBackupJob

Add-VBRViBackupJob

Add-VBRViBackupJob

Reset-HvVmChangeTracking

Set-VBRHvReplicaJob

Set-VBRViReplicaJob

Replicas

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRReplica

Remove-VBRReplica

Managing Jobs

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Copy-VBRJob

Disable-VBRJob

Enable-VBRJob

Get-VBRJob

Remove-VBRJob

Start-VBRJob

Stop-VBRJob

Objects in Jobs

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRHvJobObject

Add-VBRViJobObject

Get-VBRJobObject

Remove-VBRJobObject

Replica Re-IP Rules

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRHvReplicaReIpRule

Get-VBRViReplicaReIpRule

New-VBRHvReplicaReIpRule

New-VBRViReplicaReIpRule

Jobs Schedule

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Disable-VBRJobSchedule

Enable-VBRJobSchedule

Get-VBRJobScheduleOptions

New-VBRBackupWindowOptions

New-VBRDailyOptions

New-VBRJobScheduleOptions

New-VBRMonthlyOptions

Reset-VBRJobScheduleOptions

Set-VBRBackupWindowOptions

Set-VBRJobSchedule

Set-VBRJobScheduleOptions

Jobs Options

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRJobOptions

New-VBRJobOptions

Reset-VBRJobOptions

Set-VBRJobOptions

New-VBRNotificationOptions

New-VBRJobScriptOptions

VSS Options

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Disable-VBRJobVSSIntegration

Enable-VBRJobVSSIntegration

Get-VBRJobObjectVssOptions

Get-VBRJobVSSOptions

New-VBRJobVssOptions

Reset-VBRJobVssOptions

Set-VBRJobObjectVssOptions

Set-VBRJobVssOptions

Guest File System Indexing

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Disable-VBRJobGuestFSIndexing

Enable-VBRJobGuestFSIndexing

Advanced Job Options

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Set-VBRJobAdvancedBackupOptions

Set-VBRJobAdvancedHvOptions

Set-VBRJobAdvancedNotificationOptions

Set-VBRJobAdvancedOptions

Set-VBRJobAdvancedStorageOptions

Replica Failover

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRHvReplicaFailback

Start-VBRHvReplicaFailover

Start-VBRViReplicaFailback

Start-VBRViReplicaFailover

Stop-VBRHvReplicaFailback

Stop-VBRReplicaFailover

Stop-VBRViReplicaFailback

Failover Plans

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRFailoverPlan

Get-VBRFailoverPlan

New-VBRFailoverPlanObject

Remove-VBRFailoverPlan

Set-VBRFailoverPlan

Set-VBRFailoverPlanObject

Start-VBRFailoverPlan

Undo-VBRFailoverPlan

Backup Copy Jobs

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBREPBackupCopyJob

Add-VBRHvBackupCopyJob

Add-VBRvCloudBackupCopyJob

Add-VBRViBackupCopyJob

Sync-VBRBackupCopyJob

Configuration Backup

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRConfigurationBackupJob

New-VBRConfigurationBackupScheduleOptions

Set-VBRConfigurationBackupJob

Start-VBRConfigurationBackupJob

SureBackup

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VSBHvApplicationGroup

Add-VSBHvJob

Add-VSBHvVirtualLab

Add-VSBJob

Add-VSBViApplicationGroup

Add-VSBVirtualLab

Connect-VSBHvVirtualLab

Connect-VSBVirtualLab

Find-VSBHvVirtualLab

Find-VSBVirtualLab

Get-VSBApplicationGroup

Get-VSBHvVirtualLab

Get-VSBJob

Get-VSBJobOptions

Get-VSBJobScheduleOptions

Get-VSBSession

Get-VSBTaskSession

Get-VSBVirtualLab

New-VSBJobOptions

Remove-VSBApplicationGroup

Remove-VSBHvVirtualLab

Remove-VSBJob

Remove-VSBVirtualLab

Reset-VSBJobOptions

Set-VSBJobOptions

Set-VSBJobSchedule

Set-VSBJobScheduleOptions

Start-VSBJob

Stop-VSBJob

Quick Migration

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRQuickMigration

VeeamZIP

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRZip

Limited: parameter set for targeting VeeamZIP files to a folder or for Veeam Backup Free Edition

Quick Backup

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRQuickBackup

VM Copy

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCopyJob

VM and Guest OS Files Restore

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRRestoreSession

Remove-VBRRestoreSession

Start-VBRHvRestoreVM

Start-VBRLinuxFileRestore

Start-VBRRestoreVM

Start-VBRRestoreVMFiles

Start-VBRWindowsFileRestore

Start-VBRWindowsGuestItemRestore

Stop-VBRLinuxFileRestore

Stop-VBRWindowsFileRestore

Instant Recovery

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRInstantRecovery

Restart-VBRInstantRecovery

Start-VBRHvInstantRecovery

Start-VBRHvInstantRecoveryMigration

Start-VBRInstantRecovery

Start-VBRvCloudInstantRecovery

Stop-VBRInstantRecovery

Backups

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Export-VBRBackup

Get-VBRBackup

Get-VBRImportedEncryptedBackup

Get-VBRImportedEncryptedBackupHint

Import-VBRBackup

Remove-VBRBackup

Remove-VBRRestorePoint

Set-VBREncryptedBackupPassword

Restore Points

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRRestorePoint

Get-VBRFilesInRestorePoint

Encryption Keys

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBREncryptionKey

Get-VBREncryptionKey

Set-VBREncryptionKey

Remove-VBREncryptionKey

Credentials

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCredentials

Get-VBRCredentials

Remove-VBRCredentials

Set-VBRCredentials

Sessions

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRBackupSession

Get-VBRSession

Get-VBRTaskSession

Get-VBRRestoreSession

Remove-VBRRestoreSession

SQL Restore

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRApplicationRestorePoint

Get-VBRSQLDatabase

Get-VBRSQLDatabaseRestoreInterval

Start-VBRSQLDatabaseRestore

Oracle Restore

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBROracleDatabase

Get-VBROracleDatabaseRestoreInterval

Start-VBROracleDatabaseRestore

Tape Device Support

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRBackupToTapeJob

Add-VBRFileToTapeJob

Add-VBRTapeGFSMediaPool

Add-VBRTapeMediaPool

Add-VBRTapeServer

Add-VBRTapeVault

Disable-VBRTapeDrive

Disable-VBRTapeProtection

Eject-VBRTapeMedium

Enable-VBRTapeDrive

Enable-VBRTapeProtection

Erase-VBRTapeMedium

Export-VBRTapeMedium

Get-VBRTapeDrive

Get-VBRTapeJob

Get-VBRTapeLibrary

Get-VBRTapeMediaPool

Get-VBRTapeMedium

Get-VBRTapeServer

Get-VBRTapeVault

Import-VBRTapeMedium

Move-VBRTapeMedium

New-VBRBackupToTapeScheduleOptions

New-VBRFileToTapeBackupPolicy

New-VBRFileToTapeObject

New-VBRFullBackupToTapePolicy

New-VBRTapeGFSMediaSetPolicy

New-VBRTapeGFSScheduleOptions

New-VBRTapeMediaPoolRetentionPolicy

New-VBRTapeMediaSetCreationPolicy

Remove-VBRTapeLibrary

Remove-VBRTapeMediaPool

Remove-VBRTapeMedium

Remove-VBRTapeServer

Remove-VBRTapeVault

Set-VBRBackupToTapeJob

Set-VBRFileToTapeJob

Set-VBRTapeGFSMediaPool

Set-VBRTapeGFSScheduleOptions

Set-VBRTapeLibrary

Set-VBRTapeMediaPool

Set-VBRTapeMedium

Set-VBRTapeServer

Set-VBRTapeVault

Start-VBRTapeCatalog

Start-VBRTapeInventory

Sync-VBRBackupToTapeJob

VMware vCloud Director

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRvCloud

Add-VBRvCloudBackupCopyJob

Add-VBRvCloudJob

Add-VBRvCloudVC

Find-VBRvCloudEntity

New-VBRvCloudVAppRestoreSettings

Remove-VBRServer

Start-VBRvCloudInstantRecovery

Start-VBRvCloudRestoreVApp

Start-VBRvCloudRestoreVm

Veeam Cloud Connect - Service Provider

Veeam Cloud Connect cmdlets additionally require a Veeam Cloud Provider license.

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCloudGateway

Add-VBRCloudGatewayCertificate

Add-VBRCloudPublicIP

Add-VBRCloudSubTenant

Add-VBRCloudTenant

Add-VBRHvCloudHardwarePlan

Disable-VBRCloudGateway

Disable-VBRCloudSubTenant

Disable-VBRCloudTenant

Enable-VBRCloudGateway

Enable-VBRCloudSubTenant

Enable-VBRCloudTenant

Get-VBRCloudGateway

Get-VBRCloudGatewayCertificate

Get-VBRCloudHardwarePlan

Get-VBRCloudPublicIP

Get-VBRCloudSubTenant

Get-VBRCloudTenant

Get-VBRCloudTenantNetworkAppliance

Get-VBRCloudVLANConfiguration

Get-VBRViVirtualSwitch

New-VBRCloudSubTenantResource

New-VBRCloudTenantHwPlanOptions

New-VBRCloudTenantReplicationResources

New-VBRCloudTenantResource

New-VBRCloudVLANConfiguration

New-VBRHvCloudHWPlanDatastore

Remove-VBRCloudGateway

Remove-VBRCloudHardwarePlan

Remove-VBRCloudPublicIP

Remove-VBRCloudSubTenant

Remove-VBRCloudTenant

Remove-VBRCloudVLANConfiguration

Reset-VBRCloudTenant

Set-VBRCloudGateway

Set-VBRCloudSubTenant

Set-VBRCloudSubTenantResource

Set-VBRCloudTenant

Set-VBRCloudTenantNetworkAppliance

Set-VBRCloudTenantResource

Set-VBRCloudVLANConfiguration

Set-VBRHvCloudHardwarePlan

Set-VBRHvCloudHWPlanDatastore

Veeam Cloud Connect - Cloud User

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCloudProvider

Add-VBRCloudSubUser

Add-VBRHvCloudReplicaJob

Add-VBRViCloudReplicaJob

Disable-VBRCloudSubUser

Enable-VBRCloudSubUser

Get-VBRCloudDatastore

Get-VBRCloudProvider

Get-VBRCloudProviderNetworkAppliance

Get-VBRCloudServer

Get-VBRCloudServerNetworkInfo

Get-VBRCloudSubUser

Get-VBRDefaultGatewayConfiguration

New-VBRCloudFailoverPlanObject

New-VBRCloudProviderNetworkAppliance

New-VBRCloudSubUserResource

New-VBRFailoverPlanPublicIPRule

Remove-VBRCloudProvider

Remove-VBRCloudSubUser

Remove-VBRDefaultGateway

Set-VBRCloudFailoverPlanObject

Set-VBRCloudProvider

Set-VBRCloudProviderNetworkAppliance

Set-VBRCloudSubUser

Set-VBRCloudSubUserResource

Set-VBRDefaultGateway

Set-VBRDefaultGatewayConfiguration

Set-VBRHvCloudReplicaJob

Set-VBRViCloudReplicaJob

Direct Restore to Microsoft Azure

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRAzureAccount

Deploy-VBRAzureLinuxRestoreAppliance

Get-VBRAzureAccount

Get-VBRAzureCloudService

Get-VBRAzureLinuxRestoreAppliance

Get-VBRAzureLocation

Get-VBRAzureResourceGroup

Get-VBRAzureRestoreSession

Get-VBRAzureStorageAccount

Get-VBRAzureSubscription

Get-VBRAzureVirtualNetwork

Get-VBRAzureVirtualNetworkSubnet

Get-VBRAzureVMSize

New-VBRAzureLinuxRestoreAppliance

Remove-VBRAzureAccount

Set-VBRAzureAccount

Set-VBRAzureLinuxRestoreAppliance

Start-VBRVMRestoreToAzure

Stop-VBRVMRestoreToAzure

NetApp Storages

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-NetAppHost

Add-NetAppSnapshot

Get-NetAppHost

Get-NetAppSnapshot

Get-NetAppVolume

New-VBRStorageProtocolPolicy

Remove-NetAppHost

Remove-NetAppSnapshot

Set-NetAppHost

Sync-NetAppHost

Sync-NetAppVolume

HPE 3PAR StoreServ Storages

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-HP3Snapshot

Add-HP3Storage

Get-HP3Snapshot

Get-HP3Storage

Get-HP3Volume

Remove-HP3Snapshot

Remove-HP3Storage

Set-HP3Storage

Sync-HP3Storage

Sync-HP3Volume

HPE StoreVirtual Storages

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-HP4Storage

Get-HP4Storage

Set-HP4Storage

Remove-HP4Storage

Sync-HP4Storage

Get-HP4Cluster

Get-HP4Volume

Sync-HP4Volume

Add-HP4Snapshot

Get-HP4Snapshot

Remove-HP4Snapshot

Dell EMC VNX Storages

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VNXHost

Add-VNXSnapshot

Get-VNXHost

Get-VNXSnapshot

Get-VNXVolume

Remove-VNXHost

Remove-VNXSnapshot

Set-VNXHost

Sync-VNXHost

Sync-VNXVolume

Nimble Storages

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-NimbleHost

Add-NimbleSnapshot

Get-NimbleHost

Get-NimbleSnapshot

Get-NimbleVolume

Remove-NimbleHost

Remove-NimbleSnapshot

Set-NimbleHost

Sync-NimbleHost

Sync-NimbleVolume

Endpoint

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBREPBackupCopyJob

Disable-VBREPJob

Enable-VBREPJob

Get-VBREPJob

Get-VBREPPermission

Get-VBREPSession

Set-VBREPPermission

Start-VBREpInstantRecovery

Start-VBRRestoreVirtualDisks

Logs Export

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Export-VBRLogs

Veeam PowerShell Help

Cmdlet

Free Edition

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRCommand

Get-VBRToolkitDocumentation

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 Endpoint Backup Documentation

Veeam Management Pack Documentation