Compress-7Zip
SYNOPSIS
{{ Fill in the Synopsis }}
SYNTAX
NoPassword (Default)
Compress-7Zip [-ArchiveFileName] <String> [-Path] <String> [[-Filter] <String>] [-OutputPath <String>]
[-Format <OutputFormat>] [-CompressionLevel <CompressionLevel>] [-CompressionMethod <CompressionMethod>]
[-CustomInitialization <ScriptBlock>] [-EncryptFilenames] [-FlattenDirectoryStructure] [-VolumeSize <Int64>]
[-SkipEmptyDirectories] [-PreserveDirectoryRoot] [-DisableRecursion] [-Append] [<CommonParameters>]
PlainPassword
Compress-7Zip [-ArchiveFileName] <String> [-Path] <String> [[-Filter] <String>] [-OutputPath <String>]
[-Format <OutputFormat>] [-CompressionLevel <CompressionLevel>] [-CompressionMethod <CompressionMethod>]
[-Password <String>] [-CustomInitialization <ScriptBlock>] [-EncryptFilenames] [-FlattenDirectoryStructure]
[-VolumeSize <Int64>] [-SkipEmptyDirectories] [-PreserveDirectoryRoot] [-DisableRecursion] [-Append]
[<CommonParameters>]
SecurePassword
Compress-7Zip [-ArchiveFileName] <String> [-Path] <String> [[-Filter] <String>] [-OutputPath <String>]
[-Format <OutputFormat>] [-CompressionLevel <CompressionLevel>] [-CompressionMethod <CompressionMethod>]
[-SecurePassword <SecureString>] [-CustomInitialization <ScriptBlock>] [-EncryptFilenames]
[-FlattenDirectoryStructure] [-VolumeSize <Int64>] [-SkipEmptyDirectories] [-PreserveDirectoryRoot]
[-DisableRecursion] [-Append] [<CommonParameters>]
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
Example 1
PS C:\> {{ Add example code here }}
{{ Add example description here }}
PARAMETERS
-Append
Append files to existing archive
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ArchiveFileName
The full file name of the archive
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompressionLevel
{{ Fill CompressionLevel Description }}
Type: SevenZip.CompressionLevel
Parameter Sets: (All)
Aliases:
Accepted values: None, Fast, Low, Normal, High, Ultra
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompressionMethod
{{ Fill CompressionMethod Description }}
Type: SevenZip.CompressionMethod
Parameter Sets: (All)
Aliases:
Accepted values: Copy, Deflate, Deflate64, BZip2, Lzma, Lzma2, Ppmd, Default
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CustomInitialization
Allows setting additional parameters on SevenZipCompressor
Type: System.Management.Automation.ScriptBlock
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisableRecursion
Disables recursive files search
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EncryptFilenames
Enables encrypting filenames when using the 7z format
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Filter
The filter to be applied if Path points to a directory
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FlattenDirectoryStructure
Disables preservation of directory structure
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Format
{{ Fill Format Description }}
Type: SevenZip4PowerShell.OutputFormat
Parameter Sets: (All)
Aliases:
Accepted values: Auto, SevenZip, Zip, GZip, BZip2, Tar, XZ
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutputPath
Output path for a compressed archive
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Password
{{ Fill Password Description }}
Type: System.String
Parameter Sets: PlainPassword
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
The source folder or file
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-PreserveDirectoryRoot
Preserves directory root
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SecurePassword
{{ Fill SecurePassword Description }}
Type: System.Security.SecureString
Parameter Sets: SecurePassword
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SkipEmptyDirectories
Disables preservation of empty directories
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VolumeSize
Specifies the volume sizes in bytes, 0 for no volumes
Type: System.Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.