PowerShell Cmdlet - Export-Console
 記事記号:[mf1944] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Export-Console
    
概要
    現在のセッションのスナップインの名前をコンソール ファイルにエクスポートしま
    す。
    
構文
    Export-Console [[-Path] <string>] [-Force] [-NoClobber] [-Confirm] [-WhatIf] 
    [<CommonParameters>]
    
    
説明
    Export-Console コマンドレットは、現在のセッションの Windows PowerShell のス
    ナップインの名前を Windows PowerShell コンソール ファイル (.psc1) にエクスポ
    ートします。このコマンドレットを使用して、将来のセッションで使用するためにス
    ナップインを保存できます。
    
    .psc1 コンソール ファイル内のスナップインをセッションに追加するには、Cmd.exe 
    や別の Windows PowerShell セッションを使用して、コマンド ラインで Windows Po
    werShell (Powershell.exe) を開始します。その後、Powershell.exe の PSConsoleF
    ile パラメーターを使用してコンソール ファイルを指定します。
    
    Windows PowerShell スナップインの詳細については、「about_PSSnapins」を参照し
    てください。
    
パラメーター
    -Force [<SwitchParameter>]
        ファイルに読み取り専用属性が設定されている場合でも、コンソール ファイル
        のデータを警告なしに上書きします。読み取り専用属性は変更され、コマンドの
        完了時に読み取り専用に再設定されることはありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -NoClobber [<SwitchParameter>]
        既存のコンソール ファイルを上書きしません (内容を置き換えません)。既定で
        は、指定したパスにファイルが存在する場合、Export-Console は警告なしにフ
        ァイルを上書きします。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Path <string>
        コンソール ファイル (*.psc1) のパスとファイル名を指定します。パス (オプ
        ション) および名前を入力します。ワイルドカードは使用できません。
        
        ファイル名のみを入力した場合、Export-Console によってその名前と .psc1 フ
        ァイル名拡張子を持つファイルが現在のディレクトリに作成されます。
        
        PSConsoleFile パラメーターを使用して Windows PowerShell を開いていない場
        合、または現在のセッション中にコンソール ファイルをエクスポートしていな
        い場合、このパラメーターは必須です。NoClobber パラメーターを使用して現在
        のコンソールの上書きを禁止している場合も、このパラメーターは必須です。
        
        このパラメーターを省略した場合、このセッションで最後に使用されたコンソー
        ル ファイルが Export-Console によって上書きされます (内容が置き換えられ
        ます)。最後に使用されたコンソール ファイルへのパスは、$ConsoleFileName 
        自動変数の値に保存されます。詳細については、「about_Automatic_Variables」
        を参照してください。
        
        必須                         false
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByValue, ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Confirm [<SwitchParameter>]
        コマンドを実行する前に確認メッセージを表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -WhatIf [<SwitchParameter>]
        実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.String
        パイプを使用してパス文字列を Export-Console に渡すことができます。
    
出力
    System.IO.FileInfo
        Export-Console は、エクスポートされたエイリアスを保存するためのファイル
        を作成します。
    
