Export-Console
Exporta os nomes de snap-ins na sessão atual para um arquivo de console.
Sintaxe
Export-Console [[-Path] <string>] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>]
Descrição
O cmdlet Export-Console exporta os nomes dos snap-ins do Windows PowerShell na sessão atual para um arquivo de console do Windows PowerShell (.psc1). Você pode usar esse cmdlet para guardar os snap-ins e usá-los em sessões futuras.
Para adicionar os snap-ins do arquivo de console .psc1 a uma sessão, inicie o Windows PowerShell (Powershell.exe) na linha de comando usando Cmd.exe ou outra sessão do Windows PowerShell e, em seguida, use o parâmetro PSConsoleFile do Powershell.exe para especificar o arquivo de console.
Para obter mais informações sobre os snap-ins do Windows PowerShell, consulte about_Pssnapins.
Parâmetros
-Force
Substitui os dados em um arquivo de console sem avisar, mesmo se o arquivo tiver o atributo somente leitura. O atributo somente leitura é alterado e não é redefinido quando o comando é concluído.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-NoClobber
Não substituirá o conteúdo de um arquivo de console existente. Por padrão, se existir um arquivo no caminho especificado, Export-Console substituirá o arquivo sem avisar.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Path <string>
Especifica um caminho e um nome de arquivo para o arquivo de console (*.psc1). Insira um caminho (opcional) e um nome. Os caracteres curinga não são permitidos.
Se você digitar apenas um nome de arquivo, Export-Console criará um arquivo com esse nome e com a extensão de arquivo ".psc1" no diretório atual.
Esse parâmetro é necessário, a menos que você tenha aberto o Windows PowerShell com o parâmetro PSConsoleFile ou exportado um arquivo de console durante a sessão atual. Ele também será necessário quando você utilizar o parâmetro NoClobber para impedir que o arquivo de console atual seja substituído.
Se você omitir esse parâmetro, Export-Console substituirá o conteúdo do arquivo de console utilizado mais recentemente na sessão. O caminho para o arquivo de console usado mais recentemente é armazenado no valor da variável automática $ConsoleFileName. Para obter mais informações, consulte about_Automatic_Variables.
Necessário? |
false |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByValue, ByPropertyName) |
Aceitar caracteres curinga? |
false |
-Confirm
Solicita confirmação antes da execução do comando.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-WhatIf
Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
Entradas |
System.String Também é possível canalizar uma cadeia de caracteres de caminho para Export-Console. |
Saídas |
System.IO.FileInfo Export-Console cria um arquivo que contém os aliases exportados. |
Observações
Quando um arquivo de console (.psc1) for usado para iniciar a sessão, o nome do arquivo de console será automaticamente armazenado na variável automática $ConsoleFileName. O valor de $ConsoleFileName é atualizado quando você usar o parâmetro Path de Export-Console para especificar um novo arquivo de console. Quando nenhum arquivo de console é usado, $ConsoleFileName não tem valor algum ($null).
Para usar um arquivo de console do Windows PowerShell em uma nova sessão, use a seguinte sintaxe para iniciar o Windows PowerShell:
"powershell.exe -PsConsoleFile <ConsoleFile>.psc1".
Você também poderá salvar os snap-ins do Windows PowerShell para sessões futuras adicionando um comando Add-PSSnapin ao seu perfil do Windows PowerShell. Para obter mais informações, consulte about_Profiles.
Exemplo 1
C:\PS>export-console -path $pshome\Consoles\ConsoleS1.psc1
Descrição
-----------
Esse comando exporta os nomes de snap-ins do Windows PowerShell da sessão atual para o arquivo ConsoleS1.psc1 no subdiretório Consoles do diretório de instalação do Windows PowerShell, $pshome.
Exemplo 2
C:\PS>export-console
Descrição
-----------
Esse comando exporta os nomes de snap-ins do Windows PowerShell da sessão atual para o arquivo de console do Windows PowerShell que foi usado mais recentemente na sessão atual. Ele substitui o conteúdo do arquivo anterior.
Se você não tiver exportado um arquivo de console durante a sessão atual, será solicitada a sua permissão para continuar e, em seguida, será solicitado um nome de arquivo.
Exemplo 3
C:\PS>add-pssnapin NewPSSnapin
C:\PS> export-console -path NewPSSnapinConsole.psc1
C:\PS> powershell.exe -PsConsoleFile NewPsSnapinConsole.psc1
Descrição
-----------
Esses comandos adicionam o snap-in NewPSSnapin do Windows PowerShell à sessão atual, exportam os nomes de snap-ins do Windows PowerShell da sessão atual para um arquivo de console e iniciam uma sessão do Windows PowerShell com o arquivo de console.
O primeiro comando usa o cmdlet Add-PSSnapin para adicionar o snap-in NewPSSnapin à sessão atual. Você poderá adicionar apenas snap-ins do Windows PowerShell que estejam registrados no seu sistema.
O segundo comando exporta os nomes de snap-ins do Windows PowerShell para o arquivo NewPSSnapinConsole.psc1.
O terceiro comando inicia o Windows PowerShell com o arquivo NewPSSnapinConsole.psc1. Como o arquivo de console inclui o nome do snap-in do Windows PowerShell, os cmdlets e provedores no snap-in estarão disponíveis na sessão atual.
Exemplo 4
C:\PS>export-console -path Console01
C:\PS> notepad console01.psc1
<?xml version="1.0" encoding="utf-8"?>
<PSConsoleFile ConsoleSchemaVersion="1.0">
<PSVersion>2.0</PSVersion>
<PSSnapIns>
<PSSnapIn Name="NewPSSnapin" />
</PSSnapIns>
</PSConsoleFile>
Descrição
-----------
Esse comando exporta os nomes de snap-ins do Windows PowerShell da sessão atual para o arquivo Console01.psc1 no diretório atual.
O segundo comando exibe o conteúdo do arquivo Console01.psc1 no Bloco de Notas.
Exemplo 5
C:\PS>powershell.exe -PSConsoleFile Console01.psc1
C:\PS> add-pssnapin MySnapin
C:\PS> export-console NewConsole.psc1
C:\PS> $consolefilename
C:\PS> add-pssnapin SnapIn03
C:\PS> export-console
Descrição
-----------
Esse exemplo mostra como usar a variável automática $ConsoleFileName para determinar o arquivo de console que será atualizado se você usar Export-Console sem um valor de parâmetro Path.
O primeiro comando usa o parâmetro PSConsoleFile de PowerShell.exe para abrir o Windows PowerShell com o arquivo Console01.psc1.
O segundo comando usa o cmdlet Add-PSSnapin para adicionar o snap-in do Windows PowerShell MySnapin à sessão atual.
O terceiro comando usa o cmdlet Export-Console para exportar os nomes de todos os snap-ins do Windows PowerShell da sessão para o arquivo NewConsole.psc1.
O quarto comando usa o parâmetro $ConsoleFileName para exibir o arquivo de console usado mais recentemente. A saída de exemplo mostra que NewConsole.ps1 é o arquivo usado mais recentemente.
O quinto comando adiciona SnapIn03 ao console atual.
O sexto comando usa o cmdlet ExportConsole sem um parâmetro Path. Esse comando exporta os nomes de todos os snap-ins do Windows PowerShell da sessão atual para o arquivo usado mais recentemente, NewConsole.psc1.