Export-Console
現在のセッションのスナップインの名前をコンソール ファイルにエクスポートします。
構文
Export-Console
[[-Path] <String>]
[-Force]
[-NoClobber]
[-WhatIf]
[-Confirm]
[<CommonParameters>]説明
Export-Console コマンドレットは、現在のセッションのWindows PowerShell スナップインの名前をWindows PowerShellコンソール ファイル (.psc1) にエクスポートします。 このコマンドレットを使用すると、将来のセッションで使用するためにスナップインを保存できます。
.psc1 コンソール ファイル内のスナップインをセッションに追加するには、Cmd.exeまたは別のWindows PowerShell セッションを使用してコマンド ラインでWindows PowerShell (Powershell.exe) を開始し、Powershell.exeの PSConsoleFile パラメーターを使用してコンソール ファイルを指定します。
Windows PowerShell スナップインの詳細については、「about_PSSnapins」を参照してください。
例
例 1: 現在のセッションのスナップインの名前をエクスポートする
PS C:\> Export-Console -Path $pshome\Consoles\ConsoleS1.psc1このコマンドは、現在のセッションのWindows PowerShell スナップインの名前を、Windows PowerShell インストール フォルダーの Consoles フォルダーにある ConsoleS1.psc1 ファイルにエクスポート$pshome。
例 2: スナップインの名前を最新のコンソール ファイルにエクスポートする
PS C:\> Export-Consoleこのコマンドは、Windows PowerShell スナップインの名前を、現在のセッションから、現在のセッションで最近使用された Windows PowerShell コンソール ファイルにエクスポートします。 前のファイルの内容は上書きされます。
現在のセッション中に、コンソール ファイルをエクスポートしていない場合は、続行するためのアクセス許可の入力が求められ、その後、ファイル名の入力が求められます。
例 3: スナップインを追加し、スナップインの名前をエクスポートする
PS C:\> Add-PSSnapin NewPSSnapin
PS C:\> Export-Console -path NewPSSnapinConsole.psc1
PS C:\> powershell.exe -PsConsoleFile NewPsSnapinConsole.psc1これらのコマンドは、NewPSSnapin Windows PowerShell スナップインを現在のセッションに追加し、現在のセッションの Windows PowerShell スナップインの名前をコンソール ファイルにエクスポートして、コンソール ファイルで Windows PowerShell セッションを開始します。
最初のコマンドでは 、Add-PSSnapin コマンドレットを使用して、NewPSSnapin スナップインを現在のセッションに追加します。 システムに登録されている Windows PowerShell スナップインのみを追加できます。
2 番目のコマンドは、Windows PowerShell スナップインの名前を NewPSSnapinConsole.psc1 ファイルにエクスポートします。
3 番目のコマンドは、NewPSSnapinConsole.psc1 ファイルを使用して、Windows PowerShell を起動します。 コンソール ファイルには Windows PowerShell スナップインの名前が含まれるため、スナップイン内のコマンドレットとプロバイダーを現在のセッションで使用できます。
例 4: スナップインの名前を指定した場所にエクスポートする
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>このコマンドは、現在のセッションの Windows PowerShell スナップインの名前を、現在のディレクトリ内の Console01.psc1 ファイルにエクスポートします。
2 番目のコマンドは、メモ帳で、Console01.psc1 ファイルの内容を表示します。
例 5: 更新するコンソール・ファイルを判別する
PS C:\> powershell.exe -PSConsoleFile Console01.psc1
PS C:\> Add-PSSnapin MySnapin
PS C:\> Export-Console NewConsole.psc1
PS C:\> $ConsoleFileName
PS C:\> Add-PSSnapin SnapIn03
PS C:\> Export-Consoleこの例では、$ConsoleFileName自動変数を使用して、Path パラメーター値を指定せずに Export-Console を使用する場合に更新されるコンソール ファイルを決定する方法を示します。
最初のコマンドは、PowerShell.exeの PSConsoleFile パラメーターを使用して、Console01.psc1 ファイルでWindows PowerShellを開きます。
2 番目のコマンドでは、Add-PSSnapin コマンドレットを使用して、MySnapin Windows PowerShell スナップインを現在のセッションに追加します。
3 番目のコマンドは、Export-Console コマンドレットを使用して、セッション内のすべてのWindows PowerShell スナップインの名前を NewConsole.psc1 ファイルにエクスポートします。
4 番目のコマンドは、$ConsoleFileName変数を表示します。 これには、最近使用したコンソール ファイルが含まれています。 サンプル出力は NewConsole.ps1 が最近使用されたファイルであることを示しています。
5 番目のコマンドは、SnapIn03 を現在のコンソールに追加します。
6 番目のコマンドでは、Path パラメーターを指定せずに Export-Console コマンドレットを使用します。 このコマンドは、現在のセッションのすべての Windows PowerShell スナップインの名前を最近使用されたファイルである NewConsole.psc1 にエクスポートします。
パラメーター
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
このコマンドレットは、ファイルに読み取り専用属性がある場合でも、警告なしでコンソール ファイル内のデータを上書きすることを示します。 読み取り専用属性は変更され、コマンドが完了してもリセットされません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
このコマンドレットが既存のコンソール ファイルを上書きしないことを示します。 既定では、指定したパスにファイルが存在する場合、 Export-Console によって警告なしでファイルが上書きされます。
| Type: | SwitchParameter |
| Aliases: | NoOverwrite |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
コンソール ファイル (*.psc1) のパスとファイル名を指定します。 省略可能なパスと名前を入力します。 ワイルドカード文字は使用できません。
ファイル名のみを指定した場合、 Export-Console は、その名前と .psc1 ファイル名拡張子を持つファイルを現在のディレクトリに作成します。
PSConsoleFile パラメーターを使用してWindows PowerShellを開いたり、現在のセッション中にコンソール ファイルをエクスポートしたりしていない限り、このパラメーターは必須です。 また、 NoClobber パラメーターを使用して、現在のコンソール ファイルが上書きされないようにする場合にも必要です。
このパラメーターを省略すると、このセッションで最近使用されたコンソール ファイルが Export-Console によって上書きされます。 最近使用したコンソール ファイルのパスは、$ConsoleFileName自動変数の値に格納されます。 詳細については、「about_Automatic_Variables」を参照してください。
| Type: | String |
| Aliases: | PSPath |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
パス文字列をこのコマンドレットにパイプできます。
出力
このコマンドレットは、エクスポートされたエイリアスを含むファイルを作成します。
メモ
コンソール ファイル (.psc1) を使用してセッションを開始すると、コンソール ファイルの名前が自動的に $ConsoleFileName の自動変数に格納されます。 export-Console の Path パラメーターを使用して新しいコンソール ファイルを指定すると、$ConsoleFileNameの値が更新されます。 コンソール ファイルが使用されていない場合、$ConsoleFileNameには値 ($Null) はありません。
新しいセッションで Windows PowerShell コンソール ファイルを使用するには、次の構文を使用して Windows PowerShell を起動します。
powershell.exe -PsConsoleFile \<ConsoleFile\>.psc1Windows PowerShell プロファイルに Add-PSSnapin コマンドを追加することで、今後のセッションで使用するために Windows PowerShell スナップインを保存することもできます。 詳細については、「about_Profiles」を参照してください。