| external help file | Locale | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
System.Management.Automation.dll-Help.xml |
en-US |
Microsoft.PowerShell.Core |
09/28/2021 |
2.0.0 |
Get-PSSessionCapability |
Gets the capabilities of a specific user on a constrained session configuration.
Get-PSSessionCapability [-ConfigurationName] <String> [-Username] <String> [-Full] [<CommonParameters>]
The Get-PSSessionCapability cmdlet gets the capabilities of a specific user on a constrained
session configuration. Use this cmdlet to audit customized session configurations for users.
Starting in Windows PowerShell 5.0, you can use the RoleDefinitions property in a session
configuration (.pssc) file. Using this property lets you grant users different capabilities on a
single constrained endpoint based on group membership. The Get-PSSessionCapability cmdlet reduces
complexity when auditing these endpoints by letting you determine the exact capabilities granted to
a user.
By default, the Get-PSSessionCapability cmdlet returns a list of commands the specified user can
run in the specified endpoint. This is equivalent to the user running Get-Command in the specified
endpoint. When run with the Full parameter, this cmdlet returns an InitialSessionState
object. This object contains details about the Windows PowerShell runspace the specified user would
interact with for the specified endpoint. It includes information such as Language Mode, Execution
Policy, and Environmental Variables.
Get-PSSessionCapability -ConfigurationName Endpoint1 -Username 'CONTOSO\User'
This example returns the commands available to the user CONTOSO\User when connecting to the Endpoint1 constrained endpoint on the local computer.
Get-PSSessionCapability -ConfigurationName Endpoint1 -Username 'CONTOSO\User' -Full
This example returns details about the runspace the user CONTOSO\User would interact with when connecting to the Endpoint1 constrained endpoint.
Specifies the constrained session configuration (endpoint) that you are inspecting.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that this cmdlet returns the entire initial session state for the specified user at the specified constrained endpoint.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the user whose capabilities you are inspecting.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.