Veeam Backup & Replication 11
Veeam PowerShell Reference

Related documents

User Guide for VMware vSphere User Guide for Microsoft Hyper-V Veeam Backup Enterprise Manager Guide Veeam Agent Management Guide Veeam Cloud Connect Guide Veeam Explorers User Guide Veeam Plug-ins for Enterprise Applications Guide Integration with Veeam Backup for Google Cloud Platform Guide Integration with Veeam Backup for AWS Guide Integration with Veeam Backup for Microsoft Azure Guide Veeam Explorers PowerShell Reference REST API Reference Veeam Backup Enterprise Manager REST API Reference Required Permissions for VMware vSphere Quick Start Guide for VMware vSphere Quick Start Guide for Microsoft Hyper-V Veeam Backup & Replication for Nutanix Mine Guide

See more documents

Veeam ONE Documentation Veeam Backup for Microsoft Office 365 Documentation Veeam Agent for Microsoft Windows Documentation Veeam Agent for Linux Documentation Veeam Agent for Mac Documentation Veeam Agent for IBM AIX Documentation Veeam Agent for Oracle Solaris Documentation Veeam Backup for Google Cloud Platform Documentation Veeam Backup for AWS Documentation Veeam Backup for Microsoft Azure Documentation Veeam Backup for Nutanix AHV Documentation Veeam Management Pack Documentation Veeam Veeam Availability Orchestrator Documentation

Search

Veeam Backup & Replication 11
Veeam PowerShell Reference

Getting Started

Understanding Veeam Cmdlets
Using Get-VBRCommand
Using Get-Help
Examples of Use

Veeam PowerShell Reference

A-Z Cmdlets List
Veeam PowerShell Licensing
Connecting to Veeam Backup Server

Connect-VBRServer
Disconnect-VBRServer
Get-VBRServerSession

Licenses

Install-VBRLicense
Get-VBRInstalledLicense
Uninstall-VBRLicense
Update-VBRLicense
Generate-VBRLicenseUsageReport
Get-VBRSocketLicenseSummary
Get-VBRInstanceLicenseSummary
Get-VBRLicensedSocketWorkload
Get-VBRLicensedInstanceWorkload
Enable-VBRFreeAgentInstanceConsumption
Get-VBRFreeAgentInstanceConsumptionStatus
Disable-VBRFreeAgentInstanceConsumption
Enable-VBRLicenseAutoUpdate
Get-VBRLicenseAutoUpdateStatus
Disable-VBRLicenseAutoUpdate
Assign-VBRInstanceWorkload

Reports

Export-VBRAudit

Backup Infrastructure

Managing Infrastructure

Find-VBRViEntity
Find-VBRHvEntity
Rescan-VBREntity

VMware Virtual Units

Find-VBRViDatastore
Find-VBRViDatastoreCluster
Find-VBRViFolder
Find-VBRViResourcePool
Find-VBRViStoragePolicy

Virtual Networks

Get-VBRViServerNetworkInfo
Get-VBRHvServerNetworkInfo

Servers

Add-VBRvCenter
Set-VBRvCenter
Add-VBRESXi
Set-VBRESXi
Add-VBRHvScvmm
Add-VBRHvCluster
Add-VBRSmbV3Cluster
Add-VBRSmbV3Host
Add-VBRHvHost
Add-VBRWinServer
Add-VBRLinux
Set-VBRLinux
Get-VBRLocalhost
Get-VBRServer
Remove-VBRServer
Get-VBRHvServerConfiguration
Set-VBRHvServerConfiguration
Get-VBRHvServerVolume
Get-VBRHvVssProvider
Set-VBRHvServerVolume

Credentials

Add-VBRCredentials
Get-VBRCredentials
Set-VBRCredentials
Remove-VBRCredentials

Proxies

Add-VBRViProxy
Get-VBRViProxy
Disable-VBRViProxy
Enable-VBRViProxy
Set-VBRViProxy
Remove-VBRViProxy
Add-VBRHvProxy
Get-VBRHvProxy
Disable-VBRHvProxy
Enable-VBRHvProxy
Remove-VBRHvProxy
Add-VBRViLinuxProxy
Set-VBRViLinuxProxy
Get-VBRJobProxy
Set-VBRJobProxy

Backup Repositories

Add-VBRBackupRepository
Get-VBRBackupRepository
Set-VBRBackupRepository
Remove-VBRBackupRepository
Sync-VBRBackupRepository
Set-VBRImmutabilityLockExpirationDate

External Repositories

Add-VBRAmazonS3ExternalRepository
Set-VBRAmazonS3ExternalRepository
Add-VBRAzureExternalRepository
Set-VBRAzureExternalRepository
Get-VBRExternalRepository
Remove-VBRExternalRepository

Scale-Out Backup Repositories

Add-VBRScaleOutBackupRepository
Set-VBRScaleOutBackupRepository
Send-VBRScaleOutBackupRepositoryReport
Performance Tier

Get-VBRRepositoryExtent
Set-VBRRepositoryExtent
Enable-VBRRepositoryExtentMaintenanceMode
Disable-VBRRepositoryExtentMaintenanceMode
Enable-VBRRepositoryExtentSealedMode
Disable-VBRRepositoryExtentSealedMode
Start-VBRRepositoryExtentBackupEvacuation

Capacity Tier

Get-VBRCapacityExtent
Enable-VBRCapacityExtentMaintenanceMode
Disable-VBRCapacityExtentMaintenanceMode
Enable-VBRCapacityExtentSealedMode
Disable-VBRCapacityExtentSealedMode
Start-VBRCapacityTierSync
Start-VBRDownloadBackup

