| external help file | Module Name | ms.assetid | online version | schema |
|---|---|---|---|---|
Microsoft.Azure.Commands.Network.dll-Help.xml |
AzureRM.Network |
EFB0D7A6-0C8A-4514-873D-672641CCCAF3 |
2.0.0 |
Sets the VPN client address pool for a virtual network gateway.
Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway <PSVirtualNetworkGateway>
-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway <PSVirtualNetworkGateway>
-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]> -RadiusServerAddress <String>
-RadiusServerSecret <SecureString> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
[<CommonParameters>]
The Set-AzureRmVirtualNetworkVpnClientConfig cmdlet configures the client address pool for a virtual network gateway. Virtual private network (VPN) clients that connect to this gateway will be assigned an IP address from this address pool.
PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway"
PS C:\> Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16"
This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway. The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway. The second command in the example then uses the Set-AzureRmVirtualNetworkGatewayVpnClientConfig cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway.
PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway"
PS C:\> $Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force
PS C:\> Set-AzureRmVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16" -RadiusServerAddress "TestRadiusServer" -RadiusServerSecret $Secure_String_Pwd
This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway. The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway. The second command in the example then uses the Set-AzureRmVirtualNetworkGatewayVpnClientConfig cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway. It also configures the external radius server "TestRadiusServer" to be used for authentication for vpn clients.
The credentials, account, tenant, and subscription used for communication with azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseP2S External Radius server address.
Type: System.String
Parameter Sets: RadiusServerConfiguration
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseP2S External Radius server secret.
Type: System.Security.SecureString
Parameter Sets: RadiusServerConfiguration
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies an object reference to the virtual network gateway that contains the VPN client configuration settings that this cmdlet modifies. You can create an object reference to a virtual network gateway by using the Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway.
Type: Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the IP addresses to be assigned to clients connecting to this gateway
Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
Parameters: VirtualNetworkGateway (ByValue)