Edit

Share via


Add-WBVirtualMachine

Adds a list of virtual machines to the backup policy.

Syntax

WBVirtualMachine

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

All

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

Description

The Add-WBVirtualMachine cmdlet adds a list of virtual machines to a backup policy contained in the specified WBPolicy object.

Examples

Example 1: Add virtual machines to the backup policy

PS C:\> $Policy = Get-WBPolicy
PS C:\> $VirtualMachines = Get-WBVirtualMachine
PS C:\> Add-WBVirtualMachine -Policy $Policy -VirtualMachine $VirtualMachines

This example adds the list of volumes in the $VirtualMachines variable to the WBPolicy object contained in the $Policy variable.

The first command stores the result of the Get-WBPolicy cmdlet in the $Policy variable.

The second command stores the result of the Get-WBVirtualMachine cmdlet in the $VirtualMachines variable.

The third command adds the virtual machines listed in the $VirtualMachines variable to the backup policy in the $Policy variable.

Parameters

-All

Indicates that this cmdlet adds all virtual machines on the computer to the policy.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

All
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Policy

Specifies a WBPolicy object that contains the backup policy to update.

Parameter properties

Type:WBPolicy
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualMachine

Specifies an array of one or more virtual machines to add to the WBPolicy object.

Parameter properties

Type:

WBVirtualMachine[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

WBVirtualMachine
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

Microsoft.Windows.ServerBackup.Commands.WBVirtualMachine

Outputs

Object