Get-SCVPNConnection
Gets a VPN connection.
Syntax
Get-SCVPNConnection
[-VMMServer <ServerConnection>]
-VMNetworkGateway <VMNetworkGateway>
[-Name <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]Get-SCVPNConnection
[-VMMServer <ServerConnection>]
-ID <Guid>
[-Name <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]Description
The Get-SCVPNConnection cmdlet gets a virtual private network (VPN) connection.
Examples
Example 1: Get VPN connections
PS C:\> $VmNetworkGateway = Get-SCVMNetworkGateway -Name "VMGateway01"
$VmNetworkGateway = Get-SCVMNetworkGateway -Name "VMGateway1"
PS C:\> $VPNConnection = Get-SCVPNConnection -VMNetworkGateway $VmNetworkGateway -Name "VPN01"The first command gets a network gateway named VMGateway01, and then stores it in the $VmNetworkGateway variable.
The second command gets a VPN connection on the gateway in $VmNetworkGateway, and then stores it in the $VPNConnection variable.
Parameters
-ID
Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of a VMM object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnBehalfOfUserRole
Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.
| Type: | UserRole |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMNetworkGateway
Specifies a virtual machine network gateway object.
To obtain a VMNetworkGateway object, use the Get-SCVMNetworkGateway cmdlet.
| Type: | VMNetworkGateway |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |