Compress-Gzip Cmdlet

Parameters Output Objects Configuration Settings

The Compress-Gzip component implements a compressor GZIP format archives.

Syntax

Compress-Gzip [parameters]

Remarks

The gzip format is only used to archive a single file. Accordingly, the operation of this cmdlet is simpler than that of the other formats.

The Input property specifies the file to be compressed, and the Output property specifies the name and location of the resulting archive.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# gzip a specific file
Compress-Gzip -Input C:\temp\example.tar -Output C:\temp\example.tar.gz

Parameter List

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.


LogFile	The location of a file to which debug information is written.
CompressionLevel	The level of compression to be used.
CompressionMethod	The method of compression.
Config	Specifies one or more configuration settings.
Input	The file to be compressed.
LogFile	The location of a file to which debug information is written.
Output	The archive file.

Output Objects

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.


ZipFile	Returned after creation of a zip file.

Configuration Settings

The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.