メモ
        コンソール ファイル (.psc1) を使用してセッションを開始する場合、コンソー
        ル ファイルの名前は $ConsoleFileName 自動変数に自動的に保存されます。$Co
        nsoleFileName の値は、Export-Console の Path パラメーターを使用して新し
        いコンソール ファイルを指定すると更新されます。コンソール ファイルを使用
        しない場合、$ConsoleFileName の値は指定されません ($null に設定されます)。
        
        Windows PowerShell コンソール ファイルを新しいセッションで使用するには、
        次の構文を使用して Windows PowerShell を起動します。"powershell.exe -PsC
        onsoleFile <ConsoleFile>.psc1"
        
        Windows PowerShell プロファイルに Add-PSSnapin コマンドを追加することに
        よって、将来のセッションのために Windows PowerShell スナップインを保存す
        ることもできます。詳細については、「about_Profiles」を参照してください。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>export-console -path $pshome\Consoles\ConsoleS1.psc1
    
    説明
    -----------
    このコマンドは、Windows PowerShell インストール ディレクトリ $pshome の Cons
    oles サブディレクトリにある ConsoleS1.psc1 ファイルに、現在のセッションの Wi
    ndows PowerShell スナップインの名前をエクスポートします。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>export-console
    
    説明
    -----------
    このコマンドは、現在のセッションで最後に使用された Windows PowerShell コンソ
    ール ファイルに、現在のセッションから Windows PowerShell スナップインの名前
    をエクスポートします。既存のファイルの内容は上書きされます。
    
    現在のセッション中にまだコンソール ファイルをエクスポートしていない場合は、
    続行する許可を求めるメッセージが表示され、ファイル名を入力するよう要求されま
    す。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>add-pssnapin NewPSSnapin
    
    C:\PS> export-console -path NewPSSnapinConsole.psc1
    
    C:\PS> powershell.exe -PsConsoleFile NewPsSnapinConsole.psc1
    
    説明
    -----------
    これらのコマンドは、NewPSSnapin Windows PowerShell スナップインを現在のセッ
    ションに追加して、現在のセッションの Windows PowerShell スナップインの名前を
    コンソール ファイルにエクスポートした後、そのコンソール ファイルで Windows P
    owerShell セッションを開始します。
    
    最初のコマンドは、Add-PSSnapin コマンドレットを使用して、NewPSSnapin スナッ
    プインを現在のセッションに追加します。追加できる Windows PowerShell スナップ
    インは、システムに登録されているものに限られます。
    
    2 番目のコマンドは、Windows PowerShell スナップインの名前を NewPSSnapinConso
    le.psc1 ファイルにエクスポートします。
    
    3 番目のコマンドは、NewPSSnapinConsole.psc1 ファイルを使用して Windows Power
    Shell を起動します。コンソール ファイルには Windows PowerShell スナップイン
    の名前が含まれているため、スナップインのコマンドレットおよびプロバイダーが現
    在のセッションで利用可能です。
    
    -------------------------- 例 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>
    
    説明
    -----------
    このコマンドは、現在のディレクトリにある Console01.psc1 ファイルに現在のセッ
    ションの Windows PowerShell スナップインの名前をエクスポートします。
    
    2 番目のコマンドは、メモ帳で Console01.psc1 ファイルの内容を表示します。
    
    -------------------------- 例 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
    
    説明
    -----------
    この例は、Path パラメーターの値を使用せずに Export-Console を使用すると更新
    されるコンソール ファイルを、$ConsoleFileName 自動変数を使用して決定する方法
    を示しています。
    
    最初のコマンドは、PowerShell.exe の PSConsoleFile パラメーターを使用して、Co
    nsole01.psc1 ファイルで Windows PowerShell を開きます。
    
    2 番目のコマンドは、Add-PSSnapin コマンドレットを使用して、MySnapin Windows 
    PowerShell スナップインを現在のセッションに追加します。
    
    3 番目のコマンドは、Export-Console コマンドレットを使用して、セッション内の
    すべての Windows PowerShell スナップインを NewConsole.psc1 ファイルにエクス
    ポートします。
    
    4 番目のコマンドは、$ConsoleFileName パラメーターを使用して最後に使用された
    コンソール ファイルの名前を表示します。サンプル出力は、最後に使用されたファ
    イルが NewConsole.ps1 であることを示しています。
    
    5 番目のコマンドは、SnapIn03 を現在のコンソールに追加します。
    
    6 番目のコマンドは、Path パラメーターを使用せずに ExportConsole コマンドレッ
    トを使用しています。このコマンドは、最後に使用されたファイルである NewConsol
    e.psc1 に、現在のセッションのすべての Windows PowerShell スナップインの名前
    をエクスポートします。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113298
    Add-PSSnapin 
    Get-PSSnapin 
    Remove-PSSnapin 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Export-Console
ご利用数: 1912643
感想・要望・問い合わせは こちら