Veeam PowerShell Licensing

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

Important

Consider the following:

  • 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.
  • Neither the Get-VBRCommandReturns Veeam PowerShell module cmdlets. cmdlet nor the Get-Help cmdlet do not filter the Veeam PowerShell cmdlets by licenses.

Connecting to Veeam Backup Server

Connecting to Veeam Backup Server

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Connect-VBRServerConnects to a Veeam backup server.

Disconnect-VBRServerEnds current session with a Veeam backup server.

Get-VBRServerSessionReturns current session with a Veeam backup server.

Backup Infrastructure

Backup Infrastructure

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRESXAdds ESXi hosts to Veeam Backup & Replication. This cmdlet is obsolete and will not be supported in the next version.

Add-VBRESXiAdds VMware ESXi hosts to the backup infrastructure.

Add-VBRHvClusterAdds a Hyper-V cluster to the backup infrastructure.

Add-VBRHvHostAdds Hyper-V hosts to the backup infrastructure.

Add-VBRHvScvmmAdds a Hyper-V SCVMM server to the backup infrastructure.

Add-VBRLinuxAdds a Linux server to the backup infrastructure.

Add-VBRSmbV3ClusterAdds an SMB3 cluster to the backup infrastructure.

Add-VBRSmbV3HostAdds an SMB3 host to the backup infrastructure.

Add-VBRvCenterAdds vCenter Servers to the backup infrastructure.

Add-VBRWinServerAdds a Windows server to the backup infrastructure.

Find-VBRHvEntityReturns Hyper-V objects.

Find-VBRViDatastoreLooks for VMware datastores.

Find-VBRViDatastoreClusterLooks for VMware datastore clusters.

Find-VBRViEntityLooks for VMware objects.

Find-VBRViFolderLooks for folders on a specified ESXi host.

Find-VBRViResourcePoolReturns VMware resource pools.

Find-VBRViStoragePolicyLooks for VMware storage policy profiles.

Get-VBRHvServerNetworkInfoReturns virtual networks for a Hyper-V host.

Get-VBRLocalhostReturns the local server on which the backup infrastructure is installed.

Get-VBRServerReturns hosts connected to the backup infrastructure.

Get-VBRViServerNetworkInfoReturns virtual networks for a VMware host.

Remove-VBRServerRemoves hosts from the backup infrastructure.

Rescan-VBREntityRescans backup infrastructure components.

Set-VBRESXModifies ESXi hosts added to Veeam Backup & Replication. This cmdlet is obsolete and will not be supported the next version.

Set-VBRESXiModifies VMware ESXi hosts added to the backup infrastructure.

Set-VBRvCenterModifies VMware vSphere servers added to the backup infrastructure.

Proxy Servers

Proxy Servers

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRHvProxyAdds a Hyper-V backup proxy to the backup infrastructure.

Add-VBRViProxyAdds a VMware backup proxy to the backup infrastructure.

Disable-VBRHvProxyDisables the Hyper-V backup proxy.

Disable-VBRViProxyDisables a VMware backup proxy.

Enable-VBRHvProxyEnables the disabled Hyper-V backup proxy.

Enable-VBRViProxyEnables a disabled VMware backup proxy.

Get-VBRHvProxyReturns a list of the Hyper-V backup proxies.

Get-VBRJobProxyReturns a list of proxy servers assigned to a specific job.

Get-VBRViProxyReturns a list of VMware backup proxies.

Remove-VBRHvProxyRemoves the Hyper-V backup proxy from the backup infrastructure.

Remove-VBRViProxyRemoves a VMware backup proxy from the backup infrastructure.

Set-VBRJobProxyModifies settings of a backup proxy.

Set-VBRViProxyModifies a VMware backup proxy.

Backup Repositories

Backup Repositories

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRBackupRepositoryAdds a backup repository to the backup infrastructure.

Get-VBRBackupRepositoryReturns a list of backup repositories.

Set-VBRBackupRepositoryModifies a backup repository.

Remove-VBRBackupRepositoryRemoves a backup repository from the backup infrastructure.

Sync-VBRBackupRepositoryRescans a backup repository.

Scale-Out Backup Repositories

Scale-Out Backup Repositories

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRScaleOutBackupRepositoryAdds scale-out backup repositories to the backup infrastructure.

Limited: 3 extents maximum

Get-VBRRepositoryExtentReturns scale-out performance extents.

Set-VBRRepositoryExtentModifies performance extents of scale-out backup repositories.

Set-VBRScaleOutBackupRepositoryModifies scale-out backup repositories.

Enable-VBRRepositoryExtentMaintenanceModeEnables Maintenance mode for a performance extent or capacity extent of a scale-out backup repository.

Disable-VBRRepositoryExtentMaintenanceModeDisables Maintenance mode for extents of a scale-out backup repository.

Start-VBRRepositoryExtentBackupEvacuationEvacuates backups from a scale-out backup repository extent.

WAN Accelerators

WAN Accelerators

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRWANAcceleratorCreates a new WAN accelerator.

