Skip to content

Commit fb6f75f

Browse files
authored
Merge pull request #3393 from sbgms/patch-2
Removed references to SDN Express for 22H2 docs
2 parents 6f2c50f + d055e33 commit fb6f75f

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

azure-stack/hci/manage/sdn-express.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,33 @@ title: Deploy an SDN infrastructure using SDN Express
33
description: Learn to deploy an SDN infrastructure using SDN Express
44
author: sethmanheim
55
ms.topic: how-to
6-
ms.date: 11/29/2023
6+
ms.date: 11/07/2024
77
ms.author: sethm
8-
ms.reviewer: JasonGerend
8+
ms.reviewer: anirbanpaul
99
---
1010

1111
# Deploy an SDN infrastructure using SDN Express
1212

1313
> Applies to: Azure Stack HCI, versions 22H2 and 21H2; Windows Server 2022, Windows Server 2019, Windows Server 2016
1414
15-
In this topic, you deploy an end-to-end Software Defined Network (SDN) infrastructure using SDN Express PowerShell scripts. The infrastructure includes a highly available (HA) Network Controller (NC), and optionally, a highly available Software Load Balancer (SLB), and a highly available Gateway (GW). The scripts support a phased deployment, where you can deploy just the Network Controller component to achieve a core set of functionality with minimal network requirements.
15+
This article describes how to deploy an end-to-end Software Defined Network (SDN) infrastructure using SDN Express PowerShell scripts. The infrastructure includes a highly available (HA) Network Controller (NC), and optionally, a highly available Software Load Balancer (SLB), and a highly available Gateway (GW). The scripts support a phased deployment, in which you can deploy just the Network Controller component to achieve a core set of functionality with minimal network requirements.
1616