Archive Tier

Get-VBRArchiveExtent
Enable-VBRArchiveExtentMaintenanceMode
Disable-VBRArchiveExtentMaintenanceMode
Enable-VBRArchiveExtentSealedMode
Disable-VBRArchiveExtentSealedMode
Publish-VBRArchiveRestorePoint
Add-VBRArchiveBackupAvailabilityPeriod
Get-VBRCloudArchiveRestorePoint
Publish-VBRCloudArchiveRestorePoint
Add-VBRCloudArchiveBackupAvailabilityPeriod
Start-VBRArchiveTierSync

Immutability

Sync-VBRSOBREntityState
Get-VBRCapacityTierSyncInterval
Get-VBRArchiveTierSyncInterval

NDMP Servers

Add-VBRNDMPServer
Set-VBRNDMPServer
Get-VBRNDMPServer
Remove-VBRNDMPServer

Object Storage Repositories

Amazon

Add-VBRAmazonS3Repository
Add-VBRAmazonS3CompatibleRepository
Add-VBRAmazonS3GlacierRepository
Set-VBRAmazonS3Repository
Set-VBRAmazonS3CompatibleRepository
Set-VBRAmazonS3GlacierRepository

Azure

Add-VBRAzureDataBoxRepository
Add-VBRAzureBlobRepository
Add-VBRAzureArchiveRepository
New-VBRAzureComputeProxyAppliance
Set-VBRAzureDataBoxRepository
Set-VBRAzureBlobRepository
Set-VBRAzureArchiveRepository

Google Cloud

Add-VBRGoogleCloudRepository
Set-VBRGoogleCloudRepository

Managing Object Storage Repositories

Get-VBRObjectStorageRepository
Unmount-VBRObjectStorageRepository
Mount-VBRObjectStorageRepository
Remove-VBRArchiveObjectStorageRepository
Remove-VBRObjectStorageRepository
Get-VBRArchiveObjectStorageRepository

Network Traffic Rules

Add-VBRNetworkTrafficRule
Set-VBRNetworkTrafficRule
Get-VBRNetworkTrafficRule
Remove-VBRNetworkTrafficRule
Add-VBRPreferredNetwork
Get-VBRPreferredNetwork
Remove-VBRPreferredNetwork
Enable-VBRPreferredNetworkDataTransfer
Disable-VBRPreferredNetworkDataTransfer
Get-VBRUploadStreamsConfiguration
Set-VBRUploadStreamsConfiguration

Locations

Get-VBRLocation
Add-VBRLocation
Set-VBRLocation
Remove-VBRLocation
Apply-VBRLocation
Export-VBRLocation
Import-VBRLocation

Logs Export

Export-VBRLogs
Get-VBRExportLogSession

Managing Backups

Get-VBRBackup
Get-VBRBackupFile
Remove-VBRBackup
Remove-VBRBackupFile
Import-VBRBackup
Start-VBRDownloadBackupFile
Start-VBROffloadBackupFile
Set-VBREncryptedBackupPassword
Get-VBRImportedEncryptedBackup
Get-VBRImportedEncryptedBackupHint
Start-VBRDownloadTenantBackup
Get-VBRCloudUnavailableBackupFile
Forget-VBRCloudUnavailableBackupFile

Managing Restore Points

Get-VBRFilesInRestorePoint
Get-VBRRestorePoint
Remove-VBRRestorePoint
Get-VBRApplicationRestorePoint
Export-VBRRestorePoint

Encryption

Add-VBREncryptionKey
Get-VBREncryptionKey
Remove-VBREncryptionKey
Set-VBREncryptionKey

Server Components Upgrade

Get-VBRPhysicalHost
Update-VBRServerComponent

Veeam Backup & Replication Settings

Specifying I/O Control Settings

Get-VBRStorageLatencyControlOptions
Set-VBRStorageLatencyControlOptions
Disable-VBRStorageLatencyControl
Enable-VBRStorageLatencyControl
Add-VBRAdvancedLatencyOptions
Get-VBRAdvancedLatencyOptions
Set-VBRAdvancedLatencyOptions
Remove-VBRAdvancedLatencyOptions

Specifying Email Notification Settings

Enable-VBRMailNotification
Disable-VBRMailNotification
Get-VBRMailNotificationConfiguration
Set-VBRMailNotificationConfiguration
Test-VBRMailNotificationConfiguration

Specifying SNMP Settings

Get-VBRSNMPOptions
Set-VBRSNMPOptions
New-VBRSNMPReceiver
Set-VBRSNMPReceiver

Specifying Other Notification Settings

Get-VBRGlobalNotificationOptions
Set-VBRGlobalNotificationOptions

Configuring Security Settings

Add-VBRBackupServerCertificate
Get-VBRBackupServerCertificate
Get-VBRSecurityOptions
Set-VBRSecurityOptions
Export-VBRLinuxKnownHost
Import-VBRLinuxKnownHost
Get-VBRLinuxTrustedHostPolicy
Set-VBRLinuxTrustedHostPolicy

Specifying Session History Settings

Get-VBRHistoryOptions
Set-VBRHistoryOptions

Roles and Users

Add-VBRUserRoleAssignment
Get-VBRUserRoleAssignment
Set-VBRUserRoleAssignment
Remove-VBRUserRoleAssignment

Jobs

Backup Jobs

Add-VBRViBackupJob
Add-VBRHvBackupJob
Reset-HvVmChangeTracking

VM Copy

Add-VBRCopyJob

Quick Backup

Start-VBRQuickBackup

Managing Jobs

