Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Close-WmsSession

Last Updated: 3/31/2017

SYNOPSIS

Logs the user off of the specified session.

SYNTAX

CloseById

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

CloseAll

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
Parameter Sets: CloseAll
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: ComputerName

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SessionId

Specifies an array of session IDs.

Type: UInt32[]
Parameter Sets: CloseById
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None.

OUTPUTS

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

NOTES

Disconnect-WmsSession

Get-WmsSession

Lock-WmsSession

Unlock-WmsSession

© 2017 Microsoft