NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

Expand-Zip Cmdlet

Parameters   Output Objects   Configuration Settings  

The Expand-ZIP cmdlet implements a decompressor for ZIP, GZIP, JAR, and TAR archives.

Syntax

Expand-Zip [parameters]

Remarks

The format for decompression is specified by the Format parameter.

For the Zip format, the cmdlet uses the Deflate algorithm specified in RFC 1951 for decompression, and reads output compatible with PKZip, WinZip, etc.

For Gzip, the cmdlet component implements a gzip decompressor compliant to RFC 1952 and compatible with the UNIX gzip and gunzip utilities.

For Jar files, the operation of the cmdlet is similar to that of the Zip format.

The Tar files, the cmdlet implements a tar archive utility, compatible with the UNIX tar and untar utilities. The interface is identical to that of the Zip format and is the same whether gzip compression is used or not, so the Tar Format can be used for both .tar and .tgz archives.

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.


# scan a jar file
expand-zip -Input "simple.jar" -format jar
# extract files from a zip archive
expand-zip -input C:\tempzip3.zip -password test -output C:\temp
# extract files from a tar-gzip archive
expand-zip -input C:\sample.tgz -format tar 

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.
FormatThe format of the compression used.
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.
PasswordThe password for the zip archive.
RecurseWhether or not to recurse into subdirectories.

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.

CodePageThe system code page used for Unicode to Multibyte translations.

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