Export-Clixml

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Cria uma representação baseada em XML de um objeto ou objetos e armazena-a em um arquivo.

Syntax

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

Description

O Export-Clixml cmdlet serializou um objeto em uma representação baseada em XML da CLI (Common Language Infrastructure) armazenando-o em um arquivo. Em seguida, você pode usar o Import-Clixml cmdlet para recriar o objeto salvo com base no conteúdo desse arquivo. Para obter mais informações sobre a CLI, consulte Independência de idioma.

Esse cmdlet é semelhante ao ConvertTo-Xml, exceto que Export-Clixml armazena o XML resultante em um arquivo. ConvertTo-XML retorna o XML, para que você possa continuar a processá-lo no PowerShell.

Um uso valioso de em computadores Windows é exportar credenciais e cadeias de Export-Clixml caracteres seguras com segurança como XML. Para obter um exemplo, consulte o Exemplo 3.

Exemplos

Exemplo 1: Exportar uma cadeia de caracteres para um arquivo XML

Este exemplo cria um arquivo XML que armazena no diretório atual, uma representação da cadeia de caracteres This is a test.

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

A cadeia de caracteres This is a test é enviada pelo pipeline. Export-Clixml usa o parâmetro Path para criar um arquivo XML nomeado sample.xml no diretório atual.

Exemplo 2: Exportar um objeto para um arquivo XML

Este exemplo mostra como exportar um objeto para um arquivo XML e, em seguida, criar um objeto importando o XML do arquivo.

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

O Get-Acl cmdlet obtém o descritor de segurança do Test.txt arquivo. Ele envia o objeto pelo pipeline para passar o descritor de segurança para Export-Clixml. A representação baseada em XML do objeto é armazenada em um arquivo chamado FileACL.xml.

O Import-Clixml cmdlet cria um objeto a partir do XML no FileACL.xml arquivo. Em seguida, ele salva o $fileacl objeto na variável.

Exemplo 3: Criptografar um objeto de credencial exportado

Neste exemplo, dada uma credencial armazenada na $Credential variável executando o Get-Credential cmdlet, você pode executar o Export-Clixml cmdlet para salvar a credencial no disco.

Importante

Export-Clixml só exporta credenciais criptografadas no Windows. Em sistemas operacionais que não sejam Windows, como macOS e Linux, as credenciais são exportadas como um texto sem formatação armazenado como uma matriz de caracteres Unicode. Isso fornece alguma ofuscação, mas não fornece criptografia.

$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

O Export-Clixml cmdlet criptografa objetos de credencial usando a API de Proteção de Dados do Windows. A criptografia garante que somente sua conta de usuário nesse computador possa descriptografar o conteúdo do objeto de credencial. O arquivo exportado CLIXML não pode ser usado em um computador diferente ou por um usuário diferente.

No exemplo, o arquivo no qual a credencial é armazenada é representado por TestScript.ps1.credential. Substitua TestScript pelo nome do script com o qual você está carregando a credencial.

Você envia o objeto de credencial pelo pipeline para Export-Clixmlo , e o salva no caminho, $Credxmlpath, que você especificou no primeiro comando.

Para importar a credencial automaticamente para o script, execute os dois comandos finais. Execute Import-Clixml para importar o objeto de credencial protegido para o script. Essa importação elimina o risco de expor senhas de texto sem formatação em seu script.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-Depth

Especifica quantos níveis de objetos contidos estão incluídos na representação XML. O valor padrão é 2.

O valor padrão pode ser substituído para o Types.ps1xml tipo de objeto nos arquivos. Para obter mais informações, consulte about_Types.ps1xml.

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

-Encoding

Especifica o tipo de codificação para o arquivo de destino. O valor padrão é Unicode.

Os valores aceitáveis para esse parâmetro são os seguintes:

  • ASCII Usa o conjunto de caracteres ASCII (7 bits).
  • BigEndianUnicode Usa UTF-16 com a ordem de bytes big-endian.
  • Default Usa a codificação que corresponde à página de código ativo do sistema (geralmente ANSI).
  • OEM Usa a codificação que corresponde à página de código OEM atual do sistema.
  • Unicode Usa UTF-16 com a ordem de bytes little-endian.
  • UTF7 Usa UTF-7.
  • UTF8 Usa UTF-8.
  • UTF32 Usa UTF-32 com a ordem de bytes little-endian.
Type:String
Accepted values:ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32
Position:Named
Default value:Unicode
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Força o comando a ser executado sem solicitar a confirmação do usuário.

Faz com que o cmdlet limpe o atributo somente leitura do arquivo de saída, se necessário. O cmdlet tentará redefinir o atributo somente leitura quando o comando for concluído.

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

-InputObject

Especifica o objeto a ser convertido. Insira uma variável que contém os objetos ou digite um comando ou uma expressão que obtém os objetos. Você também pode canalizar objetos para Export-Clixmlo .

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

-LiteralPath

Especifica o caminho para o arquivo onde a representação XML do objeto será armazenada. Ao contrário de Path, o valor do parâmetro LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

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

-NoClobber

Indica que o cmdlet não substitui o conteúdo de um arquivo existente. Por padrão, se um arquivo existir no caminho especificado, Export-Clixml substituirá o arquivo sem aviso.

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

-Path

Especifica o caminho para o arquivo onde a representação XML do objeto será armazenada.

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Entradas

PSObject

Você pode canalizar qualquer objeto para esse cmdlet.

Saídas

FileInfo

Esse cmdlet retorna um objeto FileInfo que representa o arquivo criado com os dados armazenados.