Compartilhar via

Export-Console

Módulo:
Microsoft.PowerShell.Core Module

Exporta os nomes dos snap-ins na sessão atual para um arquivo de console.

Sintaxe

Default (Default) 

Export-Console
    [[-Path] <String>]
    [-Force]
    [-NoClobber]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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 salvar os snap-ins para uso em sessões futuras.

Para adicionar os snap-ins no 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 de powershell.exe para especificar o arquivo de console.

Para obter mais informações sobre snap-ins do Windows PowerShell, consulte about_PSSnapins.

Exemplos

Exemplo 1: exportar os nomes dos snap-ins na sessão atual

PS C:\> Export-Console -Path $PSHOME\Consoles\ConsoleS1.psc1

Esse comando exporta os nomes dos snap-ins do Windows PowerShell na sessão atual para o arquivo ConsoleS1.psc1 na pasta Consoles da pasta de instalação do Windows PowerShell, $PSHOME.

Exemplo 2: exportar os nomes dos snap-ins para o arquivo de console mais recente

Export-Console

Esse comando exporta os nomes dos 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 permissão para continuar e, em seguida, solicitado um nome de arquivo.

Exemplo 3: Adicionar um snap-in e exportar os nomes dos snap-ins

Add-PSSnapin NewPSSnapin
Export-Console -Path NewPSSnapinConsole.psc1
powershell.exe -PSConsoleFile NewPsSnapinConsole.psc1

Esses comandos adicionam o snap-in NewPSSnapin Windows PowerShell à sessão atual, exportam os nomes dos snap-ins do Windows PowerShell na sessão atual para um arquivo de console e, em seguida, 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ê só pode adicionar snap-ins do Windows PowerShell registrados em seu sistema.

O segundo comando exporta os nomes de snap-in 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 de snap-in do Windows PowerShell, os cmdlets e provedores no snap-in estão disponíveis na sessão atual.

Exemplo 4: exportar nomes de snap-ins para um local especificado

PS C:\> Export-Console -Path Console01
PS C:\> notepad console01.psc1
<?xml version="1.0" encoding="utf-8"?>
<PSConsoleFile ConsoleSchemaVersion="1.0">
  <PSVersion>2.0</PSVersion>
  <PSSnapIns>
     <PSSnapIn Name="NewPSSnapin" />
  </PSSnapIns>
</PSConsoleFile>

Esse comando exporta os nomes dos snap-ins do Windows PowerShell na 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: Determinar o arquivo de console a ser atualizado

powershell.exe -PSConsoleFile Console01.psc1
Add-PSSnapin MySnapin
Export-Console NewConsole.psc1
$ConsoleFileName
Add-PSSnapin SnapIn03
Export-Console

Este 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 caminho.

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 mySnapin do Windows PowerShell à sessão atual.

O terceiro comando usa o cmdlet Export-Console para exportar os nomes de todos os snap-ins do Windows PowerShell na sessão para o arquivo NewConsole.psc1.

O quarto comando exibe a variável $ConsoleFileName. Ele contém 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 Export-Console sem um parâmetro Path. Esse comando exporta os nomes de todos os snap-ins do Windows PowerShell na sessão atual para o arquivo usado mais recentemente, NewConsole.psc1.

Parâmetros

-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

Indica que esse cmdlet substitui os dados em um arquivo de console sem aviso, mesmo que o arquivo tenha o atributo somente leitura. O atributo somente leitura é alterado e não é redefinido quando o comando é concluído.

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

-NoClobber

Indica que esse cmdlet não substitui um arquivo de console existente. Por padrão, se um arquivo ocorrer no caminho especificado, Export-Console 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

-Path

Especifica um caminho e um nome de arquivo para o arquivo de console (*.psc1). Insira um caminho e um nome opcionais. Caracteres curinga não são permitidos.

Se você especificar apenas um nome de arquivo, Export-Console criará um arquivo com esse nome e a extensão de nome 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. Também é necessário quando você usa 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 arquivo de console usado mais recentemente nesta sessão. O caminho do arquivo de console usado mais recentemente é armazenado no valor da variável automática $ConsoleFileName. Para obter mais informações, confira about_Automatic_Variables.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:PSPath

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
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

String

Você pode canalizar uma cadeia de caracteres de caminhos para esse cmdlet.

Saídas

FileInfo

Esse cmdlet cria um arquivo que contém os aliases exportados.

Observações

  • Quando um arquivo de console (.psc1) é usado para iniciar a sessão, o nome do arquivo de console é armazenado automaticamente no $ConsoleFileName variável automática. O valor de $ConsoleFileName é atualizado quando você usa 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 ($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 pode salvar 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.