Skip to content

Commit 0f939ac

Browse files
Merge pull request #272501 from cherylmc/reset-active
Reset active
2 parents 47b318a + 8706df1 commit 0f939ac

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

articles/vpn-gateway/reset-gateway.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to reset a gateway or a gateway connection to reestablish
55
author: cherylmc
66
ms.service: vpn-gateway
77
ms.topic: how-to
8-
ms.date: 07/28/2023
8+
ms.date: 04/17/2024
99
ms.author: cherylmc
1010
---
1111
# Reset a VPN gateway or a connection
@@ -16,13 +16,16 @@ Resetting an Azure VPN gateway or gateway connection is helpful if you lose cros
1616

1717
### Gateway reset
1818

19-
A VPN gateway is composed of two VM instances running in an active-standby configuration. When you reset the gateway, it reboots the gateway, and then reapplies the cross-premises configurations to it. The gateway keeps the public IP address it already has. This means you won’t need to update the VPN router configuration with a new public IP address for Azure VPN gateway.
19+
A VPN gateway is composed of two virtual machine (VM) instances running in an active-standby or active-active configuration. When you reset the gateway, it reboots the gateway, and then reapplies the cross-premises configurations to it. The gateway keeps the public IP address it already has. This means you won’t need to update the VPN router configuration with a new public IP address for Azure VPN gateway.
2020

21-
When you issue the command to reset the gateway, the current active instance of the Azure VPN gateway is rebooted immediately. There will be a brief gap during the failover from the active instance (being rebooted), to the standby instance. The gap should be less than one minute.
21+
When you issue the command to reset the gateway in active-standby setup, the current active instance of the Azure VPN gateway is rebooted immediately. A brief connectivity disruption can be expected during the failover from the active instance (being rebooted), to the standby instance.
2222

23-
If the connection isn't restored after the first reboot, issue the same command again to reboot the second VM instance (the new active gateway). If the two reboots are requested back to back, there will be a slightly longer period where both VM instances (active and standby) are being rebooted. This will cause a longer gap on the VPN connectivity, up to 30 to 45 minutes for VMs to complete the reboots.
23+
When you issue the command to reset the gateway in active-active setup, one of the active instances (for example, primary active instance) of the Azure VPN gateway is rebooted immediately. A brief connectivity disruption can be expected as the gateway instance gets rebooted.
2424

25-
After two reboots, if you're still experiencing cross-premises connectivity problems, please open a support request from the Azure portal.
25+
If the connection hasn't restored after the first reboot, the next steps might vary depending on if the VPN gateway is configured as active-standby or active-active:
26+
27+
* If the VPN gateway is configured as active-standby, issue the same command again to reboot the second VM instance (the new active gateway).
28+
* If the VPN gateway is configured as active-active, the same instance gets rebooted when the reset gateway operation is issued again. You can use PowerShell or CLI to reset one or both of the instances using VIPs.
2629

2730
### Connection reset
2831

@@ -34,13 +37,13 @@ You can reset a connection easily using the Azure portal.
3437

3538
1. Go to the **Connection** that you want to reset. You can find the connection resource either by locating it in **All resources**, or by going to the **'Gateway Name' -> Connections -> 'Connection Name'**
3639
1. On the **Connection** page, in the left pane, scroll down to the **Support + Troubleshooting** section and select **Reset**.
37-
1. On the **Reset** page, click **Reset** to reset the connection.
40+
1. On the **Reset** page, select **Reset** to reset the connection.
3841

3942
:::image type="content" source="./media/reset-gateway/reset-connection.png" alt-text="Screenshot showing the Reset button selected." lightbox="./media/reset-gateway/reset-connection.png":::
4043

4144
## Reset a gateway
4245

43-
Before you reset your gateway, verify the key items listed below for each IPsec site-to-site (S2S) VPN tunnel. Any mismatch in the items will result in the disconnect of S2S VPN tunnels. Verifying and correcting the configurations for your on-premises and Azure VPN gateways saves you from unnecessary reboots and disruptions for the other working connections on the gateways.
46+
Before you reset your gateway, verify the following key items for each IPsec site-to-site (S2S) VPN tunnel. Any mismatch in the items results in the disconnect of S2S VPN tunnels. Verifying and correcting the configurations for your on-premises and Azure VPN gateways saves you from unnecessary reboots and disruptions for the other working connections on the gateways.
4447

4548
Verify the following items before resetting your gateway:
4649

@@ -54,16 +57,20 @@ You can reset a Resource Manager VPN gateway using the Azure portal.
5457

5558
[!INCLUDE [portal steps](../../includes/vpn-gateway-reset-gw-portal-include.md)]
5659

60+
Note: If the VPN gateway is configured as active-active, you can reset the gateway instances using VIPs of the instances in PowerShell or CLI.
61+
5762
### <a name="ps"></a>PowerShell
5863

59-
The cmdlet for resetting a gateway is **Reset-AzVirtualNetworkGateway**. Before performing a reset, make sure you have the latest version of the [PowerShell Az cmdlets](/powershell/module/az.network). The following example resets a virtual network gateway named VNet1GW in the TestRG1 resource group:
64+
The cmdlet for resetting a gateway is **Reset-AzVirtualNetworkGateway**. The following example resets a virtual network gateway named VNet1GW in the TestRG1 resource group:
6065

6166
```azurepowershell-interactive
6267
$gw = Get-AzVirtualNetworkGateway -Name VNet1GW -ResourceGroupName TestRG1
6368
Reset-AzVirtualNetworkGateway -VirtualNetworkGateway $gw
6469
```
6570

66-
When you receive a return result, you can assume the gateway reset was successful. However, there's nothing in the return result that indicates explicitly that the reset was successful. If you want to look closely at the history to see exactly when the gateway reset occurred, you can view that information in the [Azure portal](https://portal.azure.com). In the portal, navigate to **'GatewayName' -> Resource Health**.
71+
You can view the reset history of the gateway from [Azure portal](https://portal.azure.com) by navigating to **'GatewayName' -> Resource Health**.
72+
73+
Note: If the gateway is set up as active-active, use `-GatewayVip <string>` to reset both the instances one by one.
6774

6875
### <a name="cli"></a>Azure CLI
6976

@@ -73,13 +80,15 @@ To reset the gateway, use the [az network vnet-gateway reset](/cli/azure/network
7380
az network vnet-gateway reset -n VNet5GW -g TestRG5
7481
```
7582

76-
When you receive a return result, you can assume the gateway reset was successful. However, there's nothing in the return result that indicates explicitly that the reset was successful. If you want to look closely at the history to see exactly when the gateway reset occurred, you can view that information in the [Azure portal](https://portal.azure.com). In the portal, navigate to **'GatewayName' -> Resource Health**.
83+
You can view the reset history of the gateway from [Azure portal](https://portal.azure.com) by navigating to **'GatewayName' -> Resource Health**.
84+
85+
Note: If the gateway is set up as active-active, use `--gateway-vip <string>` to reset both the instances one by one.
7786

7887
### <a name="resetclassic"></a>Reset a classic gateway
7988

8089
The cmdlet for resetting a classic gateway is **Reset-AzureVNetGateway**. The Azure PowerShell cmdlets for Service Management must be installed locally on your desktop. You can't use Azure Cloud Shell. Before performing a reset, make sure you have the latest version of the [Service Management (SM) PowerShell cmdlets](/powershell/azure/servicemanagement/install-azure-ps#azure-service-management-cmdlets).
8190

82-
When using this command, make sure you're using the full name of the virtual network. Classic VNets that were created using the portal have a long name that is required for PowerShell. You can view the long name by using 'Get-AzureVNetConfig -ExportToFile C:\Myfoldername\NetworkConfig.xml'.
91+
When using this command, make sure you're using the full name of the virtual network. Classic VNets that were created using the portal have a long name that is required for PowerShell. You can view the long name by using `Get-AzureVNetConfig -ExportToFile C:\Myfoldername\NetworkConfig.xml`.
8392

8493
The following example resets the gateway for a virtual network named "Group TestRG1 TestVNet1" (which shows as simply "TestVNet1" in the portal):
8594

0 commit comments

Comments
 (0)