Get-VBRWANAcceleratorReturns WAN accelerators.

Remove-VBRWANAcceleratorRemoves a WAN accelerator.

Clear-VBRWANCacheRemoves data from WAN accelerator global cache.

Backup and Replication Jobs

Backup and Replication Jobs

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRHvBackupJobCreates Hyper-V backup jobs.

Add-VBRHvBackupJobCreates Hyper-V backup jobs.

Add-VBRViBackupJobCreates VMware backup jobs.

Add-VBRViBackupJobCreates VMware backup jobs.

Reset-HvVmChangeTracking

Set-VBRHvReplicaJobModifies Hyper-V replication jobs.

Set-VBRViReplicaJobModifies VMware replication jobs.

Replicas

Replicas

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRReplicaReturns replica objects of VMs or cloud VMs.

Remove-VBRReplicaRemoves replica objects and replicated VMs.

Managing Jobs

Managing Jobs

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Copy-VBRJobClones existing jobs.

Disable-VBRJobPuts a selected job on hold.

Enable-VBRJobEnables a disabled job.

Get-VBRJobReturns existing jobs.

Remove-VBRJobRemoves a selected backup, replication or backup copy job.

Start-VBRJobStarts a backup or replication job.

Stop-VBRJobStops a running backup, replication or copy job.

Objects in Jobs

Objects in Jobs

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRHvJobObjectAdds VMs to Hyper-V jobs.

Add-VBRViJobObjectAdds VMs to VMware jobs.

Get-VBRJobObjectReturns VMs or VM containers of specific jobs.

Remove-VBRJobObjectRemoves VMs or VM containers from jobs.

Replica Re-IP Rules

Replica Re-IP Rules

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRHvReplicaReIpRuleReturns Hyper-V job re-IP rules.

Get-VBRViReplicaReIpRuleReturns VMware job re-IP rules.

New-VBRHvReplicaReIpRuleCreates a new Hyper-V replica re-IPv4 rule.

New-VBRViReplicaReIpRuleCreates a new VMware replica re-IPv4 rule.

Jobs Schedule

Jobs Schedule

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Disable-VBRJobScheduleDisables job schedule.

Enable-VBRJobScheduleEnables job schedule.

Get-VBRJobScheduleOptionsReturns job scheduling settings.

New-VBRBackupWindowOptionsDefines backup window settings for a job.

New-VBRDailyOptionsCreates new job daily schedule settings.

New-VBRJobScheduleOptionsCreates new job schedule options. This cmdlet is obsolete. You can still run this cmdlet but, depending on the job type, it is recommended to run one of the following cmdlets: - The New-VBRServerScheduleOptions cmdlet to define schedule settings for backup jobs. - The New-VBRWindowsWorkstationScheduleOptions cmdlet to create a job schedule for Windows workstations. - The New-VBRLinuxScheduleOptions cmdlet to create a job schedule for Linux computers. - The New-VBRMacScheduleOptions cmdlet to create a job schedule for macOS computers. - The Set-VBRJobSchedule cmdlet to modify a job schedule.

New-VBRMonthlyOptionsCreates a new VBRMonthlyOptions object.

Reset-VBRJobScheduleOptionsApplies default schedule settings to jobs.

Set-VBRBackupWindowOptionsModifies job backup window settings.

Set-VBRJobScheduleModifies job schedule.

Set-VBRJobScheduleOptionsApplies modified job schedule settings to jobs. This cmdlet is obsolete. You can still run this cmdlet, but it is recommended to modify job schedule using the Set-VBRJobSchedule cmdlet.

Jobs Options

Jobs Options

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRJobOptionsReturns job settings.

New-VBRJobOptionsCreates new job options.

Reset-VBRJobOptionsApplies default settings to jobs.

Set-VBRJobOptionsModifies job settings.

New-VBRNotificationOptionsCreates new job notification options.

New-VBRJobScriptOptionsCreates new job script options.

Application-Aware Processing

Application-Aware Processing

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Disable-VBRJobVSSIntegrationDisables job VSS settings.

Enable-VBRJobVSSIntegrationEnables job VSS settings.

Get-VBRJobObjectVssOptionsReturns VSS settings of a specific VM in job.

Get-VBRJobVSSOptionsReturns VSS settings for a selected job.

New-VBRJobVssOptionsReturns default set of VSS options for job or VM in job.

Reset-VBRJobVssOptionsSets job VSS settings to default.

Set-VBRJobObjectVssOptionsCustomizes job VSS settings.

Set-VBRJobVssOptionsApplies custom VSS settings to a selected job.

Guest File System Indexing

Guest File System Indexing

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Disable-VBRJobGuestFSIndexingDisables job guest file system indexing option.

Enable-VBRJobGuestFSIndexingEnables job guest file system indexing option.

Advanced Job Options

Advanced Job Options

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Set-VBRJobAdvancedBackupOptionsModifies advanced job backup settings.

