Start-Transcript
Cria um registro de toda ou parte de uma sessão do PowerShell em um arquivo de texto.
Sintaxe
ByPath (Padrão)
Start-Transcript
[[-Path] <String>]
[-Append]
[-Force]
[-NoClobber]
[-IncludeInvocationHeader]
[-UseMinimalHeader]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByLiteralPath
Start-Transcript
[[-LiteralPath] <String>]
[-Append]
[-Force]
[-NoClobber]
[-IncludeInvocationHeader]
[-UseMinimalHeader]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByOutputDirectory
Start-Transcript
[[-OutputDirectory] <String>]
[-Append]
[-Force]
[-NoClobber]
[-IncludeInvocationHeader]
[-UseMinimalHeader]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Start-Transcript cria um registro de toda ou parte de uma sessão do PowerShell em um arquivo de texto. A transcrição inclui todo o comando que o usuário digita e toda a saída que aparece no console.
Por padrão, Start-Transcript armazena a transcrição no seguinte local usando o nome padrão:
- No Windows:
$HOME\Documents - No Linux ou macOS:
$HOME
O nome de arquivo padrão é PowerShell_transcript.<computername>.<random>.<timestamp>.txt.
A partir do Windows PowerShell 5.0, Start-Transcript inclui o nome do host no nome do arquivo gerado de todas as transcrições. O nome do arquivo também inclui caracteres aleatórios em nomes para evitar possíveis substituições ou duplicações quando você inicia duas ou mais transcrições simultaneamente. Incluir o nome do computador será útil se você armazenar suas transcrições em um local centralizado. A cadeia de caracteres aleatória impede que a adivinhação do nome do arquivo obtenha acesso não autorizado ao arquivo.
Se o arquivo de destino não tiver uma Marca de Ordem de Bytes (BOM), Start-Transcript o padrão será Utf8NoBom codificação no arquivo de destino.
Exemplos
Exemplo 1: iniciar um arquivo de transcrição com configurações padrão
Start-Transcript
Esse comando inicia uma transcrição no local do arquivo padrão.
Exemplo 2: iniciar um arquivo de transcrição em um local específico
Start-Transcript -Path "C:\transcripts\transcript0.txt" -NoClobber
Esse comando inicia uma transcrição no arquivo Transcript0.txt no C:\transcripts.
parâmetro NoClobber impede que todos os arquivos existentes sejam substituídos. Se o arquivo Transcript0.txt já existir, o comando falhará.
Exemplo 3: iniciar um arquivo de transcrição com um nome exclusivo e armazená-lo em um compartilhamento de arquivos
O exemplo a seguir cria um arquivo de transcrição com um nome exclusivo o suficiente para ser armazenado em um local compartilhado. O nome do arquivo é construído com base no nome do usuário, no nome do host do computador que executa o PowerShell, na versão do PowerShell e na data e hora. A transcrição é armazenada no compartilhamento de arquivos \\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).ToString()
Start-Transcript
O caminho completo para o arquivo de transcrição é armazenado na variável de preferência $Transcript. Para obter mais informações sobre a variável de preferência $Transcript, consulte about_Preference_Variables.
Exemplo 4: iniciar uma transcrição usando um caminho relativo em sistemas Windows
Quando você usa um caminho relativo com o parâmetro OutputDirectory no Windows, o caminho é relativo ao diretório Documents .
Start-Transcript -Path .\transcripts
Transcript started, output file is C:\Users\username\Documents\.\transcripts\PowerShell_transcript.HOSTNAME.8S6RpEfN.20251105152247.txt
Exemplo 5: iniciar uma transcrição usando um caminho relativo em sistemas não Windows
Quando você usa um caminho relativo com o parâmetro OutputDirectory em sistemas que não são do Windows, o caminho é relativo ao diretório base.
Start-Transcript -Path ./transcripts
Transcript started, output file is /home/username/./transcripts/PowerShell_transcript.hostname.ift21QeV.20251105151236.txt
Parâmetros
-Append
Indica que esse cmdlet adiciona a nova transcrição ao final de um arquivo existente. Use o parâmetro Path para especificar o arquivo.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Permite que o cmdlet acrescente a transcrição a um arquivo somente leitura existente. Quando usado em um arquivo somente leitura, o cmdlet altera a permissão de arquivo para leitura-gravação. O cmdlet não pode substituir restrições de segurança quando esse parâmetro é usado.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-IncludeInvocationHeader
Indica que esse cmdlet registra o carimbo de data/hora quando os comandos são executados.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-LiteralPath
Especifica um local para o arquivo de transcrição. Ao contrário do parâmetro 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. As aspas simples informam ao PowerShell para não interpretar nenhum caractere como sequências de escape.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Conjuntos de parâmetros
ByLiteralPath
| Cargo: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-NoClobber
Indica que esse cmdlet não substitui um arquivo existente. Por padrão, se houver um arquivo de transcrição no caminho especificado, Start-Transcript substituirá o arquivo sem aviso.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | NoOverwrite |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-OutputDirectory
Especifica um caminho e uma pasta específicos no qual salvar uma transcrição. O PowerShell atribui automaticamente o nome da transcrição. Se você usar um caminho relativo, o caminho será relativo ao diretório Documents no Windows. No Linux e no macOS, o caminho é relativo ao diretório base.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByOutputDirectory
| Cargo: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Path
Especifica um local para o arquivo de transcrição. Insira um caminho para um arquivo de .txt. Não são permitidos caracteres. Se qualquer um dos diretórios no caminho não existir, o comando falhará.
Se você não especificar um caminho, Start-Transcript usará o caminho no valor da variável global $Transcript. Se você ainda não criou essa variável, Start-Transcript armazenará as transcrições no local padrão e no nome do arquivo.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByPath
| Cargo: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-UseMinimalHeader
Preencha um cabeçalho curto para a transcrição, em vez do cabeçalho detalhado incluído por padrão. Esse parâmetro foi adicionado no PowerShell 6.2.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
None
Não é possível transferir objetos para esse cmdlet.
Saídas
String
Esse cmdlet retorna uma cadeia de caracteres que contém uma mensagem de confirmação e o caminho para o arquivo de saída.
Observações
Para interromper uma transcrição, use o cmdlet Stop-Transcript.
Para gravar uma sessão inteira, adicione o comando Start-Transcript ao seu perfil. Para obter mais informações, consulte about_Profiles.
