Get-PSSessionConfiguration
コンピューターに登録されているセッション構成を取得します。
構文
Get-PSSessionConfiguration
[[-Name] <String[]>]
[-Force]
[<CommonParameters>]
説明
Get-PSSessionConfiguration
コマンドレットは、ローカル コンピューターに登録されているセッション構成を取得します。 これは、ユーザーのカスタマイズされたセッション構成を管理するためにシステム管理者が使用するように設計された高度なコマンドレットです。
PowerShell 3.0 以降では、セッション構成 (.pssc) ファイルを使用してセッション構成のプロパティを定義できます。 この機能を使用すると、コンピューター プログラムを記述せずに、カスタマイズされた制限付きセッションを作成できます。 セッション構成ファイルの詳細については、about_Session_Configuration_Filesを参照してください。
また、PowerShell 3.0 以降では、Get-PSSessionConfiguration
返されるセッション構成オブジェクトに新しいノート プロパティが追加されました。 これらのプロパティを使用すると、ユーザーとセッション構成の作成者は、セッション構成を簡単に調べて比較できます。
セッション構成を作成して登録するには、Register-PSSessionConfiguration
コマンドレットを使用します。
セッション構成の詳細については、「about_Session_Configurations」を参照してください。
例
例 1 - ローカル コンピューターでセッション構成を取得する
Get-PSSessionConfiguration
例 2 - 2 つの既定のセッション構成を取得する
このコマンドでは、Get-PSSessionConfiguration
の Name パラメーターを使用して、"Microsoft" で始まる名前を持つセッション構成のみを取得します。
Get-PSSessionConfiguration -Name Microsoft*
Name PSVersion StartupScript Permission
---- --------- ------------- ----------
microsoft.powershell 5.1 BUILTIN\Administrators AccessAll...
microsoft.powershell32 5.1 BUILTIN\Administrators AccessAll...
例 3 - セッション構成のプロパティと値を取得する
この例では、セッション構成ファイルを使用して作成されたセッション構成のプロパティとプロパティ値を示します。
Get-PSSessionConfiguration -Name Full | Format-List -Property *
Copyright : (c) 2011 User01. All rights reserved.
AliasDefinitions : {System.Collections.Hashtable}
SessionType : Default
CompanyName : Unknown
GUID : 1e9cb265-dae0-4bd3-89a9-8338a47698a1
Author : User01
ExecutionPolicy : Restricted
SchemaVersion : 1.0.0.0
LanguageMode : FullLanguage
Architecture : 64
Filename : %windir%\system32\pwrshplugin.dll
ResourceUri : http://schemas.microsoft.com/powershell/Full
MaxConcurrentCommandsPerShell : 1500
UseSharedProcess : false
ProcessIdleTimeoutSec : 0
xmlns : http://schemas.microsoft.com/wbem/wsman/1/config/PluginConfiguration
MaxConcurrentUsers : 10
lang : en-US
SupportsOptions : true
ExactMatch : true
configfilepath : C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\Full_1e9cb265-dae0-4bd3-89a9-8338a47698a1.pssc
RunAsUser :
IdleTimeoutms : 7200000
PSVersion : 3.0
OutputBufferingMode : Block
AutoRestart : false
MaxShells : 300
MaxMemoryPerShellMB : 1024
MaxIdleTimeoutms : 43200000
SDKVersion : 1
Name : Full
XmlRenderingType : text
Capability : {Shell}
RunAsPassword :
MaxProcessesPerShell : 25
Enabled : True
MaxShellsPerUser : 30
Permission :
この例では、Get-PSSessionConfiguration
コマンドレットを使用して、完全なセッション構成を取得します。 パイプライン オペレーターは、完全なセッション構成を Format-List
コマンドレットに送信します。
*
(すべて) の値を持つ Property パラメーターは、リスト内のオブジェクトのすべてのプロパティと値を表示するように Format-List
を指示します。
出力には、セッション構成の作成者、セッションの種類、言語モード、このセッション構成で作成されたセッションの実行ポリシー、セッション クォータ、セッション構成ファイルへの完全なパスなど、有用な情報が含まれます。
セッション構成のこのビューは、セッション構成ファイルを含むセッションに使用されます。 セッション構成ファイルの詳細については、about_Session_Configuration_Filesを参照してください。
例 4 - セッション構成を確認する別の方法
この例では、WSMan: プロバイダー ドライブの Get-ChildItem
コマンドレット (エイリアス dir
) を使用して、Plugin ノードの内容を確認します。 これは、コンピューター上のセッション構成を確認するもう 1 つの方法です。
dir wsman:\localhost\plugin
Type Keys Name
---- ---- ----
Container {Name=Event Forwarding Plugin} Event Forwarding Plugin
Container {Name=Full} Full
Container {Name=microsoft.powershell} microsoft.powershell
Container {Name=microsoft.powershell.workf... microsoft.powershell.workflow
Container {Name=microsoft.powershell32} microsoft.powershell32
Container {Name=microsoft.ServerManager} microsoft.ServerManager
Container {Name=WMI Provider} WMI Provider
PlugIn ノードには、登録されている PowerShell セッション構成を表す ContainerElement オブジェクト (Microsoft.WSMan.Management.WSManConfigContainerElement) と WS-Management 用の他のプラグイン が含まれています。
例 6 - リモート コンピューターでのセッション構成の表示
この例では、WSMan プロバイダーを使用してリモート コンピューター上のセッション構成を表示する方法を示します。 このメソッドは、Get-PSSessionConfiguration
コマンドほど多くの情報を提供しませんが、ユーザーがこのコマンドレットを実行するために Administrators グループのメンバーである必要はありません。
Connect-WSMan -ComputerName Server01
dir WSMan:\Server01\Plugin
WSManConfig: Microsoft.WSMan.Management\WSMan::localhost\Plugin
Type Keys Name
---- ---- ----
Container {Name=Empty} Empty
Container {Name=Event Forwarding Plugin} Event Forwarding Plugin
Container {Name=Full} Full
Container {Name=microsoft.powershell} microsoft.powershell
Container {Name=microsoft.powershell.workf... microsoft.powershell.workflow
Container {Name=microsoft.powershell32} microsoft.powershell32
Container {Name=microsoft.ServerManager} microsoft.ServerManager
Container {Name=NoLanguage} NoLanguage
Container {Name=RestrictedLang} RestrictedLang
Container {Name=RRS} RRS
Container {Name=SEL Plugin} SEL Plugin
Container {Name=WithProfile} WithProfile
Container {Name=WMI Provider} WMI Provider
Connect-WSMan
コマンドレットは、Server01 リモート コンピューター上の WinRM サービスに接続します。 WSMan: ドライブの Get-ChildItem
コマンドレット (エイリアス dir
) は、Server01\Plugin パス内の項目を取得します。 出力には、Server01 コンピューターの Plugin ディレクトリ内の項目が表示されます。 これらの項目には、WSMan プラグインの一種であるセッション構成と、コンピューター上の他の種類のプラグインが含まれます。
例 7 - リモート コンピューターから詳細なセッション構成を取得する
この例では、リモート コンピューターで Get-PSSessionConfiguration
コマンドを実行する方法を示します。 このコマンドを実行するには、ローカル コンピューターのクライアント設定とリモート コンピューターのサービス設定で CredSSP 委任を有効にする必要があります。
この例のコマンドを実行するには、ローカル コンピューターとリモート コンピューターの Administrators グループのメンバーである必要があります。また、[管理者として実行] オプションを使用して PowerShell を起動する必要があります。
Enable-WSManCredSSP -Delegate Server02
Connect-WSMan Server02
Set-Item WSMan:\Server02*\Service\Auth\CredSSP -Value $true
Invoke-Command -ScriptBlock {Get-PSSessionConfiguration} -ComputerName Server02 -Authentication CredSSP -Credential Domain01\Admin01
Name PSVersion StartupScript Permission PSComputerName
---- --------- ------------- ---------- --------------
microsoft.powershell 5.1 BUILTIN\Administrators AccessAll... server02.corp.fabrikam.com
microsoft.powershell32 5.1 BUILTIN\Administrators AccessAll... server02.corp.fabrikam.com
MyX86Shell 5.1 c:\test\x86Shell.ps1 BUILTIN\Administrators AccessAll... server02.corp.fabrikam.com
Enable-WSManCredSSP
コマンドレットを使用すると、ローカル コンピューターの Server01 CredSSP 委任が有効になります。
Connect-WSMan
コマンドレットは Server02 コンピューターに接続します。 この操作により、ローカル コンピューター上の WSMan: ドライブに Server02 のノードが追加され、Server02 コンピューターの WS-Management 設定を表示および変更できます。
Set-Item
コマンドレットは、Server02 コンピューターの [サービス] ノードの CredSSP 項目の値を True に変更します。 これにより、リモート コンピューターのサービス設定が構成されます。
Invoke-Command
コマンドレットは、Server02 コンピューターでGet-PSSessionConfiguration
コマンドを実行します。 このコマンドは、Credential パラメーターを使用し、CredSSP の値を持つ Authentication パラメーター使用します。 出力には、Server02 リモート コンピューター上のセッション構成が表示されます。
例 8 - セッション構成のリソース URI を取得する
この例は、リソース URI を受け取る $PSSessionConfigurationName
基本設定変数の値を設定する場合に便利です。
(Get-PSSessionConfiguration -Name CustomShell).resourceURI
http://schemas.microsoft.com/powershell/microsoft.CustomShell
$PSSessionConfigurationName
変数は、セッションの作成時に使用される既定の構成を指定します。 この変数はローカル コンピューターに設定されますが、リモート コンピューター上の構成を指定します。
$PSSessionConfiguration
変数の詳細については、about_Preference_Variablesを参照してください。
パラメーター
-Force
サービスがまだ実行されていない場合は、WinRM サービスを再起動するように求めるメッセージを表示しません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
指定した名前または名前パターンを持つセッション構成のみを取得します。 1 つ以上のセッション構成名を入力します。 ワイルドカードを使用できます。
型: | String[] |
配置: | 0 |
規定値: | All session configurations on the local computer |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
入力
None
このコマンドレットにオブジェクトをパイプすることはできません。
出力
Microsoft.PowerShell.Commands.PSSessionConfigurationCommands
メモ
このコマンドレットを実行するには、[管理者として実行] オプションを使用して PowerShell を起動します。
コンピューター上のセッション構成を表示するには、コンピューターの Administrators グループのメンバーである必要があります。
リモート コンピューターで
Get-PSSessionConfiguration
コマンドを実行するには、ローカル コンピューターのクライアント設定 (Enable-WSManCredSSP
コマンドレットを使用) とリモート コンピューターのサービス設定で、資格情報セキュリティ サービス プロバイダー (CredSSP) 認証を有効にする必要があります。 また、リモート セッションを確立するときに、Authentication パラメーターの CredSSP 値を使用する必要があります。 それ以外の場合、アクセスは拒否されます。Get-PSSessionConfiguration
返されるオブジェクトのメモ プロパティは、値がある場合にのみオブジェクトに表示されます。 セッション構成ファイルを使用して作成されたセッション構成にのみ、定義されたすべてのプロパティがあります。セッション構成オブジェクトのプロパティは、セッション構成に設定されたオプションとそれらのオプションの値によって異なります。 また、セッション構成ファイルを使用するセッション構成には、追加のプロパティがあります。
WSMan: ドライブのコマンドを使用して、セッション構成のプロパティを変更できます。 ただし、PowerShell 2.0 の WSMan: ドライブを使用して、OutputBufferingModeなど、PowerShell 3.0 で導入されたセッション構成プロパティを変更することはできません。 PowerShell 2.0 コマンドはエラーを生成しませんが、効果がありません。 PowerShell 3.0 で導入されたプロパティを変更するには、PowerShell 3.0 の WSMan: ドライブを使用します。
関連リンク
- Disable-PSSessionConfiguration
- Enable-PSSessionConfiguration
- Get-PSSessionConfiguration
- New-PSSessionConfigurationFile
- New-PSSessionOption
- Register-PSSessionConfiguration
- Set-PSSessionConfiguration
- Test-PSSessionConfigurationFile
- Unregister-PSSessionConfiguration
- WSMan プロバイダー
- about_Session_Configurations
- about_Session_Configuration_Files
PowerShell