Compress-Tar Cmdlet

Parameters Output Objects Configuration Settings

The Compress-Tar cmdlet implements a compressor for TAR format archives.

Syntax

Compress-Tar [parameters]

Remarks

When compressing Tar files, the interface is identical to that of the Zip format and is the same whether gzip compression is used or not.

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.

# archive the contents of a folder to a tar archive
Compress-Tar -Input "C:\temp\*" -Output "C:\temptar.tar"
# create a tar archive with gzip compression
Compress-Tar -Input "C:\temp" -Output "C:\temptar.tar.gz" -UseGzipCompression

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 compression level.
Config	Specifies one or more configuration settings.
FileCompressedName	Specifies the path and filename of the file in the archive.
Input	The files to be included in the archive.
LogFile	The location of a file to which debug information is written.
Output	The archive file.
Overwrite	Whether or not to overwrite the archive.
Recurse	Whether or not to recurse into subdirectories.
UseGzipCompression	Whether or not to use gzip compression.

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.


UseBackgroundThread	Whether threads created by the cmdlet are background threads.
UseInternalSecurityAPI	Tells the cmdlet whether or not to use the system security libraries or an internal implementation.