Edit

Share via

Remove-WBVirtualMachine

  • Reference
Module:
WindowsServerBackup

Removes the list of virtual machines from the backup policy.

Syntax

Remove-WBVirtualMachine
      [-Policy] <WBPolicy>
      [[-VirtualMachine] <WBVirtualMachine[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-WBVirtualMachine
      [-Policy] <WBPolicy>
      [-All]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-WBVirtualMachine cmdlet removes the list of virtual machines from the backup policy contained in the WBPolicy object.

Examples

Example 1: Remove virtual machines from the backup policy

PS C:\> $Policy = Get-WBPolicy
PS C:\> Remove-WBVirtualMachine $Policy -All

This example removes all virtual machines from the backup policy.

The first command calls the Get-WBPolicy cmdlet and assigns the result to the $Policy variable.

The second command removes the virtual machines from the backup policy stored in the $Policy variable.

Parameters

-All

Indicates that this cmdlet removes all virtual machines from the backup contained in the WBPolicy object.

Type:SwitchParameter
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Policy

Specifies the WBPolicy object that contains the backup policy that this cmdlet updates.

Type:WBPolicy
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VirtualMachine

Specifies an array of one or more virtual machines that this cmdlet removes from the backup policy contained in the WBPolicy object.

Type:WBVirtualMachine[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Windows.ServerBackup.Commands.WBVirtualMachine[]

Outputs

Object