Start-Transcript

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

Создает запись всего сеанса PowerShell или его части в текстовый файл.

Синтаксис

Start-Transcript
     [[-Path] <String>]
     [-Append]
     [-Force]
     [-NoClobber]
     [-IncludeInvocationHeader]
     [-UseMinimalHeader]
     [-WhatIf]
     [-Confirm] 
     [<CommonParameters>]
Start-Transcript
     [[-LiteralPath] <String>]
     [-Append]
     [-Force]
     [-NoClobber]
     [-IncludeInvocationHeader]
     [-UseMinimalHeader]
     [-WhatIf]
     [-Confirm] 
     [<CommonParameters>]
Start-Transcript
     [[-OutputDirectory] <String>]
     [-Append]
     [-Force]
     [-NoClobber]
     [-IncludeInvocationHeader]
     [-UseMinimalHeader]
     [-WhatIf]
     [-Confirm] 
     [<CommonParameters>]

Описание

Командлет Start-Transcript создает запись всего сеанса PowerShell или его части в текстовый файл. Запись включает в себя все команды, вводимые пользователем, и все выходные данные, выводимые в консоли.

Начиная с Windows PowerShell 5.0, Start-Transcript включает имя узла в созданное имя файла всех расшифровок. Это особенно полезно, если ведение журнала на предприятии является централизованным. Файлы, созданные командлетом Start-Transcript , содержат случайные символы в именах, чтобы предотвратить потенциальную перезапись или дублирование при одновременном запуске двух или более расшифровок. Это также предотвращает несанкционированное обнаружение расшифровок, хранящихся в централизованной общей папке.

Если целевой файл не имеет метки порядка байтов (BOM), Start-Transcript по умолчанию используется Utf8NoBom кодировка в целевом файле.

Примеры

Пример 1. Запуск файла расшифровки с параметрами по умолчанию

Start-Transcript

Эта команда начинает записывать сеанс в файл в папке по умолчанию.

Пример 2. Запуск файла расшифровки в определенном расположении

Start-Transcript -Path "C:\transcripts\transcript0.txt" -NoClobber

Эта команда запускает расшифровку в Transcript0.txt файле в C:\transcripts. Так как используется параметр NoClobber , команда предотвращает перезапись существующих файлов. Transcript0.txt Если файл уже существует, команда завершается ошибкой.

Параметры

-Append

Указывает, что этот командлет добавляет новую расшифровку в конец существующего файла. Используйте параметр Path , чтобы указать файл.

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

-Confirm

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

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

-Force

Позволяет командлету добавить запись к существующему файлу, доступному только для чтения. При использовании применительно к файлу, доступному только для чтения, этот командлет изменяет разрешения файла, делая его доступным для чтения и записи. Командлет не может переопределить ограничения безопасности при использовании этого параметра.

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

-IncludeInvocationHeader

Указывает, что этот командлет регистрирует метку времени при выполнении команд.

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

-LiteralPath

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

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

-NoClobber

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

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

-OutputDirectory

Указывает конкретный путь и папку для сохранения расшифровки. PowerShell автоматически назначает имя расшифровки.

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

-Path

Указывает расположение файла расшифровки. Введите путь к файлу .txt . Использовать подстановочные знаки запрещено.

Если путь не указан, Start-Transcript использует путь в значении глобальной $Transcript переменной. Если вы не создали эту переменную, Start-Transcript сохраните расшифровки в файлах $HOME\My Documents directory as \PowerShell_transcript.<time-stamp>.txt .

Если какие-либо каталоги, указанные в пути, отсутствуют, команда завершается сбоем.

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

-UseMinimalHeader

Добавьте к расшифровке короткий заголовок вместо подробного заголовка, включенного по умолчанию. Этот параметр был добавлен в PowerShell 6.2.

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

-WhatIf

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

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

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

None

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

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

String

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

Примечания

Чтобы остановить расшифровку, используйте Stop-Transcript командлет .

Чтобы записать весь сеанс, добавьте команду в Start-Transcript профиль. Дополнительные сведения см. в разделе about_Profiles.