Get-VBRJob
Start-VBRJob
Stop-VBRJob
Disable-VBRJob
Enable-VBRJob
Remove-VBRJob
Copy-VBRJob

VMs in Job

Add-VBRViJobObject
Add-VBRHvJobObject
Add-VBRvCloudJobObject
Get-VBRJobObject
Remove-VBRJobObject

Job Options

Get-VBRJobOptions
New-VBRJobOptions
New-VBRJobScriptOptions
New-VBRNotificationOptions
New-VBRRPONotificationOptions
Set-VBRRPONotificationOption
Reset-VBRJobOptions
Set-VBRJobOptions
Set-VBRJobScriptOptions
Set-VBRNotificationOptions

Job Schedule

Disable-VBRJobSchedule
Enable-VBRJobSchedule
Get-VBRJobScheduleOptions
New-VBRBackupWindowOptions
New-VBRDailyOptions
New-VBRJobScheduleOptions
New-VBRMonthlyOptions
Reset-VBRJobScheduleOptions
Set-VBRBackupWindowOptions
Set-VBRJobSchedule
Set-VBRJobScheduleOptions

Configuration Backup

New-VBRConfigurationBackupScheduleOptions
Get-VBRConfigurationBackupJob
Set-VBRConfigurationBackupJob
Start-VBRConfigurationBackupJob

Guest File System Indexing

Disable-VBRJobGuestFSIndexing
Enable-VBRJobGuestFSIndexing

Advanced Job Options

Set-VBRJobAdvancedBackupOptions
Set-VBRJobAdvancedHvOptions
Set-VBRJobAdvancedNotificationOptions
Set-VBRJobAdvancedOptions
Set-VBRJobAdvancedStorageOptions
Set-VBRJobAdvancedViOptions

VSS Options

Disable-VBRJobVSSIntegration
Enable-VBRJobVSSIntegration
Get-VBRJobObjectVssOptions
Get-VBRJobVssOptions
New-VBRJobVssOptions
Reset-VBRJobVssOptions
Set-VBRJobObjectVssOptions
Set-VBRJobVssOptions

Sessions

Get-VBRBackupSession
Get-VBRSession
Get-VBRTaskSession
Get-VBRRestoreSession
Stop-VBRSession
Get-VBRCDPSession
Get-VBRCDPTaskSession

Replication

Replication Jobs

Add-VBRViReplicaJob
Set-VBRViReplicaJob
Add-VBRHvReplicaJob
Set-VBRHvReplicaJob

Replica Re-IP Rules

Get-VBRViReplicaReIpRule
New-VBRViReplicaReIpRule
Get-VBRHvReplicaReIpRule
New-VBRHvReplicaReIpRule

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

Replicas

Get-VBRReplica
Remove-VBRReplica

Continuous Data Protection (CDP)

CDP Filter Management

Install-VBRCDPFilter
Get-VBRCDPFilter
Uninstall-VBRCDPFilter

Deploying VMware CDP Proxy

Add-VBRCDPProxy
Get-VBRCDPProxy
Set-VBRCDPProxy
Enable-VBRCDPProxy
Disable-VBRCDPProxy
Remove-VBRCDPProxy

Creating Veeam CDP Policy

Add-VBRCDPPolicy
Get-VBRCDPPolicy
Set-VBRCDPPolicy
Enable-VBRCDPPolicy
Disable-VBRCDPPolicy
Remove-VBRCDPPolicy
New-VBRCDPPolicyRetentionOptions
Set-VBRCDPPolicyRetentionOptions
New-VBRIndividualGuestOSCredentials
New-VBRReplicaApplicationProcessingOptions
Set-VBRReplicaApplicationProcessingOptions

CDP Failover

Get-VBRCDPReplica
Get-VBRCDPLongTermRestorePoint
Get-VBRCDPShortTermRestoreInterval
Start-VBRCDPReplicaFailover
Stop-VBRCDPReplicaFailover
Remove-VBRCDPReplica

CDP Failback

Start-VBRCDPReplicaFailback
Stop-VBRCDPReplicaFailback

Two-Phase Failback

New-VBRFailbackSwitchingSchedule
Get-VBRFailbackSwitchingSchedule
Set-VBRFailbackSwitchingSchedule

VeeamZIP

Start-VBRZip

Quick Migration

Start-VBRQuickMigration

Backup Copy

Backup Copy Jobs for VMs and Physical Machines

Add-VBRViBackupCopyJob
Add-VBRHvBackupCopyJob
Add-VBRvCloudBackupCopyJob
New-VBRBackupCopyJobStorageOptions
Set-VBRBackupCopyJobStorageOptions
Add-VBREPBackupCopyJob
Sync-VBRBackupCopyJob

Backup Copy Jobs for HPE StoreOnce Repositories

Add-VBRCatalystCopyJob
Get-VBRCatalystCopyJob
Set-VBRCatalystCopyJob
Start-VBRCatalystCopyJob
Disable-VBRCatalystCopyJob
Enable-VBRCatalystCopyJob
Remove-VBRCatalystCopyJob

Plug-In Backup Copy Job

Add-VBRPluginBackupCopyJob
Get-VBRPluginJob
Set-VBRPluginBackupCopyJob
Remove-VBRPluginJob
Enable-VBRPluginJob
Disable-VBRPluginJob
New-VBRPluginCopyJobStorageOptions
Set-VBRPluginCopyJobStorageOptions

Backup Copy Job of Amazon EC2 Instances

