Export (0) Print
Expand All
Expand Minimize

Disconnect-VpnUser

Updated: August 15, 2012

Applies To: Windows Server 2012

Disconnect-VpnUser

Disconnects a VPN connection originated by a specific user or originating from a specific client computer.

Syntax

Parameter Set: UserName
Disconnect-VpnUser [-UserName] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: HostIP
Disconnect-VpnUser -HostIPAddress <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Disconnect-VpnUser cmdlet disconnects a VPN connection originated by a specific user or originating from a specific client computer.

The list of active VPN connections originating or ending on a VPN server is stored in the inbox accounting store on the server. Therefore, this cmdlet would have to be run on the server where the connection starts or ends to disconnect a user.

A VPN connection can be disconnected in one of the following two ways. Note: Only one of these methods can be used at a time.
-- By user name of the user who originated the connection.
-- By tunnel IP address assigned by the VPN server.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the computer on which the Remote Access server computer specific tasks should be run. When this parameter is specified the cmdlet looks for the specified user or host IP on that Remote Access server.


Aliases

Cn

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HostIPAddress<String[]>

Specifies the list of tunnel IP addresses of the VPN connection. These can be IPv4 or IPv6 addresses.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String[]>

Specifies the list of users that need to be disconnected. The Remote Access login name of the user that is used may be a domain account. If the user is a domain account, then it can be specified in DOMAIN\USERNAME format otherwise it is specified as a normal string.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.String[]

    The array of strings consists of the list of user names or host addresses of the connections that were disconnected.


Examples

EXAMPLE 1

This example disconnects a VPN connection by specifying the host address. There is one active VPN connection in this example.


 

The output of the Get-RemoteAccessConnectionStatistics cmdlet piped into the Format-List cmdlet displays the details of the active connection in a list format.


PS C:\> Get-RemoteAccessConnectionStatistics | Format-List
ClientIPAddress       : {40.1.1.11, 2002:836b:2:2000:7407:f734:9281:f9a3} 
UserName              : {corp.contoso.com \remoteuser1} 
ConnectionDuration(s) : 220 
ConnectionType        : Vpn 
AccessStatus          : User Mode/Full Corp Access 

 

This cmdlet is used to disconnect the connection by specifying the IP address of the server from which it originates. The output of this cmdlet displays the IP address of the disconnected server.


PS C:\> Disconnect-VpnUser -HostIPAddress 40.1.1.11 -PassThru
40.1.1.11

 

PS C:\> Get-RemoteAccessConnectionStatistics | Format-List

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft