Compress-Gzip Cmdlet

Parameters   Output Objects   Config Settings  

The Compress-Gzip component implements a compressor GZIP format archives.

Syntax

Compress-Gzip [parameters]

Remarks

The gzip format is only used to archive a single file. Accordingly, the operation of this cmdlet is simpler than that of the other formats.

The Input property specifies the file to be compressed, and the Output property specifies the name and location of the resulting archive.

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.

# gzip a specific file Compress-Gzip -Input C:\temp\example.tar -Output C:\temp\example.tar.gz

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 level of compression to be used.
CompressionMethod	The method of compression.
Config	Specifies one or more configuration settings.
Input	The file to be compressed.
LogFile	The location of a file to which debug information is written.
Output	The archive file.

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-Gzip Cmdlet)

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

Syntax

Compress-Gzip -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-Gzip Cmdlet)

The level of compression to be used.

Syntax

Compress-Gzip -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. A value of 0 will store the file without compression.

Invalid values will be ignored.

Default Value

4

CompressionMethod Property (Compress-Gzip Cmdlet)

The method of compression.

Syntax

Compress-Gzip -CompressionMethod string

Remarks

Possible values for compression are: Deflate, LZCCompress.

By default, the component uses the Deflate compression method described in rfc 1952. When set to the LZC compress method, the component will use a variation of the method described by the LZW (Lempel-Ziv-Welch) algorithm that is compatible with Unix's compress utility.

Default Value

0

Config Property (Compress-Gzip Cmdlet)

Specifies one or more configuration settings.

Syntax

Compress-Gzip -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

Input Property (Compress-Gzip Cmdlet)

The file to be compressed.

Syntax

Compress-Gzip -Input string

Remarks

This parameter cannot be set to a directory.

Default Value

""

Parameter Position

0

Parameter Alias

file

This is a required parameter.

LogFile Property (Compress-Gzip Cmdlet)

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

Syntax

Compress-Gzip -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-Gzip Cmdlet)

The archive file.

Syntax

Compress-Gzip -Output string

Remarks

Specifies the name of compressed file to be created.

Default Value

""

Parameter Position

1

Parameter Alias

out

ZipFile Output Object (Compress-Gzip 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-Gzip 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