Edit

New-VpnServerAddress

  • Reference
Module:
VpnClient

Creates a VPN server address object.

Syntax

New-VpnServerAddress
   [-ServerAddress] <String>
   [-FriendlyName] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-VpnServerAddress cmdlet creates a virtual private network (VPN) server address object. Specify a server by name or by IP address, and specify a friendly name for the address of the server.

Examples

Example 1: Create a VPN server address by using an FQDN

PS C:\>New-VpnServerAddress -ServerAddress "RAS.Washington.Contoso.com" -FriendlyName "Washington"
ServerAddress : RAS.Washington.Contoso.com 

FriendlyName  : Washington

This command creates a VPN server address object that has the FQDN RAS.Washington.Contoso.com. The command specifies the name Washington for the server address.

Example 2: Create a VPN server address by using an IP address

PS C:\>New-VpnServerAddress -ServerAddress "172.16.12.3" -FriendlyName "Singapore"
ServerAddress : 207.56.12.03

FriendlyName  : Singapore

This command creates a VPN server address object that has the IP address 172.16.12.3. The command specifies the name Singapore for the server address.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

Specifies a name for the VPN destination server.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ServerAddress

Specifies a DNS server. You can specify either an IPv4 or an IPv6 address, or specify a fully qualified domain name (FQDN) that resolves to an IP address.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

CimInstance