Get-VBREC2Backup
Add-VBREC2BackupCopyJob
Set-VBREC2BackupCopyJob
New-VBRRecoveryPointObjective
Set-VBRRecoveryPointObjective
Get-VBRRecoveryPointObjective
New-VBRSimpleRetentionPolicy
Get-VBRRetentionPolicy
Set-VBRSimpleRetentionPolicy
New-VBRGFSRetentionPolicy
Set-VBRGFSRetentionPolicy

Azure Backup Copy Job

Add-VBRAzureComputeBackupCopyJob
Get-VBRAzureComputeBackup
Set-VBRAzureComputeBackupCopyJob
New-VBRRecoveryPointObjective
Set-VBRRecoveryPointObjective
Get-VBRRecoveryPointObjective
New-VBRSimpleRetentionPolicy
Set-VBRSimpleRetentionPolicy
Get-VBRRetentionPolicy
New-VBRGFSRetentionPolicy
Set-VBRGFSRetentionPolicy

Veeam Agent Backup Copy Job

Add-VBRComputerBackupCopyJob
Get-VBRComputerBackupCopyJob
Copy-VBRComputerBackupCopyJob
Set-VBRComputerBackupCopyJob
Sync-VBRComputerBackupCopyJob
Disable-VBRComputerBackupCopyJob
Enable-VBRComputerBackupCopyJob
Remove-VBRComputerBackupCopyJob
New-VBRGFSRetentionPolicy
Set-VBRGFSRetentionPolicy

SureBackup

SureBackup Jobs

SureBackup Application Groups

Add-VBRViApplicationGroup
Add-VSBHvApplicationGroup
Get-VBRApplicationGroup
Set-VBRViApplicationGroup
Remove-VBRApplicationGroup
New-VBRSureBackupVM
Set-VBRSureBackupVM
New-VBRSureBackupStartupOptions
Set-VBRSureBackupStartupOptions
New-VBRSureBackupTestScript
Set-VBRSureBackupTestScript
Get-VSBApplicationGroup
Remove-VSBApplicationGroup
New-VBRApplicationGroupStartupOptions
Set-VBRApplicationGroupStartupOptions
Add-VSBViApplicationGroup

SureBackup Virtual Labs

Add-VBRViAdvancedVirtualLab
Add-VSBHvVirtualLab
Connect-VSBHvVirtualLab
Find-VSBHvVirtualLab
Get-VSBHvVirtualLab
Remove-VSBHvVirtualLab
Add-VBRViSimpleVirtualLab
Set-VBRViVirtualLab
Connect-VBRViVirtualLab
Get-VBRVirtualLab
Get-VBRViVirtualLabConfiguration
Remove-VBRVirtualLab
New-VBRViNetworkMappingRule
Set-VBRViNetworkMappingRule
New-VBRViVirtualLabNetworkOptions
Set-VBRViVirtualLabNetworkOptions
New-VBRViVirtualLabIPMappingRule
Set-VBRViVirtualLabIPMappingRule
New-VBRViVirtualLabProxyAppliance
Set-VBRViVirtualLabProxyAppliance
Add-VSBVirtualLab
Connect-VSBVirtualLab
Find-VSBVirtualLab
Get-VSBVirtualLab
Remove-VSBVirtualLab

Data Recovery

Instant VM Recovery

Start-VBRInstantRecovery
Start-VBRHvInstantRecovery
Restart-VBRInstantRecovery
Start-VBRHvInstantRecoveryMigration
Get-VBRInstantRecovery
Stop-VBRInstantRecovery

Instant VM Disk Recovery

Get-VBRViVirtualDevice
Set-VBRViVirtualDevice
Start-VBRViInstantVMDiskRecovery
Stop-VBRViInstantVMDiskRecovery

Instant First Class Disk (FCD) Recovery

New-VBRFCDInstantRecoveryMappingOptions
Start-VBRFCDInstantRecovery
Get-VBRFCDInstantRecoverySession
Get-VBRFCDInstantRecoveryInfo
Start-VBRFCDInstantRecoveryMigration
Stop-VBRFCDInstantRecovery

Entire VM Restore

Start-VBRRestoreVM
Start-VBRHvRestoreVM

VM Files Restore

Start-VBRRestoreVMFiles

Virtual Disks Restore

Start-VBRViVirtualDiskRestore
New-VBRViVirtualDeviceMappingRule
Set-VBRViVirtualDeviceMappingRule

Guest OS File Recovery

Start-VBRLinuxFileRestore
Get-VBRLinuxGuestItem
Start-VBRLinuxGuestItemRestore
Copy-VBRLinuxGuestItem
Stop-VBRLinuxFileRestore
Start-VBRWindowsFileRestore
Get-VBRWindowsGuestItem
Start-VBRWindowsGuestItemRestore
Copy-VBRWindowsGuestItem
Stop-VBRWindowsFileRestore

Instant Recovery Migration

Start-VBRViInstantRecoveryMigration

Instant Disk Recovery Migration

New-VBRViDiskMigrationMappingRule
Start-VBRViInstantRecoveryDiskMigration

Veeam Data Integration API

Publish-VBRBackupContent
Get-VBRPublishedBackupContentSession
Get-VBRPublishedBackupContentInfo
Unpublish-VBRBackupContent

Secure Restore

Copy-VBRAntivirusConfigurationFile

Amazon

Amazon Accounts

Add-VBRAmazonAccount
Get-VBRAmazonAccount
Set-VBRAmazonAccount
Remove-VBRAmazonAccount

Amazon Storage Containers

Get-VBRAmazonS3Region
Get-VBRAmazonS3Bucket
New-VBRAmazonS3Folder
Get-VBRAmazonS3Folder

Amazon Connection Service

Connect-VBRAmazonS3Service
Connect-VBRAmazonS3CompatibleService
Disconnect-VBRAmazonS3Service