Set-VBRJobAdvancedHvOptionsCustomizes Hyper-V job settings.

Set-VBRJobAdvancedNotificationOptionsCustomizes job notification settings.

Set-VBRJobAdvancedOptionsCustomizes advanced job settings.

Set-VBRJobAdvancedStorageOptionsCustomizes advanced job storage settings.

Replica Failover

Replica Failover

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRHvReplicaFailbackFails back Hyper-V VMs to production host.

Start-VBRHvReplicaFailoverFails over corrupted Hyper-V VMs to their replicas.

Start-VBRViReplicaFailbackFails back VMware VMs to production host.

Start-VBRViReplicaFailoverFails over corrupted VMware VMs to their replicas.

Stop-VBRHvReplicaFailbackUndoes Hyper-V replica failback.

Stop-VBRReplicaFailoverUndoes replica failover.

Stop-VBRViReplicaFailbackUndoes VMware replica failback.

Failover Plans

Failover Plans

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRFailoverPlanCreates failover plans or cloud failover plans.

Get-VBRFailoverPlanReturns existing failover plans or cloud failover plans.

New-VBRFailoverPlanObjectCreates the VBRFailoverPlanObject object.

Remove-VBRFailoverPlanRemoves a selected failover plan or a cloud failover plan.

Set-VBRFailoverPlanModifies a selected failover plan or cloud failover plan.

Set-VBRFailoverPlanObjectModifies VMs in failover plans.

Start-VBRFailoverPlanStarts failover by failover plan.

Undo-VBRFailoverPlanUndoes the failover by failover plan.

Backup Copy Jobs

Backup Copy Jobs

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBREPBackupCopyJobThis cmdlet is obsolete and only works for creating a simple mode backup copy job. It is recommended to create a new backup job using the Add-VBRBackupCopyJob cmdlet. Creates backup copy jobs for Veeam Agent operating in a standalone mode.

Add-VBRHvBackupCopyJobCreates a Hyper-V backup copy job. This cmdlet is obsolete and only works for creating a simple mode backup copy job. It is recommended to create a new backup job using the Add-VBRBackupCopyJob cmdlet.

Add-VBRvCloudBackupCopyJobCreates a Cloud Director backup copy job. This cmdlet is obsolete and only works for creating a simple mode backup copy job. It is recommended to create a new backup job using the Add-VBRBackupCopyJob cmdlet.

Add-VBRViBackupCopyJobCreates a VMware backup copy job. This cmdlet is obsolete and only works for creating a simple mode backup copy job. It is recommended to create a new backup job using the Add-VBRBackupCopyJob cmdlet. For Hyper-V, run the Add-VBRHvBackupCopyJob cmdlet.

Sync-VBRBackupCopyJobStarts a backup copy job.

Configuration Backup

Configuration Backup

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRConfigurationBackupJobReturns the configuration backup job.

New-VBRConfigurationBackupScheduleOptionsCreates a new VBRConfigurationBackupScheduleOptions object.

Set-VBRConfigurationBackupJobModifies the configuration backup job.

Start-VBRConfigurationBackupJobStarts the configuration backup job.

SureBackup

SureBackup

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VSBHvApplicationGroupCreates a Hyper-V application group for SureBackup job. This cmdlet is obsolete and not supported. Run the Add-VBRApplicationGroup cmdlet instead.

Add-VSBHvJobCreates a Hyper-V SureBackup job. This cmdlet is obsolete. Run the Add-VBRSureBackupJob cmdlet instead.

Add-VSBHvVirtualLabCreates a Hyper-V virtual lab. This cmdlet is obsolete and not supported. Run the Add-VBRApplicationGroup cmdlet instead.

Add-VSBJobCreates a VMware SureBackup job. This cmdlet is obsolete. Run the Add-VBRSureBackupJob cmdlet instead.

Add-VSBViApplicationGroupCreates an application group for SureBackup job. This cmdlet is obsolete and not supported. Run the Add-VBRApplicationGroup cmdlet instead

Add-VSBVirtualLabCreates a VMware virtual lab. This cmdlet is obsolete and not supported. Run the Add-VBRApplicationGroup cmdlet instead.

Connect-VSBHvVirtualLabConnects an existing Hyper-V virtual lab. This cmdlet is obsolete. The cmdlet still works but may not be supported in further versions.

Connect-VSBVirtualLabConnects an existing VMware virtual lab. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Connect-VBRViVirtualLab cmdlet.

Find-VSBHvVirtualLabLooks for virtual labs created on the specified Hyper-V host. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Find-VSBVirtualLabLooks for virtual labs created on the specified ESXi host. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Connect-VBRViVirtualLab cmdlet.

Get-VSBApplicationGroupReturns application groups. This cmdlet is obsolete. Run the Get-VBRApplicationGroup cmdlet instead.

Get-VSBHvVirtualLabReturns Hyper-V virtual labs. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Get-VSBJobReturns SureBackup jobs. This cmdlet is obsolete. Run the Get-VBRSureBackupJob cmdlet instead.

