Búsqueda de sitios web

Start-Transcript (Microsoft.PowerShell.Host)

Start-Transcript

Módulo:
Microsoft.PowerShell.Host

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

Descripción

El cmdlet Start-Transcript crea un registro de toda o parte de una sesión de PowerShell en un archivo de texto. La transcripción incluye todos los comandos que escribe el usuario y todos los resultados que aparecen en la consola.

De forma predeterminada, Start-Transcript almacena la transcripción en la siguiente ubicación usando el nombre predeterminado:

  • En Windows: $HOME\Documentos
  • En Linux o macOS: $HOME

El nombre de archivo predeterminado es PowerShell_transcript....txt.

A partir de Windows PowerShell 5.0, Start-Transcript incluye el nombre de host en el nombre del archivo generado de todas las transcripciones. El nombre del archivo también incluye caracteres aleatorios en los nombres para evitar posibles sobrescrituras o duplicaciones al iniciar dos o más transcripciones simultáneamente. Incluir el nombre de la computadora es útil si almacena sus transcripciones en una ubicación centralizada. La cadena de caracteres aleatoria evita adivinar el nombre del archivo para obtener acceso no autorizado al archivo.

Si el archivo de destino no tiene una marca de orden de bytes (BOM), Start-Transcript tiene como valor predeterminado la codificación Utf8NoBom 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 archivo Transcript0.txt en C:\transcripts. El parámetro NoClobber evita que se sobrescriban los archivos existentes. Si el archivo Transcript0.txt ya existe, el comando falla.

Ejemplo 3: iniciar un archivo de transcripción con un nombre único y almacenarlo en un archivo compartido

El siguiente ejemplo crea un archivo de transcripción con un nombre lo suficientemente exclusivo como para almacenarlo en una ubicación compartida. El nombre del archivo se construye a partir del nombre del usuario, el nombre de host de la computadora que ejecuta PowerShell, la versión de PowerShell y la fecha y hora. La transcripción se almacena en el archivo compartido \\Server01\Transcripts.

$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 completa al archivo de transcripción se almacena en la variable de preferencia $Transcript. Para obtener más información sobre la variable de preferencia $Transcript, consulte about_Preference_Variables.

Parámetros

-Append

Indica que este cmdlet agrega la nueva transcripción al final de un archivo existente. Utilice el parámetro Path para especificar el archivo.

Tipo :

SwitchParameter

Posición:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-Confirm

Le solicita confirmación antes de ejecutar el cmdlet.

Tipo :

SwitchParameter

Alias:

cf

Posición:

Nombrado

Valor predeterminado:

False

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-Force

Permite que el cmdlet agregue la transcripción a un archivo de solo lectura existente. Cuando se usa en un archivo de solo lectura, el cmdlet cambia el permiso del archivo a lectura y escritura. El cmdlet no puede anular las restricciones de seguridad cuando se usa este parámetro.

Tipo :

SwitchParameter

Posición:

Nombrado

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 comandos.

Tipo :

SwitchParameter

Posición:

Nombrado

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 utiliza exactamente tal como se escribe. Ningún carácter se interpreta como comodín. Si la ruta incluye caracteres de escape, escríbala entre comillas simples. Las comillas simples informan a PowerShell que no interprete ningún carácter como secuencia 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 especificada, Start-Transcript sobrescribe el archivo sin previo aviso.

Tipo :

SwitchParameter

Alias:

NoOverwrite

Posición:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-OutputDirectory

Especifica una ruta y una carpeta específicas para 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. Introduzca una ruta a un archivo .txt. No se permiten comodines. Si alguno de los directorios en la ruta no existe, el comando falla.

Si no especifica una ruta, Start-Transcript usa la ruta en el valor de la variable global $Transcript. 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

Anteponga un encabezado breve 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:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-WhatIf

Muestra lo que sucedería si se ejecuta el cmdlet. El cmdlet no se ejecuta.

Tipo :

SwitchParameter

Alias:

wi

Posición:

Nombrado

Valor predeterminado:

False

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

Entradas

Ninguno

No puede canalizar objetos a este cmdlet.

Salidas

Cadena

Este cmdlet devuelve una cadena que contiene un mensaje de confirmación y la ruta al archivo de salida.

Notas

Para detener una transcripción, utilice el cmdlet Stop-Transcript.

Para grabar una sesión completa, agregue el comando Iniciar-Transcripción a su perfil. Para obtener más información, consulte about_Profiles.

Artículos relacionados