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: スナップインの名前を最新のコンソール ファイルにエクスポートする
Export-Console
このコマンドは、Windows PowerShell スナップインの名前を、現在のセッションから、現在のセッションで最近使用された Windows PowerShell コンソール ファイルにエクスポートします。 前のファイルの内容は上書きされます。
現在のセッション中に、コンソール ファイルをエクスポートしていない場合は、続行するためのアクセス許可の入力が求められ、その後、ファイル名の入力が求められます。
例 3: スナップインを追加し、スナップインの名前をエクスポートする
Add-PSSnapin NewPSSnapin
Export-Console -path NewPSSnapinConsole.psc1
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: 更新するコンソール・ファイルを判別する
powershell.exe -PSConsoleFile Console01.psc1
Add-PSSnapin MySnapin
Export-Console NewConsole.psc1
$ConsoleFileName
Add-PSSnapin SnapIn03
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
) にエクスポートします。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Force
このコマンドレットは、ファイルに読み取り専用属性がある場合でも、警告なしでコンソール ファイル内のデータを上書きすることを示します。 読み取り専用属性は変更され、コマンドの終了時にはリセットされません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-NoClobber
このコマンドレットが既存のコンソール ファイルを上書きしないことを示します。 既定では、指定したパスにファイルが存在する場合、 Export-Console
は警告なしでファイルを上書きします。
型: | SwitchParameter |
Aliases: | NoOverwrite |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Path
コンソール ファイル (*.psc1
) のパスとファイル名を指定します。 省略可能なパスと名前を入力します。
ワイルドカード文字は使用できません。
ファイル名のみを指定 Export-Console
場合、その名前と .psc1 ファイル名拡張子を持つファイルが現在のディレクトリに作成されます。
PSConsoleFile パラメーターを使用して Windows PowerShell を開いたり、現在のセッション中にコンソール ファイルをエクスポートしたりしていない限り、このパラメーターは必須です。 NoClobber パラメーターを使用して、現在のコンソール ファイルが上書きされないようにする場合にも必要です。
このパラメーターを省略すると、 Export-Console
は、このセッションで最近使用されたコンソール ファイルを上書きします。 最近使用したコンソール ファイルのパスは、$ConsoleFileName自動変数の値に格納されます。 詳細については、「about_Automatic_Variables」を参照してください。
型: | String |
Aliases: | PSPath |
配置: | 0 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
パス文字列をこのコマンドレットにパイプできます。
出力
このコマンドレットは、エクスポートされたエイリアスを含むファイルを作成します。
メモ
コンソール ファイル (
.psc1
) を使用してセッションを開始すると、コンソール ファイルの名前が自動的に$ConsoleFileName
自動変数に格納されます。Export-Console
の Path パラメーターを使用して新しいコンソール ファイルを指定すると、$ConsoleFileName
の値が更新されます。 コンソール ファイルが使用されていない場合、$ConsoleFileNameには値 ($null
) はありません。新しいセッションで Windows PowerShell コンソール ファイルを使用するには、次の構文を使用して Windows PowerShell を起動します。
powershell.exe -PsConsoleFile \<ConsoleFile\>.psc1
Windows PowerShell プロファイルに Add-PSSnapin コマンドを追加することで、今後のセッションで使用するために Windows PowerShell スナップインを保存することもできます。 詳細については、「about_Profiles」を参照してください。
関連リンク
PowerShell