Get-VSBJobOptionsReturns settings of a selected SureBackup job. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Get-VSBJobScheduleOptionsReturns scheduling settings of a selected SureBackup job. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Get-VSBSessionReturns SureBackup sessions that have been run. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Get-VSBTaskSessionReturns tasks performed during the specified SureBackup session. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions. Use the Get-VBRSureBackupTaskSession cmdlet instead.

Get-VSBVirtualLabReturns VMware virtual labs. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Get-VBRVirtualLab cmdlet.

New-VSBJobOptionsSets SureBackup job options. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Remove-VSBApplicationGroupRemoves a specified application group from Veeam Backup & Replication. This cmdlet is obsolete. Run the Remove-VBRApplicationGroup cmdlet instead.

Remove-VSBHvVirtualLabRemoves a Hyper-V virtual lab. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the cmdlet.

Remove-VSBJobRemoves a specified SureBackup job. This cmdlet is obsolete. Run the Remove-VBRSureBackupJob cmdlet instead.

Remove-VSBVirtualLabRemoves a specified VMware virtual lab. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Remove-VBRVirtualLab cmdlet.

Reset-VSBJobOptionsSets SureBackup job settings to default. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Set-VSBJobOptionsApplies custom SureBackup job options. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Set-VSBJobScheduleModifies SureBackup job schedule options. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Set-VSBJobScheduleOptionsApplies customized job scheduling options to a selected SureBackup job. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

Start-VSBJobStarts a created SureBackup job. This cmdlet is obsolete. Run the Start-VBRSureBackupJob cmdlet instead.

Stop-VSBJobStops running SureBackup job. This cmdlet is obsolete. Run the Stop-VBRSureBackupJob cmdlet instead.

Quick Migration

Quick Migration

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRQuickMigrationStarts Quick Migration of a virtual machine.

VeeamZIP

VeeamZIP

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRZipPerforms VeeamZIP on the selected VM.

Quick Backup

Quick Backup

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Start-VBRQuickBackupPerforms quick backup.

VM Copy

VM Copy

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCopyJobCreates VM and file copy jobs.

VM and Guest OS Files Restore

VM and Guest OS Files Restore

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRRestoreSessionReturns restore sessions.

Remove-VBRRestoreSessionRemoves restore sessions. This cmdlet is obsolete and not supported.

Start-VBRHvRestoreVMStarts restore of an entire Hyper-V VM.

Start-VBRLinuxFileRestoreStarts a restore session of Linux-based or Unix-based guest OS files.

Start-VBRRestoreVMStarts restore of the entire VMware VM.

Start-VBRRestoreVMFilesRestores VM configuration files.

Start-VBRWindowsFileRestoreStarts Windows VM guest OS file restore session.

Start-VBRWindowsGuestItemRestoreStarts restore of Microsoft Windows guest OS files and folders to the original or new location.

Stop-VBRLinuxFileRestoreStops Linux-based or Unix-based guest OS files restore.

Stop-VBRWindowsFileRestoreStops Windows guest OS file restore session.

Instant Recovery

Instant Recovery

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRInstantRecoveryReturns running Instant Recovery sessions.

Restart-VBRInstantRecoveryRestarts a failed Hyper-V Instant Recovery session.

Start-VBRHvInstantRecoveryStarts Hyper-V Instant Recovery.

Start-VBRHvInstantRecoveryMigrationPerforms migration of instantly recovered VMs to a Hyper-V host.

Start-VBRInstantRecoveryStarts VMware Instant Recovery.

Start-VBRvCloudInstantRecoveryStarts an instant recovery of Cloud Director VMs

Stop-VBRInstantRecoveryStops running Instant Recovery sessions.

Backups

Backups

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Export-VBRBackupExports a backup or restore point files to a selected folder. This cmdlet is obsolete. Run the Copy-Item cmdlet instead.

Get-VBRBackupReturns backups.

Get-VBRImportedEncryptedBackup

Get-VBRImportedEncryptedBackupHint

Import-VBRBackupImports Veeam backups to Veeam Backup & Replication.

Remove-VBRBackupRemoves selected backups.

Remove-VBRRestorePointRemoves individual VMs from backup or replicas.

Set-VBREncryptedBackupPasswordDecrypts imported encrypted backups.

Restore Points

Restore Points

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRRestorePointReturns restore points.

Get-VBRFilesInRestorePointReturns backup files in a selected restore point.

Encryption Keys

Encryption Keys

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBREncryptionKeyCreates encryption key.

Get-VBREncryptionKeyReturns encryption keys.

Set-VBREncryptionKeyModifies encryption key.

Remove-VBREncryptionKeyRemoves encryption key.

Credentials

Credentials

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCredentialsCreates credentials records.

Get-VBRCredentialsReturns credentials records.

Remove-VBRCredentialsRemoves credentials records from Veeam Backup & Replication.

Set-VBRCredentialsModifies credentials records properties.

Sessions

Sessions

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRBackupSessionReturns jobs sessions.

