Start-Transcript
Crea un registro de toda o parte de una sesión de PowerShell en un archivo de texto.
Sintaxis
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>]
Description
El Start-Transcript
cmdlet crea un registro de toda o parte de una sesión de PowerShell en un archivo de texto. Esta transcripción incluye todos los comandos que el usuario escribe y todos los resultados que aparecen en la consola.
De forma predeterminada, Start-Transcript
almacena la transcripción en la siguiente ubicación con el nombre predeterminado:
- En Windows:
$HOME\Documents
- En Linux o macOS:
$HOME
El nombre de archivo predeterminado es PowerShell_transcript.<computername>.<random>.<timestamp>.txt
.
A partir de Windows PowerShell 5.0, Start-Transcript
incluye el nombre de host en el nombre de archivo generado de todas las transcripciones. El nombre de archivo también incluye caracteres aleatorios en nombres para evitar posibles sobrescrituras o duplicaciones al iniciar dos o más transcripciones simultáneamente. Incluir el nombre del equipo es útil si almacena las transcripciones en una ubicación centralizada. La cadena de caracteres aleatorios impide adivinar el nombre de archivo para obtener acceso no autorizado al archivo.
Si el archivo de destino no tiene una marca de orden de bytes (BOM), Start-Transcript
el valor predeterminado es Utf8NoBom
codificar en el archivo de destino.
Ejemplos
Ejemplo 1: Iniciar un archivo de transcripción con la configuración predeterminada
Start-Transcript
Este comando inicia una transcripción en la ubicación predeterminada del archivo.
Ejemplo 2: Iniciar un archivo de transcripción en una ubicación específica
Start-Transcript -Path "C:\transcripts\transcript0.txt" -NoClobber
Este comando inicia una transcripción en el Transcript0.txt
archivo de C:\transcripts
. El parámetro NoClobber impide que se sobrescriban los archivos existentes. Si el Transcript0.txt
archivo ya existe, se produce un error en el comando.
Ejemplo 3: Iniciar un archivo de transcripción con un nombre único y almacenarlo en un recurso compartido de archivos
En el ejemplo siguiente se crea un archivo de transcripción con un nombre lo suficientemente único como para almacenarse en una ubicación compartida. El nombre de archivo se construye a partir del nombre del usuario, el nombre de host del equipo que ejecuta PowerShell, la versión de PowerShell y la fecha y hora. La transcripción se almacena en el recurso compartido de \\Server01\Transcripts
archivos.
$sharepath = '\\Server01\Transcripts'
$username = $env:USERNAME
$hostname = hostname
$version = $PSVersionTable.PSVersion.ToString()
$datetime = Get-Date -f 'yyyyMMddHHmmss'
$filename = "Transcript-${username}-${hostname}-${version}-${datetime}.txt"
$Transcript = Join-Path -Path $sharepath -ChildPath $filename
Start-Transcript
La ruta de acceso completa al archivo de transcripción se almacena en la variable de $Transcript
preferencia. Para obtener más información sobre la $Transcript
variable de preferencia, consulte about_Preference_Variables.
Parámetros
-Append
Indica que este cmdlet agrega la nueva transcripción al final de un archivo existente. Use el parámetro Path para especificar el archivo.
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Confirm
Le solicita su confirmación antes de ejecutar el cmdlet.
Tipo: | SwitchParameter |
Alias: | cf |
Posición: | Named |
Valor predeterminado: | False |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Force
Permite al cmdlet anexar la transcripción a un archivo de solo lectura existente. Cuando se usa en un archivo de solo lectura, el cmdlet cambia los permisos de archivo para lectura y escritura. El cmdlet no puede invalidar las restricciones de seguridad cuando se usa este parámetro.
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-IncludeInvocationHeader
Indica que este cmdlet registra la marca de tiempo cuando se ejecutan los comandos.
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-LiteralPath
Especifica una ubicación para el archivo de transcripción. A diferencia del parámetro Path , el valor del parámetro LiteralPath se usa exactamente como se escribe. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso contiene caracteres de escape, escríbalos entre comillas simples. Las comillas simples informan a PowerShell de no interpretar ningún carácter como secuencias de escape.
Tipo: | String |
Alias: | PSPath, LP |
Posición: | 0 |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-NoClobber
Indica que este cmdlet no sobrescribe un archivo existente. De forma predeterminada, si existe un archivo de transcripción en la ruta de acceso especificada, Start-Transcript
sobrescribe el archivo sin advertencia.
Tipo: | SwitchParameter |
Alias: | NoOverwrite |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-OutputDirectory
Especifica una ruta de acceso y una carpeta específicas en las que guardar una transcripción. PowerShell asigna automáticamente el nombre de la transcripción.
Tipo: | String |
Posición: | 0 |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Path
Especifica una ubicación para el archivo de transcripción. Escriba una ruta de acceso a un .txt
archivo. No se permiten caracteres comodín. Si alguno de los directorios de la ruta de acceso no existe, se produce un error en el comando.
Si no especifica una ruta de acceso, Start-Transcript
usa la ruta de acceso en el valor de la $Transcript
variable global. Si no ha creado esta variable, Start-Transcript
almacena las transcripciones en la ubicación y el nombre de archivo predeterminados.
Tipo: | String |
Posición: | 0 |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-UseMinimalHeader
Anteponer un encabezado corto a la transcripción, en lugar del encabezado detallado incluido de forma predeterminada. Este parámetro se agregó en PowerShell 6.2.
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
Tipo: | SwitchParameter |
Alias: | wi |
Posición: | Named |
Valor predeterminado: | False |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
Entradas
None
No se pueden canalizar objetos a este cmdlet.
Salidas
Este cmdlet devuelve una cadena que contiene un mensaje de confirmación y la ruta de acceso al archivo de salida.
Notas
Para detener una transcripción, use el Stop-Transcript
cmdlet .
Para registrar una sesión completa, agregue el Start-Transcript
comando al perfil. Para obtener más información, consulte about_Profiles.