Compress-Tar Cmdlet

Parameters   Output Objects   Config Settings  

The Compress-Tar component 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.

Config Settings

---

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

BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Compress-Tar Cmdlet)

The location of a file to which debug information is written.

Syntax

Compress-Tar -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

CompressionLevel Property (Compress-Tar Cmdlet)

The compression level.

Syntax

Compress-Tar -CompressionLevel int

Remarks

This parameter specifies the level of compression to be used, between 0 and 6. Higher values will cause the cmdlet to compress better; lower values will cause the cmdlet to compress faster.

This parameter is only applicable when the UseGzipCompression flag is present.

Invalid values will be ignored.

Default Value

4

Config Property (Compress-Tar Cmdlet)

Specifies one or more configuration settings.

Syntax

Compress-Tar -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

FileCompressedName Property (Compress-Tar Cmdlet)

Specifies the path and filename of the file in the archive.

Syntax

Compress-Tar -FileCompressedName string

Remarks

This parameter is optional and may be set to specify the path and name of the file as it exists in the archive. By default the cmdlet will automatically determine this value. If path information is specified it must be specified in a Unix style format. For instance "myfolder/myfile.txt".

This parameter is only applicable when adding a single file to the archive. If multiple files are added this parameter is ignored.

Default Value

""

Input Property (Compress-Tar Cmdlet)

The files to be included in the archive.

Syntax

Compress-Tar -Input string[]

Remarks

The parameter can contain directory paths as well, where everything in the directory needs to be included in the compressed file.

Default Value

null

Parameter Position

0

Parameter Alias

files

This is a required parameter.

LogFile Property (Compress-Tar Cmdlet)

The location of a file to which debug information is written.

Syntax

Compress-Tar -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

Output Property (Compress-Tar Cmdlet)

The archive file.

Syntax

Compress-Tar -Output string

Remarks

Specifies the name of compressed file to be created.

Default Value

""

Parameter Position

1

Parameter Alias

out

Overwrite Property (Compress-Tar Cmdlet)

Whether or not to overwrite the archive.

Syntax

Compress-Tar -Overwrite SwitchParameter

Remarks

If this flag is set, the user is not queried for overwrite confirmation when the file exists.

Default Value

false

Recurse Property (Compress-Tar Cmdlet)

Whether or not to recurse into subdirectories.

Syntax

Compress-Tar -Recurse SwitchParameter

Remarks

If Input includes directory paths, this setting indicates whether a recursive search for files should be done by the cmdlet.

Default Value

false

UseGzipCompression Property (Compress-Tar Cmdlet)

Whether or not to use gzip compression.

Syntax

Compress-Tar -UseGzipCompression SwitchParameter

Remarks

If flag is included, the cmdlet the data will be streamed through a gzip compressor as it is written to the archive.

If this parameter is not included, the cmdlet will create ordinary, uncompressed tar archives.

Default Value

false

ZipFile Output Object (Compress-Tar Cmdlet)

Returned after creation of a zip file.

Syntax

Object ZipFile {
   string File;
   long Size;
   bool Secure;
}

Remarks

After constructing a zip file successfully, the ZipFile object is returned.

File contains the full path of the compressed file.

Size contains the file size of the compressed file.

Secure indicates whether or not the file was password protected.

Config Settings (Compress-Tar Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Base Config Settings