Get-VBRSessionReturns job sessions.

Get-VBRTaskSessionReturns tasks performed during job sessions.

Get-VBRRestoreSessionReturns restore sessions.

Remove-VBRRestoreSessionRemoves restore sessions. This cmdlet is obsolete and not supported.

SQL Restore

SQL Restore

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRApplicationRestorePointReturns restore points created with the VSS-aware image processing enabled.

Get-VBRSQLDatabase

Get-VBRSQLDatabaseRestoreInterval

Start-VBRSQLDatabaseRestore

Oracle Restore

Oracle Restore

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBROracleDatabase

Get-VBROracleDatabaseRestoreInterval

Start-VBROracleDatabaseRestore

Tape Device Support

Tape Device Support

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRBackupToTapeJobCreates a backup to tape job or a GFS job.

Add-VBRFileToTapeJobCreates a file to tape job or a GFS file to tape job.

Add-VBRTapeGFSMediaPoolCreates a new GFS media pool.

Add-VBRTapeMediaPoolCreates a new media pool.

Add-VBRTapeServerAdds a tape server to Veeam Backup & Replication.

Add-VBRTapeVaultCreates a tape vault.

Disable-VBRTapeDriveDisables a selected tape library drive.

Disable-VBRTapeProtectionDisables protection set for tapes.

Eject-VBRTapeMediumEjects tapes from drive.

Enable-VBRTapeDriveEnables a selected tape library drive.

Enable-VBRTapeProtectionSets overwrite protection for selected tapes.

Erase-VBRTapeMediumErases data from tape.

Export-VBRTapeMediumMoves tapes to Import and Export slot.

Get-VBRTapeDriveReturns tape drives.

Get-VBRTapeJobReturns tape jobs.

Get-VBRTapeLibraryReturns tape libraries.

Get-VBRTapeMediaPoolReturns media pools.

Get-VBRTapeMediumReturns tapes.

Get-VBRTapeServerReturns tape servers.

Get-VBRTapeVaultReturns tape vaults.

Import-VBRTapeMediumImports tapes into library.

Move-VBRTapeMediumMoves a tape to media pool or vault.

New-VBRBackupToTapeScheduleOptionsCreates schedule settings for backup to tape job.

New-VBRFileToTapeBackupPolicyCreates schedule settings for a file to tape job.

New-VBRFileToTapeObjectDefines settings of the source for the files to tape job.

New-VBRFullBackupToTapePolicyCreates schedule settings for creating virtual synthesized full backup for tape.

New-VBRTapeGFSMediaSetPolicyCreates a new VBRTapeGFSMediaSetPolicy object.

New-VBRTapeGFSScheduleOptionsCreates new GFS schedule settings.

New-VBRTapeMediaPoolRetentionPolicyDefines retention settings of a media pool.

New-VBRTapeMediaSetCreationPolicyDefines a set of rules for creating media sets.

Remove-VBRTapeLibraryRemoves a specified tape library from Veeam Backup & Replication.

Remove-VBRTapeMediaPoolRemoves a media pool.

Remove-VBRTapeMediumRemoves the selected tapes from tape catalog.

Remove-VBRTapeServerRemoves a specified tape server from the backup infrastructure.

Remove-VBRTapeVaultRemoves a specified tape vault from the backup infrastructure.

Set-VBRBackupToTapeJobModifies a backup to tape job or a GFS job.

Set-VBRFileToTapeJobModifies a file to tape job or a GFS file to tape job.

Set-VBRTapeGFSMediaPoolModifies a GFS media pool.

Set-VBRTapeGFSScheduleOptionsModifies GFS scheduling options.

Set-VBRTapeLibraryModifies a tape library.

Set-VBRTapeMediaPoolModifies a media pool.

Set-VBRTapeMediumModifies tape properties.

Set-VBRTapeServerModifies tape servers.

Set-VBRTapeVaultModifies a tape vault.

Start-VBRTapeCatalogStarts tape catalog process.

Start-VBRTapeInventoryStarts tape inventory.

Sync-VBRBackupToTapeJobStarts an active full for a selected GFS backup to tape job.

VMware Cloud Director

VMware Cloud Director

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRvCloudAdds a Cloud Director server to Veeam Backup & Replication.

Add-VBRvCloudBackupCopyJobCreates a Cloud Director backup copy job. This cmdlet is obsolete and only works for creating a simple mode backup copy job. It is recommended to create a new backup job using the Add-VBRBackupCopyJob cmdlet.

Add-VBRvCloudJobCreates a Cloud Director backup job.

Add-VBRvCloudVCAdds vCenter Server managed by Cloud Director to Veeam Backup & Replication.

Find-VBRvCloudEntityLooks for Cloud Director entities.

New-VBRvCloudVAppRestoreSettingsCreates a set of vApp restore parameters.

Remove-VBRServerRemoves hosts from the backup infrastructure.

Start-VBRvCloudInstantRecoveryStarts an instant recovery of Cloud Director VMs

