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

Remove-WBVirtualMachine

Brian Lich|Last Updated: 4/3/2017

SYNOPSIS

Removes the list of virtual machines from the backup policy.

SYNTAX

WBVirtualMachine

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

All

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
Parameter Sets: All
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
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[]
Parameter Sets: WBVirtualMachine
Aliases: 

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Windows.ServerBackup.Commands.WBPolicy

OUTPUTS

Windows.ServerBackup.Commands.WBVirtualMachine[]

NOTES

Add-WBVirtualMachine

Get-WBVirtualMachine

Get-WBPolicy

© 2017 Microsoft