Add-SCVPNConnection

Article
10/21/2013

Applies To: System Center 2012 SP1 - Virtual Machine Manager

Add-SCVPNConnection

Adds a VPN connection to a VM network.

Syntax

Parameter Set: Default
Add-SCVPNConnection [-VMNetworkGateway] <VMNetworkGateway> [-AuthenticationMethod <VPNAuthenticationMethod> ] [-AuthenticationTransformConstants <VPNAuthenticationTransformConstants> ] [-Certificate <ClientCertificate> ] [-CipherTransformConstants <VPNCipherTransformConstants> ] [-Description <String> ] [-DHGroup <VPNDHGroup> ] [-EncryptionMethod <VPNEncryptionMethod> ] [-IntegrityCheckMethod <VPNIntegrityCheckMethod> ] [-JobVariable <String> ] [-Name <String> ] [-PFSGroup <VPNPFSGroup> ] [-PROTipID <Guid> ] [-Protocol <VPNProtocol> ] [-RunAsynchronously] [-Secret <RunAsAccount> ] [-TargetIPv4VPNAddress <String> ] [-TargetIPv6VPNAddress <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Add-SCVPNConnection adds a virtual private network (VPN) connection to a VM network to establish a site-to-site tunnel from a Virtual Machine Manager (VMM) managed network gateway to another endpoint.

Parameters

-AuthenticationMethod<VPNAuthenticationMethod>

Specifies a virtual private network (VPN) authentication method. Valid values are: PSKOnly, MachineCertificates.

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

-AuthenticationTransformConstants<VPNAuthenticationTransformConstants>

Specifies a virtual private network (VPN) transform constant. Valid values are: SHA256128, MD596, SHA196, GCMAES128, GCMAES192, GCMAES256.

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

-Certificate<ClientCertificate>

Specifies a security certificate object.

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

-CipherTransformConstants<VPNCipherTransformConstants>

Specifies a virtual private network cipher transform constants. Valid values are: DES, DES3, AES128, AES192, AES256, GCMAES128, GCMAES192, GCMAES256.

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

-Description<String>

States a description for the specified object.

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

-DHGroup<VPNDHGroup>

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

-EncryptionMethod<VPNEncryptionMethod>

Specifies a virtual private network (VPN) encryption method. Valid values are: DES, DES3, AES128, AES192, AES256.

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

-IntegrityCheckMethod<VPNIntegrityCheckMethod>

Specifies a virtual private network (VPN) integrity check method. Valid values are: MD5, SHA1, SHA256, SHA384.

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

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

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

-Name<String>

Specifies the name of a VMM object.

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

-PFSGroup<VPNPFSGroup>

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

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

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

-Protocol<VPNProtocol>

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-Secret<RunAsAccount>

Specifies a Run As account.

To obtain a Run As account, use the Get-SCRunAsAccount cmdlet.

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

-TargetIPv4VPNAddress<String>

Specifies a target virtual private network (VPN) address in IPv4 format.

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

-TargetIPv6VPNAddress<String>

Specifies a target virtual private network (VPN) address in IPv6 format.

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

-VMMServer<ServerConnection>

Specifies a VMM server object.

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

-VMNetworkGateway<VMNetworkGateway>

Specifies a VM network gateway object.

To obtain a VM network gateway object, use the Get-SCVMNetworkGateway cmdlet.

Aliases	none
Required?	true
Position?	1
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.

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.

Get-SCVPNConnection

Remove-SCVPNConnection

Set-SCVPNConnection

Add-SCVPNConnection