Add-Zip Cmdlet
Parameters Output Objects Configuration Settings
The Add-ZIP cmdlet allows for the appending of a file to an existing ZIP, JAR, or TAR archive.
Syntax
Add-Zip [parameters]
Remarks
The format of the archive is specified by the Format parameter.
For the Zip format, the cmdlet uses the Deflate algorithm specified in RFC 1951 for compression, and writes output compatible with PKZip, WinZip, etc.
For Jar files, the operation of the cmdlet is similar to that of the Zip Format. .class and other files may be added into a .jar file, and then may be imported into Java code or executed by a JVM.
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.
# add a file to an existing .zip archiveadd-zip -Input newfile.txt -Output existingArchive.zip# add a file to an existing .tar archiveadd-zip -Input newfile.txt -Output existingArchive.tar# add a file to an existing .zip archive with a passwordadd-zip -Input newfile.txt -Output existingArchive.zip -Password somepasswordParameter 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. |
| Config | Specifies one or more configuration settings. |
| FileCompressedName | Specifies the path and filename of the file in the archive. |
| Format | The format of the compression used. |
| Input | The files to be added to 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. |
| Password | The password for the zip archive. |
| Recurse | Whether 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.
| ZipFile | Returned after appending file(s) to archive. |
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. |