PowerShell Logo Small


This is the built-in help made by Microsoft for the command 'Get-PSSessionConfiguration', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.


Gets the registered session configurations on the computer.


Get-PSSessionConfiguration [[-Name] [<String[]>]] [-Force] [<CommonParameters>]

Search powershellhelp.space


The Get-PSSessionConfiguration cmdlet gets the session configurations that have been registered on the local computer. This is an advanced cmdlet that is designed to be used
by system administrators to manage customized session configurations for their users.

Beginning in Windows PowerShell 3.0, you can define the properties of a session configuration by using a session configuration (.pssc) file. This feature lets you create
customized and restricted sessions without writing a computer program. For more information about session configuration files, see about_Session_Configuration_Files

Also, beginning in Windows PowerShell 3.0, new note properties have been added to the session configuration object that Get-PSSessionConfiguration returns. These properties
make it easier for users and session configuration authors to examine and compare session configurations.

To create and register a session configuration, use the Register-PSSessionConfiguration cmdlet. For more information about session configurations, see
about_Session_Configurations (http://go.microsoft.com/fwlink/?LinkID=145152).



Online Version: http://go.microsoft.com/fwlink/p/?linkid=289589
WSMan Provider




-------------------------- EXAMPLE 1 --------------------------

PS C:\>Get-PSSessionConfiguration

This command gets the session configurations on the local computer.

-------------------------- EXAMPLE 2 --------------------------

PS C:\>Get-PSSessionConfiguration -Name Microsoft*

Name PSVersion StartupScript Permission
---- --------- ------------- ----------
microsoft.powershell 2.0 BUILTIN\Administrators AccessAll...
microsoft.powershell32 2.0 BUILTIN\Administrators AccessAll...

This command gets the two default session configurations that come with Windows PowerShell. The command uses the Name parameter of Get-PSSessionConfiguration to get only the
session configurations with names that begin with "Microsoft".

-------------------------- EXAMPLE 3 --------------------------

PS C:\>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 :
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 :

This example shows the properties and property values of a session configuration that was created by using a session configuration file.

The command uses the Get-PSSessionConfiguration command to get the Full session configuration. A pipeline operator sends the Full session configuration to the Format-List
cmdlet. The Property parameter with a value of * (all) directs Format-List to display all of the properties and property values of the object in a list.

The output of this command has very useful information, including the author of the session configuration, the session type, language mode, and execution policy of sessions
that are created with this session configuration, session quotas, and the full path to the session configuration file.

This view of a session configuration is used for sessions that include a session configuration file. For more information about session configuration files, see
about_Session_Configuration_Files (http://go.microsoft.com/fwlink/?LinkID=236023).

-------------------------- EXAMPLE 4 --------------------------

PS C:\>(Get-PSSessionConfiguration Microsoft.PowerShell.Workflow).PSObject.Properties | Select-Object Name,Value | Sort-Object Name

Name Value

---- -----

ActivityProcessIdleTimeoutSec 60

AllowedActivity {PSDefaultActivities}

Architecture 64

AssemblyName ...licKeyToken=31bf3856ad364e35, processorArchitecture=MSIL

AutoRestart false

Capability {Shell}

Enabled true

EnableValidation true

ExactMatch False

Filename %windir%\system32\pwrshplugin.dll

IdleTimeoutms 7200000

lang en-US

MaxActivityProcesses 5

MaxConcurrentCommandsPerShell 1000

MaxConcurrentUsers 5

MaxConnectedSessions 100

MaxDisconnectedSessions 1000

MaxIdleTimeoutms 2147483647

MaxMemoryPerShellMB 1024

MaxPersistenceStoreSizeGB 10

MaxProcessesPerShell 15

MaxRunningWorkflows 30

MaxSessionsPerRemoteNode 5

MaxSessionsPerWorkflow 5

MaxShells 25

MaxShellsPerUser 25

ModulesToImport %windir%\system32\windowspowershell\v1.0\Modules\PSWorkflow

Name microsoft.powershell.workflow

OutOfProcessActivity {InlineScript}

OutputBufferingMode Block

ParentResourceUri ...s.microsoft.com/powershell/microsoft.powershell.workflow

Permission ...ssAllowed, BUILTIN\Remote Management Users AccessAllowed

PersistencePath ...s\juneb\AppData\Local\Microsoft\Windows\PowerShell\WF\PS

PersistWithEncryption False

ProcessIdleTimeoutSec 28800

PSSessionConfigurationTypeName ...osoft.PowerShell.Workflow.PSWorkflowSessionConfiguration

PSVersion 3.0

RemoteNodeSessionIdleTimeoutSec 60

ResourceUri ...s.microsoft.com/powershell/microsoft.powershell.workflow



SDKVersion 2

SecurityDescriptorSddl ...;GA;;;BA)(A;;GA;;;RM)S:P(AU;FA;GA;;;WD)(AU;SA;GXGW;;;WD)

SessionConfigurationData ... </SessionConfigurationData>

SessionThrottleLimit 100

SupportsOptions true

Uri ...s.microsoft.com/powershell/microsoft.powershell.workflow

UseSharedProcess true

WorkflowShutdownTimeoutMSec 500

xmlns ...as.microsoft.com/wbem/wsman/1/config/PluginConfiguration

XmlRenderingType text

This command gets the properties of the Microsoft.PowerShell.Worfklow session configuration and sorts them into alphabetical order for easy reading. You can use this command
format in a function to get this display for any session configuration.

This example was contributed by Shay Levy, a Windows PowerShell MVP from Sderot, Israel.

-------------------------- EXAMPLE 5 --------------------------

PS C:\>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

This command uses the Get-ChildItem cmdlet (alias = dir) in the WSMan: provider drive to look at the content of the Plugin node. This is another way to look at the session
configurations on the computer.

The PlugIn node contains ContainerElement objects (Microsoft.WSMan.Management.WSManConfigContainerElement) that represent the registered Windows PowerShell session
configurations, along with other plug-ins for WS-Management.

-------------------------- EXAMPLE 6 --------------------------

The first command uses the Connect-WSMan cmdlet to connect to the WinRM service on the Server01 remote computer.
PS C:\>Connect-WSMan -ComputerName Server01

The second command uses the Get-ChildItem cmdlet ("dir") in the WSMan: drive to get the items in the Server01\Plugin path.The output shows the items in the Plugin directory
on the Server01 computer. The items include the session configurations, which are a type of WSMan plug-in, along with other types of plug-ins on the computer.
PS C:\>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

The third command returns the names of the plugins that are session configurations. The command searches for a value of Shell in the Capability property, which is in the
Plugin\Resources\<ResourceNumber> path in the WSMan: drive.
PS C:\>dir WSMan:\Server01\Plugin\*\Resources\Resource*\Capability | where {$_.Value -eq "Shell"} | foreach {($_.PSPath.split("\"))[3] }

This example shows how to use the WSMan provider to view the session configurations on a remote computer. This method does not provide as much information as a
Get-PSSessionConfiguration command, but the user does not need to be a member of the Administrators group to run this command.

-------------------------- EXAMPLE 7 --------------------------

The first command uses the Enable-WSManCredSSP cmdlet to enable CredSSP delegation from the Server01 local computer to the Server02 remote computer. This configures the
CredSSP client setting on the local computer.
PS C:\>Enable-WSManCredSSP -Delegate Server02

The second command uses the Connect-WSMan cmdlet to connect to the Server02 computer. This action adds a node for the Server02 computer to the WSMan: drive on the local
computer, allowing you to view and change the WS-Management settings on the Server02 computer.
PS C:\>Connect-WSMan Server02

The third command uses the Set-Item cmdlet to change the value of the CredSSP item in the Service node of the Server02 computer to True. This configures the service settings
on the remote computer.
PS C:\>Set-Item WSMan:\Server02*\Service\Auth\CredSSP -Value $true

The fourth command uses the Invoke-Command cmdlet to run a Get-PSSessionConfiguration command on the Server02 computer. The command uses the Credential parameter, and it
uses the Authentication parameter with a value of CredSSP.The output shows the session configurations on the Server02 remote computer.
PS C:\>Invoke-Command -ScriptBlock {Get-PSSessionConfiguration} -ComputerName Server02 -Authentication CredSSP -Credential Domain01\Admin01

Name PSVersion StartupScript Permission PSComputerName
---- --------- ------------- ---------- --------------
microsoft.powershell 2.0 BUILTIN\Administrators AccessAll... server02.corp.fabrikam.com
microsoft.powershell32 2.0 BUILTIN\Administrators AccessAll... server02.corp.fabrikam.com
MyX86Shell 2.0 c:\test\x86Shell.ps1 BUILTIN\Administrators AccessAll... server02.corp.fabrikam.com

This example shows how to run a Get-PSSessionConfiguration command on a remote computer. The command requires that CredSSP delegation be enabled in the client settings on
the local computer and in the service settings on the remote computer.

To run the commands in this example, you must be a member of the Administrators group on the local computer and the remote computer and you must start Windows PowerShell
with the "Run as administrator" option.

-------------------------- EXAMPLE 8 --------------------------

PS C:\>(Get-PSSessionConfiguration -Name CustomShell).resourceURI

This command uses the Get-PSSessionConfiguration cmdlet to get the resource URI of a session configuration.

This command is useful when setting the value of the $PSSessionConfigurationName preference variable, which takes a resource URI.

The $PSSessionConfiguationName variable specifies the default configuration that is used when you create a session. This variable is set on the local computer, but it
specifies a configuration on the remote computer. For more information about the $PSSessionConfiguration variable, see about_Preference_Variables