Edit

Share via

Expand-DedupFile

  • Reference
Module:
Deduplication

Expands an optimized file into its original location.

Syntax

Expand-DedupFile
      [-Path] <String[]>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [<CommonParameters>]

Description

The Expand-DedupFile cmdlet expands an optimized file into its original location. You may need to expand optimized files because of compatibility with applications or other requirements.

Ensure that there is enough space on the volume to store the expanded file. If you do not have enough disk space, the cmdlet attempts to expand the file, and then informs you when it is unable to finish the operation. If you attempt to restore a file that is not optimized, the cmdlet notifies you of the error.

Examples

Example 1: Expand a file

Expand-DedupFile -Path "D:\Share\File07.doc"

This command expands a file to its original location, D:\Share\File07.doc. If the file is not optimized, the cmdlet informs you of the problem.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

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

-Path

Specifies an array of file paths. The cmdlet expands files to the file paths specified by this parameter.

Type:String[]
Aliases:FullName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

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

Outputs

Uint32

This cmdlet generates an integer that indicates success or failure of the operation. A value of zero indicates success.