Register-PSSessionConfiguration

Register-PSSessionConfiguration [-AssemblyName] <string> [-ConfigurationTypeName] <string> [-ApplicationBase <string>] [-Name] <string> [-Force] [-MaximumReceivedDataSizePerCommandMB <double>] [-MaximumReceivedObjectSizeMB <double>] [-NoServiceRestart] [-ProcessorArchitecture <string>] [-SecurityDescriptorSDDL <string>] [-ShowSecurityDescriptorUI] [-StartupScript <string>] [-ThreadApartmentState {<STA> | <MTA> | <Unknown>}] [-ThreadOptions {<Default> | <UseNewThread> | <ReuseThread> | <UseCurrentThread>}] [-確認] [-WhatIf] [<CommonParameters>]

C:\PS>register-pssessionConfiguration -name NewShell -applicationBase c:\MyShells\ -assemblyName MyShell.dll -configurationTypeName MyClass

説明
-----------
このコマンドは、NewShell セッション構成を登録します。このコマンドは、ApplicationName および ApplicationBase パラメーターを使用して、セッション構成のコマンドレッドおよびプロバイダーを指定する MyShell.dll ファイルの場所を指定します。また、セッションの詳細を構成する新しいクラスを指定する ConfigurationTypeName パラメーターも使用します。

この構成を使用するには、「new-pssession -configurationname newshell」と入力します。

C:\PS>register-pssessionConfiguration -name MaintenanceShell -startupScript c:\ps-test\Maintenance.ps1

説明
-----------
このコマンドは、MaintenanceShell 構成をローカル コンピューターに登録します。このコマンドは、StartupScript パラメーターを使用して Maintenance.ps1 スクリプトを指定します。

ユーザーが New-PSSession コマンドを使用して MaintenanceShell 構成を選択すると、新しいセッションで Maintenance.ps1 スクリプトが実行されます。スクリプトでは、モジュールのインポート、Windows PowerShell スナップインの追加、およびセッションの実行ポリシーの設定を始めとするセッション構成を行うことができます。スクリプトでエラー (未終了エラーを含む) が発生した場合、New-PSSession コマンドは失敗します。

C:\PS>$sddl = "O:NSG:BAD:P(A;;GA;;;BA)S:P(AU;FA;GA;;;WD)(AU;FA;SA;GWGX;;WD)"

C:\PS> register-pssessionconfiguration -name AdminShell -securityDescriptorSDDL $sddl -maximumReceivedObjectSizeMB 20 -startupScript c:\scripts\AdminShell.ps1

説明
-----------
この例は、AdminShell セッション構成を登録します。

最初のコマンドは、カスタム SDDL を $sddl 変数に保存します。

2 番目のコマンドは、新しいシェルを登録します。コマンドは、SecurityDescritorSDDL パラメーターを使用して $sddl 変数の値の SDDL を指定し、MaximumReceivedObjectSizeMB パラメーターを使用して オブジェクトのサイズ制限を増加します。また、セッションを構成するスクリプトを指定する StartupScript パラメーターも使用します。

SecurityDescriptorSDDL パラメーターを使用する代わりに、ShowSecurityDescriptorUI パラメーターを使用することができます。このパラメーターにより、セッション構成のアクセス許可を設定するために使用できるプロパティ シートが表示されます。プロパティ シートで [OK] をクリックすると、セッション構成の SDDL が生成されます。

C:\PS>$s = register-pssessionConfiguration -name MaintenanceShell -startupScript c:\ps-test\Maintenance.ps1

C:\PS> $s

   WSManConfig: Microsoft.WSMan.Management\WSMan::localhost\Plugin

Name                      Type                 Keys
----                      ----                 ----
MaintenanceShell          Container            {Name=MaintenanceShell}


C:\PS> $s.getType().fullname
TypeName: Microsoft.WSMan.Management.WSManConfigContainerElement


C:\PS> $s | format-list -property *

PSPath            : Microsoft.WSMan.Management\WSMan::localhost\Plugin\MaintenanceShell
PSParentPath      : Microsoft.WSMan.Management\WSMan::localhost\Plugin
PSChildName       : MaintenanceShell
PSDrive           : WSMan
PSProvider        : Microsoft.WSMan.Management\WSMan
PSIsContainer     : True
Keys              : {Name=MaintenanceShell}
Name              : MaintenanceShell
TypeNameOfElement : Container


C:\PS> dir wsman:\localhost\plugin

Name                      Type                 Keys
----                      ----                 ----
MaintenanceShell          Container            {Name=MaintenanceShell}
microsoft.powershell      Container            {Name=microsoft.powershell}
microsoft.powershell32    Container            {Name=microsoft.powershell32}

説明
-----------
この例は、Register-PSSessionConfiguration コマンドが WSManConfigContainerElement を返すことを示します。また、WSMan: ドライブでコンテナー要素を見つける方法も示します。

最初のコマンドは Register-PSSessionConfiguration コマンドレットを使用して MaintenanceShell 構成を登録します。このコマンドは、コマンドレットが返すオブジェクトを $s 変数に保存します。

2 番目のコマンドは、$s 変数の内容を表示します。

3 番目のコマンドは、GetType メソッドおよびその FullName プロパティを使用して、Register-PSSessionConfiguration が返すオブジェクトの型名を表示します。

4 番目のコマンドは、Format-List コマンドレットを使用して、Register-PSSessionConfiguration が返すオブジェクトのすべてのプロパティを一覧表示します。PSPath プロパティは、オブジェクトが WSMan: ドライブのディレクトリに保存されていることを示します。

5 番目のコマンドは、Get-ChildItem コマンドレットを使用して、WSMan:\LocalHost\PlugIn パスにある項目を表示します。これらの項目には、新しい MaintenanceShell 構成および Windows PowerShell に含まれる 2 つの既定の構成が含まれます。

C:\PS>register-pssessionconfiguration -name WithProfile -startupScript add-profile.ps1

# Add-Profile.ps1

. c:\users\admin01\documents\windowspowershell\profile.ps1

説明
-----------
このコマンドは、WithProfile セッション構成を作成してローカル コンピューターに登録します。このコマンドは、StartupScript パラメーターを使用することにより、セッション構成が使用されるすべてのセッションで、指定したスクリプトを実行するよう Windows PowerShell に指示します。

指定したスクリプトの内容である Add-Profile.ps1 も表示されます。スクリプトには、セッションの現在のスコープでユーザーの CurrentUserAllHosts プロファイルを実行するドット ソースを使用する単一のコマンドが含まれます。

プロファイルの詳細については、「about_Profiles」を参照してください。ドット ソースの詳細については、「about_Scopes」を参照してください。