Import-PSSession

Import-PSSession [-Session] <PSSession> [[-CommandName] <string[]>] [[-FormatTypeName] <string[]>] [-AllowClobber] [-ArgumentList <Object[]>] [-CommandType {<Alias> | <Function> | <Filter> | <Cmdlet> | <ExternalScript> | <Application> | <Script> | <All>}] [-Module <string[]>] [-Prefix <string>] [<CommonParameters>]

C:\PS>$s = new-pssession -computername Server01

C:\PS> import-pssession -session $s

説明
-----------
このコマンドは、現在のセッション内のコマンドと同じ名前のコマンドを除くすべてのコマンドを Server01 コンピューターの PSSession から現在のセッションにインポートします。

このコマンドは CommandName パラメーターを使用しないため、インポートされるコマンドに必要なすべての書式設定データもインポートします。

C:\PS>$s = new-pssession https://ps.testlabs.com/powershell

C:\PS> import-pssession -session $s -commandname *-test -formatTypeName *

C:\PS> new-test -name test1

C:\PS> get-test test1 | run-test

説明
-----------
これらのコマンドは、PSSession からローカル セッションに "-test" で終わる名前のコマンドをインポートし、インポートされたコマンドレットの使用方法を示します。

最初のコマンドは New-PSSession コマンドレットを使用して PSSession を作成します。PSSession は $s 変数に保存されます。

2 番目のコマンドは、Import-PSSession コマンドレットを使用して、$s の PSSession から現在のセッションにコマンドをインポートします。また、CommandName パラメーターを使用して Test という名詞を含むコマンドを指定し、FormatTypeName パラメーターを使用して Test コマンドの書式設定データをインポートします。

3 番目と 4 番目のコマンドは、現在のセッションにインポートされたコマンドを使用します。インポートされたコマンドは実際には現在のセッションに追加されているため、ローカル構文を使用してこれらのコマンドを実行します。インポートされたコマンドを実行するために Invoke-Command コマンドレットを使用する必要はありません。

C:\PS>$s1 = new-pssession -computername s1 

C:\PS> $s2 = new-pssession -computername s2

C:\PS> import-pssession -session s1 -type cmdlet -name New-Test, Get-Test -FormatTypeName *

C:\PS> import-pssession -session s2 -type cmdlet -name Set-Test -FormatTypeName *

C:\PS> new-test Test1 | set-test -runtype full

説明
-----------
この例は、インポートされたコマンドレットをローカル コマンドレットと同様に使用できることを示しています。

これらのコマンドは、Server01 コンピューターの PSSession から New-Test コマンドレットと Get-Test コマンドレットをインポートし、Server02 コンピューターの PSSession から Set-Test コマンドレットをインポートします。

コマンドレットは異なる PSSession からインポートされていますが、エラーを発生することなく別のコマンドレットに対してオブジェクトをパイプ処理できます。

C:\PS>$s = new-pssession -computername Server01

C:\PS> import-pssession -session $s -commandname *-test* -formattypename *

C:\PS> $batch = new-test -name Batch -asjob

C:\PS> receive-job $batch

説明
-----------
この例は、インポートされたコマンドをバックグラウンド ジョブとして実行する方法を示しています。

インポートされたコマンドはローカル コマンドよりも実行に時間がかかる場合があるため、Import-PSSession は AsJob パラメーターをインポートされたすべてのコマンドに追加します。AsJob パラメーターを使用して、コマンドをバックグラウンド ジョブとして実行できます。

最初のコマンドは、Server01 コンピューターで PSSession を作成し、PSSession オブジェクトを $s 変数に保存します。

2 番目のコマンドは、Import-PSSession を使用して $s の PSSession から現在のセッションに Test コマンドレットをインポートします。

3 番目のコマンドは、インポートされた New-Test コマンドレットの AsJob パラメーターを使用して、New-Test コマンドをバックグラウンド ジョブとして実行します。このコマンドは、New-Test によって返されるジョブ オブジェクトを $batch 変数に保存します。

4 番目のコマンドは、Receive-Job コマンドレットを使用して、$batch 変数に保存されたジョブの結果を取得します。

C:\PS>$s = new-pssession -comp Server01

C:\PS> invoke-command -session $s {import-module TestManagement}

C:\PS> import-pssession -session $s -module TestManagement

説明
-----------
この例は、リモート コンピューターの Windows PowerShell モジュールから現在のセッションにコマンドレットと関数をインポートする方法を示しています。

最初のコマンドは、Server01 コンピューターで PSSession を作成し、それを $s 変数に保存します。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、$s に保存された PSSession で Import-Module コマンドを実行します。

通常、モジュールは、Windows PowerShell プロファイルの Import-Module コマンドによってすべてのセッションに追加されますが、プロファイルは PSSessions で実行されません。

3 番目のコマンドは、Import-PSSession の Module パラメーターを使用して、モジュールのコマンドレットと関数を現在のセッションにインポートします。

C:\PS>import-pssession $s -CommandName Get-Date, SearchHelp  -formatTypeName * -AllowClobber


Name              : tmp_79468106-4e1d-4d90-af97-1154f9317239_tcw1zunz.ttf
Path              : C:\Users\User01\AppData\Local\Temp\tmp_79468106-4e1d-4d90-af97-1154f9317239_tcw1zunz.ttf\tmp_79468106-4e1d-4d90-af97-1154f9317239_
                    tcw1zunz.ttf.psm1
