Export (0) Print
Expand All
2 out of 3 rated this helpful - Rate this topic

Windows Server Backup Cmdlets in Windows PowerShell

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Windows Server Backup Cmdlets

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.

 

Cmdlet Description

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 backup file specification to a 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

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

Retrieves the current volume backup performance settings.

Get-WBPolicy

Retrieves the current backup policy for the computer.

Get-WBSchedule

Retrieves the current schedule for backups.

Get-WBSummary

Retrieves 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

Retrieves a list of volumes.

Get-WBVssBackupOption

Retrieves 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

Deletes 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

Recovers 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 2012 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.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module WindowsServerBackup cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

More Information

For more information about the cmdlets, see Windows Server Backup Feature Overview on TechNet.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.