Restore to Amazon EC2

Get-VBRAmazonEC2Region
Get-VBRAmazonEC2InstanceType
Get-VBRAmazonEC2SecurityGroup
Get-VBRAmazonEC2Subnet
Get-VBRAmazonEC2VPC
New-VBRAmazonEC2DiskConfiguration
New-VBRAmazonEC2Tag
Start-VBRVMRestoreToAmazon
Get-VBRAmazonRestoreSession
Stop-VBRVMRestoreToAmazon
New-VBRAmazonEC2ProxyAppliance

Google Cloud

Google Cloud Accounts

Add-VBRGoogleCloudAccount
Get-VBRGoogleCloudAccount
Set-VBRGoogleCloudAccount
Remove-VBRGoogleCloudAccount

Google Cloud Storage Containers

Get-VBRGoogleCloudRegion
Get-VBRGoogleCloudBucket
New-VBRGoogleCloudFolder
Get-VBRGoogleCloudFolder

Google Cloud Connection Service

Connect-VBRGoogleCloudService
Disconnect-VBRGoogleCloudService

Restore to Google Compute Engine

Add-VBRGoogleCloudComputeAccount
Get-VBRGoogleCloudComputeAccount
Set-VBRGoogleCloudComputeAccount
Remove-VBRGoogleCloudComputeAccount
Get-VBRGoogleCloudComputeRegion
Get-VBRGoogleCloudComputeZone
Get-VBRGoogleCloudComputeInstanceType
Get-VBRGoogleCloudComputeVPC
Get-VBRGoogleCloudComputeSubnet
Get-VBRGoogleCloudComputeSharedSubnet
New-VBRGoogleCloudComputeLabel
New-VBRGoogleCloudComputeProxyAppliance
New-VBRGoogleCloudComputeDiskConfiguration
Start-VBRVMRestoreToGoogleCloud
Get-VBRGoogleCloudRestoreSession
Stop-VBRVMRestoreToGoogleCloud

Microsoft Azure

Microsoft Azure Accounts

Add-VBRAzureBlobAccount
Get-VBRAzureBlobAccount
Set-VBRAzureBlobAccount
Remove-VBRAzureBlobAccount

Microsoft Azure Storage Containers

New-VBRAzureBlobFolder
Get-VBRAzureBlobContainer
Get-VBRAzureBlobFolder

Microsoft Azure Connection Service

Connect-VBRAzureBlobService
Connect-VBRAzureDataBoxService
Disconnect-VBRAzureBlobService

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-VBRAzureNetworkSecurityGroup
Get-VBRAzureVMSize
New-VBRAzureLinuxRestoreAppliance
Get-VBRAzureLinuxRestoreAppliance
Set-VBRAzureLinuxRestoreAppliance
Deploy-VBRAzureLinuxRestoreAppliance
Get-VBRAzureApplianceSession
Start-VBRVMRestoreToAzure
Get-VBRAzureRestoreSession
Stop-VBRVMRestoreToAzure

WAN Acceleration

Add-VBRWANAccelerator
Clear-VBRWANCache
Get-VBRWANAccelerator
Remove-VBRWANAccelerator

NAS Backup Support

VMware vCloud Director

Add-VBRvCloud
Add-VBRvCloudBackupCopyJob
Add-VBRvCloudJob
Add-VBRvCloudVC
Find-VBRvCloudEntity
New-VBRvCloudVAppRestoreSettings
Start-VBRvCloudInstantRecovery
Start-VBRvCloudQuickMigration
Start-VBRvCloudRestoreVApp
Start-VBRvCloudRestoreVm
Set-VBRvCloudOrganizationJobMapping
vCloud Director Replication

vCD Replication Job

Add-VBRvCDReplicaJob
Get-VBRvCDReplicaJob
Get-VBRvCDReplica
Remove-VBRvCDReplica
Set-VBRvCDReplicaJob
Enable-VBRvCDReplicaJob
Disable-VBRvCDReplicaJob
Start-VBRvCDReplicaJob
Stop-VBRvCDReplicaJob
Remove-VBRvCDReplicaJob

vCD Replica Failover

Start-VBRvCDReplicaFailover
Stop-VBRvCDReplicaFailover

vCD Replica Failback

Start-VBRvCDReplicaFailback
Stop-VBRvCDReplicaFailback

vCD Replica Advanced Settings

Get-VBRVCDOrgVdcNetworkInfo
New-VBRvCDIndividualObjectStoragePolicy
Set-VBRvCDIndividualObjectStoragePolicy

Veeam Cloud Connect

Veeam Cloud Connect Infrastructure Maintenance

Enable-VBRCloudMaintenanceMode
Disable-VBRCloudMaintenanceMode
Get-VBRCloudInfrastructureState

Veeam Cloud Connect Cloud Gateways

Add-VBRCloudGateway
Get-VBRCloudGateway
Disable-VBRCloudGateway
Enable-VBRCloudGateway
Set-VBRCloudGateway
Remove-VBRCloudGateway

Veeam Cloud Connect Cloud Gateway Pool

Add-VBRCloudGatewayPool
Get-VBRCloudGatewayPool
Set-VBRCloudGatewayPool
Remove-VBRCloudGatewayPool
Disable-VBRCloudGatewayPool
Enable-VBRCloudGatewayPool

Veeam Cloud Connect SSL Certificates

Add-VBRCloudGatewayCertificate
Get-VBRCloudGatewayCertificate

Veeam Cloud Connect Tenants Accounts

