Export-Clixml

Crea una rappresentazione basata su XML degli oggetti e la archivia in un file.

Sintassi

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

Descrizione

Il Export-Clixml cmdlet serializza un oggetto in una rappresentazione basata su XML dell'interfaccia della riga di comando (Common Language Infrastructure) lo archivia in un file. È quindi possibile usare il Import-Clixml cmdlet per ricreare l'oggetto salvato in base al contenuto del file. Per altre informazioni sull'interfaccia della riga di comando, vedere Indipendenza del linguaggio.

Questo cmdlet è simile a ConvertTo-Xml, ad eccezione del fatto che Export-Clixml archivia il codice XML risultante in un file. ConvertTo-XML restituisce il codice XML, in modo da poter continuare a elaborarlo in PowerShell.

Un uso prezioso di Export-Clixml nei computer Windows consiste nell'esportare le credenziali e proteggere le stringhe in modo sicuro come XML. Per un esempio, vedere Esempio 3.

Esempio

Esempio 1: Esportare una stringa in un file XML

In questo esempio viene creato un file XML archiviato nella directory corrente, una rappresentazione della stringa Questo è un test.

"This is a test" | Export-Clixml -Path .\sample.xml

La stringa This is a test viene inviata verso il basso nella pipeline. Export-Clixml utilizza il parametro Path per creare un file XML denominato sample.xml nella directory corrente.

Esempio 2: Esportare un oggetto in un file XML

Questo esempio mostra come esportare un oggetto in un file XML e quindi creare un oggetto importando l'XML dal file.

Get-Acl C:\test.txt | Export-Clixml -Path .\FileACL.xml
$fileacl = Import-Clixml -Path .\FileACL.xml

Il Get-Acl cmdlet ottiene il descrittore di sicurezza del Test.txt file. Invia l'oggetto verso il basso nella pipeline per passare il descrittore di sicurezza a Export-Clixml. La rappresentazione basata su XML dell'oggetto viene archiviata in un file denominato FileACL.xml.

Il Import-Clixml cmdlet crea un oggetto dal codice XML nel FileACL.xml file . Salva quindi l'oggetto nella $fileacl variabile .

Esempio 3: Crittografare un oggetto credenziale esportato in Windows

In questo esempio, data una credenziale archiviata nella $Credential variabile eseguendo il Get-Credential cmdlet , è possibile eseguire il Export-Clixml cmdlet per salvare le credenziali su disco.

Importante

Export-Clixml esporta solo le credenziali crittografate in Windows. Nei sistemi operativi non Windows, ad esempio macOS e Linux, le credenziali vengono esportate come testo normale archiviato come matrice di caratteri Unicode. In questo modo si ottiene un po' di offuscamento, ma non fornisce la crittografia.

$Credxmlpath = Join-Path (Split-Path $Profile) TestScript.ps1.credential
$Credential | Export-Clixml $Credxmlpath
$Credxmlpath = Join-Path (Split-Path $Profile) TestScript.ps1.credential
$Credential = Import-Clixml $Credxmlpath

Il Export-Clixml cmdlet crittografa gli oggetti credenziali usando l'API Protezione dati di Windows. La crittografia garantisce che solo l'account utente in tale computer possa decrittografare il contenuto dell'oggetto credenziale. Il file esportato CLIXML non può essere usato in un computer diverso o da un altro utente.

Nell'esempio il file in cui vengono archiviate le credenziali è rappresentato da TestScript.ps1.credential. Sostituire TestScript con il nome dello script con cui si caricano le credenziali.

Si invia l'oggetto credenziale verso il basso nella pipeline a Export-Clixmle lo si salva nel percorso, $Credxmlpath, specificato nel primo comando.

Per importare automaticamente le credenziali nello script, eseguire i due comandi finali. Eseguire Import-Clixml per importare l'oggetto credenziale protetto nello script. Questa importazione elimina il rischio di esporre le password in testo normale nello script.

Esempio 4: Esportazione di un oggetto credenziale in Linux o macOS

In questo esempio viene creato un PSCredential nella $Credential variabile usando il Get-Credential cmdlet . Si usa Export-Clixml quindi per salvare le credenziali su disco.

Importante

Export-Clixml esporta solo le credenziali crittografate in Windows. Nei sistemi operativi non Windows, ad esempio macOS e Linux, le credenziali vengono esportate come testo normale archiviato come matrice di caratteri Unicode. In questo modo si ottiene un po' di offuscamento, ma non fornisce la crittografia.

