Get-ApplianceBackupPart

Retrieves a list of parts that can be included in a backup job, and their estimated backup size. Non-optional backup parts are always included in the backup.

Syntax

-Id  <String[]>
[-OptionalOnly]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id
String[] named Retrieves only those backup parts whose IDs match the provided IDs. Type: String[] Parameter Sets: ById Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
optional
OptionalOnly
SwitchParameter named Returns optional backup parts only. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
optional
Server
VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. Type: VIServer[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False

[-Name  <String[]>]
[-OptionalOnly]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Name
String[] named Retrieves only those backup parts whose names match the provided names. Type: String[] Parameter Sets: Default Aliases: Required: False Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False
optional
OptionalOnly
SwitchParameter named Returns optional backup parts only. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False
optional
Server
VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. Type: VIServer[] Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False

Output

VMware.VimAutomation.ViCore.Interop.V1.Appliance.Backup.ApplianceBackupPart

Examples


Example 1

Get-ApplianceBackupPart

Lists all available backup parts.

Example 2

Get-ApplianceBackupPart -OptionalOnly

Retrieves all optional backup parts. You can pass them by pipeline to the New-ApplianceBackupJob cmdlet.

Example 3

Get-ApplianceBackupPart | Measure-Object -Sum -Property SizeMB | Select-Object -ExpandProperty Sum

Compute the estimated size of a full backup in MBs.

Related Commands

Feedback

Was this page helpful?