Start-VBRvCloudRestoreVAppStarts a vApp restore.

Start-VBRvCloudRestoreVmStarts a Cloud Director VM restore.

Veeam Cloud Connect - Service Provider

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

Veeam Cloud Connect - Service Provider

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCloudGatewayCreates cloud gateways for Veeam Cloud Connect.

Add-VBRCloudGatewayCertificateAssigns a TLS certificate to the service provider.

Add-VBRCloudPublicIPAdds public IP address or a pool of IP addresses.

Add-VBRCloudSubTenantCreates cloud subtenant accounts.

Add-VBRCloudTenantCreates standalone tenant accounts.

Add-VBRHvCloudHardwarePlanCreates Hyper-V hardware plans.

Disable-VBRCloudGatewayDisables cloud gateways.

Disable-VBRCloudSubTenantDisables cloud subtenant accounts.

Disable-VBRCloudTenantDisables cloud tenant accounts.

Enable-VBRCloudGatewayEnables disabled cloud gateways.

Enable-VBRCloudSubTenantEnables disabled cloud subtenant accounts.

Enable-VBRCloudTenantEnables disabled cloud tenant accounts.

Get-VBRCloudGatewayReturns cloud gateways.

Get-VBRCloudGatewayCertificateReturns TLS certificates.

Get-VBRCloudHardwarePlanReturns existing hardware plans.

Get-VBRCloudPublicIPReturns existing public IP addresses.

Get-VBRCloudSubTenantReturns cloud subtenant accounts.

Get-VBRCloudTenantReturns cloud tenant accounts.

Get-VBRCloudTenantNetworkApplianceReturns network extension appliances.

Get-VBRCloudVLANConfigurationReturns reserved VLAN ranges.

Get-VBRViVirtualSwitchReturns VMware virtual switches.

New-VBRCloudSubTenantResourceCreates quotas of cloud subtenant resources.

New-VBRCloudTenantHwPlanOptionsCreates the VBRCloudTenantHwPlanOptions objects that contains hardware plan options.

New-VBRCloudTenantReplicationResourcesCreates the VBRCloudTenantReplicationResources objects that contain replication resources.

New-VBRCloudTenantResourceCreates the VBRCloudTenantResource objects that contain backup resources.

New-VBRCloudVLANConfigurationCreates pools of VLANs that will be reserved for Veeam Cloud Connect.

New-VBRHvCloudHWPlanDatastoreCreates Hyper-V cloud storage for tenants replication resources.

Remove-VBRCloudGatewayRemoves cloud gateways.

Remove-VBRCloudHardwarePlanRemoves hardware plans.

Remove-VBRCloudPublicIPRemoves IP addresses from public IP addresses pools.

Remove-VBRCloudSubTenantRemoves cloud subtenant accounts.

Remove-VBRCloudTenantRemoves cloud tenant accounts.

Remove-VBRCloudVLANConfigurationRemoves pools of VLANs reserved for Veeam Backup & Replication.

Reset-VBRCloudTenantResets licenses for cloud account tenants.

Set-VBRCloudGatewayModifies cloud gateways.

Set-VBRCloudSubTenantModifies settings of cloud subtenant accounts.

Set-VBRCloudSubTenantResourceModifies quotas of cloud subtenant resources settings.

Set-VBRCloudTenantModifies settings for standalone tenant accounts.

Set-VBRCloudTenantNetworkApplianceModifies a network extension appliance.

Set-VBRCloudTenantResourceModifies tenants backup resources settings.

Set-VBRCloudVLANConfigurationModifies pools of VLANs reserved for Veeam Cloud Connect.

Set-VBRHvCloudHardwarePlanModifies Hyper-V hardware plans.

Set-VBRHvCloudHWPlanDatastoreModifies Hyper-V cloud storage for tenants replication resources.

Enable-VBRCloudMaintenanceModeEnables Maintenance mode for the cloud infrastructure.

Disable-VBRCloudMaintenanceModeDisables Maintenance mode for the cloud infrastructure.

Get-VBRCloudInfrastructureStateReturns the current state of the cloud infrastructure.

Veeam Cloud Connect - Cloud User

Veeam Cloud Connect - Cloud User

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRCloudProviderAdds cloud service providers.

Add-VBRCloudSubUserCreates cloud subuser accounts.

Add-VBRHvCloudReplicaJobCreates a new Hyper-V cloud replication job.

Add-VBRViCloudReplicaJobCreates a new VMware cloud replication job.

Disable-VBRCloudSubUserDisables cloud subuser accounts.

Enable-VBRCloudSubUserEnables disabled cloud subuser accounts.

Get-VBRCloudDatastoreReturns datastores or disk volumes allocated to you under your cloud resources.

Get-VBRCloudProviderReturns service providers.

Get-VBRCloudProviderNetworkApplianceReturns network extension appliance configured on the user side.

Get-VBRCloudServerReturns cloud hosts allocated by a service provider.

