Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

WindowsServerBackup Module

Brian Lich|Last Updated: 4/3/2017

Description

This reference provides cmdlet descriptions and syntax for all Windows Server Backup cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

WindowsServerBackup Cmdlets

Add-WBBackupTarget

Adds a backup target to a backup policy.

Add-WBBareMetalRecovery

Adds items to a backup policy so that backups that use the policy can perform bare metal recoveries.

Add-WBFileSpec

Adds a backup file specification to a backup policy.

Add-WBSystemState

Adds the system state components to the backup policy.

Add-WBVirtualMachine

Adds a list of virtual machines to the backup policy.

Add-WBVolume

Adds the list of source volumes to the backup policy.

Get-WBBackupSet

Gets backups for a server from a location that you specify.

Get-WBBackupTarget

Gets backup storage locations that you specified as part of a backup policy.

Get-WBBackupVolumeBrowsePath

Mounts a volume inside a backup so that you can browse the files on the volume.

Get-WBBareMetalRecovery

Gets a Boolean value that indicates whether or not a backup policy can perform bare metal recoveries from backups.

Get-WBDisk

Gets a list of internal and external disks that are online for the local computer.

Get-WBFileSpec

Gets the list of backup file specifications associated with a backup policy.

Get-WBJob

Gets the current backup operation.

Get-WBPerformanceConfiguration

Gets the current volume backup performance settings.

Get-WBPolicy

Gets the current backup policy for the computer.

Get-WBSchedule

Gets the current schedule for backups.

Get-WBSummary

Gets the history of backup operations on the computer.

Get-WBSystemState

Gets a Boolean value that indicates whether system state recovery was added to the backup policy.

Get-WBVirtualMachine

Gets all virtual machines and components from the backup policy.

Get-WBVolume

Gets a list of volumes.

Get-WBVssBackupOption

Gets a VSS setting from the backup policy.

New-WBBackupTarget

Creates a backup target object.

New-WBFileSpec

Creates a backup file specification.

New-WBPolicy

Creates a backup policy object.

Remove-WBBackupSet

Removes backups from a target catalog, a system catalog, or both.

Remove-WBBackupTarget

Removes backup storage locations from a backup policy.

Remove-WBBareMetalRecovery

Removes a request to include items that implement bare metal recovery from the current backup policy.

Remove-WBCatalog

Removes the backup catalog from the local computer.

Remove-WBFileSpec

Removes a backup file specification from a backup policy.

Remove-WBPolicy

Removes the backup policy.

Remove-WBSystemState

Removes the system state components from the backup policy.

Remove-WBVirtualMachine

Removes the list of virtual machines from the backup policy.

Remove-WBVolume

Removes the volume from the backup policy.

Restore-WBCatalog

Restores a backup catalog for the local computer from a storage location.

Resume-WBBackup

Resumes a backup operation to a removable device after you add media to the device.

Resume-WBVolumeRecovery

Resumes a volume recovery operation from a removable device and specific media.

Set-WBPerformanceConfiguration

Sets the current volume backup performance settings.

Set-WBPolicy

Sets the backup policy for scheduled backups.

Set-WBSchedule

Sets the current schedule for backups.

Set-WBVssBackupOption

Sets a value that determines the VSS setting in the backup policy.

Start-WBApplicationRecovery

Starts an application recovery operation.

Start-WBBackup

Starts a one-time backup operation.

Start-WBFileRecovery

Starts a file recovery operation.

Start-WBHyperVRecovery

Starts recovery of a Hyper-V Server 2016 virtual machine.

Start-WBSystemStateRecovery

Starts a system state recovery operation.

Start-WBVolumeRecovery

Starts a volume recovery operation.

Stop-WBJob

Stops the current backup or recovery job.

© 2017 Microsoft