Add-VBRCloudTenant
Add-VBRvCDCloudTenant
Add-VBRaDCloudTenant
Get-VBRCloudTenant
Enable-VBRCloudTenant
Disable-VBRCloudTenant
Set-VBRCloudTenant
Set-VBRvCDCloudTenant
Set-VBRaDCloudTenant
Reset-VBRCloudTenant
Remove-VBRCloudTenant
Start-VBRCloudTenantBackupEvacuation

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

New-VBRCloudTenantResource
Set-VBRCloudTenantResource

Veeam Cloud Connect Replication Resources

New-VBRCloudTenantReplicationResources
New-VBRCloudTenantHwPlanOptions
Set-VBRCloudTenantNetworkAppliance
Get-VBRCloudTenantNetworkAppliance
Stop-VBRCloudTenantNetworkAppliance
Remove-VBRCloudPublicIP
Get-VBRCloudPublicIP
Add-VBRCloudPublicIP
New-VBRvCDReplicationResource
New-VBRvCDOrganizationvDCOptions

vCD Cloud Replication Job

Add-VBRvCDCloudReplicaJob
Set-VBRvCDCloudReplicaJob
Get-VBRvCDCloudOrganizationvDC
Get-VBRvCDCloudStoragePolicy
Get-VBRvCDCloudNetworkInfo
Get-VBRvCDCloudvApp
Get-VBRvCDCloudVM

Veeam Cloud Connect Subtenants

New-VBRCloudSubTenantResource
Set-VBRCloudSubTenantResource
Add-VBRCloudSubTenant
Add-VBRvCDCloudSubTenant
Get-VBRCloudSubTenant
Set-VBRCloudSubTenant
Remove-VBRCloudSubTenant
Disable-VBRCloudSubTenant
Enable-VBRCloudSubTenant

Veeam Cloud Connect Service Provider

Add-VBRCloudProvider
Get-VBRCloudProvider
Set-VBRCloudProvider
Remove-VBRCloudProvider

Cloud Provider Credentials

Add-VBRCloudProviderCredentials
Get-VBRCloudProviderCredentials
Set-VBRCloudProviderCredentials
Remove-VBRCloudProviderCredentials

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
Get-VBRvCDCloudOrganizationUser
Add-VBRvCDCloudSubUser

Tape Devices

Tape Servers

Add-VBRTapeServer
Get-VBRTapeServer
Remove-VBRTapeServer
Set-VBRTapeServer

Tape Media Pools

Add-VBRTapeMediaPool
New-VBRTapeMediaPoolRetentionPolicy
New-VBRTapeMediaSetCreationPolicy
Set-VBRTapeMediaPool
Add-VBRTapeGFSMediaPool
New-VBRTapeGFSMediaSetPolicy
Set-VBRTapeGFSMediaPool
Get-VBRTapeMediaPool
Remove-VBRTapeMediaPool

Tape Vaults

Add-VBRTapeVault
Get-VBRTapeVault
Remove-VBRTapeVault
Set-VBRTapeVault

Tape Libraries

Get-VBRTapeLibrary
Remove-VBRTapeLibrary
Set-VBRTapeLibrary
Start-VBRTapeCatalog
Start-VBRTapeInventory
Enable-VBRTapeLibraryMaintenance
Disable-VBRTapeLibraryMaintenance

Tape Drives

Disable-VBRTapeDrive
Enable-VBRTapeDrive
Get-VBRTapeDrive

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
Get-VBRTapeRestoreAllContentDependentMedium
Start-VBRTapeRestoreAllContent

Managing Tapes

Disable-VBRTapeProtection
Eject-VBRTapeMedium
Enable-VBRTapeProtection
Erase-VBRTapeMedium
Export-VBRTapeMedium
Get-VBRTapeMedium
Import-VBRTapeMedium
Move-VBRTapeMedium
Remove-VBRTapeMedium
Set-VBRTapeMedium
Get-VBRTapeCopyDependentMedium
Start-VBRTapeVerification
Start-VBRTapeCopy

Tenant to Tape

Get-VBRCloudTapeBackupTenant
Get-VBRCloudTapeBackupTenantRepository
Get-VBRCloudTapeBackupTenantJob
Start-VBRCloudTapeRestore
Get-VBRCloudTapeRestoreSession
Stop-VBRCloudTapeRestore

Tape Decryption

Get-VBREncryptedTapeMediumHint
Set-VBREncryptedTapeMediumPassword

NDMP Volumes Restore

Get-VBRNDMPVolume
Get-VBRNDMPVolumeRestorePoint
Start-VBRNDMPVolumeRestore

Veeam Agent Management

Veeam Agent Management Security Settings

Get-VBRBackupServerCertificate
Add-VBRBackupServerCertificate
Get-VBRLinuxTrustedHostPolicy
Set-VBRLinuxTrustedHostPolicy
Import-VBRLinuxKnownHost
Export-VBRLinuxKnownHost
Reset-VBRProtectionGroupCertificate

Working with Protection Groups

Veeam Agent Management Protection Scope

New-VBRADContainer
New-VBRManuallyDeployedContainer
Set-VBRADContainer
Get-VBRADDomain
Find-VBRADEntity
New-VBRADCustomCredentials
New-VBRIndividualComputerContainer
Set-VBRIndividualComputerContainer
New-VBRIndividualComputerCustomCredentials
New-VBRCSVContainer
Set-VBRCSVContainer
New-VBRCSVCustomCredentials

Veeam Agent Management Protection Groups

