NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

Expand-Tar Cmdlet

Parameters   Output Objects   Configuration Settings  

The Expand-Tar cmdlet implements a decompressor for TAR archives.

Syntax

Expand-Tar [parameters]

Remarks

To scan an archive, set the Input parameter to the archive to examine, and set the Format parameter to the appropriate type. A ZipFileInfo object will be returned for every entry in the archive.

If the Output parameter is set, the cmdlet will attempt to extract the archive to the specified location. A single ZipFileInfo object will be returned indicating the success of the operation and the number of extracted files.

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.


# extract files from a tar archive
Expand-Tar -Input C:\temp\example.tar -Output C:\temp
# extract files from a tar-gzip archive
Expand-Tar -Input C:\temp\example.tar.gz -Output C:\temp -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.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
ExcludedFilesA list of files to exclude.
IncludedFilesSpecifies that only files matching the provided values should be extracted.
InputThe archive file from which to read.
LogFileThe location of a file to which debug information is written.
OutputThe directory where the files will be decompressed.
OverwriteWhether or not to overwrite files when writing to them.
RecurseWhether or not to recurse into subdirectories.
UseGzipCompressionWhether or not the archive is gzip-compressed.

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.

ZipFileInfoInformation about the entries in the archive.

Configuration Settings


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

UseBackgroundThreadWhether threads created by the cmdlet are background threads.
UseInternalSecurityAPITells the cmdlet whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
NetCmdlets 2016 - Version 16.0 [Build 6592]