Get-VpnConnection
Get-VpnConnection
Retrieves the specified VPN connection profile information.
Syntax
Parameter Set: Get1
Get-VpnConnection [[-Name] <String[]> ] [-AllUserConnection] [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-VpnConnection cmdlet retrieves the specified VPN connection profile and its properties. If you do not specify a profile name, the cmdlet returns a list of all VPN connections in the phone book.
Parameters
-AllUserConnection
Indicates that the VPN connection is retrieved from the global phone book.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AsJob
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of the VPN connection profile.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#VpnConnection[]
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
The VpnConnection object contains the VpnConnection configuration settings.
Examples
Example 1: Get all available VPN connections
This command returns a list of all available VPN connections in the user's local phone book.
PS C:\> Get-VpnConnection
Example 2: Get all available VPN connections from the global phonebook
This command retrieves all the available VPN connections from the global phone book.
PS C:\> Get-VpnConnection -AllUserConnection
Example 3: Get a specific VPN connection from the global phone book
This command retrieves the VPN connection named Test3 from the global phone book.
PS C:\> Get-VpnConnection -Name "Test3" –AllUserConnection
Example 4: Get multiple VPN connections
This command retrieves multiple specified VPN connections from the global phone book.
PS C:\> Get-VpnConnection -Name "Test3", "Test4", "test5" –AllUserConnection