Skip to content

Commit b425f52

Browse files
authored
Merge pull request #268864 from cherylmc/freshness-configscript
freshness update
2 parents ada2466 + 57a3f13 commit b425f52

File tree

9 files changed

+28
-35
lines changed

9 files changed

+28
-35
lines changed
Binary file not shown.
91.1 KB
Loading
140 KB
Loading
130 KB
Loading
Binary file not shown.

articles/vpn-gateway/vpn-gateway-download-vpndevicescript.md

Lines changed: 28 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,70 +5,63 @@ titleSuffix: Azure VPN Gateway
55
author: cherylmc
66
ms.service: vpn-gateway
77
ms.topic: how-to
8-
ms.date: 10/24/2022
8+
ms.date: 03/13/2024
99
ms.author: cherylmc
1010
ms.custom: devx-track-azurepowershell
1111

1212
---
1313
# Download VPN device configuration scripts for S2S VPN connections
1414

15-
This article walks you through downloading VPN device configuration scripts for S2S VPN connections with Azure VPN Gateways. The following diagram shows the high-level workflow.
15+
This article walks you through downloading VPN device configuration scripts for site-to-site (S2S) VPN connections with Azure VPN Gateway. The following diagram shows the high-level workflow.
1616

17-
![download-script](./media/vpn-gateway-download-vpndevicescript/downloaddevicescript.png)
17+
:::image type="content" source="./media/vpn-gateway-download-vpndevicescript/downloaddevicescript.png" alt-text="Diagram shows the high level workflow for VPN device configuration scripts." lightbox="./media/vpn-gateway-download-vpndevicescript/downloaddevicescript.png":::
1818

1919
## <a name="about"></a>About VPN device configuration scripts
2020

2121
A cross-premises VPN connection consists of an Azure VPN gateway, an on-premises VPN device, and an IPsec S2S VPN tunnel connecting the two. The typical work flow includes the following steps:
2222

23-
1. Create and configure an Azure VPN gateway (virtual network gateway)
24-
2. Create and configure an Azure local network gateway that represents your on-premises network and VPN device
25-
3. Create and configure an Azure VPN connection between the Azure VPN gateway and the local network gateway
26-
4. Configure the on-premises VPN device represented by the local network gateway to establish the actual S2S VPN tunnel with the Azure VPN gateway
23+
1. Create and configure an Azure VPN gateway (virtual network gateway).
24+
1. Create and configure an Azure local network gateway that represents your on-premises network and VPN device.
25+
1. Create and configure an Azure VPN connection between the Azure VPN gateway and the local network gateway.
26+
1. Configure the on-premises VPN device represented by the local network gateway to establish the actual S2S VPN tunnel with the Azure VPN gateway.
2727

2828
You can complete steps 1 through 3 using the Azure [portal](./tutorial-site-to-site-portal.md), [PowerShell](vpn-gateway-create-site-to-site-rm-powershell.md), or [CLI](vpn-gateway-howto-site-to-site-resource-manager-cli.md). The last step involves configuring the on-premises VPN devices outside of Azure. This feature allows you to download a configuration script for your VPN device with the corresponding values of your Azure VPN gateway, virtual network, and on-premises network address prefixes, and VPN connection properties, etc. already filled in. You can use the script as a starting point, or apply the script directly to your on-premises VPN devices via the configuration console.
2929

30-
> [!IMPORTANT]
31-
> * The syntax for each VPN device configuration script is different, and heavily dependent on the models and firmware versions. Pay special attention to your device model and version information against the available templates.
32-
> * Some parameter values must be unique on the device, and cannot be determined without accessing the device. The Azure-generated configuration scripts pre-fill these values, but you need to ensure the provided values are valid on your device. For examples:
33-
> * Interface numbers
34-
> * Access control list numbers
35-
> * Policy names or numbers, etc.
36-
> * Look for the keyword, "**REPLACE**", embedded in the script to find the parameters you need to verify before applying the script.
37-
> * Some templates include a "**CLEANUP**" section you can apply to remove the configurations. The cleanup sections are commented out by default.
30+
The syntax for each VPN device configuration script is different and heavily dependent on the models and firmware versions. Pay special attention to your device model and version information against the available templates.
3831