Get-VBRCloudServerNetworkInfoReturns networks available in your cloud resources.

Get-VBRCloudSubUserReturns cloud subuser accounts.

Get-VBRDefaultGatewayConfigurationReturns configuration of default gateways.

New-VBRCloudFailoverPlanObjectDefines VM replicas that you want to add to a failover plan.

New-VBRCloudProviderNetworkApplianceCreates a network extension appliance on the user side.

New-VBRCloudSubUserResourceCreates quotas of cloud subuser resources.

New-VBRFailoverPlanPublicIPRuleCreates a rule for mapping public IP and ports to the internal IP and ports of the cloud replica VM.

Remove-VBRCloudProviderRemoves service providers.

Remove-VBRCloudSubUserRemoves cloud subuser accounts.

Remove-VBRDefaultGatewayRemoves default cloud gateways.

Set-VBRCloudFailoverPlanObjectModifies VMs in cloud failover plans.

Set-VBRCloudProviderModifies service providers.

Set-VBRCloudProviderNetworkApplianceModifies network extension appliances on user side.

Set-VBRCloudSubUserModifies settings of cloud subuser accounts.

Set-VBRCloudSubUserResourceModifies quotas of cloud subuser resources settings.

Set-VBRDefaultGatewayModifies cloud default gateways.

Set-VBRDefaultGatewayConfigurationModifies default gateway configuration.

Set-VBRHvCloudReplicaJobModifies a Hyper-V cloud replication job.

Set-VBRViCloudReplicaJobModifies a VMware cloud replication job.

Direct Restore to Microsoft Azure

Direct Restore to Microsoft Azure

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBRAzureAccountAdds a Microsoft Azure compute account to Veeam Backup & Replication.

Deploy-VBRAzureLinuxRestoreApplianceDeploys or removes helper appliances for restoring Linux VMs to Microsoft Azure.

Get-VBRAzureAccountReturns Microsoft Azure accounts added to Veeam Backup & Replication.

Get-VBRAzureCloudServiceReturns Microsoft Azure cloud services available for a subscription.

Get-VBRAzureLinuxRestoreApplianceReturns helper appliances for restoring Linux VMs to Microsoft Azure.

Get-VBRAzureLocationReturns geographic locations of Microsoft Azure datacenters available for a subscription.

Get-VBRAzureResourceGroupReturns Microsoft Azure resource groups available for a subscription.

Get-VBRAzureRestoreSessionReturns VM backup restore to Microsoft Azure sessions.

Get-VBRAzureStorageAccountReturns Microsoft Azure storage accounts available for a subscription.

Get-VBRAzureSubscriptionReturns subscriptions associated with a Microsoft Azure account.

Get-VBRAzureVirtualNetworkReturns Microsoft Azure virtual networks available for a subscription.

Get-VBRAzureVirtualNetworkSubnetReturns Microsoft Azure virtual network subnets available for a subscription.

Get-VBRAzureVMSizeReturns Microsoft Azure VM configuration options available for a subscription.

New-VBRAzureLinuxRestoreApplianceCreates helper appliances for restoring Linux VMs to Microsoft Azure.

Remove-VBRAzureAccountRemoves Microsoft Azure accounts from Veeam Backup & Replication.

Set-VBRAzureAccountModifies Microsoft Azure compute account added to Veeam Backup & Replication.

Set-VBRAzureLinuxRestoreApplianceModifies helper appliances for restoring Linux VMs to Microsoft Azure.

Start-VBRVMRestoreToAzureRestores VM backups to Microsoft Azure.

Stop-VBRVMRestoreToAzureStops running VM backup restore to Microsoft Azure sessions.

Veeam Agent for Microsoft Windows

Veeam Agent for Microsoft Windows

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VBREPBackupCopyJobThis cmdlet is obsolete and only works for creating a simple mode backup copy job. It is recommended to create a new backup job using the Add-VBRBackupCopyJob cmdlet. Creates backup copy jobs for Veeam Agent operating in a standalone mode.

Disable-VBREPJobDisables backup jobs run by Veeam Agent operating in the standalone mode.

Enable-VBREPJobEnables disabled backup jobs run by Veeam Agent operating in the standalone mode.

Get-VBREPJobReturns backup jobs run by Veeam Agent operating in the standalone mode.

Get-VBREPPermissionReturns user access permissions for backup repositories for Veeam Agent or Veeam Plug-in operating in the standalone mode.

Get-VBREPSessionReturns sessions of backup jobs run by Veeam Agent operating in a standalone mode.

Set-VBREPPermissionApplies user access permissions to backup repositories used by Veeam Agent or Veeam Plug-in operating in the standalone mode.

Start-VBREpInstantRecoveryStarts instant recovery of physical computers to virtual infrastructure.

Start-VBRRestoreVirtualDisksRestores disks from backups of physical or virtual machines and converts them to the VMDK, VHD or VHDX formats.

NetApp Storage Systems

NetApp Storage Systems

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-NetAppHostAdds NetApp storage systems to Veeam Backup & Replication.

