Export-Clixml - PowerShell command help and examples

Creates an XML-based representation of an object or objects and stores it in a file. (Export-Clixml)

... Examples      
 NAME
 
    Export-Clixml 

 SYNOPSIS
 
    Creates an XML-based representation of an object or objects and stores it in a file. 

 SYNTAX
 
    Export-Clixml [-Path] <string> -InputObject <psobject> [-Depth <int>] [-Encoding <string>] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>] 

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

    This cmdlet is similar to ConvertTo-XML, except that Export-Clixml stores the resulting XML in a file. ConvertTo-XML returns the XML, so you can continue to process it in Windows PowerShell. 

 PARAMETERS
 
    -Depth <int> 
        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                2 
        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. UTF8 is the default. 

        Required?                    false 
        Position?                    named 
        Default value                UTF8 
        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 
        Accept pipeline input?       false 
        Accept wildcard characters?  false 

    -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-Clixml. 

        Required?                    true 
        Position?                    named 
        Default value 
        Accept pipeline input?       true (ByValue) 
        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-Clixml overwrites the file without warning. 

        Required?                    false 
        Position?                    named 
        Default value 
        Accept pipeline input?       false 
        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 

    -Confirm [<SwitchParameter>] 
        Prompts you for confirmation before executing the command. 

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

    -WhatIf [<SwitchParameter>] 
        Describes what would happen if you executed the command without actually executing the command. 

        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 and OutVariable. For more information, type, 
        "get-help about_commonparameters". 

 INPUTS
 
    System.Management.Automation.PSObject 
        You can pipe any object to Export-Clixml. 

 OUTPUTS
 
    System.IO.FileInfo 
        Export-Clixml creates a file that contains the XML. 

 NOTES
 

 Examples
    
EXAMPLE 1
 

    C:\PS>"This is a test" | export-clixml sample.xml 

     Description
 
    ----------- 
    This command creates an XML file that stores a representation of the string, "This is a test". 

    
EXAMPLE 2
 

    C:\PS>get-acl C:\test.txt | export-clixml -Path fileacl.xml 

    C:\PS> $fileacl = import-clixml fileacl.xml 

     Description
 
    ----------- 
    This example shows how to export an object to an XML file and then create an object by importing the XML from the file. 

    The first command uses the Get-ACL cmdlet to get the security descriptor of the Test.txt file. It uses a pipeline operator to pass the security descriptor to Export-Clixml, which stores an XML-based representation of the object in a file named FileACL.xml. 

    The second command uses the Import-Clixml cmdlet to create an object from the XML in the FileACL.xml file. Then, it saves the object in the $FileAcl variable. 

RELATED LINKS 
    Online version: http://go.microsoft.com/fwlink/?LinkID=113297 
    Import-Clixml 
    ConvertTo-XML 
    Export-Csv 
    ConvertTo-Html 

C:\Windows>powershell get-help Import-Clixml -full 

Microsoft Windows [Version 10.0.19045.3693]
Copyright (c) 2023 Microsoft Corporation.

ColorConsole [Version 3.7.1000] PowerShell 2.0-Export

Windows 11, 10, 8.1, 8, 7 / Server 2022, 2019, 2016