Add-VPN Cmdlet
Parameters Output Objects Configuration Settings
The Add-VPN cmdlet can be used to create a new VPN connection on the system.
Syntax
Add-VPN [parameters]
Remarks
The user can specify a series of properties for adding the VPN, such as Name, Server, DNSServer, etc. The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.
# create a new VPN connectionadd-vpn -name "NewEntry" -server "vpn.contoso.com" -user "contoso\user"Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| Config | Specifies one or more configuration settings. |
| DNSServer | The DNS server to use. |
| IPAddress | The IP Address to assign. |
| LogFile | The location of a file to which debug information is written. |
| Name | The name of the VPN connection. |
| Password | The password to use for authentication. |
| Protocol | The protocol to use for the VPN connection. |
| Server | The address of the Server. |
| User | The username to use for authentication. |
| WINSServer | The WINS server to use. |
Output Objects
The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.
| VPNCreatedEntry | Represents a created VPN entry. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| IgnoreModemSpeaker | Whether the cmdlet will ignore the default modem speaker settings. |
| IgnoreSoftwareCompression | Whether the cmdlet will ignore the default software compression settings. |
| OverrideEntrySetting | Whether or not to use the cmdlet settings when dialing a phone book entry. |
| PausedStates | Whether the cmdlet will accept paused states. |
| PauseOnScript | Tells the cmdlet to display a logon terminal. |
| SetModemSpeaker | Whether the cmdlet will use the modem speaker. |
| SetSoftwareCompression | Whether the cmdlet will use software compression. |
| UseCustomScripting | Tells the cmdlet to use custom script DLLs. |
| UsePrefixSuffix | Whether or not to use the dialing prefix and suffix in the phone book. |
| UseRemoteDefaultGateway | Whether or not the entry should use the default gateway on the remote network. |
| VPNType | Sets the VPN Type when creating entries with NetDial. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |