Unregister-PSSessionConfiguration

Unregister-PSSessionConfiguration
    [-Name] <String>
    [-Force]
    [-NoServiceRestart]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

このコマンドレットは、Windows プラットフォームでのみ使用できます。

Unregister-PSSessionConfiguration コマンドレットは、登録済みのセッション構成をコンピューターから削除します。 このコマンドレットは、システム管理者がユーザーのカスタマイズされたセッション構成を管理できるように設計されています。

変更を有効にするには、WinRM サービス Unregister-PSSessionConfiguration 再起動します。 再起動を回避するには、NoServiceRestart パラメーターを指定します。

既定の Microsoft.PowerShell または Microsoft.PowerShell32 セッション構成を誤って削除した場合は、Enable-PSRemoting コマンドレットを使用して復元します。 詳細については、about_Session_Configurationsを参照してください。

次の使用例は、コンピューターから MaintenanceShell セッション構成を削除します。

Unregister-PSSessionConfiguration -Name "MaintenanceShell"

この例では、MaintenanceShell 構成を削除し、WinRM サービスを再起動します。 Force パラメーターは、プロンプトを表示せずに WinRM サービスを再起動するすべてのユーザー メッセージを抑制します。

Unregister-PSSessionConfiguration -Name MaintenanceShell -Force

この例では、コンピューター上のすべてのセッション構成を削除する 2 つの方法を示します。 どちらのコマンドも同じ効果を持ち、同じ意味で使用できます。

Unregister-PSSessionConfiguration -Name *
Get-PSSessionConfiguration -Name * | Unregister-PSSessionConfiguration

この例では、NoServiceRestart パラメーターを使用して、コンピューター上のセッションを中断するサービスの再起動を防ぐ効果を示します。

PS> Unregister-PSSessionConfiguration -Name "MaintenanceShell" -NoServiceRestart
PS> Get-PSSessionConfiguration -Name "MaintenanceShell"

Get-PSSessionConfiguration -Name MaintenanceShell : No Session Configuration matches criteria "MaintenanceShell".
+ CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
+ FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException

PS> New-PSSession -ConfigurationName "MaintenanceShell"

Id Name      ComputerName    State    Configuration         Availability
-- ----      ------------    -----    -------------         ------------
1 Session1  localhost       Opened   MaintenanceShell      Available

PS> Restart-Service winrm
PS> New-PSSession -ConfigurationName MaintenanceShell

[localhost] Connecting to remote server failed with the following error message :
 The WS-Management service cannot process the request.
 The resource URI (http://schemas.microsoft.com/powershell/MaintenanceShell) was not found in the WS-Management catalog.
 The catalog contains the metadata that describes resources, or logical endpoints.
 For more information, see the about_Remote_Troubleshooting Help topic.
 + CategoryInfo          : OpenError: (System.Manageme....RemoteRunspace:RemoteRunspace) [], PSRemotingTransportException
 + FullyQualifiedErrorId : PSSessionOpenFailed

Unregister-PSSessionConfiguration は、MaintenanceShell セッション構成を削除します。 ただし、コマンドは NoServiceRestart パラメーターを使用するため、WinRM サービスは再起動されず、変更はまだ完全には有効ではありません。

次に、Get-PSSessionConfiguration は MaintenanceShell セッションの取得を試みます。 セッションは WS-Management リソース テーブルから削除されているため、Get-PSSessionConfiguration は返すことができません。

New-PSSession コマンドレットは、MaintenanceShell 構成を使用してセッションを作成します。 コマンドは成功します。 次に、WinRM サービスを再起動します。

最後に、New-PSSession コマンドレットは、MaintenanceShell 構成を使用するセッションの作成を試みます。 今回は、WinRM サービスの再起動時に MaintenanceShell 構成が削除されたため、セッションは失敗します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

セッション構成オブジェクトをこのコマンドレットにパイプできます。

このコマンドレットは出力を返しません。

このコマンドレットは、Windows プラットフォームでのみ使用できます。

このコマンドレットを実行するには、[管理者として実行] オプションを使用して PowerShell を起動する必要があります。