You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: azure-stack/hci/manage/sdn-express.md
+25-24Lines changed: 25 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,33 +3,33 @@ title: Deploy an SDN infrastructure using SDN Express
3
3
description: Learn to deploy an SDN infrastructure using SDN Express
4
4
author: sethmanheim
5
5
ms.topic: how-to
6
-
ms.date: 11/29/2023
6
+
ms.date: 11/07/2024
7
7
ms.author: sethm
8
-
ms.reviewer: JasonGerend
8
+
ms.reviewer: anirbanpaul
9
9
---
10
10
11
11
# Deploy an SDN infrastructure using SDN Express
12
12
13
13
> Applies to: Azure Stack HCI, versions 22H2 and 21H2; Windows Server 2022, Windows Server 2019, Windows Server 2016
14
14
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.
16
16
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).
18
18
19
19
> [!IMPORTANT]
20
20
> You can't use Microsoft System Center Virtual Machine Manager 2019 to manage clusters running Azure Stack HCI, version 21H2 or Windows Server 2022.
21
21
22
22
## Before you begin
23
23
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:
-[Create a cluster using Windows Admin Center](../deploy/create-cluster.md)
29
29
-[Create a cluster using Windows PowerShell](../deploy/create-cluster-powershell.md)
30
30
-[Plan a Software Defined Network infrastructure](../concepts/plan-software-defined-networking-infrastructure.md)
31
31
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.
33
33
34
34
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.
35
35
@@ -48,28 +48,28 @@ The following requirements must be met for a successful SDN deployment:
> The SDN Express script files are no longer available on GitHub.
52
53
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
54
55
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:
56
57
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
+
```
58
61
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\**.
63
63
64
64
## Edit the configuration file
65
65
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).
67
67
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.
69
69
70
70
### General settings and parameters
71
71
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).
73
73
74
74
-**VHDPath** - VHD file path used by all SDN infrastructure VMs (NC, SLB, GW)
75
75
-**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
94
94
-**Locale** - if not specified, locale of deployment computer is used
95
95
-**TimeZone** - if not specified, local time zone of deployment computer is used
96
96
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:
98
98
99
99
-**DomainJoinSecurePassword** - for domain account
100
100
-**LocalAdminSecurePassword** - for local administrator account
@@ -104,7 +104,7 @@ Passwords can be optionally included if stored encrypted as text-encoded secure
104
104
105
105
A minimum of three Network Controller VMs are recommended for SDN.
106
106
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.
108
108
109
109
-**ComputerName** - name of NC VM
110
110
-**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
115
115
116
116
A minimum of two Software Load Balancer VMs are recommended for SDN.
117
117
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.
119
119
120
120
Leave this section empty (`Muxes = @()`) if not deploying the SLB component:
121
121
@@ -143,23 +143,24 @@ Leave this section empty (`Gateways = @()`) if not deploying the Gateway compone
143
143
144
144
### Additional settings for SLB and Gateway
145
145
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:
147
147
148
148
-**SDNASN** - Autonomous System Number (ASN) used by SDN to peer with network switches
149
149
-**RouterASN** - Gateway router ASN
150
150
-**RouterIPAddress** - Gateway router IP address
151
151
-**PrivateVIPSubnet** - virtual IP address (VIP) for the private subnet
152
152
-**PublicVIPSubnet** - virtual IP address for the public subnet
153
153
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:
155
155
156
156
-**PoolName** - pool name used by all Gateway VMs
157
157
-**GRESubnet** - VIP subnet for GRE (if using GRE connections)
158
158
-**Capacity** - capacity in Kbps for each Gateway VM in the pool
159
159
-**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.
160
160
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.
0 commit comments