登録済みのセッション構成をコンピューターから削除します。
構文
Unregister-PSSessionConfiguration [-Name] <string> [-Force] [-NoServiceRestart] [-確認] [-WhatIf] [<CommonParameters>]
説明
Unregister-PSSessionConfiguration コマンドレットは、登録済みのセッション構成をコンピューターから削除します。これは、システム管理者がユーザーの代わりにカスタマイズされたセッション構成を管理するために使用する高度なコマンドレットです。
誤って既定の Microsoft.PowerShell または Microsoft.PowerShell32 セッション構成を削除した場合は、Enable-PSRemoting コマンドレットを使用して、セッション構成を復元します。
パラメーター
-Force
ユーザー プロンプトをすべて非表示にし、プロンプトを表示することなく WinRM サービスを再起動します。サービスを再起動すると、構成の変更が有効になります。
再起動せず、再起動プロンプトが表示されないようにするには、NoServiceRestart パラメーターを使用します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-Name <string>
削除するセッション構成の名前を指定します。1 つ以上の構成名を入力します。ワイルドカードを使用できます。このパラメーターは必須です。
パイプを使用して Unregister-PSSessionConfiguration にセッション構成オブジェクトを渡すこともできます。
|
必須 |
true |
|
位置 |
1 |
|
既定値 |
|
|
パイプライン入力を許可する |
true (ByPropertyName) |
|
ワイルドカード文字を許可する |
false |
-NoServiceRestart
WinRM サービスを再起動せず、サービスの再起動を確認するメッセージを非表示にします。
既定では、Unregister-PSSessionConfiguration コマンドを入力すると、変更を適用するために WinRM サービスを再起動するよう求められます。セッション構成が Get-PSSessionConfiguration で見つからない場合でも、WinRM サービスを再起動せずに未登録のセッション構成を使用できます。
確認メッセージを表示しないで WinRM サービスを再起動するには、Force パラメーターを使用します。WinRM サービスを手動で再起動するには、Restart-Service コマンドレットを使用します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-確認
コマンドを実行する前に確認メッセージを表示します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
|
入力 |
Microsoft.PowerShell.Commands.PSSessionConfigurationCommands#PSSessionConfiguration パイプを使用して Get-PSSessionConfiguration から Unregister-PSSessionConfiguration にセッション構成オブジェクトを渡すことができます。 |
|
出力 |
None このコマンドレットはオブジェクトを返しません。 |
注
Windows Vista、Windows Server 2008、およびそれ以降のバージョンの Windows でこのコマンドレットを実行するには、Windows PowerShell を起動する際に [管理者として実行] を指定する必要があります。
例 1
C:\PS>unregister-pssessionconfiguration -name MaintenanceShell 説明 ----------- このコマンドは、MaintenanceShell セッション構成をコンピューターから削除します。
例 2
C:\PS>unregister-pssessionconfiguration -maintenanceShell -force 説明 ----------- このコマンドは、MaintenanceShell セッション構成をコンピューターから削除します。このコマンドは、Force パラメーターを使用して、ユーザー メッセージをすべて非表示にして WinRM サービスを再起動します。
例 3
C:\PS>unregister-pssessionconfiguration -name * C:\PS> get-pssessionconfiguration -name * | unregister-pssessionconfiguration 説明 ----------- これらのコマンドは、コンピューターのすべてのセッション構成を削除します。これらのコマンドの効果はすべて同じであり、置き換えて使用することもできます。
例 4
C:\PS>unregister-pssessionconfiguration -name maintenanceShell -noServiceRestart
C:\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
C:\PS> new-pssession -configurationName MaintenanceShell
Id Name ComputerName State Configuration Availability
-- ---- ------------ ----- ------------- ------------
1 Session1 localhost Opened MaintenanceShell Available
C:\PS> restart-service winrm
C:\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 (https://schemas.microsoft.com/powershell/MaintenanceShell) was not found in the WS-Management catalog. The catalog contains the metadata that describes resour
ces, or logical endpoints. For more information, see the about_Remote_Troubleshooting Help topic.
+ CategoryInfo : OpenError: (System.Manageme....RemoteRunspace:RemoteRunspace) [], PSRemotingTransportException
+ FullyQualifiedErrorId : PSSessionOpenFailed
説明
-----------
この例は、Unregister-PSSessionConfiguration の NoServiceRestart パラメーターを使用した結果を示しています。このパラメーターは、コンピューターのセッション中断を避けるためにサービスの再起動を防止することを目的としています。
最初のコマンドは Unregister-PSSessionConfiguration コマンドレットを使用して MaintenanceShell セッション構成を削除します。ただし、コマンドで NoServiceRestart パラメーターが使用されているので、WinRM サービスが再起動されておらず、変更は完全に有効にはなっていません。
2 番目のコマンドは、Get-PSSessionConfiguration コマンドレットを使用して、MaintenanceShell セッションを取得します。セッションは WS-Management リソース テーブルから削除されているので、Get-PSSession はセッションを返すことができません。
3 番目のコマンドは、New-PSSession コマンドレットを使用して、MaintenanceShell 構成を使用するローカル コンピューターでセッションを作成します。コマンドが成功します。
4 番目のコマンドは、Restart-Service コマンドレットを使用して WinRM サービスを再開します。
5 番目のコマンドは、New-PSSession コマンドレットを再度使用して、MaintenanceShell 構成を使用するセッションを作成します。MaintenanceShell 構成がコンピューターから削除されているので、このセッションは失敗します。
関連項目