17-
You can also deploy an SDN infrastructure using Windows Admin Center or using System Center Virtual Machine Manager (VMM). For more information, see [Create a cluster - Step 5: SDN](../deploy/create-cluster.md#step-5-sdn-optional) and see [Manage SDN resources in the VMM fabric](/system-center/vmm/network-sdn).
17+
You can also deploy an SDN infrastructure using Windows Admin Center or using System Center Virtual Machine Manager (VMM). For more information, see [Create a cluster - Step 5: SDN](../deploy/create-cluster.md#step-5-sdn-optional) and [Manage SDN resources in the VMM fabric](/system-center/vmm/network-sdn).
1818

1919
> [!IMPORTANT]
2020
> You can't use Microsoft System Center Virtual Machine Manager 2019 to manage clusters running Azure Stack HCI, version 21H2 or Windows Server 2022.
2121
2222
## Before you begin
2323

24-
Before you begin an SDN deployment, plan out and configure your physical and host network infrastructure. Reference the following articles:
24+
Before you begin an SDN deployment, plan out and configure your physical and host network infrastructure. See the following articles:
2525

2626
- [Physical network requirements](../concepts/physical-network-requirements.md)
2727
- [Host network requirements](../concepts/host-network-requirements.md)
2828
- [Create a cluster using Windows Admin Center](../deploy/create-cluster.md)
2929
- [Create a cluster using Windows PowerShell](../deploy/create-cluster-powershell.md)
3030
- [Plan a Software Defined Network infrastructure](../concepts/plan-software-defined-networking-infrastructure.md)
3131

32-
You do not have to deploy all SDN components. See the [Phased deployment](../concepts/plan-software-defined-networking-infrastructure.md#phased-deployment) section of [Plan a Software Defined Network infrastructure](../concepts/plan-software-defined-networking-infrastructure.md) to determine which infrastructure components you need, and then run the scripts accordingly.
32+
You don't have to deploy all SDN components. See the [Phased deployment](../concepts/plan-software-defined-networking-infrastructure.md#phased-deployment) section of [Plan a Software Defined Network infrastructure](../concepts/plan-software-defined-networking-infrastructure.md) to determine which infrastructure components you need, and then run the scripts accordingly.
3333

3434
Make sure all host servers have the Azure Stack HCI operating system installed. See [Deploy the Azure Stack HCI operating system](../deploy/operating-system.md) on how to do this.
3535

@@ -48,28 +48,28 @@ The following requirements must be met for a successful SDN deployment:
4848

4949
[!INCLUDE [download-vhdx](../../includes/hci-download-vhdx.md)]
5050

51-
## Download the GitHub repository
51+
> [!NOTE]
52+
> The SDN Express script files are no longer available on GitHub.
5253
53-
The SDN Express script files live in GitHub. The first step is to get the necessary files and folders onto your deployment computer.
54+
## Install the SDN Express PowerShell module
5455

55-
1. Go to the [Microsoft SDN GitHub](https://github.com/microsoft/SDN) repository.
56+
Run the following command to install the latest version of the SDN Express PowerShell module on the machine on which you want to run the SDN installation:
5657

57-
1. In the repository, expand the **Code** drop-down list, and then choose either **Clone** or **Download ZIP** to download the SDN files to your designated deployment computer.
58+
```powershell
59+
Install-Module -Name SDNExpress
60+
```
5861

59-
> [!NOTE]
60-
> The designated deployment computer must be running Windows Server 2016 or later.
61-
62-
1. Extract the ZIP file and copy the `SDNExpress` folder to your deployment computer's `C:\` folder.
62+
The files automatically install in the default PowerShell module directory: **C:\Program Files\WindowsPowerShell\Modules\SdnExpress\**.
6363

6464
## Edit the configuration file
6565

66-
The PowerShell `MultiNodeSampleConfig.psd1` configuration data file contains all the parameters and settings that are needed for the SDN Express script as input for the various parameters and configuration settings. This file has specific information about what needs to be filled out based on whether you are deploying only the network controller component, or the software load balancer and gateway components as well. For detailed information, see [Plan a Software Defined Network infrastructure](../concepts/plan-software-defined-networking-infrastructure.md) topic.
66+
The PowerShell `MultiNodeSampleConfig.psd1` configuration data file (located at the above mentioned install path) contains all the parameters and settings that are needed for the SDN Express script as input for the various parameters and configuration settings. This file has specific information about what needs to be filled out based on whether you are deploying only the network controller component, or the software load balancer and gateway components as well. For detailed information, see [Plan a Software Defined Network infrastructure](../concepts/plan-software-defined-networking-infrastructure.md).
6767

68-
Navigate to the `C:\SDNExpress\scripts` folder and open the `MultiNodeSampleConfig.psd1` file in your favorite text editor. Change specific parameter values to fit your infrastructure and deployment:
68+
Navigate to the **C:\Program Files\WindowsPowerShell\Modules\SdnExpress\** folder and open the **MultiNodeSampleConfig.psd1** file in a text editor. Change specific parameter values to fit your infrastructure and deployment, as described in the next section.
6969

7070
### General settings and parameters
7171

72-
The settings and parameters are used by SDN in general for all deployments. For specific recommendations, see [SDN infrastructure VM role requirements](../concepts/plan-software-defined-networking-infrastructure.md#sdn-infrastructure-vm-role-requirements).
72+
These settings and parameters are used by SDN in general for all deployments. For specific recommendations, see [SDN infrastructure VM role requirements](../concepts/plan-software-defined-networking-infrastructure.md#sdn-infrastructure-vm-role-requirements).
7373

7474
- **VHDPath** - VHD file path used by all SDN infrastructure VMs (NC, SLB, GW)
7575
- **VHDFile** - VHDX file name used by all SDN infrastructure VMs
@@ -94,7 +94,7 @@ The settings and parameters are used by SDN in general for all deployments. For
9494
- **Locale** - if not specified, locale of deployment computer is used
9595
- **TimeZone** - if not specified, local time zone of deployment computer is used
9696

97-
Passwords can be optionally included if stored encrypted as text-encoded secure strings. Passwords will only be used if SDN Express scripts are run on the same computer where passwords were encrypted, otherwise it will prompt for these passwords:
97+
Passwords can be optionally included if stored encrypted as text-encoded secure strings. Passwords are only used if SDN Express scripts are run on the same computer where passwords were encrypted, otherwise it prompts for these passwords:
9898

9999
- **DomainJoinSecurePassword** - for domain account
100100
- **LocalAdminSecurePassword** - for local administrator account
@@ -104,7 +104,7 @@ Passwords can be optionally included if stored encrypted as text-encoded secure
104104

105105
A minimum of three Network Controller VMs are recommended for SDN.
106106

107-
The `NCs = @()` section is used for the Network Controller VMs. Make sure that the MAC address of each NC VM is outside the `SDNMACPool` range listed in the General settings.
107+
The `NCs = @()` section is used for the Network Controller VMs. Make sure that the MAC address of each NC VM is outside the `SDNMACPool` range listed in the general settings.
108108

109109
- **ComputerName** - name of NC VM
110110
- **HostName** - host name of server where the NC VM is located
@@ -115,7 +115,7 @@ The `NCs = @()` section is used for the Network Controller VMs. Make sure that t
115115

116116
A minimum of two Software Load Balancer VMs are recommended for SDN.
117117

118-
The `Muxes = @()` section is used for the SLB VMs. Make sure that the `MACAddress` and `PAMACAddress` parameters of each SLB VM are outside the `SDNMACPool` range listed in the General settings. Ensure that you get the `PAIPAddress` parameter from outside the PA Pool specified in the configuration file, but part of the PASubnet specified in the configuration file.
118+
The `Muxes = @()` section is used for the SLB VMs. Make sure that the `MACAddress` and `PAMACAddress` parameters of each SLB VM are outside the `SDNMACPool` range listed in the general settings. Ensure that you get the `PAIPAddress` parameter from outside the PA Pool specified in the configuration file, but part of the PASubnet specified in the configuration file.
119119

120120
Leave this section empty (`Muxes = @()`) if not deploying the SLB component:
121121

@@ -143,23 +143,24 @@ Leave this section empty (`Gateways = @()`) if not deploying the Gateway compone
143143

144144
### Additional settings for SLB and Gateway
145145

146-
The following additional parameters are used by SLB and Gateway VMs. Leave these values blank if you are not deploying SLB or Gateway VMs:
146+
The following additional parameters are used by SLB and Gateway VMs. Leave these values empty if you are not deploying SLB or Gateway VMs:
147147

148148
- **SDNASN** - Autonomous System Number (ASN) used by SDN to peer with network switches
149149
- **RouterASN** - Gateway router ASN
150150
- **RouterIPAddress** - Gateway router IP address
151151
- **PrivateVIPSubnet** - virtual IP address (VIP) for the private subnet
152152
- **PublicVIPSubnet** - virtual IP address for the public subnet
153153

154-
The following additional parameters are used by Gateway VMs only. Leave these values blank if you are not deploying Gateway VMs:
154+
The following additional parameters are only used by Gateway VMs. Leave these values blank if you are not deploying Gateway VMs:
155155

156156
- **PoolName** - pool name used by all Gateway VMs
157157
- **GRESubnet** - VIP subnet for GRE (if using GRE connections)
158158
- **Capacity** - capacity in Kbps for each Gateway VM in the pool
159159
- **RedundantCount** - number of gateways in redundant mode. The default value is 1. Redundant gateways don't have any active connections. Once an active gateway goes down, the connections from that gateway move to the redundant gateway and the redundant gateway becomes active.
160160

161-
> [!NOTE]
162-
> If you fill in a value for **RedundantCount**, ensure that the total number of gateway VMs is at least one more than the **RedundantCount**. By default, the **RedundantCount** is 1, so you must have at least 2 gateway VMs to ensure that there is at least 1 active gateway to host gateway connections.
161+
> [!NOTE]
162+
> If you fill in a value for **RedundantCount**, ensure that the total number of gateway VMs is at least one more than the **RedundantCount**. By default, the
163+
> **RedundantCount** is 1, so you must have at least 2 gateway VMs to ensure that there is at least 1 active gateway to host gateway connections.
163164
164165
### Settings for tenant overlay networks
165166

0 commit comments

Comments
 (0)