Get-VBRProtectionGroup
Get-VBRProtectionGroupLinuxPackage
Get-VBRProtectionGroupUnixPackage
Add-VBRProtectionGroup
Set-VBRProtectionGroup
New-VBRPeriodicallyOptions
New-VBRProtectionGroupScheduleOptions
New-VBRProtectionGroupDeploymentOptions
New-VBRProtectionGroupNotificationOptions
Set-VBRProtectionGroupNotificationOptions
New-VBRProtectionGroupAdvancedWindowsOptions
Disable-VBRProtectionGroup
Enable-VBRProtectionGroup
Remove-VBRProtectionGroup

Managing Protected Computers

Veeam Agent Management Recovery Media

Add-VBRDiscoveredComputerRecoveryMedia
Get-VBRRecoveryMediaTarget
New-VBRRecoveryMediaISOTarget

Veeam Agent Management Discovered Computers

Get-VBRDiscoveredComputer
Install-VBRDiscoveredComputerAgent
Uninstall-VBRDiscoveredComputerAgent
Reset-VBRDiscoveredComputer
Reset-VBRAgentCertificate
Get-VBRDiscoveredComputerUpdate
Set-VBRDiscoveredComputerUpdate

Working with Veeam Agent Backup Jobs and Policies

Veeam Agent Management Backup Jobs

Add-VBRComputerBackupJob
Set-VBRComputerBackupJob
Get-VBRComputerBackupJob
Get-VBRComputerBackupJobSession
Start-VBRComputerBackupJob
Stop-VBRComputerBackupJob
Copy-VBRComputerBackupJob
Remove-VBRComputerBackupJob
Apply-VBRManagedByAgentPolicy
Clear-VBRManagedByAgentPolicyCache
Enable-VBRComputerBackupJob
Disable-VBRComputerBackupJob

Veeam Agent Job Target Settings

New-VBRComputerDestinationOptions
Set-VBRComputerDestinationOptions

Veeam Agent Job Backup Scope

New-VBRSelectedFilesBackupOptions
Set-VBRSelectedFilesBackupOptions
New-VBRLinuxSelectedVolume
Set-VBRLinuxSelectedVolume
New-VBRSelectedPersonalFolders
Set-VBRSelectedPersonalFolders

Veeam Agent Job Schedule

New-VBRWindowsWorkstationScheduleOptions
Set-VBRWindowsWorkstationScheduleOptions
New-VBRLinuxScheduleOptions
Set-VBRLinuxScheduleOptions
New-VBRServerScheduleOptions
Set-VBRServerScheduleOptions
New-VBRMacScheduleOptions
Set-VBRMacScheduleOptions
New-VBRUnixScheduleOptions

Veeam Agent Job Guest Processing Options

New-VBRApplicationProcessingOptions
Set-VBRApplicationProcessingOptions
New-VBROracleProcessingOptions
Set-VBROracleProcessingOptions
New-VBRSQLProcessingOptions
Set-VBRSQLProcessingOptions
New-VBRPostgreSQLProcessingOptions
Set-VBRPostgreSQLProcessingOptions
New-VBRMySQLProcessingOptions
Set-VBRMySQLProcessingOptions
New-VBRScriptProcessingOptions
Set-VBRScriptProcessingOptions
New-VBRComputerIndexingOptions
Set-VBRComputerIndexingOptions

Veeam Agent Job Advanced Settings

New-VBRFullBackupOptions
Set-VBRFullBackupOptions
New-VBRSyntheticFullOptions
Set-VBRSyntheticFullOptions
New-VBRStorageOptions
Set-VBRStorageOptions
New-VBRBackupCacheOptions
Set-VBRBackupCacheOptions
New-VBRComputerGFSOptions
Set-VBRComputerGFSOptions
New-VBRComputerGFSWeeklyOptions
Set-VBRComputerGFSWeeklyOptions
New-VBRComputerGFSMonthlyOptions
Set-VBRComputerGFSMonthlyOptions
New-VBRComputerGFSYearlyOptions
Set-VBRComputerGFSYearlyOptions
New-VBRComputerWarningOptions
Set-VBRComputerWarningOptions

Veeam Agent Management Storage Integration

Add-VBRComputerFileProxyServer
Get-VBRComputerFileProxyServer
Set-VBRComputerFileProxyServer
Remove-VBRComputerFileProxyServer
New-VBRSanIntegrationOptions
Set-VBRSanIntegrationOptions

Veeam Agent Standalone Mode

Get-VBREPPermission
Set-VBREPPermission
Get-VBREPJob
Disable-VBREPJob
Enable-VBREPJob
Get-VBREPSession
Add-VBREpBackupCopyJob
Start-VBRRestoreVirtualDisks
Start-VBREpInstantRecovery

Restoring Data from Veeam Agent Backups

Restoring Veeam Agent Backup to vSphere VM

Get-VBRComputerNetworkInfo
Start-VBRViComputerInstantRecovery

Restoring Volumes

Get-VBRComputerDisk
Get-VBRComputerDiskPartition
Start-VBRComputerVolumeRestore

Restoring Files and Folders

Storage Systems

Cisco HyperFlex Storage Systems

Add-HyperFlexHost
Get-HyperFlexHost
Set-HyperFlexHost
Sync-HyperFlexHost
Remove-HyperFlexHost

Dell EMC VNX Storage Systems

Add-VNXHost
Get-VNXHost
Set-VNXHost
Sync-VNXHost
Remove-VNXHost
Get-VNXVolume
Get-VNXInfrastructureVolume
Sync-VNXVolume
Add-VNXSnapshot
Get-VNXSnapshot
Remove-VNXSnapshot

Dell EMC Isilon Storage Systems

