Export-Clixml

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Создает XML-представление объекта или объектов и сохраняет его в файл.

Синтаксис

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>]

Описание

Командлет Export-Clixml сериализовал объект в XML-представление на основе XML-кода, основанного на интерфейсе командной строки, сохраняет его в файле. Затем можно использовать Import-Clixml командлет для повторного создания сохраненного объекта на основе содержимого этого файла. Дополнительные сведения о интерфейсе командной строки см. в разделе "Независимость языка".

Этот командлет аналогичен ConvertTo-Xml, за исключением того, что Export-Clixml сохраняет полученный XML-код в файле. ConvertTo-XML возвращает XML-код, чтобы продолжить обработку его в PowerShell.

Полезное использование Export-Clixml на компьютерах Windows заключается в том, чтобы безопасно экспортировать учетные данные и безопасные строки в виде XML. Пример см. в примере 3.

Примеры

Пример 1. Экспорт строки в XML-файл

В этом примере создается XML-файл, который хранится в текущем каталоге, представление строки Это тест.

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

Строка This is a test отправляется вниз конвейера. Export-Clixmlиспользует параметр Path для создания XML-файла с именем sample.xml в текущем каталоге.

Пример 2. Экспорт объекта в XML-файл

В этом примере показано, как экспортировать объект в XML-файл и затем создать объект путем импорта из XML-файла.

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

Командлет Get-Acl получает дескриптор Test.txt безопасности файла. Он отправляет объект вниз конвейера, чтобы передать дескриптор Export-Clixmlбезопасности. Xml-представление объекта хранится в файле с именем FileACL.xml.

Командлет Import-Clixml создает объект из XML-файла FileACL.xml . Затем он сохраняет объект в переменной $fileacl .

Пример 3. Шифрование экспортированного объекта учетных данных в Windows

В этом примере с учетом учетных данных, хранящихся в $Credential переменной, выполнив Get-Credential командлет, можно запустить Export-Clixml командлет, чтобы сохранить учетные данные на диске.

Внимание

Export-Clixml экспортирует только зашифрованные учетные данные в Windows. В операционных системах, отличных от Windows, таких как macOS и Linux, учетные данные экспортируются в виде обычного текста, хранящегося в виде массива символов Юникода. Это обеспечивает некоторую маскировку, но не обеспечивает шифрование.

$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

Командлет Export-Clixml шифрует объекты учетных данных с помощью API защиты данных Windows. Шифрование гарантирует, что только ваша учетная запись пользователя на компьютере может расшифровывать содержимое объекта учетных данных. Экспортируемый CLIXML файл нельзя использовать на другом компьютере или другом пользователе.

В примере файл, в котором хранятся учетные данные, представлен в TestScript.ps1.credential. Замените TestScript именем скрипта, с которым вы загружаете учетные данные.

Объект учетных данных отправляется в конвейер Export-Clixmlи сохраняется в пути, $Credxmlpathуказанном в первой команде.

Чтобы автоматически импортировать учетные данные в скрипт, выполните последние две команды. Выполните импорт Import-Clixml защищенного объекта учетных данных в скрипт. Этот импорт устраняет риск предоставления паролей обычного текста в скрипте.

Пример 4. Экспорт объекта учетных данных в Linux или macOS

В этом примере мы создадим PSCredential в переменной $Credential с помощью командлета Get-Credential . Затем мы используем Export-Clixml для сохранения учетных данных на диске.

Внимание

Export-Clixml экспортирует только зашифрованные учетные данные в Windows. В операционных системах, отличных от Windows, таких как macOS и Linux, учетные данные экспортируются в виде обычного текста, хранящегося в виде массива символов Юникода. Это обеспечивает некоторую маскировку, но не обеспечивает шифрование.

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

Выходные данные Get-Content в этом примере были усечены, чтобы сосредоточиться на учетных данных в XML-файле. Обратите внимание, что значение обычного текста пароля хранится в XML-файле в виде массива символов Юникода, Format-Hexкак показано. Поэтому значение закодировано, но не зашифровано.

Параметры

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-Depth

Указывает, сколько уровней вложенных объектов включается в XML-представление. Значение по умолчанию — 2.

Значение по умолчанию можно переопределить для типа объекта в файлах Types.ps1xml . Дополнительные сведения см. в разделе about_Types.ps1xml.

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

-Encoding

Указывает тип кодировки для целевого файла. Значение по умолчанию — utf8NoBOM.

Допустимые значения для этого параметра приведены следующим образом:

  • ascii: использует кодировку для набора символов ASCII (7-разрядная версия).
  • bigendianunicode: кодирует в формате UTF-16 с помощью порядка байтов больших байтов.
  • bigendianutf32: кодирует в формате UTF-32 с помощью порядка байтов больших байтов.
  • oem: использует кодировку по умолчанию для программ MS-DOS и консольных программ.
  • unicode: кодирует в формате UTF-16 с помощью байтового порядка байтов.
  • utf7: кодирует в формате UTF-7.
  • utf8: кодирует в формате UTF-8.
  • utf8BOM: кодирует в формате UTF-8 с меткой порядка байтов (BOM)
  • utf8NoBOM: кодирует в формате UTF-8 без метки порядка байтов (BOM)
  • utf32: кодирует в формате UTF-32.

Начиная с PowerShell 6.2, параметр кодирования также позволяет числовым идентификаторам зарегистрированных кодовых страниц (например) или строковым именам зарегистрированных кодовых страниц (например-Encoding "windows-1251"-Encoding 1251). Дополнительные сведения см. в документации по .NET для Encoding.CodePage.

Примечание.

UTF-7* больше не рекомендуется использовать. По состоянию на PowerShell 7.1 предупреждение записывается при указании utf7 параметра кодирования .

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

Принудительное выполнение команды без запроса на подтверждение пользователем.

В результате командлет снимает атрибут только для чтения выходного файла при необходимости. Командлет попытается сбросить атрибут "только для чтения" после выполнения команды.

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

-InputObject

Задает объект для преобразования. Введите переменную, которая содержит объекты, или команду или выражение, которое возвращает объекты. Можно также передать объекты Export-Clixmlв .

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

-LiteralPath

Указывает путь к файлу, где будет храниться XML-представление объекта. В отличие от Path, значение параметра LiteralPath используется точно так же, как он типизированный. Никакие символы не интерпретируются как знаки подстановки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки говорят PowerShell не интерпретировать какие-либо символы как escape-последовательности.

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

-NoClobber

Указывает, что командлет не перезаписывает содержимое существующего файла. По умолчанию, если файл существует в указанном пути, Export-Clixml перезаписывает файл без предупреждения.

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

-Path

Указывает путь к файлу, где будет храниться XML-представление объекта.

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

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

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

Входные данные

PSObject

Вы можете конвейерировать любой объект в этот командлет.

Выходные данные

FileInfo

Этот командлет возвращает объект FileInfo , представляющий созданный файл с сохраненными данными.