NetAppDocs-Lite PowerShell Module

Export-CompressedClixml


NAME
    Export-CompressedClixml

SYNOPSIS
    Compresses the raw data output from the Get-Ntap* functions (as an alternative to the uncompressed Export-Clixml function).


SYNTAX
    Export-CompressedClixml -InputObject <PSObject> [-Path] <String> [-Depth <Int32>] [-Force] [-NoClobber] [-Encoding <String>]
    [-WhatIf] [-Confirm] [<CommonParameters>]

    Export-CompressedClixml -InputObject <PSObject> -LiteralPath <String> [-Depth <Int32>] [-Force] [-NoClobber] [-Encoding
    <String>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
    The Export-CompressedClixml cmdlet uses Export-Clixml to create an XML-based representation of an object or objects and then
    stores it in a compressed file. You can then uncompress the file and use the Import-Clixml cmdlet to re-create the saved
    object based on the contents of that file.


PARAMETERS
    -InputObject <PSObject>
        Specifies the object to be converted. Enter a variable that contains the objects, or type a command
        or expression that gets the objects. You can also pipe objects to Export-CompressedClixml.

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

    -Path <String>
        Specifies the path to the file where the XML representation of the object will be stored.

        Required?                    true
        Position?                    1
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -LiteralPath <String>
        Specifies the path to the file where the XML representation of the object will be stored. Unlike Path, the value of the
        LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes
        escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret
        any characters as escape sequences.

        Required?                    true
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Depth <Int32>
        Specifies how many levels of contained objects are included in the XML representation. The default value is 2.

        The default value can be overridden for the object type in the Types.ps1xml files. For more information, see
        about_Types.ps1xml.

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Force [<SwitchParameter>]
        Causes the cmdlet to clear the read-only attribute of the output file if necessary. The cmdlet will
        attempt to reset the read-only attribute when the command completes.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -NoClobber [<SwitchParameter>]
        Ensures that the cmdlet does not overwrite the contents of an existing file. By default, if a file exists
        in the specified path, Export-CompressedClixml overwrites the file without warning.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Encoding <String>
        Specifies the type of encoding for the target file. Valid values are ASCII, UTF8, UTF7, UTF32, Unicode,
        BigEndianUnicode, Default, and OEM. Unicode is the default.

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -WhatIf [<SwitchParameter>]

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Confirm [<SwitchParameter>]

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS
    System.Management.Automation.PSCustomObject


OUTPUTS
    System.IO.FileInfo


    -------------------------- EXAMPLE 1 --------------------------

    PS>"This is a test" | Export-CompressedClixml -Path sample.xml

    This command creates a sample.xml.gzcompressed file that stores a representation of the string, "This is a test".





RELATED LINKS
    https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs
    Export-Clixml