Edit

Share via

Close-WmsSession

  • Reference
Module:
MultiPoint

Logs the user off of the specified session.

Syntax

Close-WmsSession
     [-SessionId] <UInt32[]>
     [-Server <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Close-WmsSession
     [-All]
     [-Server <String>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Close-WmsSession cmdlet logs off the user for the specified session. Only administrators can close administrator sessions. You cannot close the cmdlet's session.

Examples

Example 1: Close a session

PS C:\> Close-WmsSession -SessionId 3

This command closes the remote desktop session with ID 3.

Parameters

-All

Indicates that this operation applies to all sessions on the target host.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Server

Specifies the fully qualified host name of the MultiPoint Server that is the target of the command. The default is localhost.

Type:String
Aliases:ComputerName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SessionId

Specifies an array of session IDs.

Type:UInt32[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

None

This cmdlet returns an ItemNotFoundException if the specified session ID is not found.