Add-VBRIsilonHost
Get-VBRIsilonHost
Set-VBRIsilonHost
Sync-VBRIsilonHost
Remove-VBRIsilonHost
Get-VBRIsilonInfrastructureVolume
Get-VBRIsilonVolume
Sync-VBRIsilonVolume

HPE 3PAR StoreServ Storage Systems

Add-HP3Storage
Get-HP3Storage
Set-HP3Storage
Sync-HP3Storage
Remove-HP3Storage
Get-HP3Volume
Get-HP3InfrastructureVolume
Sync-HP3Volume
Add-HP3Snapshot
Get-HP3Snapshot
Remove-HP3Snapshot
New-VBRStorageProtocolPolicy

HPE StoreVirtual Storage Systems

Add-HP4Storage
Get-HP4Storage
Set-HP4Storage
Sync-HP4Storage
Remove-HP4Storage
Get-HP4Cluster
Get-HP4Volume
Get-HP4InfrastructureVolume
Sync-HP4Volume
Add-HP4Snapshot
Get-HP4Snapshot
Remove-HP4Snapshot

HPE Nimble Storage Systems

Add-NimbleHost
Get-NimbleHost
Set-NimbleHost
Sync-NimbleHost
Remove-NimbleHost
Get-NimbleVolume
Get-NimbleInfrastructureVolume
Sync-NimbleVolume
Add-NimbleSnapshot
Get-NimbleSnapshot
Remove-NimbleSnapshot

Lenovo ThinkSystem Storage Systems

Add-ThinkSystemHost
Get-ThinkSystemHost
Set-ThinkSystemHost
Sync-ThinkSystemHost
Remove-ThinkSystemHost
Add-ThinkSystemSnapshot
Get-ThinkSystemSnapshot
Remove-ThinkSystemSnapshot
Get-ThinkSystemInfrastructureVolume
Get-ThinkSystemVolume
Sync-ThinkSystemVolume

NetApp Storage Systems

Add-NetAppHost
Get-NetAppHost
Set-NetAppHost
Sync-NetAppHost
Remove-NetAppHost
Get-NetAppVolume
Get-NetAppInfrastructureVolume
Sync-NetAppVolume
Add-NetAppSnapshot
Get-NetAppSnapshot
Remove-NetAppSnapshot

Universal Storage API Integrated Systems

Get-VBRStoragePlugin
Get-StoragePluginHost
Add-StoragePluginHost
Set-StoragePluginHost
Sync-StoragePluginHost
Remove-StoragePluginHost
Get-StoragePluginVolume
Get-StoragePluginInfrastructureVolume
Sync-StoragePluginVolume
Get-StoragePluginSnapshot
Add-StoragePluginSnapshot
Remove-StoragePluginSnapshot

Veeam PowerShell Help

Get-VBRCommand
Get-VBRToolkitDocumentation

Veeam PowerShell Enumerations
Veeam PowerShell Types

Obsolete Cmdlets

Add-VBRESX (obsolete)
Add-VBRBackupJob (obsolete)
Add-VBRJobObject (obsolete)
Add-VBRReplicaJob (obsolete)
Add-VBRTapeFilesJob (obsolete)
Add-VBRTapeVMJob (obsolete)
Add-VSBApplicationGroup (obsolete)
Eject-VBRTapeDrive (obsolete)
Export-VBRBackup (obsolete)
Export-VBRConfiguration (obsolete)
Find-VBRDatastore (obsolete)
Find-VBRObject (obsolete)
Find-VBRResourcePool (obsolete)
Find-VBRTapeCatalog (obsolete)
Find-VBRTapeCatalogVersion (obsolete)
Get-VBROracleDatabase (obsolete)
Get-VBROracleDatabaseRestoreInterval (obsolete)
Get-VBRSQLDatabase (obsolete)
Get-VBRSQLDatabaseRestoreInterval (obsolete)
Get-VBRTapeBackup (obsolete)
Get-VBRTapeMediaPoolOptions (obsolete)
Import-VBRConfiguration (obsolete)
Remove-VBRBackupSession (obsolete)
Remove-VBRRestoreSession (obsolete)
Remove-VSBSession (obsolete)
Start-VBROracleDatabaseRestore (obsolete)
Start-VBRReplicaFailover (obsolete)
Start-VBRSQLDatabaseRestore (obsolete)
Start-VBRTapeRestore (obsolete)
Start-VBRTapeRestoreFiles (obsolete)
Set-VBRTapeMediaPoolOptions (obsolete)
Set-VBRESX (obsolete)

How to

Performing Instant Recovery of a VMware VM
Performing Instant Recovery of a Hyper-V VM
Creating VMware Backup Job
Creating Hyper-V Backup Job
Creating Hyper-V Replica Job
Creating VMware Replica Job
Working with Hyper-V Application Group
Working with VMware Application Group
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
Administering VMware SureBackup Job
Administering Hyper-V SureBackup Job
Working with Hyper-V Virtual Lab
Working with VMware Virtual Lab

>Veeam PowerShell Reference>Veeam PowerShell Reference>Tape Devices

Tape Devices

In this article

The following topics contain instructions on managing and storing your data on tapes by means of Veeam PowerShell.

In this section

Tape Servers
Tape Media Pools
Tape Vaults
Tape Libraries
Tape Drives
Tape Jobs
Tapes
Tenant to Tape
Tape Decryption
NDMP Volumes Restore

Page updated 10/19/2020

Send feedback

Home | Products | Forums | Support | Contact Sales | EULA

©2021 Veeam® Software Privacy Notice | Cookie Notice

View all results across Veeam

Back to document search

I want to report a typo

There is a misspelling right here:

I want to let the Veeam Documentation Team know about that.

Submit report