PS> $Credential = Get-Credential

PowerShell credential request
Enter your credentials.
User: User1
Password for user User1: ********

PS> $Credential | Export-Clixml ./cred2.xml
PS> Get-Content ./cred2.xml

...
    <Props>
      <S N="UserName">User1</S>
      <SS N="Password">700061007300730077006f0072006400</SS>
    </Props>
...

PS> 'password' | Format-Hex -Encoding unicode

   Label: String (System.String) <52D60C91>

          Offset Bytes                                           Ascii
                 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
          ------ ----------------------------------------------- -----
0000000000000000 70 00 61 00 73 00 73 00 77 00 6F 00 72 00 64 00 p a s s w o r d

L'output di Get-Content in questo esempio è stato troncato per concentrarsi sulle informazioni sulle credenziali nel file XML. Si noti che il valore di testo normale della password viene archiviato nel file XML come matrice di caratteri Unicode, come dimostrato da Format-Hex. Il valore viene quindi codificato ma non crittografato.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

Specifica il numero di livelli di oggetti contenuti inclusi nella rappresentazione XML. Il valore predefinito è 2.

È possibile eseguire l'override del valore predefinito per il tipo di oggetto nei Types.ps1xml file. Per altre informazioni, vedere about_Types.ps1xml.

Type:Int32
Position:Named
Default value:2
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

Specifica il tipo di codifica per il file di destinazione. Il valore predefinito è utf8NoBOM.

I valori accettabili per questo parametro sono i seguenti:

  • ascii: usa la codifica per il set di caratteri ASCII (a 7 bit).
  • bigendianunicode: codifica in formato UTF-16 usando l'ordine dei byte big-endian.
  • bigendianutf32: codifica in formato UTF-32 usando l'ordine dei byte big-endian.
  • oem: usa la codifica predefinita per i programmi MS-DOS e console.
  • unicode: codifica in formato UTF-16 usando l'ordine dei byte little-endian.
  • utf7: codifica in formato UTF-7.
  • utf8: codifica in formato UTF-8.
  • utf8BOM: codifica in formato UTF-8 con byte order mark (BOM)
  • utf8NoBOM: codifica in formato UTF-8 senza byte order mark (BOM)
  • utf32: codifica in formato UTF-32.

A partire da PowerShell 6.2, il parametro Encoding consente anche ID numerici di tabelle codici registrate (ad esempio ) o nomi di stringhe di tabelle codici registrate (ad esempio -Encoding 1251-Encoding "windows-1251"). Per altre informazioni, vedere la documentazione di .NET per Encoding.CodePage.

Nota

UTF-7* non è più consigliato per l'uso. A partire da PowerShell 7.1, viene scritto un avviso se si specifica utf7 per il parametro Encoding .

Type:Encoding
Accepted values:ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:Named
Default value:UTF8NoBOM
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forza l'esecuzione del comando senza chiedere conferma all'utente.

Consente al cmdlet di deselezionare l'attributo di sola lettura del file di output, se necessario. Il cmdlet tenterà di reimpostare l'attributo di sola lettura al termine del comando.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifica l'oggetto da convertire. Immettere una variabile che contiene gli oggetti oppure digitare un comando o un'espressione che ottiene gli oggetti. È anche possibile inviare oggetti tramite pipe a Export-Clixml.

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

Specifica il percorso del file in cui verrà archiviata la rappresentazione XML dell'oggetto. A differenza di Path, il valore del parametro LiteralPath viene usato esattamente come viene digitato. Nessun carattere viene interpretato come carattere jolly. Se il percorso include caratteri di escape, racchiuderlo tra virgolette singole. Le virgolette singole indicano a PowerShell di non interpretare alcun carattere come sequenze di escape.

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoClobber

Indica che il cmdlet non sovrascrive il contenuto di un file esistente. Per impostazione predefinita, se un file esiste nel percorso specificato, Export-Clixml sovrascrive il file senza avviso.

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Specifica il percorso del file in cui verrà archiviata la rappresentazione XML dell'oggetto.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Input

PSObject

È possibile eseguire la pipeline di qualsiasi oggetto in questo cmdlet.

Output

FileInfo

Questo cmdlet restituisce un oggetto FileInfo che rappresenta il file creato con i dati archiviati.