Get-ApplianceBackupPart Command | Vmware PowerCLI Reference

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

Get-ApplianceBackupPart
-Id < String[] >
[-OptionalOnly ]
[-ProgressAction < ActionPreference > ]
[-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.
optional OptionalOnly SwitchParameter named
Returns optional backup parts only.
optional ProgressAction ActionPreference named
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.
Get-ApplianceBackupPart
[-Name < String[] > ]
[-OptionalOnly ]
[-ProgressAction < ActionPreference > ]
[-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.
optional OptionalOnly SwitchParameter named
Returns optional backup parts only.
optional ProgressAction ActionPreference named
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.

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

ApplianceBackupJob

This cmdlet retrieves a list of backup jobs for a vCenter Server system.

This cmdlet starts a backup job for a vCenter Server system.

This cmdlet stops running backup jobs on a vCenter Server system.

This cmdlet monitors the progress of a backup job and returns the ApplianceBackupJob object when the backup job is complete.

ApplianceBackupPart

This cmdlet retrieves backup parts that can be included in a backup for a vCenter Server system.