Add-NetAppSnapshotCreates NetApp storage snapshots.

Get-NetAppHostReturns NetApp storage systems added to Veeam Backup & Replication.

Get-NetAppSnapshotReturns NetApp storage snapshots.

Get-NetAppVolumeReturns NetApp storage volumes added to the backup infrastructure.

New-VBRStorageProtocolPolicyCreates protocol policies for storage systems.

Remove-NetAppHostRemoves NetApp storage systems.

Remove-NetAppSnapshotRemoves NetApp storage snapshots.

Set-NetAppHostModifies NetApp storage system settings.

Sync-NetAppHostRescans NetApp storage systems.

Sync-NetAppVolumeRescans NetApp storage volumes added to the backup infrastructure.

HPE 3PAR StoreServ Storage Systems

HPE 3PAR StoreServ Storage Systems

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-HP3SnapshotCreates HPE 3PAR StoreServ storage snapshots.

Add-HP3StorageAdds HPE 3PAR StoreServ storage systems to Veeam Backup & Replication.

Get-HP3SnapshotReturns HPE 3PAR StoreServ storage snapshots.

Get-HP3StorageReturns HPE 3PAR StoreServ storage systems.

Get-HP3VolumeReturns HPE 3PAR StoreServ storage volumes added to the backup infrastructure.

Remove-HP3SnapshotRemoves HPE 3PAR StoreServ storage snapshots.

Remove-HP3StorageRemoves HPE 3PAR StoreServ storage systems.

Set-HP3StorageModifies settings of HPE 3PAR StoreServ storage systems.

Sync-HP3StorageRescans HPE 3PAR StoreServ storage systems.

Sync-HP3VolumeRescans HPE 3PAR StoreServ storage volumes added to the backup infrastructure.

Dell VNX Storage Systems

Dell VNX Storage Systems

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-VNXHostAdds Dell VNX storage systems to Veeam Backup & Replication.

Add-VNXSnapshotCreates Dell VNX storage snapshots.

Get-VNXHostReturns Dell VNX storage systems.

Get-VNXSnapshotReturns Dell VNX storage snapshots.

Get-VNXVolumeReturns Dell VNX volumes added to the backup infrastructure.

Remove-VNXHostRemoves Dell VNX storage systems from Veeam Backup & Replication.

Remove-VNXSnapshotRemoves Dell VNX storage snapshots.

Set-VNXHostModifies Dell VNX storage settings.

Sync-VNXHostRescans Dell VNX storage system.

Sync-VNXVolumeRescans Dell VNX storage volumes added to the backup infrastructure.

HPE Nimble Storage Systems

HPE Nimble Storage Systems

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Add-NimbleHostAdds HPE Nimble storage systems to Veeam Backup & Replication.

Add-NimbleSnapshotCreates HPE Nimble storage snapshots.

Get-NimbleHostReturns HPE Nimble storage systems.

Get-NimbleSnapshotReturns HPE Nimble storage snapshots.

Get-NimbleVolumeReturns HPE Nimble volumes added to the backup infrastructure.

Remove-NimbleHostRemoves HPE Nimble storage systems from Veeam Backup & Replication.

Remove-NimbleSnapshotRemoves HPE Nimble storage snapshots.

Set-NimbleHostModifies settings of HPE Nimble storage systems.

Sync-NimbleHostRescans HPE Nimble storage systems.

Sync-NimbleVolumeRescans HPE Nimble storage volumes added to the backup infrastructure.

Universal Storage API Integrated Systems

Universal Storage API Integrated Systems

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRStoragePluginReturns plug-ins for adding Universal Storage API integrated systems.

Get-StoragePluginHostReturns Universal Storage API integrated systems.

Add-StoragePluginHostAdds Universal Storage API integrated systems to Veeam Backup & Replication.

Set-StoragePluginHostModifies settings of Universal Storage API integrated systems.

Sync-StoragePluginHostRescans Universal Storage API integrated systems.

Remove-StoragePluginHostRemoves Universal Storage API integrated systems from Veeam Backup & Replication console.

Get-StoragePluginVolumeReturns volumes of Universal Storage API integrated systems added to the backup infrastructure.

Sync-StoragePluginVolumeRescans volumes of Universal Storage API integrated systems.

Add-StoragePluginSnapshotCreates snapshots of Universal Storage API integrated systems.

Get-StoragePluginSnapshotReturns snapshots of Universal Storage API integrated systems.

Remove-StoragePluginSnapshotRemoves snapshots of Universal Storage API integrated systems.

Logs Export

Logs Export

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Export-VBRLogsCollects system logs for export.

Veeam PowerShell Help

Veeam PowerShell Help

Cmdlet

Standard Edition

Enterprise Edition

Enterprise Plus Edition

Get-VBRCommandReturns Veeam PowerShell module cmdlets.

Get-VBRToolkitDocumentationOpens Veeam PowerShell online help.

Page updated 2026-09-03

Page content applies to build 13.1.1.18