Skip to content

Stop-TerminalSession

SYNOPSIS

PSCX Cmdlet: Logs off a specific remote desktop session on a system running Terminal Services/Remote Desktop

SYNTAX

Stop-TerminalSession [-Force] [[-Id] <Int32[]>] [[-ComputerName] <String[]>] [-Wait] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Logs off a specific remote desktop session on a system running Terminal Services/Remote Desktop

EXAMPLES

EXAMPLE 1

PS C:\>


PARAMETERS

-ComputerName

Logs off a remote desktop session on the specified computers. The default is the local computer. Type the NETBIOS name, an IP address or a fully-qualified domain name of one or more computers.

Type: System.String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: Localhost
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Id

Identifier of the session to be logged of.

Type: System.Int32[]
Parameter Sets: (All)
Aliases: SessionId

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

-Force

Does not ask for confirmation.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Wait

Wait for results before returning.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
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

OUTPUTS

NOTES

Back to top