39-
## Download the configuration script from Azure portal
32+
* Some parameter values must be unique on the device, and can't be determined without accessing the device. The Azure-generated configuration scripts prefill these values, but you need to ensure the provided values are valid on your device. For examples:
4033

41-
Create an Azure VPN gateway, local network gateway, and a connection resource connecting the two. The following page guides you through the steps:
42-
43-
* [Create a Site-to-Site connection in the Azure portal](./tutorial-site-to-site-portal.md)
44-
45-
Once the connection resource is created, follow the instructions below to download the VPN device configuration scripts:
34+
* Interface numbers
35+
* Access control list numbers
36+
* Policy names or numbers, etc.
4637

47-
1. From a browser, navigate to the [Azure portal](https://portal.azure.com) and, if necessary, sign in with your Azure account
48-
2. Go to the connection resource you created. You can find the list of all connection resources by clicking "All services", then "NETWORKING", and "Connections."
38+
* Look for the keyword, "**REPLACE**", embedded in the script to find the parameters you need to verify before applying the script.
39+
* Some templates include a "**CLEANUP**" section you can apply to remove the configurations. The cleanup sections are commented out by default.
4940

50-
![connection-list](./media/vpn-gateway-download-vpndevicescript/connectionlist.png)
41+
## Download the configuration script - Azure portal
5142

52-
3. Click on the connection you want to configure.
53-
54-
![connection-overview](./media/vpn-gateway-download-vpndevicescript/connectionoverview.png)
43+
Create an Azure VPN gateway, local network gateway, and a connection resource connecting the two. The following page guides you through the steps:
5544

56-
4. Click on the "Download configuration" link as highlighted in red in the Connection overview page; this opens the "Download configuration" page.
45+
* [Create a Site-to-Site connection in the Azure portal](./tutorial-site-to-site-portal.md)
5746

58-
![download-script-1](./media/vpn-gateway-download-vpndevicescript/downloadscript-1.png)
47+
Once the connection resource is created, use the following instructions to download the VPN device configuration scripts:
5948

60-
5. Select the model family and firmware version for your VPN device, then click on the "Download configuration" button.
49+
1. In the Azure portal, go to your VPN gateway.
50+
1. In the left pane, select **Connections** to view a list of connections.
51+
1. Select the connection to open the page for that connection. At the top of the page, click **Download configuration**.
6152

62-
![download66-script-2](./media/vpn-gateway-download-vpndevicescript/downloadscript-2.PNG)
53+
:::image type="content" source="./media/vpn-gateway-download-vpndevicescript/download-configuration.png" alt-text="Screenshot of the configuration screen showing the download configuration link." lightbox="./media/vpn-gateway-download-vpndevicescript/download-configuration.png":::
6354

64-
6. You're prompted to save the downloaded script (a text file) from your browser.
65-
7. Once you downloaded the configuration script, open it with a text editor and search for the keyword "REPLACE" to identify and examine the parameters that may need to be replaced.
55+
1. On the **Download configuration** page, from the dropdowns, select the device vendor, device family, and firmware version.
6656

67-
![edit-script](./media/vpn-gateway-download-vpndevicescript/editscript.png)
57+
:::image type="content" source="./media/vpn-gateway-download-vpndevicescript/download-configuration-page.png" alt-text="Screenshot of the configuration screen showing the download configuration page to select vendor, family, and firmware version." lightbox="./media/vpn-gateway-download-vpndevicescript/download-configuration-page.png":::
6858

69-
## Download the configuration script using Azure PowerShell
59+
1. Once you've selected the device, click **Download configuration**. The configuration is generated and you're prompted to save the downloaded script (a text file) from your browser.
60+
1. Open the configuration script with a text editor and search for the keyword "REPLACE" to identify and examine the parameters that might need to be replaced before applying the script to your VPN device.
7061

62+
:::image type="content" source="./media/vpn-gateway-download-vpndevicescript/edit-script.png" alt-text="Screenshot shows the configuration file opened using a text editor." lightbox="./media/vpn-gateway-download-vpndevicescript/edit-script.png":::
7163

64+
## Download the configuration script - Azure PowerShell
7265

7366
You can also download the configuration script using Azure PowerShell, as shown in the following example:
7467

0 commit comments

Comments
 (0)