Start-Transcript
Cria um registro de toda ou parte de uma sessão do PowerShell para um arquivo de texto.
Sintaxe
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
O Start-Transcript cmdlet cria um registro de toda ou parte de uma sessão do PowerShell para um arquivo de texto. A transcrição inclui todos os comandos 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 do 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ção quando você inicia duas ou mais transcrições simultaneamente. Incluir o nome do computador é útil se você armazenar suas transcrições em um local centralizado. A cadeia de caracteres aleatórios impede a adivinhação do nome do arquivo para obter 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 a codificação no arquivo de destino.
Exemplos
Exemplo 1: Iniciar um arquivo de transcrição com as configurações padrão
Start-TranscriptEste 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" -NoClobberEste comando inicia uma transcrição no Transcript0.txt arquivo em C:\transcripts. O parâmetro NoClobber impede que quaisquer arquivos existentes sejam substituídos. Se o Transcript0.txt arquivo 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 a partir do nome do usuário, do nome do host do computador que executa o PowerShell, da versão do PowerShell e da data e hora. A transcrição é armazenada no compartilhamento de \\Server01\Transcripts arquivos.
$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-TranscriptO caminho completo para o arquivo de transcrição é armazenado na $Transcript variável de preferência. Para obter mais informações sobre a variável de $Transcript preferência, consulte about_Preference_Variables.
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.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Confirm
Solicita a sua confirmação antes de executar o cmdlet.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | 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 do arquivo para leitura-gravação. O cmdlet não pode substituir restrições de segurança quando esse parâmetro é usado.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-IncludeInvocationHeader
Indica que esse cmdlet registra o carimbo de data/hora quando os comandos são executados.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | 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 curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. As aspas simples informam o PowerShell para não interpretar nenhum caractere como sequências de escape.
| Tipo: | String |
| Aliases: | PSPath, LP |
| Position: | 0 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-NoClobber
Indica que esse cmdlet não substitui um arquivo existente. Por padrão, se existir um arquivo de transcrição no caminho especificado, Start-Transcript substituirá o arquivo sem aviso.
| Tipo: | SwitchParameter |
| Aliases: | NoOverwrite |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-OutputDirectory
Especifica um caminho e uma pasta específicos nos quais salvar uma transcrição. O PowerShell atribui automaticamente o nome da transcrição.
| Tipo: | String |
| Position: | 0 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-Path
Especifica um local para o arquivo de transcrição. Insira um caminho para um .txt arquivo. Curingas não são permitidos. Se algum 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 $Transcript variável global. Se você não criou essa variável, Start-Transcript armazena as transcrições no local e no nome do arquivo padrão.
| Tipo: | String |
| Position: | 0 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-UseMinimalHeader
Insira um cabeçalho curto na transcrição, em vez do cabeçalho detalhado incluído por padrão. Esse parâmetro foi adicionado no PowerShell 6.2.
| Tipo: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-WhatIf
Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
Entradas
None
Não é possível canalizar objetos para este cmdlet.
Saídas
Este cmdlet retorna uma cadeia de caracteres contendo uma mensagem de confirmação e o caminho para o arquivo de saída.
Notas
Para interromper uma transcrição, use o Stop-Transcript cmdlet.
Para gravar uma sessão inteira, adicione o Start-Transcript comando ao seu perfil. Para obter mais informações, consulte about_Profiles.
