Set-SCVPNConnection

Article
01/03/2016

Set-SCVPNConnection

Sets the properties of a VPN connection.

Syntax

Parameter Set: GRETunnel
Set-SCVPNConnection [-VPNConnection] <Microsoft.SystemCenter.VirtualMachineManager.VPNConnection> -GRETunnel [-Description <System.String> ] [-GREIPv4Address <System.String> ] [-GREIPv6Address <System.String> ] [-GREKey <Nullable [System.UInt32]> ] [-JobVariable <System.String> ] [-MaximumBandwidthInboundKbps <Nullable [System.UInt64]> ] [-MaximumBandwidthOutboundKbps <Nullable [System.UInt64]> ] [-Name <System.String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Nullable [System.Guid]> ] [-RemoveMaximumBandwidthInbound] [-RemoveMaximumBandwidthOutbound] [-RunAsynchronously] [-Status <Nullable [Microsoft.VirtualManager.Remoting.GatewayConnectionStatus]> ] [-TargetIPv4VPNAddress <System.String> ] [-TargetIPv6VPNAddress <System.String> ] [-VMMServer <Microsoft.SystemCenter.VirtualMachineManager.Remoting.ServerConnection> ] [ <CommonParameters>]

Parameter Set: VPNTunnel
Set-SCVPNConnection [-VPNConnection] <Microsoft.SystemCenter.VirtualMachineManager.VPNConnection> [-AuthenticationMethod <Microsoft.VirtualManager.Remoting.VPNAuthenticationMethod> {PSKOnly | MachineCertificates} ] [-AuthenticationTransformConstants <Microsoft.VirtualManager.Remoting.VPNAuthenticationTransformConstants> {SHA256128 | MD596 | SHA196 | GCMAES128 | GCMAES192 | GCMAES256} ] [-Certificate <Microsoft.SystemCenter.VirtualMachineManager.Remoting.ClientCertificate> ] [-CipherTransformConstants <Microsoft.VirtualManager.Remoting.VPNCipherTransformConstants> {DES | DES3 | AES128 | AES192 | AES256 | GCMAES128 | GCMAES192 | GCMAES256} ] [-Description <System.String> ] [-DHGroup <Microsoft.VirtualManager.Remoting.VPNDHGroup> {None | Group1 | Group2 | Group14 | ECP256 | ECP384 | Group24} ] [-EncryptionMethod <Microsoft.VirtualManager.Remoting.VPNEncryptionMethod> {DES | DES3 | AES128 | AES192 | AES256} ] [-IntegrityCheckMethod <Microsoft.VirtualManager.Remoting.VPNIntegrityCheckMethod> {MD5 | SHA1 | SHA256 | SHA384} ] [-JobVariable <System.String> ] [-MaximumBandwidthInboundKbps <Nullable [System.UInt64]> ] [-MaximumBandwidthOutboundKbps <Nullable [System.UInt64]> ] [-Name <System.String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PFSGroup <Microsoft.VirtualManager.Remoting.VPNPFSGroup> {None | PFS1 | PFS2 | PFS2048 | ECP256 | ECP384 | PFSMM | PFS24} ] [-PROTipID <Nullable [System.Guid]> ] [-RemoveMaximumBandwidthInbound] [-RemoveMaximumBandwidthOutbound] [-RunAsynchronously] [-Secret <Microsoft.SystemCenter.VirtualMachineManager.RunAsAccount> ] [-Status <Nullable [Microsoft.VirtualManager.Remoting.GatewayConnectionStatus]> ] [-TargetIPv4VPNAddress <System.String> ] [-TargetIPv6VPNAddress <System.String> ] [-VMMServer <Microsoft.SystemCenter.VirtualMachineManager.Remoting.ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Set-SCVPNConnection cmdlet updates the properties of a virtual private network (VPN) connection.

Parameters

-AuthenticationMethod<Microsoft.VirtualManager.Remoting.VPNAuthenticationMethod>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AuthenticationTransformConstants<Microsoft.VirtualManager.Remoting.VPNAuthenticationTransformConstants>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Certificate<Microsoft.SystemCenter.VirtualMachineManager.Remoting.ClientCertificate>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CipherTransformConstants<Microsoft.VirtualManager.Remoting.VPNCipherTransformConstants>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Description<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DHGroup<Microsoft.VirtualManager.Remoting.VPNDHGroup>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EncryptionMethod<Microsoft.VirtualManager.Remoting.VPNEncryptionMethod>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-GREIPv4Address<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-GREIPv6Address<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-GREKey<Nullable [System.UInt32]>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-GRETunnel

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IntegrityCheckMethod<Microsoft.VirtualManager.Remoting.VPNIntegrityCheckMethod>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-JobVariable<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaximumBandwidthInboundKbps<Nullable [System.UInt64]>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaximumBandwidthOutboundKbps<Nullable [System.UInt64]>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-OnBehalfOfUser<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PFSGroup<Microsoft.VirtualManager.Remoting.VPNPFSGroup>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PROTipID<Nullable [System.Guid]>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RemoveMaximumBandwidthInbound

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RemoveMaximumBandwidthOutbound

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RunAsynchronously

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Secret<Microsoft.SystemCenter.VirtualMachineManager.RunAsAccount>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Status<Nullable [Microsoft.VirtualManager.Remoting.GatewayConnectionStatus]>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-TargetIPv4VPNAddress<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-TargetIPv6VPNAddress<System.String>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMMServer<Microsoft.SystemCenter.VirtualMachineManager.Remoting.ServerConnection>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true(ByValue)
Accept Wildcard Characters?	false

-VPNConnection<Microsoft.SystemCenter.VirtualMachineManager.VPNConnection>

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true(ByValue)
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.

Add-SCVPNConnection

Get-SCVPNConnection

Read-SCVPNConnection

Remove-SCVPNConnection

Get-SCRunAsAccount

Set-SCVPNConnection