Optimize-VHDSet

Optimizes VHD set files.

Syntax

Optimize-VHDSet
        [-Path] <String[]>
        [-AsJob]
        [-CimSession <CimSession[]>]
        [-ComputerName <String[]>]
        [-Confirm]
        [-Credential <PSCredential[]>]
        [-Passthru]
        [-WhatIf]
        [<CommonParameters>]

Description

The Optimize-VHDSet cmdlet optimizes the allocation of space used by virtual hard disk (VHD) set files.

Examples

Example 1: Optimize a VHD set

PS C:\> Optimize-VHDSet -Path "c:\data.vhds"

This command optimizes the allocation of space on the VHD set file c:\data.vhds.

Required Parameters

-Path

Specifies an array of paths of VHD sets that this cmdlet optimizes.

Type:String[]
Aliases:FullName
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

Runs the cmdlet as a background job.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type:String[]
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type:PSCredential[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Indicates that this cmdlet returns the Microsoft.HyperV.PowerShell.VirtualHardDisk object that it optimizes.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.Vhd.PowerShell.VirtualHardDisk

This cmdlet returns a VirtualHardDisk object, if you specify the Passthru parameter.