< Back
Set-AzureRmVirtualNetworkGatewayVpnClientConfig
Post
NAME Set-AzureRmVirtualNetworkGatewayVpnClientConfig
SYNOPSIS
Sets the VPN client address pool for a virtual network gateway.
SYNTAX
Set-AzureRmVirtualNetworkGatewayVpnClientConfig [-DefaultProfile <IAzureContextContainer>] -RadiusServerAddress <String> -RadiusServerSecret
<SecureString> -VirtualNetworkGateway <PSVirtualNetworkGateway> -VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RadiusServerAddress <String>
P2S External Radius server address.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RadiusServerSecret <SecureString>
P2S External Radius server secret.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetworkGateway <PSVirtualNetworkGateway>
Specifies 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>
Specifies the IP addresses to be assigned to clients connecting to this gateway
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
This cmdlet accepts pipelined instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.
OUTPUTS
This cmdlet modifies existing instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.
NOTES
Example 1: Assign a VPN client address pool to a virtual network gateway
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.
Example 2: Configure external radius based authentication on existing gateway
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ientconfig
Get-AzureRmVpnClientPackage
Get-AzureRmVirtualNetworkGateway
Resize-AzureRmVirtualNetworkGateway
SYNOPSIS
Sets the VPN client address pool for a virtual network gateway.
SYNTAX
Set-AzureRmVirtualNetworkGatewayVpnClientConfig [-DefaultProfile <IAzureContextContainer>] -RadiusServerAddress <String> -RadiusServerSecret
<SecureString> -VirtualNetworkGateway <PSVirtualNetworkGateway> -VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RadiusServerAddress <String>
P2S External Radius server address.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RadiusServerSecret <SecureString>
P2S External Radius server secret.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetworkGateway <PSVirtualNetworkGateway>
Specifies 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>
Specifies the IP addresses to be assigned to clients connecting to this gateway
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
This cmdlet accepts pipelined instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.
OUTPUTS
This cmdlet modifies existing instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.
NOTES
Example 1: Assign a VPN client address pool to a virtual network gateway
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.
Example 2: Configure external radius based authentication on existing gateway
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ientconfig
Get-AzureRmVpnClientPackage
Get-AzureRmVirtualNetworkGateway
Resize-AzureRmVirtualNetworkGateway