Provides help resources for the Veeam Backup & Replication cmdlets.
In This Section
Operations | VMware | Hyper-V |
Returns Veeam cmdlets | ||
Opens Veeam Backup & Replication online help | ||
Send feedback | Updated on 4/4/2017
Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference
PowerShell Reference
- Getting Started
- Veeam PowerShell Reference
- A-Z Cmdlets List
- Veeam PowerShell Licensing
- Connecting to Veeam Backup Server
- Managing Infrastructure
- Servers
- Add-VBRvCenter
- Set-VBRvCenter
- Add-VBRESX
- Set-VBRESX
- Add-VBRESXi
- Set-VBRESXi
- Add-VBRHvScvmm
- Add-VBRHvCluster
- Add-VBRSmbV3Cluster
- Add-VBRSmbV3Host
- Add-VBRHvHost
- Add-VBRWinServer
- Add-VBRLinux
- Get-VBRLocalhost
- Get-VBRServer
- Remove-VBRServer
- Proxies
- Add-VBRViProxy
- Get-VBRViProxy
- Disable-VBRViProxy
- Enable-VBRViProxy
- Set-VBRViProxy
- Remove-VBRViProxy
- Add-VBRHvProxy
- Get-VBRHvProxy
- Disable-VBRHvProxy
- Enable-VBRHvProxy
- Remove-VBRHvProxy
- Get-VBRJobProxy
- Set-VBRJobProxy
- Backup Repositories
- Add-VBRBackupRepository
- Get-VBRBackupRepository
- Set-VBRBackupRepository
- Remove-VBRBackupRepository
- Sync-VBRBackupRepository
- Scale-Out Backup Repositories
- Add-VBRScaleOutBackupRepository
- Disable-VBRRepositoryExtentMaintenanceMode
- Enable-VBRRepositoryExtentMaintenanceMode
- Get-VBRRepositoryExtent
- Set-VBRRepositoryExtent
- Set-VBRScaleOutBackupRepository
- Start-VBRRepositoryExtentBackupEvacuation
- VMware Virtual Units
- Find-VBRViDatastore
- Find-VBRViDatastoreCluster
- Find-VBRViFolder
- Find-VBRViResourcePool
- Find-VBRViStoragePolicy
- Virtual Networks
- WAN Acceleration
- Configuration Backup
- New-VBRConfigurationBackupScheduleOptions
- Get-VBRConfigurationBackupJob
- Set-VBRConfigurationBackupJob
- Start-VBRConfigurationBackupJob
- Logs Export
- Backup Jobs
- Creating VMware Backup Job
- Creating Hyper-V Backup Job
- Add-VBRViBackupJob
- Add-VBRHvBackupJob
- Reset-HvVmChangeTracking
- Replication Jobs
- Creating VMware Replica Job
- Creating Hyper-V Replica Job
- Add-VBRViReplicaJob
- Set-VBRViReplicaJob
- Add-VBRHvReplicaJob
- Set-VBRHvReplicaJob
- Backup Copy Jobs
- Add-VBRViBackupCopyJob
- Add-VBRHvBackupCopyJob
- Add-VBRvCloudBackupCopyJob
- Add-VBREPBackupCopyJob
- Sync-VBRBackupCopyJob
- Managing Jobs
- VMs in Job
- Job Options
- Get-VBRJobOptions
- New-VBRJobOptions
- New-VBRJobScriptOptions
- New-VBRNotificationOptions
- Reset-VBRJobOptions
- Set-VBRJobOptions
- Job Schedule
- Disable-VBRJobSchedule
- Enable-VBRJobSchedule
- Get-VBRJobScheduleOptions
- New-VBRBackupWindowOptions
- New-VBRDailyOptions
- New-VBRJobScheduleOptions
- New-VBRMonthlyOptions
- Reset-VBRJobScheduleOptions
- Set-VBRBackupWindowOptions
- Set-VBRJobSchedule
- Set-VBRJobScheduleOptions
- Guest File System Indexing
- VSS Options
- Disable-VBRJobVSSIntegration
- Enable-VBRJobVSSIntegration
- Get-VBRJobObjectVssOptions
- Get-VBRJobVSSOptions
- New-VBRJobVssOptions
- Reset-VBRJobVssOptions
- Set-VBRJobObjectVssOptions
- Set-VBRJobVssOptions
- Advanced Job Options
- Set-VBRJobAdvancedBackupOptions
- Set-VBRJobAdvancedHvOptions
- Set-VBRJobAdvancedNotificationOptions
- Set-VBRJobAdvancedOptions
- Set-VBRJobAdvancedStorageOptions
- Set-VBRJobAdvancedViOptions
- Replica Re-IP Rules
- Failover Plans
- Performing Failover by Failover Plan
- New-VBRFailoverPlanObject
- Set-VBRFailoverPlanObject
- Add-VBRFailoverPlan
- Get-VBRFailoverPlan
- Set-VBRFailoverPlan
- Remove-VBRFailoverPlan
- Start-VBRFailoverPlan
- Undo-VBRFailoverPlan
- Failover and Failback
- Start-VBRViReplicaFailover
- Start-VBRViReplicaFailback
- Stop-VBRViReplicaFailback
- Start-VBRHvReplicaFailover
- Start-VBRHvReplicaFailback
- Stop-VBRHvReplicaFailback
- Stop-VBRReplicaFailover
- Backups
- Get-VBRBackup
- Remove-VBRBackup
- Remove-VBRRestorePoint
- Import-VBRBackup
- Export-VBRBackup
- Set-VBREncryptedBackupPassword
- Get-VBRImportedEncryptedBackup
- Get-VBRImportedEncryptedBackupHint
- Restore Points
- Replicas
- VM Copy
- Quick Backup
- VeeamZIP
- Quick Migration
- Encryption
- Credentials
- Sessions
- SureBackup Virtual Labs
- Working with VMware Virtual Lab
- Working with Hyper-V Virtual Lab
- Add-VSBHvVirtualLab
- Add-VSBVirtualLab
- Connect-VSBHvVirtualLab
- Connect-VSBVirtualLab
- Find-VSBHvVirtualLab
- Find-VSBVirtualLab
- Get-VSBHvVirtualLab
- Get-VSBVirtualLab
- Remove-VSBHvVirtualLab
- Remove-VSBVirtualLab
- SureBackup Application Groups
- Working with VMware Application Group
- Working with Hyper-V Application Group
- Add-VSBHvApplicationGroup
- Add-VSBViApplicationGroup
- Get-VSBApplicationGroup
- Remove-VSBApplicationGroup
- SureBackup Jobs
- Administering VMware SureBackup Job
- Adminestering Hyper-V SureBackup Job
- Add-VSBHvJob
- Add-VSBJob
- Disable-VSBJob
- Disable-VSBJobSchedule
- Enable-VSBJob
- Enable-VSBJobSchedule
- Get-VSBJob
- Get-VSBJobOptions
- Get-VSBJobScheduleOptions
- Get-VSBSession
- Get-VSBTaskSession
- New-VSBJobOptions
- Remove-VSBJob
- Reset-VSBJobOptions
- Set-VSBJobOptions
- Set-VSBJobSchedule
- Set-VSBJobScheduleOptions
- Start-VSBJob
- Stop-VSBJob
- VM Restore
- Instant VM Recovery
- Performing Instant Recovery of a VMware VM
- Performing Instant Recovery of a Hyper-V VM
- Start-VBRInstantRecovery
- Start-VBRHvInstantRecovery
- Restart-VBRInstantRecovery
- Start-VBRHvInstantRecoveryMigration
- Get-VBRInstantRecovery
- Stop-VBRInstantRecovery
- Guest OS Files Restore
- Start-VBRWindowsFileRestore
- Stop-VBRWindowsFileRestore
- Start-VBRLinuxFileRestore
- Stop-VBRLinuxFileRestore
- Start-VBRWindowsGuestItemRestore
- Oracle Restore
- SQL Restore
- Get-VBRApplicationRestorePoint
- Get-VBRSQLDatabase
- Get-VBRSQLDatabaseRestoreInterval
- Start-VBRSQLDatabaseRestore
- Tape Servers
- Tape Media Pools
- Add-VBRTapeMediaPool
- New-VBRTapeMediaPoolRetentionPolicy
- New-VBRTapeMediaSetCreationPolicy
- Set-VBRTapeMediaPool
- Add-VBRTapeGFSMediaPool
- New-VBRTapeGFSMediaSetPolicy
- Set-VBRTapeGFSMediaPool
- Get-VBRTapeMediaPool
- Remove-VBRTapeMediaPool
- Tape Vaults
- Tape Libraries
- Tape Drives
- Tape Jobs
- Add-VBRBackupToTapeJob
- Add-VBRFileToTapeJob
- Get-VBRTapeJob
- New-VBRBackupToTapeScheduleOptions
- New-VBRFileToTapeBackupPolicy
- New-VBRFileToTapeObject
- New-VBRFullBackupToTapePolicy
- New-VBRTapeGFSScheduleOptions
- Set-VBRBackupToTapeJob
- Set-VBRFileToTapeJob
- Set-VBRTapeGFSScheduleOptions
- Sync-VBRBackupToTapeJob
- Tapes
- Disable-VBRTapeProtection
- Eject-VBRTapeMedium
- Enable-VBRTapeProtection
- Erase-VBRTapeMedium
- Export-VBRTapeMedium
- Get-VBRTapeMedium
- Import-VBRTapeMedium
- Move-VBRTapeMedium
- Remove-VBRTapeMedium
- Set-VBRTapeMedium
- VMware vCloud Director
- Add-VBRvCloud
- Add-VBRvCloudBackupCopyJob
- Add-VBRvCloudJob
- Add-VBRvCloudVC
- Find-VBRvCloudEntity
- New-VBRvCloudVAppRestoreSettings
- Start-VBRvCloudInstantRecovery
- Start-VBRvCloudRestoreVApp
- Start-VBRvCloudRestoreVm
- Set-VBRvCloudOrganizationJobMapping
- Veeam Cloud Connect SSL Certificates
- Veeam Cloud Connect Cloud Gateways
- Add-VBRCloudGateway
- Get-VBRCloudGateway
- Disable-VBRCloudGateway
- Enable-VBRCloudGateway
- Set-VBRCloudGateway
- Remove-VBRCloudGateway
- Veeam Cloud Connect Tenants Accounts
- Add-VBRCloudTenant
- Get-VBRCloudTenant
- Enable-VBRCloudTenant
- Disable-VBRCloudTenant
- Set-VBRCloudTenant
- Reset-VBRCloudTenant
- Remove-VBRCloudTenant
- Veeam Cloud Connect Hardware Plans
- Add-VBRViCloudHardwarePlan
- Set-VBRViCloudHardwarePlan
- Add-VBRHvCloudHardwarePlan
- Set-VBRHvCloudHardwarePlan
- Get-VBRCloudHardwarePlan
- Remove-VBRCloudHardwarePlan
- New-VBRViCloudHWPlanDatastore
- Set-VBRViCloudHWPlanDatastore
- New-VBRHvCloudHWPlanDatastore
- Set-VBRHvCloudHWPlanDatastore
- Get-VBRViVirtualSwitch
- Remove-VBRCloudVLANConfiguration
- Set-VBRCloudVLANConfiguration
- Get-VBRCloudVLANConfiguration
- New-VBRCloudVLANConfiguration
- Veeam Cloud Connect Backup Resources
- Veeam Cloud Connect Replication Resources
- New-VBRCloudTenantReplicationResources
- New-VBRCloudTenantHwPlanOptions
- Set-VBRCloudTenantNetworkAppliance
- Get-VBRCloudTenantNetworkAppliance
- Remove-VBRCloudPublicIP
- Get-VBRCloudPublicIP
- Add-VBRCloudPublicIP
- Veeam Cloud Connect Subtenants
- New-VBRCloudSubTenantResource
- Set-VBRCloudSubTenantResource
- Add-VBRCloudSubTenant
- Get-VBRCloudSubTenant
- Set-VBRCloudSubTenant
- Remove-VBRCloudSubTenant
- Disable-VBRCloudSubTenant
- Enable-VBRCloudSubTenant
- Veeam Cloud Connect Service Provider
- Veeam Cloud Connect Network Appliances
- New-VBRCloudProviderNetworkAppliance
- Get-VBRCloudProviderNetworkAppliance
- Set-VBRCloudProviderNetworkAppliance
- Veeam Cloud Connect Replication
- Add-VBRViCloudReplicaJob
- Set-VBRViCloudReplicaJob
- Add-VBRHvCloudReplicaJob
- Set-VBRHvCloudReplicaJob
- Get-VBRCloudDatastore
- Get-VBRCloudServer
- Get-VBRCloudServerNetworkInfo
- Veeam Cloud Connect Failover Plans
- New-VBRCloudFailoverPlanObject
- Set-VBRCloudFailoverPlanObject
- Get-VBRDefaultGatewayConfiguration
- Set-VBRDefaultGatewayConfiguration
- Set-VBRDefaultGateway
- Remove-VBRDefaultGateway
- New-VBRFailoverPlanPublicIPRule
- Veeam Cloud Connect Subusers
- New-VBRCloudSubUserResource
- Set-VBRCloudSubUserResource
- Add-VBRCloudSubUser
- Get-VBRCloudSubUser
- Set-VBRCloudSubUser
- Remove-VBRCloudSubUser
- Disable-VBRCloudSubUser
- Enable-VBRCloudSubUser
- Direct Restore to Microsoft Azure
- Add-VBRAzureAccount
- Get-VBRAzureAccount
- Set-VBRAzureAccount
- Remove-VBRAzureAccount
- Get-VBRAzureSubscription
- Get-VBRAzureCloudService
- Get-VBRAzureLocation
- Get-VBRAzureResourceGroup
- Get-VBRAzureStorageAccount
- Get-VBRAzureVirtualNetwork
- Get-VBRAzureVirtualNetworkSubnet
- Get-VBRAzureVMSize
- New-VBRAzureLinuxRestoreAppliance
- Get-VBRAzureLinuxRestoreAppliance
- Set-VBRAzureLinuxRestoreAppliance
- Deploy-VBRAzureLinuxRestoreAppliance
- Get-VBRAzureApplicanceSession
- Start-VBRVMRestoreToAzure
- Get-VBRAzureRestoreSession
- Stop-VBRVMRestoreToAzure
- NetApp Storages
- Add-NetAppHost
- Get-NetAppHost
- Set-NetAppHost
- Sync-NetAppHost
- Remove-NetAppHost
- Get-NetAppVolume
- Sync-NetAppVolume
- Add-NetAppSnapshot
- Get-NetAppSnapshot
- Remove-NetAppSnapshot
- HPE 3PAR StoreServ Storages
- Add-HP3Storage
- Get-HP3Storage
- Set-HP3Storage
- Sync-HP3Storage
- Remove-HP3Storage
- Get-HP3Volume
- Sync-HP3Volume
- Add-HP3Snapshot
- Get-HP3Snapshot
- Remove-HP3Snapshot
- New-VBRStorageProtocolPolicy
- HPE StoreVirtual Storages
- Add-HP4Storage
- Get-HP4Storage
- Set-HP4Storage
- Sync-HP4Storage
- Remove-HP4Storage
- Get-HP4Cluster
- Get-HP4Volume
- Sync-HP4Volume
- Add-HP4Snapshot
- Get-HP4Snapshot
- Remove-HP4Snapshot
- DELL EMC VNX Storages
- Add-VNXHost
- Get-VNXHost
- Set-VNXHost
- Sync-VNXHost
- Remove-VNXHost
- Get-VNXVolume
- Sync-VNXVolume
- Add-VNXSnapshot
- Get-VNXSnapshot
- Remove-VNXSnapshot
- Nimble Storages
- Add-NimbleHost
- Get-NimbleHost
- Set-NimbleHost
- Sync-NimbleHost
- Remove-NimbleHost
- Get-NimbleVolume
- Sync-NimbleVolume
- Add-NimbleSnapshot
- Get-NimbleSnapshot
- Remove-NimbleSnapshot
- Veeam Endpoint Backup
- Get-VBREPPermission
- Set-VBREPPermission
- Get-VBREPJob
- Disable-VBREPJob
- Enable-VBREPJob
- Get-VBREPSession
- Add-VBREPBackupCopyJob
- Start-VBRRestoreVirtualDisks
- Start-VBREpInstantRecovery
- Veeam PowerShell Help
- Veeam PowerShell Enumerations
- Veeam PowerShell Types
- PSCryptoKey
- VBRApplicationRestorePoint
- VBRAzureAccount
- VBRAzureApplianceSession
- VBRAzureCloudService
- VBRAzureLinuxRestoreAppliance
- VBRAzureLocation
- VBRAzureNetworkSubnet
- VBRAzureResourceGroup
- VBRAzureRestoreSession
- VBRAzureStorageAccount
- VBRAzureSubscription
- VBRAzureVirtualNetwork
- VBRAzureVMSize
- VBRBackupSession
- VBRBackupToTapeJob
- VBRBackupToTapeScheduleOptions
- VBRCloudCertificate
- VBRCloudDatastore
- VBRCloudDatastoreQuota
- VBRCloudFailoverPlan
- VBRCloudFailoverPlanObject
- VBRCloudGateway
- VBRCloudIP
- VBRCloudProvider
- VBRCloudProviderDatastore
- VBRCloudProviderReplicationResource
- VBRCloudProviderResource
- VBRCloudServer
- VBRCloudServerNetworkInfo
- VBRCloudSubTenant
- VBRCloudSubtenantResource
- VBRCloudSubUser
- VBRCloudSubUserResource
- VBRCloudTenant
- VBRCloudTenantHwPlanOptions
- VBRCloudTenantNetworkAppliance
- VBRCloudTenantReplicationResources
- VBRCloudTenantResource
- VBRCloudVLANConfiguration
- VBRConfigurationBackupJob
- VBRConfigurationBackupScheduleOptions
- VBRDailyOptions
- VBRDatabaseRestoreInterval
- VBRDataLocalityExtent
- VBRDefaultGateway
- VBRDefaultGatewayConfiguration
- VBREncryptionOptions
- VBREPJob
- VBREPPermission
- VBRFailoverPlan
- VBRFailoverPlanObject
- VBRFailoverPlanPublicIPRule
- VBRFileToTapeBackupPolicy
- VBRFileToTapeJob
- VBRFileToTapeObject
- VBRFullBackupToTapePolicy
- VBRGlobalMediaPoolOptions
- VBRHvCloudHardwarePlan
- VBRHvCloudHardwarePlanDatastore
- VBRHvCloudProviderNetworkAppliance
- VBRHvReplicaReIpRule
- VBRHvServerNetworkInfo
- VBRHvReplicaReIpRule
- VBRJob
- VBRJobScriptOptions
- VBRLogItem
- VBRMonthlyOptions
- VBRMultiStreamingOptions
- VBRNotificationOptions
- VBROracleDatabase
- VBROracleDatabaseRestoreInterval
- VBRPerformanceExtent
- VBRRepositoryExtent
- VBRScaleOutBackupRepository
- VBRSession
- VBRSQLDatabase
- VBRStorageProtocolPolicy
- VBRTapeDrive
- VBRTapeGFSMediaPool
- VBRTapeGFSMediaSetOptions
- VBRTapeGFSMediaSetPolicy
- VBRTapeGFSScheduleMonthlyOptions
- VBRTapeGFSScheduleOptions
- VBRTapeGFSScheduleQuarterlyOptions
- VBRTapeGFSScheduleWeeklyOptions
- VBRTapeGFSScheduleYearlyOptions
- VBRTapeLibrary
- VBRTapeMediaPool
- VBRTapeMediaPoolRetentionPolicy
- VBRTapeMediaSet
- VBRTapeMediaSetCreationPolicy
- VBRTapeMedium
- VBRTapeServer
- VBRTapeVault
- VBRTenantFailoverPlan
- VBRViCloudHardwarePlan
- VBRViCloudHardwarePlanDatastore
- VBRViCloudProviderNetworkAppliance
- VBRViDatastoreCluster
- VBRViDVSNetworkInfo
- VBRViNetworkInfo
- VBRViReplicaReIpRule
- VBRViStoragePolicy
- VBRViVirtualSwitch
- Obsolete Cmdlets
- Add-VBRBackupJob (obsolete)
- Add-VBRJobObject (obsolete)
- Add-VBRReplicaJob (obsolete)
- Add-VBRTapeFilesJob (obsolete)
- Add-VBRTapeVMJob (obsolete)
- Add-VSBApplicationGroup (obsolete)
- Eject-VBRTapeDrive (obsolete)
- Export-VBRConfiguration (obsolete)
- Find-VBRDatastore (obsolete)
- Find-VBRObject (obsolete)
- Find-VBRResourcePool (obsolete)
- Find-VBRTapeCatalog (obsolete)
- Find-VBRTapeCatalogVersion (obsolete)
- Get-VBRTapeBackup (obsolete)
- Get-VBRTapeMediaPoolOptions (obsolete)
- Import-VBRConfiguration (obsolete)
- Remove-VBRBackupSession (obsolete)
- Remove-VBRRestoreSession (obsolete)
- Remove-VSBSession (obsolete)
- Start-VBRReplicaFailover (obsolete)
- Start-VBRTapeRestore (obsolete)
- Start-VBRTapeRestoreFiles (obsolete)
- How to
- How to Change Cloud Repository Name Displayed to Tenant
- How to Add ESXi Host to VBR
- How to Add VMware vCenter Server to VBR
- How to Add Hyper-V Host to VBR
- How to Add Hyper-V Cluster to VBR
- How to Assign SSL Certificate to Service Provider
- How to Configure VLANs for VMware Cloud Hardware Plan
- How to Configure VLANs for Hyper-V Cloud Hardware Plan
- How to Create VMware Cloud Hardware Plan
- How to Create Hyper-V Cloud Hardware Plan
- Revision History
