Get-WmsSession
Gets session information.
Syntax
GetById
Get-WmsSession
[-SessionId] <UInt32[]>
[-Thumbnail <ThumbnailSizePS>]
[-Server <String>]
[<CommonParameters>]
GetAll
Get-WmsSession
[-All]
[-Thumbnail <ThumbnailSizePS>]
[-Server <String>]
[<CommonParameters>]
Description
The Get-WmsSession cmdlet gets information for a specified session or for all sessions.
Examples
Example 1: Get all sessions
PS C:\> Get-WmsSession -All
SessionId : 2
State : RemoteConnection
IsOrchestratable : False
IsAdmin : True
IsMOGUser : True
UserName : Test
StationId : 0
ComputerName : Test1
ClientName : Test2
DomainName : TestDomain
IsRail : False
SessionId : 3
State : ConnectedToStation
IsOrchestratable : False
IsAdmin : True
IsMOGUser : True
UserName : Administrator
StationId : 1
ComputerName : Test1
ClientName : Test1
DomainName : TestDomain
IsRail : False
This command gets session information for all sessions. The session with ID 2 is a remote session, and the session with ID 3 is a session connected to a local Windows MultiPoint Server station.
Parameters
-All
Indicates that this operation applies to all sessions on the target host.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetAll
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Server
Specifies the fully qualified host name of the MultiPoint Server that is the target of the command. The default is localhost.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ComputerName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-SessionId
Specifies an array of session IDs.
Parameter properties
| Type: | UInt32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetById
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Thumbnail
Specifies the Thumbnail size of the session.
Parameter properties
| Type: | ThumbnailSizePS |
| Default value: | None |
| Accepted values: | Small, Medium, Large, FullScreen |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.