Add-Zip Cmdlet
Parameters Output Objects Config 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 archive
add-zip -Input newfile.txt -Output existingArchive.zip
# add a file to an existing .tar archive
add-zip -Input newfile.txt -Output existingArchive.tar
# add a file to an existing .zip archive with a password
add-zip -Input newfile.txt -Output existingArchive.zip -Password somepassword
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. |
| 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. |
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 (Add-Zip Cmdlet)
The location of a file to which debug information is written.
Syntax
Add-Zip -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
Config Property (Add-Zip Cmdlet)
Specifies one or more configuration settings.
Syntax
Add-Zip -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 (Add-Zip Cmdlet)
Specifies the path and filename of the file in the archive.
Syntax
Add-Zip -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
""
Format Property (Add-Zip Cmdlet)
The format of the compression used.
Syntax
Add-Zip -Format string
Remarks
Possible values for the compression used include: Zip, Jar, Tar.
Default Value
0
Input Property (Add-Zip Cmdlet)
The files to be added to the archive.
Syntax
Add-Zip -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 (Add-Zip Cmdlet)
The location of a file to which debug information is written.
Syntax
Add-Zip -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 (Add-Zip Cmdlet)
The archive file.
Syntax
Add-Zip -Output string
Remarks
Specifies the name of the compressed file to be appended to.
Default Value
""
Parameter Position
1
Parameter Alias
out
Overwrite Property (Add-Zip Cmdlet)
Whether or not to overwrite the archive.
Syntax
Add-Zip -Overwrite SwitchParameter
Remarks
If this flag is set, the user is not queried for overwrite confirmation when the file exists.
Default Value
false
Password Property (Add-Zip Cmdlet)
The password for the zip archive.
Syntax
Add-Zip -Password string
Remarks
The EncryptionAlgorithm of the compressed file determines the AES encryption strength.
Default Value
""
Recurse Property (Add-Zip Cmdlet)
Whether or not to recurse into subdirectories.
Syntax
Add-Zip -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
ZipFile Output Object (Add-Zip Cmdlet)
Returned after appending file(s) to archive.
Syntax
Object ZipFile {string File;
long Size;
bool Secure;
}
Remarks
After successfully appending a file(s), 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 (Add-Zip 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
| BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a cmdlet is using. It will return the following information:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these cmdlets: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the cmdlet whether or not to use the system security libraries or an internal implementation.
When set to false, the cmdlet will use the system security libraries by default to perform cryptographic functions where applicable.
In this case, calls to unmanaged code will be made. In certain environments this is not desirable.
To use a completely managed security implementation set this setting to true.
Setting this setting to true tells the cmdlet to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries. Note: This setting is static. The value set is applicable to all cmdlets used in the application. When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file. |