Description       : Implicit remoting for http://server01.corp.fabrikam.com/wsman
Guid              : 79468106-4e1d-4d90-af97-1154f9317239
Version           : 1.0
ModuleBase        : C:\Users\User01\AppData\Local\Temp\tmp_79468106-4e1d-4d90-af97-1154f9317239_tcw1zunz.ttf
ModuleType        : Script
PrivateData       : {ImplicitRemoting}
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {}
ExportedFunctions : {[Get-Date, Get-Date], [SearchHelp, SearchHelp]}
ExportedVariables : {}
NestedModules     : {}

説明
-----------
この例では、Import-PSSession を使用してディスク上の一時ファイルにモジュールを作成しています。また、すべてのコマンドを関数に変換してから、現在のセッションにインポートしています。

このコマンドは、Import-PSSession コマンドレットを使用して、Get-Date コマンドレットと SearchHelp 関数を現在のセッションにインポートします。

Import-PSSession コマンドレットは、一時モジュールを表す PSModuleInfo オブジェクトを返します。Path プロパティの値は、Import-PSSession によって一時的な場所にスクリプト モジュール (.psm1) ファイルが作成されたことを示しています。ExportedFunctions プロパティは、Get-Date コマンドレットと SearchHelp 関数がいずれも関数としてインポートされたことを示しています。

C:\PS>import-pssession $s -CommandName Get-Date -formatTypeName * -AllowClobber

C:\PS> get-command get-date

CommandType   Name       Definition
-----------   ----       ----------
Function      Get-Date   ...
Cmdlet        Get-Date   Get-Date [[-Date] <DateTime>] [-Year <Int32>] [-Month <Int32>]

C:\PS> Get-Date
09074   

C:\PS> (get-command -type cmdlet -name get-date).pssnapin.name
Microsoft.PowerShell.Utility

C:\PS> Microsoft.PowerShell.Utility\get-date

Sunday, March 15, 2009 2:08:26 PM

説明
-----------
この例は、インポートされたコマンドによって隠れた状態になっているコマンドの実行方法を示しています。

最初のコマンドは、$s 変数の PSSession から Get-Date コマンドレットをインポートします。現在のセッション内に Get-Date コマンドレットが存在するため、このコマンドには AllowClobber パラメーターが必須です。

2 番目のコマンドは、Get-Command コマンドレットを使用して、現在のセッションの Get-Date コマンドを取得します。出力には、セッションに元の Get-Date コマンドレットと Get-Date 関数が存在することが示されます。Get-Date 関数は、インポートされた Get-Date コマンドレットを $s の PSSession で実行します。

3 番目のコマンドは Get-Date コマンドを実行します。関数はコマンドレットよりも優先されるので、インポートされた Get-Date 関数が実行され、ユリウス歴の日付が返されます。

4 番目と 5 番目のコマンドは、インポートされたコマンドによって隠れた状態になっているコマンドを、修飾名を使用して実行する方法を示しています。

4 番目のコマンドは、元の Get-Date コマンドレットを現在のセッションに追加した Windows PowerShell スナップインの名前を取得します。

5 番目のコマンドは、スナップイン名で修飾した Get-Date コマンドレットの名前を使用して、Get-Date コマンドを実行します。

コマンドの優先順位と隠れているコマンドの詳細については、「about_Command_Precedence」を参照してください。

C:\PS>import-pssession -session $s -commandName *Item* -AllowClobber

説明
-----------
このコマンドは、名前に "Item" が含まれるコマンドを $s の PSSession からインポートします。コマンドには CommandName パラメーターが含まれていますが、FormatTypeData パラメーターは含まれていないため、コマンドだけがインポートされます。

現在のセッションにコマンドの書式設定データが既に存在しており、Import-PSSession を使用してリモート コンピューターでコマンドを実行する場合に、このコマンドを使用します。

C:\PS>$m = import-pssession -session $s -CommandName *bits* -formattypename *bits*

C:\PS> get-command -module $m

CommandType     Name
-----------     ----
Function        Add-BitsFile
Function        Complete-BitsTransfer
Function        Get-BitsTransfer
Function        Remove-BitsTransfer
Function        Resume-BitsTransfer
Function        Set-BitsTransfer
Function        Start-BitsTransfer
Function        Suspend-BitsTransfer

説明
-----------
このコマンドは、Import-PSSession コマンドによってセッションにインポートされたコマンドを、Get-Command の Module パラメーターを使用して見つける方法を示しています。

最初のコマンドは、Import-PSSession コマンドレットを使用して、名前に "bits" が含まれるコマンドを $s 変数の PSSession からインポートします。そして、Import-PSSession コマンドが返す一時モジュールを $m 変数に保存します。

2 番目のコマンドは、Get-Command コマンドレットを使用して、$m 変数に保存されたモジュールによってエクスポートされるコマンドを取得します。

Module パラメーターは、モジュール名用の文字列値を受け取ります。ただし、モジュール オブジェクトを渡した場合、Windows PowerShell はモジュール名を返す ToString メソッドをそのモジュール オブジェクトに対して適用します。

Get-Command コマンドは、"get-command $m.name" と同等です。