A-Z Cmdlets List
This page provides with a list of all cmdlets added to the Veeam Backup PowerShell module.
Add
Add-HP3SnapshotCreates HPE 3PAR StoreServ storage snapshots.Add-HP3StorageAdds HPE 3PAR StoreServ storage systems to Veeam Backup & Replication.Add-HyperFlexHostAdds Cisco HyperFlex storage systems to the backup infrastructure.Add-NetAppHostAdds NetApp storage systems to Veeam Backup & Replication.Add-NetAppSnapshotCreates NetApp storage snapshots.Add-NimbleHostAdds HPE Nimble storage systems to Veeam Backup & Replication.Add-NimbleSnapshotCreates HPE Nimble storage snapshots.Add-StoragePluginHostAdds Universal Storage API integrated systems to Veeam Backup & Replication.Add-StoragePluginSnapshotCreates snapshots of Universal Storage API integrated systems.Add-ThinkSystemHostAdds ThinkSystem storage systems to the backup infrastructure.Add-ThinkSystemSnapshotCreates ThinkSystem storage snapshots.Add-VBR1111SystemsS3RepositoryAdds the 11:11 Cloud object storage repository to the backup infrastructure.Add-VBRAdCloudTenantCreates Active Directory tenant accounts.Add-VBRAdvancedLatencyOptionsDefines latency settings for a specific datastore.Add-VBRAmazonAccountCreates AWS credentials records.Add-VBRAmazonS3CompatibleRepositoryAdds S3 compatible and S3-integrated object storage repositories to the backup infrastructure.Add-VBRAmazonS3ExternalRepositoryAdds external Amazon S3 storage repository to the backup infrastructure.Add-VBRAmazonS3GlacierRepositoryAdds Amazon S3 Glacier archive storage repository to the backup infrastructure.Add-VBRAmazonS3RepositoryAdds Amazon S3 object storage repository to the backup infrastructure.Add-VBRAmazonS3ServerAdds Amazon S3 storage as unstructured data source to the inventory.Add-VBRApplicationBackupJobCreates application backup policies.Add-VBRApplicationBackupRepositoryAdds an application backup repository.Add-VBRApplicationGroupCreates application groups for SureBackup jobs.Add-VBRArchiveBackupAvailabilityPeriodExtends the availability period of the backup files from the archive storage.Add-VBRAzureAccountAdds a Microsoft Azure compute account to Veeam Backup & Replication.Add-VBRAzureADAccountAdds Azure Entra ID-based storage accounts to Veeam Backup & Replication.Add-VBRAzureArchiveRepositoryAdds Azure Archive repository to the backup infrastructure.Add-VBRAzureBlobAccountCreates Microsoft Azure Blob credentials records.Add-VBRAzureBlobRepositoryAdds Azure Blob object storage repository to the backup infrastructure.Add-VBRAzureBlobServerAdds Microsoft Azure Blob storage as unstructured data source to the inventory.Add-VBRAzureComputeBackupCopyJobCreates Azure IaaS backup copy jobs. 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-VBRAzureDataBoxRepositoryAdds Azure Data Box storage as an object storage repository to the backup infrastructure.Add-VBRAzureExternalRepositoryAdds external Microsoft Azure Blob storage repository to the backup infrastructure.Add-VBRAzureRestoreProxyCreates a proxy appliance used for restoring workloads to Microsoft Azure.Add-VBRAzureStorageServerAdds Microsoft Azure object storage as unstructured data source to the inventory.Add-VBRBackupCopyJobCreates a backup copy job.Add-VBRBackupJobCreates a new backup job. This cmdlet is obsolete. In Veeam Backup & Replication 6 this cmdlet was replaced by Add-VBRViBackupJob and Add-VBRHvBackupJob due to multihypervisor support introduced in the new version. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.Add-VBRBackupRepositoryAdds a backup repository to the backup infrastructure.Add-VBRBackupServerCertificateSpecifies a TLS certificate used to establish secure communication from backup infrastructure components to the backup server.Add-VBRBackupToTapeJobCreates a backup to tape job or a GFS job.Add-VBRCatalystCopyJobCreates backup copy jobs for HPE StoreOnce repositories. This cmdlet is obsolete. Run the Add-VBRStorageCopyJob cmdlet instead.Add-VBRCDPPolicyCreates CDP policies for VMware vSphere VMs.Add-VBRCDPProxyAdds CDP proxies to the backup infrastructure.Add-VBRCloudArchiveBackupAvailabilityPeriodExtends the availability of the tenant backup files located in the archive storage.Add-VBRCloudCDPPolicyCreates a cloud CDP policy.Add-VBRCloudGatewayCreates cloud gateways for Veeam Cloud Connect.Add-VBRCloudGatewayCertificateAssigns a TLS certificate to the service provider.Add-VBRCloudGatewayPoolCreates cloud gateway pools.Add-VBRCloudProviderAdds cloud service providers.Add-VBRCloudProviderCredentialsAdds cloud provider credentials records to Veeam Backup & Replication.Add-VBRCloudPublicIPAdds public IP address or a pool of IP addresses.Add-VBRCloudSubTenantCreates cloud subtenant accounts.Add-VBRCloudSubUserCreates cloud subuser accounts.Add-VBRCloudTenantCreates standalone tenant accounts.Add-VBRComputerBackupCopyJobCreates Veeam Agent backup copy jobs. 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-VBRComputerBackupJobCreates Veeam Agent backup jobs and Veeam Agent backup policies.Add-VBRComputerFileProxyServerAdds general-purpose backup proxies to the backup infrastructure.Add-VBRComputerRecoveryTokenCreates tokens for bare-metal recovery.Add-VBRCopyJobCreates VM and file copy jobs.Add-VBRCredentialsCreates credentials records.Add-VBRDataCloudVaultRepositoryAdds a Veeam Data Cloud Vault to the backup infrastructure. You cannot add Veeam Data Cloud Vault Archive using this cmdlet.Add-VBRDiscoveredComputerConfigurationPolicyUpdates Veeam Agent settings on discovered computers using available configuration options. Make sure to test this cmdlet in the lab before you run it in the production environment.Add-VBRDiscoveredComputerRecoveryMediaCreates Veeam Recovery Media.Add-VBREC2BackupCopyJobCreates backup copy jobs for backups of Amazon EC2 instances. 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-VBREncryptionKeyCreates encryption key.Add-VBREntraIDLogsBackupJobCreates a Microsoft Entra ID log backup job.Add-VBREntraIDTenantAdds a Microsoft Entra ID tenant to the backup infrastructure.Add-VBREntraIDTenantBackupJobCreates a Microsoft Entra ID tenant backup job.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-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-VBRFailoverPlanCreates failover plans or cloud failover plans.Add-VBRFilerAdds an enterprise NAS system as a file share to the inventory.Add-VBRFileToTapeJobCreates a file to tape job or a GFS file to tape job.Add-VBRGoogleCloudAccountCreates Google Cloud credentials records.Add-VBRGoogleCloudComputeAccountAdds Google Cloud service account credentials record.Add-VBRGoogleCloudExternalRepositoryAdds external Google Cloud storage repository to the backup infrastructure.Add-VBRGoogleCloudRepositoryAdds the Google Cloud object storage repository to the backup infrastructure.Add-VBRHighAvailabilityClusterAssembles an HA cluster.Add-VBRHvAdvancedVirtualLabCreates a Hyper-V advanced virtual lab.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-VBRHvBackupJobCreates Hyper-V backup jobs.Add-VBRHvCloudHardwarePlanCreates Hyper-V hardware plans.Add-VBRHvCloudReplicaJobCreates a new Hyper-V cloud replication job.Add-VBRHvClusterAdds a Hyper-V cluster to the backup infrastructure.Add-VBRHvHostAdds Hyper-V hosts to the backup infrastructure.Add-VBRHvJobObjectAdds VMs to Hyper-V jobs.Add-VBRHvProxyAdds a Hyper-V backup proxy to the backup infrastructure.Add-VBRHvReplicaJobCreates Hyper-V replication jobs.Add-VBRHvScvmmAdds a Hyper-V SCVMM server to the backup infrastructure.Add-VBRHvSimpleVirtualLabCreates a Hyper-V basic virtual lab.Add-VBRIBMCloudRepositoryAdds the IBM Cloud object storage repository to the backup infrastructure.Add-VBRIrisBackupJobCreates InterSystems IRIS application backup policies.Add-VBRIsilonHostAdds Dell PowerScale (formerly Isilon) storage systems to Veeam Backup & Replication.Add-VBRJobObjectAdds VMs to existing job. This cmdlet is obsolete. The cmdlet still works, but it is recommended to create a new backup job using the Add-VBRViJobObject or the Add-VBRHvJobObject cmdlets.Add-VBRKMSServerAdds KMS servers to the Veeam Backup & Replication console.Add-VBRLinuxAdds a Linux server to the backup infrastructure.Add-VBRLocationCreates a geographic location in Veeam Backup & Replication.Add-VBRMalwareDetectionExclusionAdds a malware exclusion rule.Add-VBRMongoDBBackupJobCreates MongoDB backup policies.Add-VBRNASBackupJobCreates file backup jobs.Add-VBRNASFileServerAdds managed Windows or Linux file serves to the Veeam Backup & Replication infrastructure.Add-VBRNASNFSServerAdds NFS network shared folders to the inventory.Add-VBRNASProxyServerAdds the general-purpose backup proxy to the Veeam Backup & Replication infrastructure.Add-VBRNASSMBServerAdds SMB network shared folders to the Veeam Backup & Replication infrastructure.Add-VBRNDMPServerAdds NDMP servers to the backup infrastructure.Add-VBRNetAppNDMPServerAdds NetApp NDMP servers.Add-VBRNetworkTrafficRuleCreates network traffic rules.Add-VBRNutanixHostAdds Nutanix Files storage systems to the backup infrastructure.Add-VBRObjectStorageBackupJobCreates object storage backup job.Add-VBRObjectToTapeJobCreates an object to tape or GFS object to tape job.Add-VBRPluginBackupCopyJobCreates plug-in backup copy jobs.Add-VBRPreferredNetworkSpecifies preferred networks.Add-VBRProtectionGroupCreates protection groups in Veeam Backup & Replication.Add-VBRReplicaJob (obsolete)Add-VBRS3CompatibleServerAdds S3 compatible object storage as unstructured data source to the inventory.Add-VBRS3GlacierCompatibleRepositoryAdds S3 compatible object storage with data archiving to the backup infrastructure.Add-VBRScaleOutBackupRepositoryAdds scale-out backup repositories to the backup infrastructure.Add-VBRSmbV3ClusterAdds an SMB3 cluster to the backup infrastructure.Add-VBRSmbV3HostAdds an SMB3 host to the backup infrastructure.Add-VBRStorageCopyJobCreates storage backup copy jobs.Add-VBRSureBackupContentScanJobCreates a backup content scan SureBackup job.Add-VBRSureBackupJobCreates a SureBackup job.Add-VBRSyslogEventFilterAdds a syslog event filter for an event ID.Add-VBRSyslogServerAdds a syslog server to Veeam Backup & Replication.Add-VBRTapeFilesJobCreates a new files to tape copy job. This cmdlet is obsolete. The cmdlet still works, but it is recommended to create a new files to tape copy job using the Add-VBRFileToTapeJob cmdlet.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.Add-VBRTapeVMJobCreates a new backup to tape copy job. This cmdlet is obsolete. The cmdlet still works, but it is recommended to create backup to tape copy jobs using the Add-VBRBackupToTapeJob cmdlet.Add-VBRUniversalCDPPolicyCreates a universal CDP policy.Add-VBRUserRoleAssignmentAdds a role to a user or a user group.Add-VBRvCDCDPPolicyCreates a Cloud Director CDP policy.Add-VBRvCDCloudCDPPolicyCreates a VDC CDP policy.Add-VBRvCDCloudReplicaJobCreates Cloud Director cloud replication jobs.Add-VBRvCDCloudSubTenantCreates Cloud Director subtenant accounts.Add-VBRvCDCloudSubUserCreates Cloud Director subuser accounts.Add-VBRvCDCloudTenantCreates VMware Cloud Director tenant accounts.Add-VBRvCDReplicaJobCreates Cloud Director replication jobs.Add-VBRvCenterAdds vCenter Servers to the backup infrastructure.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-VBRvCloudJobObjectAdds VMs to Cloud Director backup jobs.Add-VBRvCloudVCAdds vCenter Server managed by Cloud Director to Veeam Backup & Replication.Add-VBRViAdvancedVirtualLabCreates a VMware advanced virtual lab.Add-VBRViApplicationGroupCreates VMware application groups for SureBackup jobs. This cmdlet is obsolete and not supported. Run the Add-VBRApplicationGroup cmdlet instead.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.Add-VBRViBackupJobCreates VMware backup jobs.Add-VBRViCloudHardwarePlanCreates VMware hardware plans.Add-VBRViCloudReplicaJobCreates a new VMware cloud replication job.Add-VBRViJobObjectAdds VMs to VMware jobs.Add-VBRViLinuxProxyAdds Linux backup proxies to the backup infrastructure.Add-VBRViProxyAdds a VMware backup proxy to the backup infrastructure.Add-VBRViReplicaJobCreates VMware replication jobs.Add-VBRViSimpleVirtualLabCreates a VMware basic virtual lab.Add-VBRViSureBackupJobCreates a VMware SureBackup job. This cmdlet is obsolete. Run the Add-VBRSureBackupJob cmdlet instead.Add-VBRVMExclusionAdds VMs to global VM exclusions.Add-VBRWANAcceleratorCreates a new WAN accelerator.Add-VBRWinServerAdds a Windows server to the backup infrastructure.Add-VNXHostAdds Dell VNX storage systems to Veeam Backup & Replication.Add-VNXSnapshotCreates Dell VNX storage snapshots.Add-VSBApplicationGroupCreates a VMware application group for SureBackup job. This cmdlet is obsolete. The cmdlet still works, but it is recommended to create backup to tape copy jobs using the Add-VSBViApplicationGroup or Add-VSBHvApplicationGroup cmdlets.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 insteadAdd-VSBVirtualLabCreates a VMware virtual lab. This cmdlet is obsolete and not supported. Run the Add-VBRApplicationGroup cmdlet instead.
Apply
Apply-VBRBackgroundRetentionPerforms background retention for backups.Apply-VBRLocationAssigns geographic locations to the backup infrastructure components.Apply-VBRManagedByAgentPolicyAssigns Veeam Agent backup policies to protected computers.
Assign
Assign-VBRInstanceWorkloadSets the product edition for standalone Veeam Agents.
Attach
Attach-VBRDiscoveredComputerBackupAllows a discovered computer to access a backup.
Clear
Clear-VBRManagedByAgentPolicyCacheRemoves cache from the protected computers.Clear-VBRWANCacheRemoves data from WAN accelerator global cache.
Compare
Compare-VBREntraIDTenantItemCompares backed-up objects between two restore points or a restore point and the production state.Compare-VBRUnstructuredBackupFLRItemCompares backed-up objects with objects on production file share or object storage.Compare-VBRUnstructuredBackupFLRItemAttributesCompares attributes of backed-up objects with objects on production file share or object storage.Compare-VBRWindowsGuestItemsAttributesCompares attributes of files and folders from a backup with attributes of original files and folders.
Connect
Connect-VBRAmazonS3CompatibleServiceConnects to S3 compatible object storage.Connect-VBRAmazonS3ServiceConnects to Amazon S3 object storage.Connect-VBRAzureBlobServiceConnects to Microsoft Azure Blob storage.Connect-VBRAzureDataBoxServiceConnects to Azure Data Box storage.Connect-VBRGoogleCloudServiceConnects to Google Cloud object storage.Connect-VBRHvVirtualLabAdds VMs to Veeam Backup & Replication.Connect-VBRServerConnects to a Veeam backup server.Connect-VBRViVirtualLabAdds VMs to Veeam Backup & Replication.Connect-VBRWindowsGuestProductionMachineConnects to the machine where original files and folders reside.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.
Convert
Convert-VBRLegacyCopyBackupConverts legacy backup file of legacy periodic backup copy job to the per-machine backup with separate metadata files using mapping.Convert-VBRNASBackupRootFormatConverts backups created by one file backup job for separate non-root shared folders residing on the same server into the backup created for the server single root folder.Convert-VBRNASBackupSANFormatConverts backups created for SMB or NFS file shares residing on an enterprise NAS system into the format of a NAS filer share on the same storage system.Convert-VBRNASBackupStorageFormatConverts format of baskets used for storing backups created with file backup and file backup copy jobs.
Copy
Copy-VBRAntivirusConfigurationFileCopies the antivirus configuration file.Copy-VBRBackupCopies backups to a repository or local or shared folder.Copy-VBRBackupCopyJobClones a backup copy job.Copy-VBRComputerBackupCopyJobClones Veeam Agent backup copy jobs. This cmdlet is obsolete and only works for cloning a simple mode backup copy job. It is recommended to clone a new backup job using the Copy-VBRBackupCopyJob cmdlet.Copy-VBRComputerBackupJobClones Veeam Agent backup jobs and Veeam Agent backup policies.Copy-VBRJobClones existing jobs.Copy-VBRLinuxGuestItemCopies Linux-based or Unix-based guest OS files to the target host.Copy-VBRNASBackupCopies file share backups to another repository or local or shared folder. This cmdlet is obsolete. Run the Copy-VBRUnstructuredBackup cmdlet instead.Copy-VBRUnstructuredBackupCopies backups created by file backup jobs and object storage backup jobs to another location.Copy-VBRWindowsGuestItemCopies Microsoft Windows guest OS files to the target host.
Deploy
Deploy-VBRAzureApplianceTemplateDeploys a helper appliance template.Deploy-VBRAzureLinuxRestoreApplianceDeploys or removes helper appliances for restoring Linux VMs to Microsoft Azure.
Detach
Detach-VBRBackupDetaches backups from the job they belong to.Detach-VBRDiscoveredComputerBackupRevokes a discovered computer's access to a backup.
Disable
Disable-VBRApplicationBackupJobDisables application backup policies.Disable-VBRArchiveExtentMaintenanceModeDisables the Maintenance mode for the archive extent.Disable-VBRArchiveExtentSealedModeDisables the Sealed mode for the archive extent.Disable-VBRBackgroundRetentionDisables background retention for backups.Disable-VBRBackupCopyJobDisables backup copy jobs.Disable-VBRCapacityExtentMaintenanceModeDisables the Maintenance mode for capacity extents.Disable-VBRCapacityExtentSealedModeDisable Sealed mode for capacity extents.Disable-VBRCatalystCopyJobDisables backup copy jobs for HPE StoreOnce repositories. This cmdlet is obsolete. Run the Disable-VBRStorageCopyJob cmdlet instead.Disable-VBRCDPPolicyDisables CDP policies including Cloud Director CDP policies, CDP policies, cloud CDP policies and so on.Disable-VBRCDPProxyDisables CDP proxies.Disable-VBRCloudGatewayDisables cloud gateways.Disable-VBRCloudGatewayPoolDisables cloud gateway pools.Disable-VBRCloudMaintenanceModeDisables Maintenance mode for the cloud infrastructure.Disable-VBRCloudSubTenantDisables cloud subtenant accounts.Disable-VBRCloudSubUserDisables cloud subuser accounts.Disable-VBRCloudTenantDisables cloud tenant accounts.Disable-VBRComputerBackupCopyJobDisables Veeam Agent backup copy jobs.Disable-VBRComputerBackupJobDisables Veeam Agent backup jobs and Veeam Agent backup policies.Disable-VBRComputerFileProxyServerDisables general-purpose backup proxies.Disable-VBREPJobDisables backup jobs run by Veeam Agent operating in the standalone mode.Disable-VBRFreeAgentInstanceConsumptionDisables instance consumption by non-licensed Veeam Agents.Disable-VBRHvProxyDisables the Hyper-V backup proxy.Disable-VBRJobPuts a selected job on hold.Disable-VBRJobGuestFSIndexingDisables job guest file system indexing option.Disable-VBRJobScheduleDisables job schedule.Disable-VBRJobVSSIntegrationDisables job VSS settings.Disable-VBRLicenseAutoUpdateDisables the automatic license update option.Disable-VBRMailNotificationDisables global email notification settings.Disable-VBRNASProxyServerDisables general-purpose backup proxies.Disable-VBRPluginJobDisables backup jobs that were created with standalone Veeam Plug-ins and backup copy jobs of backups created with Veeam Plug-ins.Disable-VBRPreferredNetworkDataTransferDisables data transfer over preferred networks only.Disable-VBRProtectionGroupDisables automatic discovery for the protection group computers.Disable-VBRRepositoryExtentMaintenanceModeDisables Maintenance mode for extents of a scale-out backup repository.Disable-VBRRepositoryExtentSealedModeDisables Sealed mode for extents of a scale-out backup repository.Disable-VBRStorageCopyJobDisables storage backup copy jobs.Disable-VBRStorageLatencyControlDisables the storage latency control option.Disable-VBRSureBackupJobDisables running SureBackup jobs.Disable-VBRTapeDriveDisables a selected tape library drive.Disable-VBRTapeLibraryMaintenanceDisables the Maintenance mode for a tape library or a standalone tape drive.Disable-VBRTapeProtectionDisables protection set for tapes.Disable-VBRvCDReplicaJobDisables Cloud Director replication jobs.Disable-VBRViProxyDisables a VMware backup proxy.Disable-VSBJobPuts a selected SureBackup job on hold. This cmdlet is obsolete. Run the Disable-VBRSureBackupJob cmdlet instead.Disable-VSBJobScheduleDisables a selected SureBackup job schedule. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.
Disconnect
Disconnect-VBRAmazonS3ServiceStops active sessions with Amazon S3 and S3 compatible object storage.Disconnect-VBRAzureBlobServiceStops active sessions with Microsoft Azure Blob storage.Disconnect-VBRGoogleCloudServiceStops active sessions with Google Cloud object storage.Disconnect-VBRServerEnds current session with a Veeam backup server.
Download
Download-VBRDeletedArchivedBackupFileRetrieves a backup file deleted from the archive tier and preserved by insider protection.
Eject
Eject-VBRTapeDriveEjects tape from the selected media drive. This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using the Eject-VBRTapeMedium cmdlet.Eject-VBRTapeMediumEjects tapes from drive.
Enable
Enable-VBRApplicationBackupJobEnables application backup policies.Enable-VBRArchiveExtentMaintenanceModeEnables the Maintenance mode for the archive extent.Enable-VBRArchiveExtentSealedModeEnables the Sealed mode for the archive extent.Enable-VBRBackgroundRetentionEnables previously disabled background retention for backups.Enable-VBRBackupCopyJobEnables backup copy jobs.Enable-VBRCapacityExtentMaintenanceModeEnables the Maintenance mode for capacity extents.Enable-VBRCapacityExtentSealedModeEnables Sealed mode for capacity extents.Enable-VBRCatalystCopyJobEnables backup copy jobs for HPE StoreOnce repositories. This cmdlet is obsolete. Run the Enable-VBRStorageCopyJob cmdlet instead.Enable-VBRCDPPolicyEnables CDP policies including Cloud Director CDP policies, CDP policies, cloud CDP policies and so on.Enable-VBRCDPProxyEnables CDP proxies that were disabled.Enable-VBRCloudGatewayEnables disabled cloud gateways.Enable-VBRCloudGatewayPoolEnables disabled cloud gateway pools.Enable-VBRCloudMaintenanceModeEnables Maintenance mode for the cloud infrastructure.Enable-VBRCloudSubTenantEnables disabled cloud subtenant accounts.Enable-VBRCloudSubUserEnables disabled cloud subuser accounts.Enable-VBRCloudTenantEnables disabled cloud tenant accounts.Enable-VBRComputerBackupCopyJobEnables Veeam Agent backup copy jobs.Enable-VBRComputerBackupJobEnables Veeam Agent backup jobs and Veeam Agent backup policies.Enable-VBRComputerFileProxyServerEnables disabled general-purpose backup proxies.Enable-VBREPJobEnables disabled backup jobs run by Veeam Agent operating in the standalone mode.Enable-VBRFreeAgentInstanceConsumptionEnables instance consumption by unlicensed Veeam Agents.Enable-VBRHvProxyEnables the disabled Hyper-V backup proxy.Enable-VBRJobEnables a disabled job.Enable-VBRJobGuestFSIndexingEnables job guest file system indexing option.Enable-VBRJobScheduleEnables job schedule.Enable-VBRJobVSSIntegrationEnables job VSS settings.Enable-VBRLicenseAutoUpdateEnables the automatic license update option.Enable-VBRMailNotificationEnables global email notification settings.Enable-VBRNASProxyServerEnables general-purpose backup proxies.Enable-VBRPluginJobEnables backup jobs that were created with standalone Veeam Plug-ins and backup copy jobs of backups created with Veeam Plug-ins.Enable-VBRPreferredNetworkDataTransferEnables data transfer over preferred networks only.Enable-VBRProtectionGroupEnables automatic discovery for the protection group computers.Enable-VBRRepositoryExtentMaintenanceModeEnables Maintenance mode for a performance extent or capacity extent of a scale-out backup repository.Enable-VBRRepositoryExtentSealedModeEnables Sealed mode for extents of a scale-out backup repository.Enable-VBRStorageCopyJobEnables storage backup copy jobs.Enable-VBRStorageLatencyControlEnables the storage latency control option.Enable-VBRSureBackupJobEnables stopped SureBackup jobs.Enable-VBRTapeDriveEnables a selected tape library drive.Enable-VBRTapeLibraryMaintenanceEnables the Maintenance mode for a tape library or a standalone tape drive.Enable-VBRTapeProtectionSets overwrite protection for selected tapes.Enable-VBRvCDReplicaJobEnables Cloud Director replication jobs.Enable-VBRViProxyEnables a disabled VMware backup proxy.Enable-VSBJobEnables a disabled SureBackup job. This cmdlet is obsolete. Run the Enable-VBRSureBackupJob cmdlet instead.Enable-VSBJobScheduleEnables a SureBackup job schedule. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.
Erase
Erase-VBRTapeMediumErases data from tape.
Export
Export-VBRAuditExports report on actions performed in Veeam Backup & Replication.Export-VBRBackupExports a backup or restore point files to a selected folder. This cmdlet is obsolete. Run the Copy-Item cmdlet instead.Export-VBRConfigurationStarts configuration backup job. This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using cmdlets from the Configuration Backup section.Export-VBREntraIDTenantItemToJsonExports Microsoft Entra ID tenant item properties and metadata in the JSON format.Export-VBRJobObjectMasksExports masks of objects for file backup jobs and object storage backup jobs.Export-VBRLinuxKnownHostExports trusted Linux SSH and deployer certificate fingerprints to a file on the backup server.Export-VBRLocationExports geographic locations from Veeam Backup & Replication.Export-VBRLogsCollects system logs for export.Export-VBRMalwareDetectionExtensionListExports a list of suspicious files extensions to a certain file.Export-VBRRestorePointExports backup files of a specific restore point.Export-VBRTapeMediumMoves tapes to Import and Export slot.Export-VBRVSAEventForwardingFilteringRuleExports Veeam Software Appliance syslog event forwarding filtering rules to a file.
Find
Find-VBRADEntityLooks for Active Directory objects.Find-VBRDatastoreReturns a list of VMware datastores connected to the specified ESXi host. This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using the Find-VBRViDatastore cmdlet.Find-VBRHvEntityReturns Hyper-V objects.Find-VBRObjectReturns a list of all VMs and VM containers on the specified ESXi host. This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using the Find-VBRViEntity and Find-VBRHvEntity cmdlets.Find-VBRResourcePoolLooks for VMware resource pools. This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using the Find-VBRViResourcePool cmdlet.Find-VBRTapeCatalogLooks for files stored on tapes. This cmdlet is obsolete. The cmdlet still works but may not be supported in further versions.Find-VBRTapeCatalogItemLooks for files or folders backed-up by tape jobs.Find-VBRTapeCatalogItemVersionLooks for backed up versions of a file or folder.Find-VBRTapeCatalogVersionLooks for versions of files stored on tapes. This cmdlet is obsolete. The cmdlet still works but may not be supported in further versions.Find-VBRvCloudEntityLooks for Cloud Director entities.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.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.
Forget
Forget-VBRCloudUnavailableBackupFileRemoves backup files, that are no longer available, from a cloud repository.
Generate
Generate-VBRBackupServerCertificateGenerates a TLS certificate that is used to establish a secure connection from backup infrastructure components to the backup server.Generate-VBRBackupServerDeployerKitGenerates Veeam Installer Service and Veeam Deployer Service certificates and installation packages for Microsoft Windows, Linux, and Unix computers.Generate-VBRCloudGatewayCertificateCreates a new self-signed TLS certificate for cloud gateways.Generate-VBREntraIDTenantUserPasswordCreates passwords.Generate-VBRLicenseUsageReportCreates reports on license usage.Generate-VBRViMigrationSpecificationFileGenerates a migration task file.
Get
Get-HP3InfrastructureVolumeReturns volumes of HPE 3PAR StoreServ storage systems.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.Get-HyperFlexHostReturns Cisco HyperFlex storage systems.Get-NetAppHostReturns NetApp storage systems added to Veeam Backup & Replication.Get-NetAppInfrastructureVolumeReturns storage volumes of NetApp storage systems.Get-NetAppSnapshotReturns NetApp storage snapshots.Get-NetAppVolumeReturns NetApp storage volumes added to the backup infrastructure.Get-NimbleHostReturns HPE Nimble storage systems.Get-NimbleInfrastructureVolumeReturns volumes of HPE Nimble storage systems.Get-NimbleSnapshotReturns HPE Nimble storage snapshots.Get-NimbleVolumeReturns HPE Nimble volumes added to the backup infrastructure.Get-StoragePluginArchivedSnapshotReturns archived snapshots of Universal Storage API integrated systems.Get-StoragePluginHostReturns Universal Storage API integrated systems.Get-StoragePluginInfrastructureVolumeReturns volumes of Universal Storage API integrated systems.Get-StoragePluginSnapshotReturns snapshots of Universal Storage API integrated systems.Get-StoragePluginVolumeReturns volumes of Universal Storage API integrated systems added to the backup infrastructure.Get-ThinkSystemHostReturns ThinkSystem storage systems added to the backup infrastructure.Get-ThinkSystemInfrastructureVolumeReturns storage volumes of ThinkSystem storage systems.Get-ThinkSystemSnapshotReturns ThinkSystem storage snapshots.Get-ThinkSystemVolumeReturns ThinkSystem storage volumes added to the backup infrastructure.Get-VBRADDomainCreates an object for connecting to Active Directory domain.Get-VBRADForestReturns Microsoft Active Directory forests in your infrastructure.Get-VBRADForestDomainReturns Active Directory domains within a forest or a restore point.Get-VBRADForestDomainControllerReturns domain controllers for an Active Directory domain.Get-VBRADForestDomainRestorePointReturns restore points for an Active Directory domain.Get-VBRADForestRestorePointReturns restore points for a Microsoft Active Directory forest.Get-VBRADForestRestoreSessionReturns Microsoft Active Directory forest restore sessions.Get-VBRAdvancedLatencyOptionsReturns latency settings for a specific datastore.Get-VBRAmazonAccountReturns AWS credentials records.Get-VBRAmazonEC2InstanceTypeReturns an array of Amazon EC2 instances.Get-VBRAmazonEC2RegionReturns AWS Regions and datacenters.Get-VBRAmazonEC2SecurityGroupReturns an array of AmazonEC2 security groups.Get-VBRAmazonEC2SubnetReturns an array of Amazon VPC subnets.Get-VBRAmazonEC2VMReturns Amazon EC2 instances.Get-VBRAmazonEC2VPCReturns an Amazon VPC.Get-VBRAmazonRestoreSessionReturns active restore sessions to Amazon EC2.Get-VBRAmazonS3BucketReturns Amazon S3 buckets.Get-VBRAmazonS3FolderReturns Amazon S3 folders.Get-VBRAmazonS3RegionReturns Amazon S3 regions.Get-VBRApplicationBackupJobReturns application backup policies.Get-VBRApplicationBackupJobSessionReturns job sessions.Get-VBRApplicationBackupRepositoryReturns application backup repositories.Get-VBRApplicationBackupSnapshotReturns application backup snapshots.Get-VBRApplicationGroupReturns VMware and Hyper-V application groups.Get-VBRApplicationRestorePointReturns restore points created with the VSS-aware image processing enabled.Get-VBRArchiveExtentReturns the archive extent.Get-VBRArchiveObjectStorageRepositoryReturns archive repositories added to the backup infrastructure.Get-VBRArchiveTierSyncIntervalReturns a time period of checkpoints in the archive tier that are available for synchronization.Get-VBRAvailableUpdatesReturns available software updates for a Linux-based backup server or a Veeam Infrastructure Appliance.Get-VBRAzureAccountReturns Microsoft Azure accounts added to Veeam Backup & Replication.Get-VBRAzureADAccountReturns Azure Entra ID-based storage accounts.Get-VBRAzureApplianceSessionReturns statuses of deployment sessions for helper restore appliance.Get-VBRAzureApplianceTemplateReturns deployed helper appliance templates.Get-VBRAzureBlobAccountReturns Microsoft Azure Blob credentials records.Get-VBRAzureBlobContainerReturns Azure Blob containers.Get-VBRAzureBlobFolderReturns Microsoft Azure Blob folders.Get-VBRAzureCloudServiceReturns Microsoft Azure cloud services available for a subscription.Get-VBRAzureComputeBackupReturns Azure backups.Get-VBRAzureInstantRecoveryReturns an array of objects on the Instant Recovery to Microsoft Azure operation.Get-VBRAzureInstantRecoverySessionReturns session logs for the Instant Recovery to Microsoft Azure operation.Get-VBRAzureInstantRecoverySwitchingOptionsReturns the switchover options.Get-VBRAzureLinuxRestoreApplianceReturns helper appliances for restoring Linux VMs to Microsoft Azure.Get-VBRAzureLocationReturns geographic locations of Microsoft Azure datacenters available for a subscription.Get-VBRAzureNetworkSecurityGroupReturns Microsoft Azure security groups.Get-VBRAzureResourceGroupReturns Microsoft Azure resource groups available for a subscription.Get-VBRAzureRestoreProxyReturns a restore proxy appliance for restoring backups to Microsoft Azure VMs.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-VBRAzureVMReturns Azure VMs.Get-VBRAzureVMSizeReturns Microsoft Azure VM configuration options available for a subscription.Get-VBRBackupReturns backups.Get-VBRBackupCopyJobReturns backup copy jobs.Get-VBRBackupFileReturns backup files.Get-VBRBackupObjectReturns backups or replicas of machines.Get-VBRBackupRepositoryReturns a list of backup repositories.Get-VBRBackupServerCertificateReturns TLS certificates.Get-VBRBackupServerInfoReturns the backup server information.Get-VBRBackupSessionReturns jobs sessions.Get-VBRCapacityExtentReturns the capacity extents.Get-VBRCapacityTierSyncIntervalReturns a time period of checkpoints in capacity tier that are available for synchronization.Get-VBRCatalystCopyJobReturns backup copy jobs for HPE StoreOnce repositories. This cmdlet is obsolete. Run the Get-VBRStorageCopyJob cmdlet instead.Get-VBRCDPFilterReturns a list of Veeam I/O filters that are installed on VMware clusters.Get-VBRCDPLongTermRestorePointReturns a long-term restore point of VM replicas.Get-VBRCDPPolicyReturns CDP policies including Cloud Director CDP policies, CDP policies, cloud CDP policies and so on.Get-VBRCDPProxyReturns CDP proxies added to the backup infrastructure.Get-VBRCDPReplicaReturns CDP replicas created by CDP policies including Cloud Director CDP policies, CDP policies, cloud CDP policies and so on.Get-VBRCDPReplicaGet-VBRCDPSessionReturns CDP policy sessions.Get-VBRCDPShortTermRestoreIntervalReturns a list of replicated states for VM replicas.Get-VBRCDPTaskSessionReturns VMs processed during CDP policy sessions.Get-VBRCloudArchiveRestorePointReturns restore points of tenant backups located in the archive tier.Get-VBRCloudDatastoreReturns datastores or disk volumes allocated to you under your cloud resources.Get-VBRCloudGatewayReturns cloud gateways.Get-VBRCloudGatewayCertificateReturns TLS certificates.Get-VBRCloudGatewayPoolReturns cloud gateway pools.Get-VBRCloudHardwarePlanReturns existing hardware plans.Get-VBRCloudInfrastructureStateReturns the current state of the cloud infrastructure.Get-VBRCloudProviderReturns service providers.Get-VBRCloudProviderCredentialsReturns an array of cloud provider credentials records added to Veeam Backup & Replication.Get-VBRCloudProviderNetworkApplianceReturns network extension appliance configured on the user side.Get-VBRCloudPublicIPReturns existing public IP addresses.Get-VBRCloudServerReturns cloud hosts allocated by a service provider.Get-VBRCloudServerNetworkInfoReturns networks available in your cloud resources.Get-VBRCloudSubTenantReturns cloud subtenant accounts.Get-VBRCloudSubUserReturns cloud subuser accounts.Get-VBRCloudTapeBackupTenantReturns tenants backups.Get-VBRCloudTapeBackupTenantJobReturns tenant jobs.Get-VBRCloudTapeBackupTenantRepositoryReturns tenant cloud repositories.Get-VBRCloudTapeRestoreSessionReturns active restore sessions of the tenant data from tape.Get-VBRCloudTenantReturns cloud tenant accounts.Get-VBRCloudTenantBackupReturns backups of AD tenants and tenants managed by the Service Provider.Get-VBRCloudTenantNetworkApplianceReturns network extension appliances.Get-VBRCloudTenantRestorePointReturns restore points of non-encrypted backups for AD tenants and tenants managed by the Service Provider.Get-VBRCloudUnavailableBackupFileReturns a list of backup files that are no longer available in the cloud repository.Get-VBRCloudVLANConfigurationReturns reserved VLAN ranges.Get-VBRCommandReturns Veeam PowerShell module cmdlets.Get-VBRComputerBackupCopyJobReturns Veeam Agent backup copy jobs.Get-VBRComputerBackupJobReturns Veeam Agent backup jobs and Veeam Agent backup policies.Get-VBRComputerBackupJobSessionReturns jobs sessions.Get-VBRComputerDiskReturns disks of computers backed-up with Veeam Agent for Microsoft Windows.Get-VBRComputerDiskPartitionReturns volumes of computers backed-up with Veeam Agent for Microsoft Windows.Get-VBRComputerFileProxyServerReturns general-purpose backup proxies added to the Veeam Backup & Replication infrastructure.Get-VBRComputerNetworkInfoReturns networks connected to Veeam Agent computers.Get-VBRComputerRecoveryTokenReturns tokens for bare-metal recovery.Get-VBRConfigurationBackupJobReturns the configuration backup job.Get-VBRCopyBackupSessionReturns copy sessions.Get-VBRCredentialsReturns credentials records.Get-VBRDefaultGatewayConfigurationReturns configuration of default gateways.Get-VBRDefaultLinuxMountServerReturns the default Linux mount server.Get-VBRDefaultWindowsMountServerReturns the default Windows mount server.Get-VBRDeletedArchivedBackupFileReturns an array of backup files deleted from the archive tier and preserved by insider protection.Get-VBRDeletedDehydratedBackupFileReturns a list of backup files deleted from the capacity tier and preserved by insider protection.Get-VBRDiscoveredApplicationReturns discovered applications from the computer.Get-VBRDiscoveredComputerReturns discovered computers.Get-VBRDiscoveredComputerBackupReturns backups of discovered computers.Get-VBRDiscoveredComputerConfigurationPolicyReturns configuration options applied to protected computers.Get-VBRDiscoveredComputerNetworkReturns network adapters of discovered computers with the Veeam CDP Agent Service installed.Get-VBRDiscoveredComputerUpdateReturns available Veeam Agent private fixes.Get-VBREC2BackupReturns EC2 instance backups.Get-VBREncryptedBackupReturns encrypted backups.Get-VBREncryptedBackupHintReturns password hints for imported encrypted backups.Get-VBREncryptedTapeMediumHintReturns password hints for encrypted backups stored on tapes.Get-VBREncryptionKeyReturns encryption keys.Get-VBREntraIDLogsBackupReturns backups of Microsoft Entra ID logs.Get-VBREntraIDLogsBackupFLRItemReturns backed-up objects created by a log backup job.Get-VBREntraIDLogsBackupJobReturns Microsoft Entra ID log backup jobs.Get-VBREntraIDTenantReturns Microsoft Entra ID tenants added to the backup infrastructure.Get-VBREntraIDTenantBackupReturns backups of Microsoft Entra ID tenants.Get-VBREntraIDTenantBackupJobReturns backup jobs that protect Microsoft Entra ID tenants.Get-VBREntraIDTenantItemReturns Microsoft Entra ID items that a backup contains.Get-VBREntraIDTenantItemRestoreSessionReturns a restore session launched for the item or attribute restore.Get-VBREntraIDTenantRestorePointReturns restore points of a Microsoft Entra ID tenant backup.Get-VBREntraIDTenantRestoreSessionReturns restore sessions started to recover Microsoft Entra ID tenant backups.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.Get-VBRExportLogSessionReturns details on sessions that were started to collect system logs.Get-VBRExternalRepositoryReturns an array of external repositories from the backup infrastructure.Get-VBRFailbackSwitchingScheduleReturns the failback switching schedule.Get-VBRFailoverPlanReturns existing failover plans or cloud failover plans.Get-VBRFCDInstantRecoveryInfoReturns details on the mounting of virtual disks that are recovered within an FCD instant recovery session.Get-VBRFCDInstantRecoverySessionReturns an array of FCD recovery sessions.Get-VBRFilerReturns enterprise NAS systems added as file shares to the inventory.Get-VBRFilesInRestorePointReturns backup files in a selected restore point.Get-VBRFreeAgentInstanceConsumptionStatusReturns a state of the instance consumption by non-licensed Veeam Agents.Get-VBRGeneralUpdateOptionsReturns general update settings for the Linux-based backup server and Veeam Infrastructure Appliances.Get-VBRGlobalNotificationOptionsReturns global notification settings.Get-VBRGoogleCloudAccountReturns Google Cloud credentials records.Get-VBRGoogleCloudBackupReturns backups of Google Cloud VM instances.Get-VBRGoogleCloudBucketReturns Google Cloud buckets.Get-VBRGoogleCloudComputeAccountReturns Google Cloud service account credentials record.Get-VBRGoogleCloudComputeInstanceTypeReturns Google Cloud VM instance types.Get-VBRGoogleCloudComputeRegionReturns Google Cloud regions.Get-VBRGoogleCloudComputeSharedSubnetReturns subnets of Google Cloud shared VPC network.Get-VBRGoogleCloudComputeSubnetReturns subnets for Google Cloud region.Get-VBRGoogleCloudComputeVPCReturns Virtual Private Cloud (VPC) networks.Get-VBRGoogleCloudComputeZoneReturns Google Cloud availability zones.Get-VBRGoogleCloudFolderReturns Google Cloud folders.Get-VBRGoogleCloudRegionReturns Google Cloud regions.Get-VBRGoogleCloudRestoreSessionReturns restore to Google Cloud sessions.Get-VBRHighAvailabilityClusterReturns an HA cluster and information about the state of the cluster and the nodes.Get-VBRHistoryOptionsReturns job sessions history settings.Get-VBRHvProxyReturns a list of the Hyper-V backup proxies.Get-VBRHvReplicaReIpRuleReturns Hyper-V job re-IP rules.Get-VBRHvServerConfigurationReturns settings of Microsoft Hyper-V hosts added to the backup infrastructure.Get-VBRHvServerNetworkInfoReturns virtual networks for a Hyper-V host.Get-VBRHvServerVolumeReturns volume-specific settings for Microsoft Hyper-V hosts.Get-VBRHvVirtualLabConfigurationReturns virtual labs and their settings.Get-VBRHvVssProviderReturns VSS providers.Get-VBRInstalledLicenseReturns details about licenses installed on a backup server.Get-VBRInstanceLicenseSummaryReturns details on the per-instance license usage.Get-VBRInstantRecoveryReturns running Instant Recovery sessions.Get-VBRInstantRecoveryMigrationReturns running migration sessions launched during Instant Recovery.Get-VBRInternetProxyUpdateOptionsReturns internet proxy update settings.Get-VBRIrisInstanceOriginalPathReturns original paths of InterSystems IRIS instance data in a restore point.Get-VBRIsilonHostReturns Dell PowerScale (formerly Isilon) storage systems.Get-VBRIsilonInfrastructureVolumeReturns volumes of Dell PowerScale (formerly Isilon) storage systems.Get-VBRIsilonVolumeReturns Dell PowerScale (formerly Isilon) volumes added to the backup infrastructure.Get-VBRJobReturns existing jobs.Get-VBRJobObjectReturns VMs or VM containers of specific jobs.Get-VBRJobObjectVssOptionsReturns VSS settings of a specific VM in job.Get-VBRJobOptionsReturns job settings.Get-VBRJobProxyReturns a list of proxy servers assigned to a specific job.Get-VBRJobScheduleOptionsReturns job scheduling settings.Get-VBRJobVSSOptionsReturns VSS settings for a selected job.Get-VBRKMSServerReturns KMS servers added to the Veeam Backup & Replication console.Get-VBRLegacyBackupCopySourceJobReturns legacy periodic backup copy job source objects.Get-VBRLicenseAutoUpdateStatusReturns a state of the automatic license update option.Get-VBRLicensedInstanceWorkloadReturns details on protected workloads for the per-instance license.Get-VBRLicensedSocketWorkloadReturns details on licensed hosts.Get-VBRLinuxGuestItemReturns Linux-based or Unix-based guest OS files.Get-VBRLinuxPackageReturns information about Linux components installed on the backup server.Get-VBRLinuxTrustedHostPolicyReturns the trust policy for protected Linux and Microsoft Windows machines.Get-VBRLocalhostReturns the local server on which the backup infrastructure is installed.Get-VBRLocationReturns geographic locations created in Veeam Backup & Replication.Get-VBRMailNotificationConfigurationReturns global email notification settings.Get-VBRMalwareDetectionEventReturns malware detection events for machines.Get-VBRMalwareDetectionExclusionReturns a list of machines added to malware exclusions.Get-VBRMalwareDetectionObjectReturns machines affected by malware.Get-VBRMalwareDetectionOptionsReturns malware detection settings.Get-VBRMalwareDetectionTaskSessionReturns malware detection session.Get-VBRMongoDBComputerReturns a list of all computers within specified replica sets.Get-VBRMoveBackupSessionReturns move sessions.Get-VBRNASBackupReturns backup files created by the file backup job. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackup cmdlet instead.Get-VBRNASBackupCopyJobReturns file backup copy jobs. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupCopyJob cmdlet instead.Get-VBRNASBackupFLRItemReturns backed-up objects created by file backup jobs. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupFLRItem cmdlet instead.Get-VBRNASBackupFLRItemVersionReturns versions of objects backed-up by file backup jobs. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupFLRItemVersion cmdlet instead.Get-VBRNASBackupFLRSessionReturns restore sessions started to recover backups created by file backup jobs. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupFLRSession cmdlet instead.Get-VBRNASBackupJobReturns file backup jobs. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupJob cmdlet instead.Get-VBRNASBackupRestorePointReturns restore points of backups created by file backup jobs. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupRestorePoint cmdlet instead.Get-VBRNASBackupSessionReturns file backup job sessions. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupSession cmdlet instead.Get-VBRNASBackupTaskSessionReturns tasks for file backup sessions. This cmdlet is obsolete. Run the Get-VBRUnstructuredBackupTaskSession cmdlet instead.Get-VBRNASInstantRecoveryReturns active instant restore sessions started to recover backups created by file backup jobs.Get-VBRNASInstantRecoveryMigrationReturns active sessions of migration to production during the instant file share recovery.Get-VBRNASObjectStorageTransformThresholdReturns the blob transformation threshold defined for an object storage repository that stores file backups.Get-VBRNASProxyServerReturns file backup proxy servers added to the Veeam Backup & Replication infrastructure.Get-VBRNASServerReturns file shares that are added to the Veeam Backup & Replication infrastructure. This cmdlet is obsolete. Run the Get-VBRUnstructuredServer cmdlet instead.Get-VBRNASServerPathReturns files paths to NFS network shared folders.Get-VBRNDMPServerReturns NDMP servers.Get-VBRNDMPVolumeReturns NDMP server volumes.Get-VBRNDMPVolumeRestorePointReturns restore points of NDMP server volumes.Get-VBRNetAppNDMPHostedServerReturns NetApp NDMP LIFs.Get-VBRNetworkTrafficRuleReturns network traffic rules.Get-VBRNetworkTrafficRuleOptionsReturns settings of global network traffic rules.Get-VBRNodeExporterOptionsReturns node exporter metrics for Veeam Software Appliance.Get-VBRNutanixHostReturns Nutanix Files storage systems.Get-VBRNutanixInfrastructureVolumeReturns Nutanix Files volumes added to the backup infrastructure.Get-VBRNutanixVolumeReturns all volumes of the specified Nutanix Files storage systems.Get-VBRObjectRestorePointReturns restore points created by jobs.Get-VBRObjectStorageRepositoryReturns object storage added as backup repositories to Veeam Backup & Replication.Get-VBROracleDatabase (obsolete)Get-VBROracleDatabaseRestoreInterval (obsolete)Get-VBRPhysicalHostReturns managed servers added to the backup infrastructure.Get-VBRPluginBackupSessionReturns sessions of application backup policies and backup jobs for standalone Veeam Plug-ins.Get-VBRPluginJobReturns backup jobs that were created with standalone Veeam Plug-ins and backup copy jobs of backups created with Veeam Plug-ins.Get-VBRPluginRestoreSessionReturns active restore sessions for standalone and managed Veeam Plug-ins.Get-VBRPreferredNetworkReturns preferred networks.Get-VBRProtectionGroupReturns protection groups.Get-VBRProtectionGroupLinuxPackageReturns Veeam Agent for Linux packages.Get-VBRProtectionGroupUnixPackageReturns Veeam Agents for Unix packages.Get-VBRPublishedBackupContentInfoReturns details on the published disks.Get-VBRPublishedBackupContentSessionReturns sessions that are running to publish disks from a backup or replica.Get-VBRRecoveryMediaTargetReturns available bootable media for creating Veeam Recovery Media.Get-VBRRecoveryPointObjectiveReturns a schedule for a backup copy jobs that process backups stored on external repositories.Get-VBRReplicaReturns replica objects of VMs or cloud VMs.Get-VBRRepositoryExtentReturns scale-out performance extents.Get-VBRRepositoryMountServerOptionsReturns settings of a mount server associated with a backup repository.Get-VBRRestorePointReturns restore points.Get-VBRRestoreSessionReturns restore sessions.Get-VBRRetentionPolicyReturns a retention policy for backup copy jobs.Get-VBRRoleEntityReturns roles configured in Veeam Backup & Replication.Get-VBRS3CompatibleRepositorySecurityOptionsReturns settings that Veeam Agent uses to access S3 compatible repositories.Get-VBRScanTaskSessionReturns scan task sessions performed during the specified SureBackup session.Get-VBRScanTaskSessionLogReturns the results of scan task sessions performed during the specified SureBackup job session.Get-VBRSecurityComplianceAnalyzerResultsReturns Security & Compliance Analyzer scan results.Get-VBRSecurityOptionsReturns Veeam Backup & Replication security settings.Get-VBRServerReturns hosts connected to the backup infrastructure.Get-VBRServerSessionReturns current session with a Veeam backup server.Get-VBRSessionReturns job sessions.Get-VBRSnapshotBackupReturns InterSystems IRIS snapshot backups.Get-VBRSnapshotRestorePointReturns restore points of InterSystems IRIS snapshot backups.Get-VBRSNMPOptionsReturns global SNMP settings.Get-VBRSOBRObjectStorageBackupReturns backups available in archive extents and capacity extents of scale-out backup repositories.Get-VBRSOBRObjectStorageRestorePointReturns restore points stored in archive extents and capacity extents of a scale-out backup repository.Get-VBRSocketLicenseSummaryReturns details on the per-socket license usage.Get-VBRSQLDatabase (obsolete)Get-VBRSQLDatabaseRestoreInterval (obsolete)Get-VBRStorageCopyJobReturns storage backup copy jobs.Get-VBRStorageLatencyControlOptionsReturns storage latency control settings on the production datastores.Get-VBRStoragePluginReturns plug-ins for adding Universal Storage API integrated systems.Get-VBRSureBackupJobReturns SureBackup jobs.Get-VBRSureBackupSessionReturns SureBackup sessions that have been run.Get-VBRSureBackupTaskSessionReturns tasks performed during the specified SureBackup session.Get-VBRSyslogEventFiltersReturns the list of syslog event filters.Get-VBRSyslogServerReturns the syslog server added to Veeam Backup & Replication.Get-VBRTapeBackupReturns the list of backups recorded to tape. This cmdlet is obsolete. The cmdlet will still work but it is recommended to perform the tape restore operation with Veeam Backup & Replication UI for full functionality.Get-VBRTapeBackupSessionReturns tape backup job sessions.Get-VBRTapeCopyDependentMediumReturns dependent tapes.Get-VBRTapeDbPluginRestorePointReturns restore points of database plug-in backups stored on tape.Get-VBRTapeDriveReturns tape drives.Get-VBRTapeJobReturns tape jobs.Get-VBRTapeLibraryReturns tape libraries.Get-VBRTapeMediaPoolReturns media pools.Get-VBRTapeMediaPoolOptionsReturns settings of a selected media pool. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.Get-VBRTapeMediumReturns tapes.Get-VBRTapeRestoreAllContentDependentMediumReturns dependent tapes.Get-VBRTapeServerReturns tape servers.Get-VBRTapeVaultReturns tape vaults.Get-VBRTaskSessionReturns tasks performed during job sessions.Get-VBRToolkitDocumentationOpens Veeam PowerShell online help.Get-VBRUnstructuredBackupReturns backup files created by file backup jobs and object storage backup jobs.Get-VBRUnstructuredBackupCopyJobReturns file backup copy jobs and object storage backup jobs.Get-VBRUnstructuredBackupFLRItemReturns backed-up objects created by file backup jobs or object storage backup jobs.Get-VBRUnstructuredBackupFLRItemVersionReturns versions of objects backed-up by file backup jobs or object storage backup jobs.Get-VBRUnstructuredBackupFLRSessionReturns restore sessions started to recover backups created by file backup jobs and object storage backup jobs.Get-VBRUnstructuredBackupJobReturns file backup jobs and object storage backup jobs.Get-VBRUnstructuredBackupRestorePointReturns restore points created by file backup jobs and object storage backup jobs.Get-VBRUnstructuredBackupRetrievalReturns active unstructured data retrieval operations.Get-VBRUnstructuredBackupSessionReturns backup sessions for file backup jobs and object storage backup jobs.Get-VBRUnstructuredBackupTaskSessionReturns tasks for file share and object storage backup sessions.Get-VBRUnstructuredServerReturns unstructured data sources added to the inventory.Get-VBRUploadStreamsConfigurationReturns details on data transfer settings for job sessions.Get-VBRUserRoleAssignmentReturns a role that is assigned to a user or a user group.Get-VBRvCDCDPFilterReturns a list of Veeam I/O filters installed on an ESXi host.Get-VBRvCDCDPLongTermRestorePointReturns long-term restore points of a Cloud Director CDP replica.Get-VBRvCDCDPShortTermRestoreIntervalReturns short-term restore points of a Cloud Director CDP replica.Get-VBRvCDCloudNetworkInfoReturns target VDC networks for replica mapping.Get-VBRvCDCloudOrganizationUserReturns Cloud Director user accounts.Get-VBRvCDCloudOrganizationvDCReturns organization VDCs.Get-VBRvCDCloudStoragePolicyReturns Cloud Director storage policies.Get-VBRvCDCloudvAppReturns VDC vApps.Get-VBRvCDCloudVMReturns cloud VMs from organization VDCs.Get-VBRVCDOrgVdcNetworkInfoReturns target networks for Cloud Director replica mapping.Get-VBRvCDReplicaReturns Cloud Director replicas.Get-VBRvCDReplicaJobReturns Cloud Director replication jobs.Get-VBRVeeamDataCloudAssignedVaultReturns Veeam storage vaults assigned to the backup server.Get-VBRViCloudVMReturns VMs available in cloud hosts allocated by cloud resources.Get-VBRViProxyReturns a list of VMware backup proxies.Get-VBRViReplicaReIpRuleReturns VMware job re-IP rules.Get-VBRVirtualLabReturns virtual labs with main settings.Get-VBRViServerNetworkInfoReturns virtual networks for a VMware host.Get-VBRViVirtualDeviceReturns details on VMware VM virtual disks.Get-VBRViVirtualLabConfigurationReturns virtual labs and their settings.Get-VBRViVirtualSwitchReturns VMware virtual switches.Get-VBRViVMReturns VMs available on a vCenter Server.Get-VBRVMExclusionReturns a list of global VM exclusions.Get-VBRVSAEventForwardingOptionsReturns Veeam Software Appliance syslog event forwarding settings.Get-VBRWANAcceleratorReturns WAN accelerators.Get-VBRWindowsGuestItemReturns Microsoft Windows guest OS files.Get-VBRYARARuleReturns YARA rules.Get-VNXHostReturns Dell VNX storage systems.Get-VNXInfrastructureVolumeReturns volumes of Dell VNX storage systems.Get-VNXSnapshotReturns Dell VNX storage snapshots.Get-VNXVolumeReturns Dell VNX volumes added to the backup infrastructure.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.
Import
Import-VBRBackupImports Veeam backups to Veeam Backup & Replication.Import-VBRConfigurationImports backup of Veeam Backup & Replication server configuration file. This cmdlet is obsolete and not supported.Import-VBRJobObjectMasksReturns details on the masks for file backup jobs and object storage backup jobs.Import-VBRLinuxKnownHostImports trusted Linux SSH and deployer certificate fingerprints from a file.Import-VBRLocationImports geographic locations to Veeam Backup & Replication.Import-VBRMalwareDetectionExtensionListImports a list of suspicious files extensions from a certain file.Import-VBRTapeMediumImports tapes into library.Import-VBRVSAEventForwardingFilteringRuleImports Veeam Software Appliance syslog event forwarding filtering rules from a file.
Install
Install-VBRAvailableUpdatesInstalls available software updates on a Linux-based backup server or a Veeam Infrastructure Appliance.Install-VBRCDPFilterInstalls Veeam I/O filters on VMware clusters.Install-VBRDiscoveredComputerAgentInstalls Veeam Agents on discovered computers.Install-VBRDiscoveredComputerCDPAgentInstalls Veeam CDP Guest Service and Veeam CDP volume filter driver.Install-VBRDiscoveredComputerPluginInstalls Veeam Plug-Ins on discovered computers.Install-VBRLicenseInstalls licenses on a backup server.Install-VBRLinuxTransportServiceInstalls Veeam Data Mover for guest processing on Linux VMs.Install-VBRvCDCDPFilterInstalls Veeam I/O filter on organization VDCs.
Mount
Mount-VBRObjectStorageRepositoryMounts object storage and archive repositories.Mount-VBRWindowsFileRestoreItemsMounts disks of VMs for which restore is launched to the Veeam Backup & Replication console.
Move
Move-VBRBackupMoves all backups of a job to another repository or specific workloads and their backups to another job.Move-VBRTapeMediumMoves a tape to media pool or vault.
New
New-VBRADContainerCreates a scope of Active Directory objects for a protection group.New-VBRADCustomCredentialsSpecifies custom credentials for authenticating with Active Directory objects.New-VBRADForestReIpRuleCreates a re-IP rule for a Microsoft Active Directory forest restore.New-VBRAmazonEC2ContainerDefines a scope of Amazon EC2 instances, EC2 tags or AWS datacenters for a protection group.New-VBRAmazonEC2DiskConfigurationCreates storage volume settings for Amazon EC2 instances.New-VBRAmazonEC2ProxyApplianceDefines settings for Amazon EC2 helper appliances.New-VBRAmazonEC2TagDefines AWS tags.New-VBRAmazonIpAddressDefines settings of a private IP address for Amazon EC2 instances.New-VBRAmazonS3FolderCreates Amazon S3 folders.New-VBRApplicationBackupOptionsCreates the backup settings and full backup schedule for application backup policies.New-VBRApplicationBackupRepositoryPermissionCreates a new permission for hosts to access an application backup repository NFS share.New-VBRApplicationBackupRepositoryScheduleOptionsCreates a snapshot creation schedule for application backup repositories.New-VBRApplicationBackupSnapshotCreates a new snapshot of the application backup repository.New-VBRApplicationProcessingOptionsCreates application-aware processing settings for Veeam Agent backup jobs.New-VBRApplicationScheduleOptionsCreates the schedule for application backup policies.New-VBRAzureApplianceTemplateDeploymentOptionsDefines deployment options for a helper appliance template.New-VBRAzureBlobFolderCreates Microsoft Azure Blob folders.New-VBRAzureComputeProxyApplianceDefines proxy appliance settings for adding Azure Archive repository.New-VBRAzureContainerDefines a scope of Azure VMs, Azure tags or Azure Availability Zone for a protection group.New-VBRAzureDiskConfigurationDefines Azure VM disk types.New-VBRAzureInstantRecoverySwitchingOptionsDefines the switchover options.New-VBRAzureLinuxRestoreApplianceCreates helper appliances for restoring Linux VMs to Microsoft Azure.New-VBRAzureTagDefines Azure metadata tags.New-VBRBackupCacheOptionsDefines backup cache settings for Veeam Agent for Microsoft Windows backup jobs.New-VBRBackupCopyJobStorageOptionsDefines storage settings for Veeam Agent backup copy jobs.New-VBRBackupToTapeScheduleOptionsCreates schedule settings for backup to tape job.New-VBRBackupWindowOptionsDefines backup window settings for a job.New-VBRCDPPolicyRetentionOptionsDefines retention settings of CDP policies.New-VBRCloudFailoverPlanObjectDefines VM replicas that you want to add to a failover plan.New-VBRCloudProviderNetworkApplianceCreates a network extension appliance on the user side.New-VBRCloudSubTenantResourceCreates quotas of cloud subtenant resources.New-VBRCloudSubUserResourceCreates quotas of cloud subuser 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-VBRComputerDestinationOptionsCreates the target location settings for backup policies.New-VBRComputerGFSMonthlyOptionsSpecifies settings of the monthly GFS retention policy for Veeam Agent backup jobs.New-VBRComputerGFSOptionsDefines settings of GFS retention for Veeam Agent backup jobs.New-VBRComputerGFSWeeklyOptionsDefines settings of the weekly GFS retention policy for Veeam Agent backup jobs.New-VBRComputerGFSYearlyOptionsDefines settings of the yearly GFS retention policy for Veeam Agent backup jobs.New-VBRComputerIndexingOptionsCreates indexing settings for Veeam Agent backup jobs.New-VBRComputerWarningOptionsDefines notification settings for computers not processed by Veeam Agent jobs.New-VBRConfigurationBackupScheduleOptionsCreates a new VBRConfigurationBackupScheduleOptions object.New-VBRCSVContainerCreates a scope of computers listed in a CSV file.New-VBRCSVCustomCredentialsSpecifies custom credentials for authenticating with computers listed in a CSV file.New-VBRDailyOptionsCreates new job daily schedule settings.New-VBRDatabaseProcessingOptionsCreates the database processing settings for application backup policies.New-VBRDecryptionSetDefines data decryption settings.New-VBRDiscoveredComputerConfigurationOptionCreates new configuration options for Veeam Agent settings. Make sure to test this cmdlet in the lab before you run it in the production environment.New-VBREncryptionOptionsDefines encryption settings.New-VBREntraIDBackupSecondaryTargetDefines secondary repository settings.New-VBREntraIDTenantItemExportMappingDefines an object with a restore point that you want to use when exporting Microsoft Entra ID item data.New-VBREntraIDTenantItemIncludedPropertyDefines an object with item properties or references that you want to restore.New-VBREntraIDTenantProtectedScopeSpecifies the tenant protection scope.New-VBREntraIDUserCredentialsDefines an object that matches a Microsoft Entra ID user and a password.New-VBRFailbackSwitchingScheduleDefines the failback switching schedule.New-VBRFailoverPlanObjectCreates the VBRFailoverPlanObject object.New-VBRFailoverPlanPublicIPRuleCreates a rule for mapping public IP and ports to the internal IP and ports of the cloud replica VM.New-VBRFCDInstantRecoveryMappingOptionsDefines mapping settings of virtual disks that you want to restore using the Instant FCD Recovery.New-VBRFileRestoreLinuxHelperApplianceOptionsDefines configuration settings for a temporary helper appliance.New-VBRFileToTapeBackupPolicyCreates schedule settings for a file to tape job.New-VBRFileToTapeObjectDefines settings of the source for the files to tape job.New-VBRFullBackupOptionsCreates active full backup schedule settings for Veeam Agent backup jobs.New-VBRFullBackupToTapePolicyCreates schedule settings for creating virtual synthesized full backup for tape.New-VBRGFSRetentionPolicyCreates a GFS retention policy for backup copy jobs that process backups stored on external repositories.New-VBRGoogleCloudComputeDiskConfigurationCreates storage volume settings for Google Cloud instances.New-VBRGoogleCloudComputeLabelCreates Google Cloud labels.New-VBRGoogleCloudComputeProxyApplianceCreates proxy appliances for restoring VMs to Google Cloud.New-VBRGoogleCloudFolderCreates Google Cloud folders.New-VBRHealthCheckOptionsDefines the health check schedule options.New-VBRHighAvailabilityClusterNodeDefines settings of the secondary node of an HA cluster.New-VBRHvADForestDomainRestoreSpecCreates a Hyper-V domain restore specification for a Microsoft Active Directory forest restore.New-VBRHvCloudHWPlanDatastoreCreates Hyper-V cloud storage for tenants replication resources.New-VBRHvInstantRecoveryHelperApplianceDefines settings for a helper appliance.New-VBRHvInstantRecoveryNetworkMappingRuleCreates a new network mapping rule.New-VBRHvIsolatedNetworkOptionsDefines network settings of isolated networks.New-VBRHvProductionNetworkOptionsDefines production networks options for Hyper-V virtual lab.New-VBRHvReplicaReIpIPv6RuleCreates a new Hyper-V replica re-IPv6 rule.New-VBRHvReplicaReIpRuleCreates a new Hyper-V replica re-IPv4 rule.New-VBRHvVirtualDeviceMappingRuleDefines mapping settings of a backed-up virtual disk.New-VBRHvVirtualLabProxyApplianceDefines settings of proxy appliances.New-VBRHvVirtualLabStaticIPMappingRuleDefines static IP address mapping rules.New-VBRIndividualComputerContainerCreates a scope of computers for a protection group.New-VBRIndividualComputerCustomCredentialsSpecifies a method for authenticating individual computers.New-VBRIndividualGuestOSCredentialsDefines a user account that will be explicitly used to connect to specific machine guest OSes.New-VBRIrisContainerDefines containers of InterSystems IRIS servers for protection groups.New-VBRIrisInstancePathMappingRuleDefines path mapping rules for InterSystems IRIS instance restore.New-VBRIrisProcessingOptionsDefines processing options for discovered InterSystems IRIS instances.New-VBRJobOptionsCreates new job options.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-VBRJobScriptOptionsCreates new job script options.New-VBRJobVssOptionsReturns default set of VSS options for job or VM in job.New-VBRKerberosPermissionCreates a new permission to access an application backup repository NFS share with Kerberos credentials.New-VBRLinuxFileRestoreHelperHostCreates temporary Linux helper host used to launch the Guest OS File Restore.New-VBRLinuxScheduleOptionsCreates the schedule for backup policies for Linux computers.New-VBRLinuxSelectedVolumeDefines the scope of volumes for Veeam Agent backup jobs that back up Linux machines.New-VBRMacScheduleOptionsDefines the schedule for macOS jobs.New-VBRMaintenanceWindowOptionsConfigures a maintenance window for automatic update installation.New-VBRManuallyDeployedContainerDefines a scope of Veeam Agent setup files.New-VBRMongoDBContainerCreates a MongoDB container for an array of existing custom credentials.New-VBRMongoDBCustomCredentialsCreates custom credentials for computers within MongoDB replica sets to be selected for backup operations.New-VBRMongoDBDeploymentConnects to and adds MongoDB replica sets to protection groups.New-VBRMongoDBOplogProcessingOptionsEnables operations log (oplog) processing options for MongoDB replica sets.New-VBRMongoDBProcessingOptionsCreates processing options for each MongoDB replica set.New-VBRMonthlyOptionsCreates a new VBRMonthlyOptions object.New-VBRMSSQLCredentialsOptionsCreates Microsoft SQL Server credentials configuration that defines the connection between Veeam Backup & Replication and a discovered Microsoft SQL Server instance for Veeam Plug-In for Microsoft SQL Server backup operations.New-VBRMSSQLOptionsCreates a new Microsoft SQL Server backup options object that defines how Microsoft SQL Server transaction logs and databases are handled during backup jobs.New-VBRMSSQLProcessingOptionsCreates the Microsoft SQL Server database log backup settings for application backup policies.New-VBRMSSQLStorageOptionsCreates Microsoft SQL Server storage options configuration that defines compression, encryption, and full-backup maintenance policies for SQL Server backups.New-VBRMySQLProcessingOptionsDefines settings for processing backed-up MySQL databases on Linux computers.New-VBRNASBackupArchivalOptionsDefines long-term retention policy for file versions of backed up files from file shares. This cmdlet is obsolete. Run the New-VBRUnstructuredBackupArchivalOptions cmdlet instead.New-VBRNASBackupJobObjectDefines settings of files and folders and enterprise NAS system that will be added to the file backup job.New-VBRNASBackupPathMaskDefines an exclusion mask for path for a file backup job.New-VBRNASBackupSecondaryTargetCreates secondary backup repositories for file backup jobs. This cmdlet is obsolete. Run the New-VBRUnstructuredBackupSecondaryTarget cmdlet instead.New-VBRNASBackupVersionRetentionOptionsDefines version-based retention policy settings that will be applied for the file backup job. This cmdlet is obsolete. Run the New-VBRUnstructuredBackupVersionRetentionOptions cmdlet instead.New-VBRNASBackupWildcardMaskDefines a wildcard mask for file backup job.New-VBRNASInstantRecoveryMigrationSwitchOverOptionsDefines the switchover parameter that can be used when starting the file share migration session or for changing settings of an already running file share migration session.New-VBRNASInstantRecoveryMountOptionsCreates a mapping configuration for instant restore of file backups.New-VBRNASPermissionSetCreates a permission set for instant restore of file share backups that will be used if the file share backup does not contain security information.New-VBRNotificationOptionsCreates new job notification options.New-VBRObjectStorageBackupContainerPathMaskDefines an exclusion mask for objects in object storage.New-VBRObjectStorageBackupJobObjectDefines a scope of objects that will be added to the object storage backup job.New-VBRObjectStorageBackupServerPathMaskDefines an exclusion mask for prefixes in object storage.New-VBRObjectStorageBackupTagMaskDefines a tag mask for objects and prefixes in object storage.New-VBROracleProcessingOptionsCreates settings for processing Oracle database archived logs.New-VBROracleRMANOptionsCreates the Oracle RMAN backup settings for application backup policies.New-VBROracleRMANProcessingOptionsCreates the Oracle RMAN database processing settings for application backup policies.New-VBROracleRMANStorageOptionsCreates the Oracle RMAN storage settings for application backup policies.New-VBRPeriodicallyOptionsCreates periodical schedule settings.New-VBRPluggableDatabasesOptionsCreates the pluggable database settings for application backup policies.New-VBRPluginCopyJobStorageOptionsDefines storage optimization settings for plug-in backup copy jobs.New-VBRPostgreSQLProcessingOptionsDefines settings for processing backed-up PostgreSQL databases on Linux computers.New-VBRProtectionGroupAdvancedWindowsOptionsCreates additional settings for Veeam Agent for Microsoft Windows.New-VBRProtectionGroupDeploymentOptionsDefines protection group deployment settings.New-VBRProtectionGroupNotificationOptionsCreates notification options for protection groups.New-VBRProtectionGroupScheduleOptionsCreates a discovery schedule.New-VBRRecoveryMediaISOTargetCreates the path for saving Veeam Recovery Media in the ISO file format.New-VBRRecoveryPointObjectiveCreates an interval for backup copy jobs that process backups stored on external repositories.New-VBRReplicaApplicationProcessingOptionsDefines guest processing settings for Cloud Director replica jobs and CDP policies.New-VBRRepositoryMountServerOptionsDefines settings of a mount server.New-VBRRPONotificationOptionDefines RPO notification settings.New-VBRSanIntegrationOptionsDefines storage integration settings for the Veeam Agent backup job.New-VBRSAPHANACredentialsOptionsCreates the SAP HANA credentials settings for application backup policies.New-VBRSAPHANAOptionsCreates the SAP HANA backup settings for application backup policies.New-VBRSAPHANAProcessingOptionsCreates the SAP HANA database processing settings for application backup policies.New-VBRSAPHANAStorageOptionsCreates the SAP HANA storage encryption settings for application backup policies.New-VBRSAPOnOracleOptionsCreates the SAP on Oracle backup settings for application backup policies.New-VBRSAPOnOracleProcessingOptionsCreates the SAP on Oracle database processing settings for application backup policies.New-VBRSAPOnOracleStorageOptionsCreates the SAP on Oracle storage settings for application backup policies.New-VBRScriptProcessingOptionsCreates pre-freeze and post-thaw scripts settings for Veeam Agent backup jobs.New-VBRSelectedFilesBackupOptionsDefines backup scope settings for Veeam Agent backup jobs.New-VBRSelectedPersonalFoldersDefines the scope of personal data for Agent Backup jobs that back up Microsoft Windows and Mac computers.New-VBRServerScheduleOptionsCreates the schedule for jobs.New-VBRSimpleRetentionPolicyCreates a retention policy for backup copy jobs that process backups stored on external repositories.New-VBRSNMPReceiverDefines SNMP recipient settings.New-VBRSQLProcessingOptionsDefines settings for processing Microsoft SQL database transaction logs.New-VBRStorageOptionsDefines storage optimization settings for backup jobs.New-VBRStorageProtocolPolicyCreates protocol policies for storage systems.New-VBRSureBackupJobScheduleOptionsDefines a SureBackup job schedule.New-VBRSureBackupJobVerificationOptionsDefines verification settings for the SureBackup job.New-VBRSureBackupLinkedJobDefines jobs linked with the SureBackup job.New-VBRSureBackupStartupOptionsDefines startup settings for VMs.New-VBRSureBackupTestScriptDefines recovery verification scripts for VMs.New-VBRSureBackupVMDefines VMs to add to the SureBackup job or to the application group.New-VBRSyntheticFullOptionsCreates synthetic full backup schedule settings for Veeam Agent backup jobs.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.New-VBRUniversalCDPCloudDestinationDefines the target location settings for cloud universal CDP policies.New-VBRUniversalCDPNetworkMappingRuleDefines network mapping rules for universal CDP policies.New-VBRUniversalCDPvCDCloudDestinationDefines the target location settings for VDC universal CDP policies.New-VBRUniversalCDPViDestinationDefines the target location settings for universal CDP policies.New-VBRUnixScheduleOptionsDefines the schedule for Unix jobs.New-VBRUnstructuredBackupArchivalOptionsDefines a scope of file versions to keep on an archive repository for file backup job or object storage backup job.New-VBRUnstructuredBackupRetrievalSettingsDefines retrieval policy settings for archive object storage repositories.New-VBRUnstructuredBackupSecondaryTargetCreates secondary backup repository for file backup jobs and object storage backup jobs.New-VBRUnstructuredBackupVersionRetentionOptionsDefines version-based retention policy settings for file backup jobs and object storage backup jobs.New-VBRvCDIndividualObjectStoragePolicyDefines Cloud Director storage policies for vApps or VMs.New-VBRvCDOrganizationvDCOptionsCreates organization vDCs settings.New-VBRvCDReplicationResourceDefines Cloud Director replication resource settings.New-VBRvCloudVAppRestoreSettingsCreates a set of vApp restore parameters.New-VBRViADForestDomainRestoreSpecCreates a VMware domain restore specification for a Microsoft Active Directory forest restore.New-VBRViCloudHWPlanDatastoreCreates VMware cloud storage for tenants replication resources.New-VBRViDiskMigrationMappingRuleDefines mapping settings of recovered VM virtual disks and target datastores.New-VBRViNetworkMappingRuleDefines network mapping rules of isolated networks.New-VBRViReplicaReIpIPv6RuleCreates a new VMware replica re-IPv6 rule.New-VBRViReplicaReIpRuleCreates a new VMware replica re-IPv4 rule.New-VBRViVirtualDeviceMappingRuleDefines backed-up virtual disk mapping settings.New-VBRViVirtualLabIPMappingRuleDefines static IP address mapping rules.New-VBRViVirtualLabNetworkOptionsDefines network settings of isolated networks.New-VBRViVirtualLabProxyApplianceDefines settings of proxy appliances.New-VBRVSAEventForwardingFilteringRuleCreates an advanced filtering rule for Veeam Software Appliance syslog event forwarding.New-VBRWindowsWorkstationScheduleOptionsCreates the schedule for the backup policy for Windows workstations.New-VSBJobOptionsSets SureBackup job options. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.
Publish
Publish-StoragePluginArchivedSnapshotRetrieves and restores an archived snapshot.Publish-VBRArchiveRestorePointRetrieves data from archive storage.Publish-VBRBackupContentPublishes disks from a backup or replica using the iSCSI or FUSE protocol.Publish-VBRCloudArchiveRestorePointRetrieves tenant data from archive storage.
Rehydrate
Rehydrate-VBRDeletedBackupFileRehydrates a backup file deleted from the capacity tier and preserved by insider protection.
Remove
Remove-HP3SnapshotRemoves HPE 3PAR StoreServ storage snapshots.Remove-HP3StorageRemoves HPE 3PAR StoreServ storage systems.Remove-HyperFlexHostRemoves Cisco HyperFlex storage systems from the backup infrastructure.Remove-NetAppHostRemoves NetApp storage systems.Remove-NetAppSnapshotRemoves NetApp storage snapshots.Remove-NimbleHostRemoves HPE Nimble storage systems from Veeam Backup & Replication.Remove-NimbleSnapshotRemoves HPE Nimble storage snapshots.Remove-StoragePluginArchivedSnapshotRemoves archived snapshots of Universal Storage API integrated systems.Remove-StoragePluginHostRemoves Universal Storage API integrated systems from Veeam Backup & Replication console.Remove-StoragePluginSnapshotRemoves snapshots of Universal Storage API integrated systems.Remove-ThinkSystemHostRemoves ThinkSystem storage systems.Remove-ThinkSystemSnapshotRemoves ThinkSystem storage snapshots.Remove-VBRAdvancedLatencyOptionsRemoves datastore latency settings from Veeam Backup & Replication settings.Remove-VBRAmazonAccountRemoves AWS credentials records from Veeam Backup & Replication.Remove-VBRApplicationBackupJobRemoves application backup policies.Remove-VBRApplicationBackupRepositoryRemoves an application backup repository from the backup infrastructure.Remove-VBRApplicationGroupRemoves application groups from the Veeam Backup & Replication infrastructure.Remove-VBRArchiveObjectStorageRepositoryRemoves archive repositories added to the backup infrastructure.Remove-VBRAzureAccountRemoves Microsoft Azure accounts from Veeam Backup & Replication.Remove-VBRAzureADAccountRemoves Azure Entra ID-based storage accounts from Veeam Backup & Replication.Remove-VBRAzureApplianceTemplateRemoves deployed helper appliance templates.Remove-VBRAzureBlobAccountRemoves Microsoft Azure Blob credentials records.Remove-VBRAzureRestoreProxyRemoves a restore proxy appliance from the backup infrastructure.Remove-VBRBackupRemoves selected backups.Remove-VBRBackupCopyJobRemoves backup copy jobs.Remove-VBRBackupFileRemoves missing backup files from the Veeam Backup & Replication configuration database.Remove-VBRBackupRepositoryRemoves a backup repository from the backup infrastructure.Remove-VBRBackupServerDeployerCertificateRemoves all Veeam Deployer Service certificates from the Veeam Backup & Replication database.Remove-VBRBackupSessionRemoves a specified backup session. This cmdlet is obsolete and not supported.Remove-VBRCatalystCopyJobRemoves backup copy jobs for HPE StoreOnce repositories. This cmdlet is obsolete. Run the Remove-VBRStorageCopyJob cmdlet instead.Remove-VBRCDPPolicyRemoves CDP policies including Cloud Director CDP policies, CDP policies, cloud CDP policies and so on.Remove-VBRCDPProxyRemoves CDP proxies from the backup infrastructure.Remove-VBRCDPReplicaRemoves a CDP replica from the configuration database or disk.Remove-VBRCDPReplicaRemove-VBRCloudGatewayRemoves cloud gateways.Remove-VBRCloudGatewayPoolRemoves cloud gateway pools.Remove-VBRCloudHardwarePlanRemoves hardware plans.Remove-VBRCloudProviderRemoves service providers.Remove-VBRCloudProviderCredentialsRemoves cloud provider credentials records from Veeam Backup & Replication.Remove-VBRCloudPublicIPRemoves IP addresses from public IP addresses pools.Remove-VBRCloudSubTenantRemoves cloud subtenant accounts.Remove-VBRCloudSubUserRemoves cloud subuser accounts.Remove-VBRCloudTenantRemoves cloud tenant accounts.Remove-VBRCloudTenantBackupRemoves selected backups of tenants from disk.Remove-VBRCloudVLANConfigurationRemoves pools of VLANs reserved for Veeam Backup & Replication.Remove-VBRComputerBackupCopyJobRemoves Veeam Agent backup copy jobs.Remove-VBRComputerBackupJobRemoves Veeam Agent backup jobs and Veeam Agent backup policies.Remove-VBRComputerFileProxyServerRemoves general-purpose backup proxies from the Veeam Backup & Replication infrastructure.Remove-VBRComputerRecoveryTokenRemoves tokens for bare-metal recovery.Remove-VBRCredentialsRemoves credentials records from Veeam Backup & Replication.Remove-VBRDefaultGatewayRemoves default cloud gateways.Remove-VBRDiscoveredComputerConfigurationPolicyRemoves policies that contain configuration options for Veeam Agent settings. Make sure to test this cmdlet in the lab before you run it in the production environment.Remove-VBREncryptedBackupRemoves selected encrypted backups.Remove-VBREncryptionKeyRemoves encryption key.Remove-VBREntraIDLogsBackupJobRemoves Microsoft Entra ID log backup jobs.Remove-VBREntraIDTenantRemoves Microsoft Entra ID tenants from the backup infrastructure.Remove-VBREntraIDTenantBackupJobRemoves backup jobs that protect Microsoft Entra ID tenants.Remove-VBRExternalRepositoryRemoves external repositories from the backup infrastructure.Remove-VBRFailoverPlanRemoves a selected failover plan or a cloud failover plan.Remove-VBRFilerRemoves an enterprise NAS system added to the inventory.Remove-VBRGoogleCloudAccountRemoves Google Cloud credentials records from Veeam Backup & Replication.Remove-VBRGoogleCloudComputeAccountRemoves Google Cloud service account credentials records.Remove-VBRHighAvailabilityClusterDisassembles an HA cluster.Remove-VBRHvProxyRemoves the Hyper-V backup proxy from the backup infrastructure.Remove-VBRIsilonHostRemoves Dell PowerScale (formerly Isilon) storage systems from Veeam Backup & Replication.Remove-VBRJobRemoves a selected backup, replication or backup copy job.Remove-VBRJobObjectRemoves VMs or VM containers from jobs.Remove-VBRKMSServerRemoves KMS servers from the Veeam Backup & Replication console.Remove-VBRLocationRemoves geographic locations from Veeam Backup & Replication.Remove-VBRMalwareDetectionExclusionRemoves machines from a malware exclusions list.Remove-VBRNASBackupRemoves backup files created by the file backup job. This cmdlet is obsolete. Run the Remove-VBRUnstructuredBackup cmdlet instead.Remove-VBRNASBackupJobRemoves file backup jobs from Veeam Backup & Replication infrastructure. This cmdlet is obsolete. Run the Remove-VBRUnstructuredBackupJob cmdlet instead.Remove-VBRNASProxyServerRemoves general-purpose backup proxies from the Veeam Backup & Replication infrastructure.Remove-VBRNASServerRemoves file shares that are added to the Veeam Backup & Replication infrastructure. This cmdlet is obsolete. Run the Remove-VBRUnstructuredServer cmdlet instead.Remove-VBRNDMPServerRemoves NDMP and NetApp NDMP servers from the backup infrastructure.Remove-VBRNetworkTrafficRuleRemoves network traffic rules.Remove-VBRNutanixHostRemoves Nutanix Files storage systems from the backup infrastructure.Remove-VBRObjectStorageRepositoryRemoves object storage added as backup repository to Veeam Backup & Replication.Remove-VBRPluginJobRemoves backup jobs that were created with standalone Veeam Plug-ins and backup copy jobs of backups created with Veeam Plug-ins from the Veeam Backup & Replication infrastructure.Remove-VBRPreferredNetworkRemoves preferred networks.Remove-VBRProtectionGroupRemoves protection groups.Remove-VBRReplicaRemoves replica objects and replicated VMs.Remove-VBRRestorePointRemoves individual VMs from backup or replicas.Remove-VBRRestoreSessionRemoves restore sessions. This cmdlet is obsolete and not supported.Remove-VBRServerRemoves hosts from the backup infrastructure.Remove-VBRStorageCopyJobRemoves storage backup copy jobs from the backup infrastructure.Remove-VBRSureBackupJobRemoves SureBackup jobs.Remove-VBRSyslogEventFilterRemoves syslog event filters for an event ID.Remove-VBRSyslogServerRemoves the syslog server.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.Remove-VBRUnstructuredBackupRemoves backup files created by the file backup jobs and object storage backup jobs.Remove-VBRUnstructuredBackupJobRemoves file backup jobs and object storage backup jobs from the backup infrastructure. If the four-eyes authorization is enabled, you cannot run this cmdlet. For more information, see the Four-Eyes Authorization section in the User Guide for VMware vSphere.Remove-VBRUnstructuredServerRemoves unstructured data sources from the inventory.Remove-VBRUserRoleAssignmentRemoves a role from a user or a user group.Remove-VBRvCDReplicaRemoves Cloud Director replicas.Remove-VBRvCDReplicaJobRemoves Cloud Director replication jobs.Remove-VBRViProxyRemoves a VMware backup proxy from the backup infrastructure.Remove-VBRVirtualLabRemoves virtual labs from Veeam Backup & Replication.Remove-VBRVMExclusionRemoves global VM exclusions.Remove-VBRWANAcceleratorRemoves a WAN accelerator.Remove-VNXHostRemoves Dell VNX storage systems from Veeam Backup & Replication.Remove-VNXSnapshotRemoves Dell VNX storage snapshots.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-VSBSessionRemoves a specified SureBackup job session from Veeam Backup & Replication. This cmdlet is obsolete and not supported.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.
Request
Request-VBREntraIDLoginRequests login to Microsoft Entra ID using an account associated with the tenant whose data you are restoring.
Rescan
Rescan-VBRAzureApplianceTemplateRescans the Azure Backup Appliance template in the backup infrastructure.Rescan-VBREntityRescans backup infrastructure components.
Reset
Reset-HvVmChangeTrackingReset-VBRAgentCertificateResets Veeam Agents SSL certificates.Reset-VBRBackupServerClientCertificateCreates a new TLS certificate in the Veeam Backup & Replication database.Reset-VBRCloudTenantResets licenses for cloud account tenants.Reset-VBRDiscoveredComputerReboots discovered computers.Reset-VBRJobOptionsApplies default settings to jobs.Reset-VBRJobScheduleOptionsApplies default schedule settings to jobs.Reset-VBRJobVssOptionsSets job VSS settings to default.Reset-VBRPluginCertificateResets Veeam Plug-In SSL certificates.Reset-VBRProtectionGroupCertificateRemoves a certificate associated with a protection group with a flexible scope.Reset-VSBJobOptionsSets SureBackup job settings to default. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.
Restart
Restart-VBRInstantRecoveryRestarts a failed Hyper-V Instant Recovery session.
Restore
Restore-VBREntraIDTenantItemRestores a Microsoft Entra ID item.Restore-VBREntraIDTenantItemAttributesRestores properties of Microsoft Entra ID items.Restore-VBRNASBackupFLRItemRestores objects backed up by file backup jobs to original file shares. This cmdlet is obsolete. Run the Restore-VBRUnstructuredBackupFLRItem cmdlet instead.Restore-VBRUnstructuredBackupFLRItemRestores objects backed up by file backup jobs or object storage backup jobs to original file shares or object storage.
Retry
Retry-VBRCopyBackupSessionRetries the copy operation for failed workloads.Retry-VBRMoveBackupSessionRetries the move operation for failed workloads.
Save
Save-VBREntraIDLogsBackupFLRItemRestores files and folders backed up by a log backup job that protects Microsoft Entra ID audit and sign-in logs.Save-VBRNASBackupFLRItemRestores objects backed up by file backup jobs to the specified file shares. This cmdlet is obsolete. Run the Save-VBRUnstructuredBackupFLRItem cmdlet instead.Save-VBRUnstructuredBackupFLRItemRestores objects backed up by file backup jobs or object storage backup jobs to the specified file shares or object storage.
Send
Send-VBRScaleOutBackupRepositoryReportSends reports on processing results of scale-out backup repositories.
Set
Set-HP3StorageModifies settings of HPE 3PAR StoreServ storage systems.Set-HyperFlexHostModifies Cisco HyperFlex storage settings.Set-NetAppHostModifies NetApp storage system settings.Set-NimbleHostModifies settings of HPE Nimble storage systems.Set-StoragePluginHostModifies settings of Universal Storage API integrated systems.Set-ThinkSystemHostModifies ThinkSystem storage system settings.Set-VBR1111SystemsS3RepositoryModifies settings of the 11:11 Cloud object storage repository added to the backup infrastructure.Set-VBRAdCloudTenantModifies Active Directory tenant accounts.Set-VBRADContainerModifies a scope of Active Directory objects.Set-VBRAdvancedLatencyOptionsModifies latency settings for a specific datastore.Set-VBRAmazonAccountModifies AWS credentials records.Set-VBRAmazonEC2ContainerModifies a scope of Amazon EC2 instances, EC2 tags or AWS datacenters for a protection group.Set-VBRAmazonS3CompatibleRepositoryModifies settings for S3 compatible object storage added as a backup repository.Set-VBRAmazonS3ExternalRepositoryModifies external Amazon S3 storage repository.Set-VBRAmazonS3GlacierRepositoryModifies settings for Amazon S3 Glacier archive storage added as a backup repository.Set-VBRAmazonS3RepositoryModifies settings of Amazon S3 object storage added to the backup infrastructure.Set-VBRAmazonS3ServerModifies settings of Amazon S3 storage added as unstructured data source to the inventory.Set-VBRApplicationBackupJobModifies application backup policies.Set-VBRApplicationBackupRepositoryModifies application backup repository settings.Set-VBRApplicationGroupModifies settings of application groups.Set-VBRApplicationProcessingOptionsModifies application-aware processing settings for Veeam Agent backup jobs.Set-VBRAzureAccountModifies Microsoft Azure compute account added to Veeam Backup & Replication.Set-VBRAzureADAccountModifies settings of Azure Entra ID-based storage accounts.Set-VBRAzureArchiveRepositoryModifies settings for Azure Archive repository added to the backup infrastructure.Set-VBRAzureBlobAccountModifies Microsoft Azure Blob credentials records.Set-VBRAzureBlobRepositoryModifies Azure Blob storage added as a backup repository to the backup infrastructure.Set-VBRAzureBlobServerModifies settings of Microsoft Azure Blob storage added as unstructured data source to the inventory.Set-VBRAzureComputeBackupCopyJobModifies Azure IaaS backup copy jobs.Set-VBRAzureContainerModifies a scope of Azure VMs, Azure tags or Azure Availability Zone for a protection group.Set-VBRAzureDataBoxRepositoryModifies settings of Azure Data Box storage as an object storage repository to the backup infrastructure.Set-VBRAzureExternalRepositoryModifies external Microsoft Azure Blob storage repository.Set-VBRAzureInstantRecoverySwitchingOptionsSets the switchover options for an Instant Recovery operation.Set-VBRAzureLinuxRestoreApplianceModifies helper appliances for restoring Linux VMs to Microsoft Azure.Set-VBRAzureStorageServerModifies settings of Microsoft Azure object storage added as unstructured data source to the inventory.Set-VBRBackupCacheOptionsModifies backup cache settings for Veeam Agent backup jobs.Set-VBRBackupCopyJobModifies backup copy jobs.Set-VBRBackupCopyJobStorageOptionsModifies storage optimization settings for Veeam Agent backup copy jobs.Set-VBRBackupRepositoryModifies a backup repository.Set-VBRBackupToTapeJobModifies a backup to tape job or a GFS job.Set-VBRBackupWindowOptionsModifies job backup window settings.Set-VBRCatalystCopyJobModifies backup copy jobs for HPE StoreOnce repositories. This cmdlet is obsolete. Run the Set-VBRStorageCopyJob cmdlet instead.Set-VBRCDPPolicyModifies CDP policies.Set-VBRCDPPolicyRetentionOptionsModifies retention settings of CDP policies.Set-VBRCDPProxyModifies settings of CDP proxies added to the backup infrastructure.Set-VBRCloudCDPPolicyModifies a cloud CDP policy.Set-VBRCloudFailoverPlanObjectModifies VMs in cloud failover plans.Set-VBRCloudGatewayModifies cloud gateways.Set-VBRCloudGatewayPoolModifies cloud gateway pools.Set-VBRCloudProviderModifies service providers.Set-VBRCloudProviderCredentialsModifies cloud provider credential records.Set-VBRCloudProviderNetworkApplianceModifies network extension appliances on user side.Set-VBRCloudSubTenantModifies settings of cloud subtenant accounts.Set-VBRCloudSubTenantResourceModifies quotas of cloud subtenant resources settings.Set-VBRCloudSubUserModifies settings of cloud subuser accounts.Set-VBRCloudSubUserResourceModifies quotas of cloud subuser 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-VBRComputerBackupCopyJobModifies Veeam Agent backup copy jobs.Set-VBRComputerBackupJobModifies Veeam Agent backup jobs and Veeam Agent backup policies.Set-VBRComputerDestinationOptionsModifies the target location for Veeam Agent backup policies.Set-VBRComputerFileProxyServerModifies general-purpose backup proxies added to the Veeam Backup & Replication infrastructure.Set-VBRComputerGFSMonthlyOptionsModifies settings of the monthly GFS retention policy for Veeam Agent backup jobs.Set-VBRComputerGFSOptionsModifies GFS retention settings for Veeam Agent backup jobs.Set-VBRComputerGFSWeeklyOptionsModifies settings of the weekly GFS retention policy for Veeam Agent backup jobs.Set-VBRComputerGFSYearlyOptionsModifies settings of for the yearly GFS retention policy for Veeam Agent backup jobs.Set-VBRComputerIndexingOptionsModifies indexing settings for Veeam Agent backup jobs.Set-VBRComputerRecoveryTokenModifies tokens for bare-metal recovery.Set-VBRComputerWarningOptionsModifies notification settings for computers not processed by Veeam Agent jobs.Set-VBRConfigurationBackupJobModifies the configuration backup job.Set-VBRCredentialsModifies credentials records properties.Set-VBRCSVContainerModifies a scope of computers listed in a CSV file.Set-VBRDatabaseProcessingOptionsModifies the database processing settings for application backup policies.Set-VBRDataCloudVaultRepositoryModifies a Veeam Data Cloud Vault added to the backup infrastructure.Set-VBRDefaultGatewayModifies cloud default gateways.Set-VBRDefaultGatewayConfigurationModifies default gateway configuration.Set-VBRDefaultLinuxMountServerModifies the default Linux mount server.Set-VBRDefaultWindowsMountServerModifies the default Microsoft Windows mount server.Set-VBRDiscoveredComputerUpdateAssigns Veeam Agent private fixes to discovered computers.Set-VBREC2BackupCopyJobModifies backup copy jobs for backups of Amazon EC2 instances.Set-VBREncryptedBackupPasswordDecrypts imported encrypted backups.Set-VBREncryptedTapeMediumPasswordDecrypts encrypted backups stored on tapes.Set-VBREncryptionKeyModifies encryption key.Set-VBREntraIDBackupSecondaryTargetModifies secondary repository settings.Set-VBREntraIDLogsBackupJobModifies a Microsoft Entra ID log backup job.Set-VBREntraIDTenantModifies a Microsoft Entra ID tenant added to the backup infrastructure.Set-VBREntraIDTenantBackupJobModifies a backup job that protects a Microsoft Entra ID tenant.Set-VBREPPermissionApplies user access permissions to backup repositories used by Veeam Agent or Veeam Plug-in operating in the standalone mode.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-VBRFailbackSwitchingScheduleModifies the failback switching schedule.Set-VBRFailoverPlanModifies a selected failover plan or cloud failover plan.Set-VBRFailoverPlanObjectModifies VMs in failover plans.Set-VBRFilerModifies enterprise NAS systems added as file shares to the inventory.Set-VBRFileToTapeJobModifies a file to tape job or a GFS file to tape job.Set-VBRFullBackupOptionsModifies active full backup schedule settings for Veeam Agent backup jobs.Set-VBRGeneralUpdateOptionsModifies general update settings for the Linux-based backup server and Veeam Infrastructure Appliances.Set-VBRGFSRetentionPolicyModifies a GFS retention policy for backup copy jobs that process backups stored on external repositories.Set-VBRGlobalNotificationOptionsModifies global notification settings.Set-VBRGoogleCloudAccountModifies Google Cloud credentials records.Set-VBRGoogleCloudComputeAccountModifies Google Cloud service account credentials record.Set-VBRGoogleCloudExternalRepositoryModifies external Google Cloud storage repository.Set-VBRGoogleCloudRepositoryModifies settings for Google Cloud object storage added to the backup infrastructure.Set-VBRHealthCheckOptionsModifies the health check schedule options.Set-VBRHighAvailabilityClusterModifies settings of an HA cluster.Set-VBRHistoryOptionsModifies job sessions history settings.Set-VBRHvCloudHardwarePlanModifies Hyper-V hardware plans.Set-VBRHvCloudHWPlanDatastoreModifies Hyper-V cloud storage for tenants replication resources.Set-VBRHvCloudReplicaJobModifies a Hyper-V cloud replication job.Set-VBRHvClusterModifies settings of a Hyper-V cluster.Set-VBRHvHostModifies settings of Hyper-V hosts.Set-VBRHvInstantRecoveryHelperApplianceModifies settings for a helper appliance.Set-VBRHvIsolatedNetworkOptionsModifies network settings of isolated networks for Hyper-V virtual lab.Set-VBRHvProductionNetworkOptionsModifies production network options for Hyper-V virtual lab.Set-VBRHvReplicaJobModifies Hyper-V replication jobs.Set-VBRHvScvmmModifies settings of a Hyper-V SCVMM server.Set-VBRHvServerConfigurationModifies settings of Microsoft Hyper-V hosts added to the backup infrastructure.Set-VBRHvServerVolumeModifies volume-specific settings for Microsoft Hyper-V hosts.Set-VBRHvVirtualLabModifies settings of Hyper-V virtual labs.Set-VBRHvVirtualLabProxyApplianceModifies settings of proxy appliances for Hyper-V virtual lab.Set-VBRHvVirtualLabStaticIPMappingRuleModifies static IP address mapping rules for Hyper-V virtual lab.Set-VBRIBMCloudRepositoryModifies settings of the IBM Cloud object storage repository added to the backup infrastructure.Set-VBRImmutabilityLockExpirationDateModifies immutability period of restore points located in a hardened repository. This cmdlet does not support the following types of restore points: - Restore points created by unstructured data source jobs. - Restore points created by application backup policies. - Restore points for transaction logs.Set-VBRIndividualComputerContainerModifies a scope of individual computers.Set-VBRInternetProxyUpdateOptionsModifies internet proxy update settings.Set-VBRIrisBackupJobModifies InterSystems IRIS application backup policies.Set-VBRIrisProcessingOptionsModifies processing options for discovered InterSystems IRIS instances.Set-VBRIsilonHostModifies Dell PowerScale (formerly Isilon) storage settings.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.Set-VBRJobAdvancedViOptionsCustomizes VMware job settings.Set-VBRJobObjectVssOptionsCustomizes job VSS settings.Set-VBRJobOptionsModifies job settings.Set-VBRJobProxyModifies settings of a backup proxy.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.Set-VBRJobScriptOptionsModifies job script options.Set-VBRJobVssOptionsApplies custom VSS settings to a selected job.Set-VBRKMSServerModifies settings of KMS servers.Set-VBRLinuxModifies settings of a Linux server added to the backup infrastructure.Set-VBRLinuxFileRestoreHelperHostModifies temporary Linux helper host specifications.Set-VBRLinuxScheduleOptionsModifies the schedule for backup policies for Linux computers.Set-VBRLinuxSelectedVolumeModifies the scope of volumes for Veeam Agent backup jobs that back up Linux machines.Set-VBRLinuxTrustedHostPolicySets the trust policy for protected Linux and Microsoft Windows machines.Set-VBRLocationModifies geographic locations in Veeam Backup & Replication.Set-VBRMacScheduleOptionsModifies schedule for macOS jobs.Set-VBRMailNotificationConfigurationModifies global email notification settings.Set-VBRMalwareDetectionExclusionModifies settings of machines added to malware exclusions.Set-VBRMalwareDetectionObjectAsCleanSets the clean status for machines and hosts detected by malware.Set-VBRMalwareDetectionOptionsModifies malware detection settings.Set-VBRMongoDBBackupJobModifies MongoDB backup policies.Set-VBRMongoDBContainerModifies MongoDB containers that include an array of custom credentials.Set-VBRMongoDBOplogProcessingOptionsModifies operations log (oplog) processing options for MongoDB replica sets.Set-VBRMongoDBProcessingOptionsModifies processing options for each MongoDB replica set.Set-VBRMSSQLProcessingOptionsModifies the Microsoft SQL Server database processing settings for application backup policies.Set-VBRMySQLProcessingOptionsModifies settings for processing backed-up MySQL databases for Veeam Agent backup jobs.Set-VBRMySQLProcessingOptionsSet-VBRNASBackupJobModifies file backup jobs.Set-VBRNASBackupJobObjectModifies settings of files and folders that will be added to the file backup job.Set-VBRNASBackupSecondaryTargetModifies settings of secondary backup repositories. This cmdlet is obsolete. Run the Set-VBRUnstructuredBackupSecondaryTarget cmdlet instead.Set-VBRNASBackupVersionRetentionOptionsModifies version-based retention policy settings that will be applied for the file backup job. This cmdlet is obsolete. Run the Set-VBRUnstructuredBackupVersionRetentionOptions cmdlet instead.Set-VBRNasFilerNFSServerModifies settings of NFS shared folders located on an enterprise NAS system and added to the inventory.Set-VBRNasFilerSMBServerModifies settings of SMB shares located on an enterprise NAS system added to the inventory.Set-VBRNASFileServerModifies managed Windows or Linux file servers added to the Veeam Backup & Replication infrastructure.Set-VBRNASInstantRecoveryMigrationModifies switchover parameters for the specified session of migration to production during the instant file share recovery.Set-VBRNASNFSServerModifies settings of NFS shared folders added to the inventory.Set-VBRNASObjectStorageTransformThresholdModifies the blob transformation threshold for an object storage repository that stores file backups.Set-VBRNASProxyServerModifies the general-purpose backup proxy added to the Veeam Backup & Replication infrastructure.Set-VBRNASSMBServerModifies settings of SMB network shared folders added to the Veeam Backup & Replication infrastructure.Set-VBRNDMPServerModifies NDMP server settings.Set-VBRNetAppNDMPServerModifies a NetApp NDMP server.Set-VBRNetworkTrafficRuleModifies network traffic rules.Set-VBRNetworkTrafficRuleOptionsModifies settings of global network traffic rules.Set-VBRNodeExporterOptionsModifies node exporter metrics for Veeam Software ApplianceSet-VBRNotificationOptionsModifies job notification settings.Set-VBRNutanixHostModifies Nutanix Files storage system settings.Set-VBRObjectRestorePointStatusModifies the malware status of restore points.Set-VBRObjectStorageBackupJobModifies settings of object storage backup job.Set-VBRObjectStorageBackupJobObjectModifies settings of objects that will be added to the object storage backup job.Set-VBRObjectToTapeJobModifies an object to tape job or GFS object to tape job.Set-VBROracleProcessingOptionsModifies settings for processing Oracle database archived logs.Set-VBROracleRMANProcessingOptionsModifies the Oracle RMAN database processing settings for application backup policies.Set-VBRPluggableDatabasesOptionsModifies the pluggable database settings for application backup policies.Set-VBRPluginBackupCopyJobModifies plug-in backup copy jobs.Set-VBRPluginCopyJobStorageOptionsModifies storage optimization settings for plug-in backup copy jobs.Set-VBRPostgreSQLProcessingOptionsModifies settings for processing backed-up PostgreSQL databases on Linux computers.Set-VBRProtectionGroupModifies protection groups.Set-VBRProtectionGroupNotificationOptionsModifies notification options for protection groups.Set-VBRPSQLDatabaseServerLimitsModifies settings of the PostgreSQL instance.Set-VBRRecoveryPointObjectiveModifies an interval for backup copy jobs that process backups stored on external repositories.Set-VBRReplicaApplicationProcessingOptionsModifies guest processing settings for Cloud Director replica jobs and CDP policies.Set-VBRRepositoryExtentModifies performance extents of scale-out backup repositories.Set-VBRRepositoryMountServerOptionsModifies settings of a mount server.Set-VBRRPONotificationOptionModifies RPO notification settings.Set-VBRS3CompatibleRepositorySecurityOptionsModifies settings that Veeam Agent uses to access S3 compatible repositories.Set-VBRS3CompatibleServerModifies settings of Amazon S3 storage added as unstructured data source to the inventory.Set-VBRS3GlacierCompatibleRepositoryModifies settings of S3 compatible object storage with data archiving.Set-VBRSanIntegrationOptionsModifies storage integration settings for the Veeam Agent backup job.Set-VBRSAPHANAProcessingOptionsModifies the SAP HANA database processing settings for application backup policies.Set-VBRSAPOnOracleProcessingOptionsModifies the SAP on Oracle database processing settings for application backup policies.Set-VBRScaleOutBackupRepositoryModifies scale-out backup repositories.Set-VBRScriptProcessingOptionsModifies pre-freeze and post-thaw scripts settings for Veeam Agent backup jobs.Set-VBRSecurityOptionsModifies Veeam Backup & Replication security settings.Set-VBRSelectedFilesBackupOptionsModifies the backup scope settings for Veeam Agent backup jobs.Set-VBRSelectedPersonalFoldersModifies the scope of personal data for Agent Backup jobs that back up Microsoft Windows and Mac computers.Set-VBRServerScheduleOptionsModifies the schedule for Veeam Agent backup jobs.Set-VBRSimpleRetentionPolicyModifies a retention policy for backup copy jobs that process backups stored on external repositories.Set-VBRSNMPOptionsModifies global SNMP settings.Set-VBRSNMPReceiverModifies SNMP recipient settings.Set-VBRSQLProcessingOptionsModifies settings for processing Microsoft SQL database transaction logs.Set-VBRStorageCopyJobModifies storage backup copy jobs.Set-VBRStorageLatencyControlOptionsModifies storage latency control settings on the production datastores.Set-VBRStorageOptionsModifies storage optimization settings for Veeam Agent backup jobs.Set-VBRSureBackupContentScanJobModifies settings of a SureBackup job that runs in the backup content scan verification mode.Set-VBRSureBackupJobModifies settings of SureBackup jobs.Set-VBRSureBackupJobScheduleOptionsModifies settings of a SureBackup job schedule.Set-VBRSureBackupJobVerificationOptionsModifies additional settings for the SureBackup job.Set-VBRSureBackupLinkedJobModifies settings of jobs linked with the SureBackup job.Set-VBRSureBackupStartupOptionsModifies startup settings for VMs that are added to application groups and to jobs that are linked to SureBackup jobs.Set-VBRSureBackupTestScriptModifies settings of custom recovery verification scripts for VMs.Set-VBRSureBackupVMModifies settings of VMs added to the SureBackup job or to the application group.Set-VBRSyntheticFullOptionsModifies the synthetic full backup schedule settings for Veeam Agent backup jobs.Set-VBRSyslogServerModifies the existing syslog server settings.Set-VBRTapeGFSMediaPoolModifies a GFS media pool.Set-VBRTapeGFSScheduleOptionsModifies GFS scheduling options.Set-VBRTapeLibraryModifies a tape library.Set-VBRTapeMediaPoolModifies a media pool.Set-VBRTapeMediaPoolOptionsModifies media pool options. This cmdlet is obsolete. The cmdlet will still work but it is recommended to perform the tape restore operation with Veeam Backup & Replication UI for full functionality.Set-VBRTapeMediumModifies tape properties.Set-VBRTapeServerModifies tape servers.Set-VBRTapeVaultModifies a tape vault.Set-VBRUniversalCDPPolicyModifies a universal CDP policy.Set-VBRUnixScheduleOptionsModifies schedule for Unix jobs.Set-VBRUnstructuredBackupArchivalOptionsModifies a scope of file versions to keep on an archive repository for file backup job or object storage backup job.Set-VBRUnstructuredBackupRetrievalModifies the availability period of an active unstructured data retrieval operation.Set-VBRUnstructuredBackupSecondaryTargetModifies settings of secondary backup repositories.Set-VBRUnstructuredBackupVersionRetentionOptionsModifies version-based retention policy settings for file backup jobs and object storage backup jobs.Set-VBRUploadStreamsConfigurationModifies data transfer settings for job sessions.Set-VBRUserRoleAssignmentModifies a role that is assigned to a user or a user group.Set-VBRvCDCDPPolicyModifies a Cloud Director CDP policy.Set-VBRvCDCloudCDPPolicyModifies a VDC CDP policy.Set-VBRvCDCloudReplicaJobModifies Cloud Director cloud replication jobs.Set-VBRvCDCloudTenantModifies VMware Cloud Director tenant accounts.Set-VBRvCDIndividualObjectStoragePolicyModifying the Cloud Director storage policies for vApps or VMs.Set-VBRvCDReplicaJobModifies Cloud Director replication jobs.Set-VBRvCenterModifies VMware vSphere servers added to the backup infrastructure.Set-VBRVCenterNameModifies VMware vCenter name.Set-VBRvCloudOrganizationJobMappingAdds Cloud Director backup jobs, replication jobs, CDP policies, backups and replicas to the self-service portal of a Cloud Director Organization or removes them from it.Set-VBRViApplicationGroupModifies settings of application groups. This cmdlet is obsolete. For new application groups, run the Set-VBRApplicationGroup cmdlet instead.Set-VBRViCloudHardwarePlanModifies VMware hardware plans.Set-VBRViCloudHWPlanDatastoreModifies VMware cloud storage for tenants replication resources.Set-VBRViCloudReplicaJobModifies a VMware cloud replication job.Set-VBRViLinuxProxyModifies settings of Linux backup proxies.Set-VBRViNetworkMappingRuleModifies network mapping rules of isolated networks.Set-VBRViProxyModifies a VMware backup proxy.Set-VBRViReplicaJobModifies VMware replication jobs.Set-VBRViSureBackupJobModifies settings of VMware SureBackup jobs. This cmdlet is obsolete. For new SureBackup jobs, run the Set-VBRSureBackupJob cmdlet instead.Set-VBRViVirtualDeviceModifies settings of VM virtual disks.Set-VBRViVirtualDeviceMappingRuleModifies backed-up virtual disk mapping settings.Set-VBRViVirtualLabModifies settings of VMware virtual labs.Set-VBRViVirtualLabIPMappingRuleModifies static IP address mapping rules.Set-VBRViVirtualLabNetworkOptionsModifies network settings of isolated networks.Set-VBRViVirtualLabProxyApplianceModifies settings of proxy appliances.Set-VBRVmBiosUuidCollects MORef IDs.Set-VBRVMExclusionModifies a global VM exclusion.Set-VBRVSAEventForwardingFilteringRuleReturns an updated copy of an advanced filtering rule for Veeam Software Appliance syslog event forwarding.Set-VBRVSAEventForwardingOptionsModifies Veeam Software Appliance syslog event forwarding settings.Set-VBRWindowsWorkstationScheduleOptionsModifies the schedule of the backup policy for Windows workstations.Set-VBRWinServerModifies Windows server added to the backup infrastructure.Set-VNXHostModifies Dell VNX storage settings.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
Start-VBRADForestRestoreStarts a Microsoft Active Directory forest restore.Start-VBRApplicationBackupCopyInstantRecoveryStarts instant recovery of the application backup repository data from a backup copy restore point.Start-VBRApplicationBackupJobStarts application backup policies.Start-VBRApplicationBackupRepositoryRescanRescans an application backup repository.Start-VBRApplicationBackupSnapshotInstantRecoveryStarts instant recovery from an application backup repository snapshot.Start-VBRApplicationBackupSnapshotRecoveryStarts recovery from an application backup repository snapshot.Start-VBRArchiveTierSyncStarts the archiving job.Start-VBRAzureInstantRecoveryStarts Instant Recovery to Microsoft Azure.Start-VBRAzureInstantRecoveryMigrationStarts migration to production for the specified Instant Recovery to Microsoft Azure operation.Start-VBRCapacityTierSyncStarts to offload data stored on the performance tier to capacity tier.Start-VBRCatalystCopyJobStarts backup copy jobs for HPE StoreOnce repositories. This cmdlet is obsolete. Run the Start-VBRStorageCopyJob cmdlet instead.Start-VBRCDPLinuxFileRestoreStarts a restore session of Linux-based or Unix-based guest OS files from a CDP replica.Start-VBRCDPReplicaFailbackStarts to perform failback from a CDP replica to the production VM.Start-VBRCDPReplicaFailoverStarts to perform failover to VM replicas.Start-VBRCDPWindowsFileRestoreStarts Microsoft Windows guest OS file restore session for a CDP replica.Start-VBRCloudTapeRestoreStarts a restore session of the tenant data from tape.Start-VBRCloudTenantBackupEvacuationStarts to migrate tenant data between performance extents.Start-VBRComputerBackupJobStarts Veeam Agent backup jobs and Veeam Agent backup policies.Start-VBRComputerVolumeRestoreStarts restore to original location of computer volumes backed-up with Veeam Agent for Microsoft Windows.Start-VBRConfigurationBackupJobStarts the configuration backup job.Start-VBRDownloadBackupDownloads backup files from the capacity tier to the performance tier.Start-VBRDownloadBackupFileDownloads backup files from the capacity tier to the performance tier.Start-VBRDownloadTenantBackupDownloads tenant backups from capacity tier to performance tier.Start-VBREncryptionAnalysisStarts an analysis of an encrypted data malware event.Start-VBREntraIDDBRepositoryRescanStarts rescan of the repository where the Microsoft Entra ID tenant backups are stored.Start-VBREntraIDLogsBackupFLRSessionStarts a restore session to explore log files and folders that a log backup contains.Start-VBREntraIDTenantBackupJobStarts Entra ID tenant backup jobs.Start-VBREntraIDTenantCopyRestoreStarts a restore session from a backup copy of a Microsoft Entra ID tenant.Start-VBREntraIDTenantRestoreStarts a restore session for a Microsoft Entra ID tenant.Start-VBREpInstantRecoveryStarts instant recovery of physical computers to virtual infrastructure.Start-VBRFailoverPlanStarts failover by failover plan.Start-VBRFCDInstantRecoveryStarts the FCD instant recovery session.Start-VBRFCDInstantRecoveryMigrationStarts Quick Migration of FCDs.Start-VBRHighAvailabilityClusterFailoverStarts failover of an HA cluster.Start-VBRHighAvailabilityClusterSwitchoverStarts switchover of an HA cluster.Start-VBRHvInstantRecoveryStarts Hyper-V Instant Recovery.Start-VBRHvInstantRecoveryMigrationPerforms migration of instantly recovered VMs to a Hyper-V host.Start-VBRHvReplicaFailbackFails back Hyper-V VMs to production host.Start-VBRHvReplicaFailoverFails over corrupted Hyper-V VMs to their replicas.Start-VBRHvRestoreVMStarts restore of an entire Hyper-V VM.Start-VBRInstantRecoveryStarts VMware Instant Recovery.Start-VBRIrisInstanceRestoreStarts restore of InterSystems IRIS instances.Start-VBRJobStarts a backup or replication job.Start-VBRLinuxFileRestoreStarts a restore session of Linux-based or Unix-based guest OS files.Start-VBRLinuxGuestItemRestoreRestores Linux-based or Unix-based guest OS files.Start-VBRNASBackupFLRSessionStarts a restore session to explore objects backed-up by file backup jobs. This cmdlet is obsolete. Run the Start-VBRUnstructuredBackupFLRSession cmdlet instead.Start-VBRNASBackupHealthCheckPerforms a health check for the latest restore point in the backup chain and its repair if necessary. This cmdlet is obsolete. Run the Start-VBRUnstructuredBackupHealthCheck cmdlet instead.Start-VBRNasBackupRestoreStarts restore of backups created by the file backup job.Start-VBRNASInstantRecoveryStarts an instant restore of backups created by the file backup job.Start-VBRNASInstantRecoveryMigrationStarts migration to production for the running instant file share recovery session.Start-VBRNDMPVolumeRestoreRestores data from tape to an NDMP server.Start-VBRObjectStorageBackupRestoreStarts restore of backups created by an object storage backup job.Start-VBROffloadBackupFileMoves backup files to the capacity tier.Start-VBROracleDatabaseRestore (obsolete)Start-VBRQuickBackupPerforms quick backup.Start-VBRQuickMigrationStarts Quick Migration of a virtual machine.Start-VBRReplicaFailoverFails over a corrupted VM to its replica. This cmdlet is obsolete. The cmdlet still works, but it is recommended to rewrite your scripts using the Start-VBRViReplicaFailover cmdlet.Start-VBRRepositoryExtentBackupEvacuationEvacuates backups from a scale-out backup repository extent.Start-VBRRestoreVirtualDisksRestores disks from backups of physical or virtual machines and converts them to the VMDK, VHD or VHDX formats.Start-VBRRestoreVMStarts restore of the entire VMware VM.Start-VBRRestoreVMFilesRestores VM configuration files.Start-VBRScaleOutBackupRepositoryRebalanceStarts to rebalance data of scale-out backup repositories.Start-VBRScanBackupStarts a scan of backups with antivirus or YARA scan.Start-VBRScanUnstructuredBackupStarts a scan of file backups and object storage backups with antivirus or YARA scan.Start-VBRSecurityComplianceAnalyzerStarts the Security & Compliance Analyzer scan.Start-VBRSQLDatabaseRestore (obsolete)Start-VBRStorageCopyJobStarts storage backup copy jobs.Start-VBRSureBackupJobStarts the SureBackup job.Start-VBRTapeCatalogStarts tape catalog process.Start-VBRTapeCopyStarts tape copy jobs.Start-VBRTapeFileRestoreStarts the restore of files and folders from tape.Start-VBRTapeInventoryStarts tape inventory.Start-VBRTapeObjectStorageRestoreStarts the restore of objects from tape.Start-VBRTapeRestoreStarts VM or database plug-in backups restore from tape. This cmdlet is obsolete. The cmdlet will still work but it is recommended to perform the tape restore operation with Veeam Backup & Replication UI for full functionality.Start-VBRTapeRestoreAllContentStarts restoring all content of the specified tapes.Start-VBRTapeRestoreFilesStarts files restore from tape. This cmdlet is obsolete. The cmdlet will still work but it is recommended to perform the tape restore operation with Veeam Backup & Replication UI for full functionalityStart-VBRTapeVerificationStarts tape verification jobs.Start-VBRUnstructuredBackupFLRSessionStarts a restore session to explore objects backed-up by file backup jobs and object storage backup jobs.Start-VBRUnstructuredBackupHealthCheckPerforms a health check of the latest restore point created by file backup jobs and object storage backup jobs and their repair if necessary.Start-VBRvCDCDPReplicaFailbackStarts to perform failback from a Cloud Director CDP replica to the production vApp.Start-VBRvCDCDPReplicaFailoverStarts to perform failover to a Cloud Director CDP replica.Start-VBRvCDReplicaFailbackStarts to perform failback from Cloud Director replica to the production VM.Start-VBRvCDReplicaFailoverStarts to perform failover to a Cloud Director replica.Start-VBRvCDReplicaJobStarts Cloud Director replication jobs.Start-VBRvCloudInstantRecoveryStarts an instant recovery of Cloud Director VMsStart-VBRvCloudQuickMigrationStarts a quick migration of Cloud Director VMs.Start-VBRvCloudRestoreVAppStarts a vApp restore.Start-VBRvCloudRestoreVmStarts a Cloud Director VM restore.Start-VBRViComputerInstantRecoveryStarts instant recovery of machines to the VMware infrastructure.Start-VBRViInstantRecoveryDiskMigrationStarts publish VM virtual disks to the production environment.Start-VBRViInstantRecoveryMigrationStarts VMs quick migration to specified ESXi host.Start-VBRViInstantVMDiskRecoveryStarts restore of VM virtual disks from backups.Start-VBRViReplicaFailbackFails back VMware VMs to production host.Start-VBRViReplicaFailoverFails over corrupted VMware VMs to their replicas.Start-VBRViVirtualDiskRestoreStarts VMware VM virtual disk restore.Start-VBRViVMMigrationStarts the MORef IDs update.Start-VBRVMRestoreToAmazonStarts a restore session of workloads to Amazon EC2 service.Start-VBRVMRestoreToAzureRestores VM backups to Microsoft Azure.Start-VBRVMRestoreToGoogleCloudStarts a restore session to Google Compute Engine.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.Start-VBRZipPerforms VeeamZIP on the selected VM.Start-VSBJobStarts a created SureBackup job. This cmdlet is obsolete. Run the Start-VBRSureBackupJob cmdlet instead.
Stop
Stop-VBRApplicationBackupJobStops application backup policies.Stop-VBRApplicationBackupSnapshotInstantRecoveryStops snapshot instant recovery session for an application backup repository.Stop-VBRAzureInstantRecoveryStops the specified Instant Recovery to Microsoft Azure operation.Stop-VBRBackupCopyJobStops backup copy jobs.Stop-VBRCDPReplicaFailbackUndoes a CDP replica failback.Stop-VBRCDPReplicaFailoverUndoes a CDP replica failover.Stop-VBRCloudTapeRestoreThis cmdlet stops the restore session of the tenant data from tape.Stop-VBRCloudTenantNetworkApplianceDisables network extension appliances on the tenant side.Stop-VBRComputerBackupJobStops Veeam Agent backup jobs and Veeam Agent backup policies.Stop-VBRCopyBackupSessionSpecifies how to process backups for which a copy session failed.Stop-VBREntraIDLogsBackupFLRSessionStops a restore session started to recover data from Microsoft Entra ID log backups.Stop-VBREntraIDTenantBackupJobStops running backup jobs that protect Microsoft Entra ID tenants.Stop-VBREntraIDTenantItemRestoreSessionStops a session launched to restore Microsoft Entra ID items or their attributes.Stop-VBREntraIDTenantRestoreStops a Microsoft Entra ID tenant restore session.Stop-VBRFCDInstantRecoveryStops the FCD instant recovery session.Stop-VBRHvReplicaFailbackUndoes Hyper-V replica failback.Stop-VBRInstantRecoveryStops running Instant Recovery sessions.Stop-VBRInstantRecoveryMigrationStops running migration sessions launched during Instant Recovery.Stop-VBRJobStops a running backup, replication or copy job.Stop-VBRLinuxFileRestoreStops Linux-based or Unix-based guest OS files restore.Stop-VBRLinuxGuestItemRestoreStops Linux guest OS file restore session initiated with the Start-VBRLinuxGuestItemRestore cmdlet.Stop-VBRMoveBackupSessionSpecifies how to process backups for which a move sessions failed.Stop-VBRNASBackupFLRSessionStops restore sessions started to recover backups created by file backup jobs. This cmdlet is obsolete. Run the Stop-VBRUnstructuredBackupFLRSession cmdlet instead.Stop-VBRNASInstantRecoveryStops an instant restore of backups created by the file backup job.Stop-VBRReplicaFailoverUndoes replica failover.Stop-VBRSessionStops tape jobs sessions.Stop-VBRSureBackupJobStops the SureBackup job.Stop-VBRUnstructuredBackupFLRItemComparisonStops sessions that are running to compare backed-up objects with objects on production file share or object storage.Stop-VBRUnstructuredBackupFLRSessionStops restore sessions started to recover backups created by file backup jobs or object storage backup jobs.Stop-VBRvCDCDPReplicaFailbackStops Cloud Director CDP replica failback.Stop-VBRvCDCDPReplicaFailoverStops Cloud Director CDP replica failover.Stop-VBRvCDReplicaFailbackStops a Cloud Director replica failback.Stop-VBRvCDReplicaFailoverStops Cloud Director replica failover.Stop-VBRvCDReplicaJobStops Cloud Director replication jobs.Stop-VBRViInstantVMDiskRecoveryStops restore of VM virtual disks.Stop-VBRViReplicaFailbackUndoes VMware replica failback.Stop-VBRVMRestoreToAmazonStops running restore to Amazon EC2 sessions.Stop-VBRVMRestoreToAzureStops running VM backup restore to Microsoft Azure sessions.Stop-VBRVMRestoreToGoogleCloudStops running restore to Google Compute Engine sessions.Stop-VBRWindowsFileRestoreStops Windows guest OS file restore session.Stop-VBRWindowsGuestItemRestoreStops Windows guest OS file restore session initiated with the Start-VBRWindowsGuestItemRestore cmdlet.Stop-VSBJobStops running SureBackup job. This cmdlet is obsolete. Run the Stop-VBRSureBackupJob cmdlet instead.
Switch
Switch-VBRAzureInstantRecoveryMigrationStarts the manual switchover for finalizing the migration to production process after you perform the Instant Recovery to Microsoft Azure.Switch-VBRCloudTenantsQuotaRepositoryToSOBRSwitches tenant quotas on the cloud repository to a scale-out backup repository.Switch-VBRNASInstantRecoveryMigrationStarts the manual switchover for completing the migration to production after you perform the instant file share recovery.
Sync
Sync-HP3StorageRescans HPE 3PAR StoreServ storage systems.Sync-HP3VolumeRescans HPE 3PAR StoreServ storage volumes added to the backup infrastructure.Sync-HyperFlexHostRescans Cisco HyperFlex storage system.Sync-NetAppHostRescans NetApp storage systems.Sync-NetAppVolumeRescans NetApp storage volumes added to the backup infrastructure.Sync-NimbleHostRescans HPE Nimble storage systems.Sync-NimbleVolumeRescans HPE Nimble storage volumes added to the backup infrastructure.Sync-StoragePluginHostRescans Universal Storage API integrated systems.Sync-StoragePluginVolumeRescans volumes of Universal Storage API integrated systems.Sync-ThinkSystemHostRescans ThinkSystem storage systems.Sync-ThinkSystemVolumeRescans ThinkSystem storage volumes added to the backup infrastructure.Sync-VBRBackupCopyJobStarts a backup copy job.Sync-VBRBackupRepositoryRescans a backup repository.Sync-VBRBackupToTapeJobStarts an active full for a selected GFS backup to tape job.Sync-VBRCloudTenantResourceRefreshes information about current usage of backup resources by a cloud tenant.Sync-VBRCloudTenantReplicationResourcesSync-VBRComputerBackupCopyJobSynchronizes Veeam Agent backup copy jobs.Sync-VBRFileToTapeJobStarts an active full for a selected GFS file to tape job.Sync-VBRIsilonHostRescans Dell PowerScale (formerly Isilon) storage system.Sync-VBRIsilonVolumeRescans Dell PowerScale (formerly Isilon) storage volumes added to the backup infrastructure.Sync-VBRNASBackupMetadataDownloads metadata of backup files from the long-term backup repository. This cmdlet is obsolete. Run the Sync-VBRUnstructuredBackupMetadata cmdlet instead.Sync-VBRNutanixHostRescans Nutanix Files storage systems.Sync-VBRNutanixVolumeRescans Nutanix Files volumes added to the backup infrastructure.Sync-VBRObjectToTapeJobStarts an active full for a selected GFS object to tape job.Sync-VBRSOBREntityStateSynchronizes the state of backup chains on performance extents with the state of data on capacity and archive extents of a scale-out backup repositories.Sync-VBRUnstructuredBackupMetadataDownloads metadata of backup files from the long-term backup repository.Sync-VNXHostRescans Dell VNX storage system.Sync-VNXVolumeRescans Dell VNX storage volumes added to the backup infrastructure.
Test
Test-VBRMailNotificationConfigurationTests global email notification settings.
Undo
Undo-VBRFailoverPlanUndoes the failover by failover plan.
Uninstall
Uninstall-VBRCDPFilterRemoves Veeam I/O filter from VMware clusters.Uninstall-VBRDiscoveredComputerAgentRemoves Veeam Agent from a specific protected computer.Uninstall-VBRDiscoveredComputerCDPAgentRemoves Veeam CDP Guest Service and Veeam CDP volume filter driver.Uninstall-VBRDiscoveredComputerComponentsUninstalls Veeam components from discovered computers.Uninstall-VBRDiscoveredComputerPluginRemoves Veeam Plug-Ins from a specific protected computer.Uninstall-VBRLicenseRemoves a license from a backup server.Uninstall-VBRLinuxTransportServiceUninstalls guest processing Veeam Data Mover from Linux VMs.Uninstall-VBRServerComponentRemoves a backup infrastructure component from the backup infrastructure.Uninstall-VBRvCDCDPFilterRemoves Veeam I/O filter from organization VDCs.
Unmount
Unmount-VBRObjectStorageRepositoryUnmounts object storage and archive repositories.
Unpublish
Unpublish-VBRBackupContentUnpublishes disks.
Update
Update-VBRLicenseUpdates licenses.Update-VBRNasBackupPathUpdates the file path to the source file share. This cmdlet is obsolete. Run the Update-VBRUnstructuredBackupPath cmdlet instead.Update-VBRServerComponentUpgrades all components on managed servers.Update-VBRUnstructuredBackupPathUpdates the data source for file backups and object storage backups.
Upgrade
Upgrade-VBRBackupUpgrades the backup chain format of backups from per-machine (split machine) to true per-machine.
Validate
Validate-VBRDiscoveredComputerRecoveryMediaVerifies that Veeam Recovery Media is valid.Validate-VBREntraIDTenantItemValidates that a restore point contains data for the specified Microsoft Entra ID items.Validate-VBRInfrastructureValidates the network infrastructure of a backup server.
Related Topics