Skip to content

Commit d055e33

Browse files
authored
Update sdn-express.md
1 parent 7159012 commit d055e33

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

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

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ ms.reviewer: anirbanpaul
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

@@ -52,21 +52,24 @@ The following requirements must be met for a successful SDN deployment:
5252
> The SDN Express script files are no longer available on GitHub.
5353
5454
## Install the SDN Express PowerShell module
55-
Run the following command to install the latest version of the SDN Express PowerShell module on the machine where you want to run the SDN installation:
55+
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:
57+
5658
```powershell
5759
Install-Module -Name SDNExpress
5860
```
59-
The files automatically install in the default PowerShell module directory: `C:\Program Files\WindowsPowerShell\Modules\SdnExpress\`
61+
62+
The files automatically install in the default PowerShell module directory: **C:\Program Files\WindowsPowerShell\Modules\SdnExpress\**.
6063

6164
## Edit the configuration file
6265

63-
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) 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).
6467

65-
Navigate to the 'C:\Program Files\WindowsPowerShell\Modules\SdnExpress\` 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.
6669

6770
### General settings and parameters
6871

69-
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).
7073

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

94-
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:
9598

9699
- **DomainJoinSecurePassword** - for domain account
97100
- **LocalAdminSecurePassword** - for local administrator account
@@ -101,7 +104,7 @@ Passwords can be optionally included if stored encrypted as text-encoded secure
101104

102105
A minimum of three Network Controller VMs are recommended for SDN.
103106

104-
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.
105108

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

113116
A minimum of two Software Load Balancer VMs are recommended for SDN.
114117

115-
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.
116119

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

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

141144
### Additional settings for SLB and Gateway
142145

143-
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:
144147

145148
- **SDNASN** - Autonomous System Number (ASN) used by SDN to peer with network switches
146149
- **RouterASN** - Gateway router ASN
147150
- **RouterIPAddress** - Gateway router IP address
148151
- **PrivateVIPSubnet** - virtual IP address (VIP) for the private subnet
149152
- **PublicVIPSubnet** - virtual IP address for the public subnet
150153

151-
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:
152155

153156
- **PoolName** - pool name used by all Gateway VMs
154157
- **GRESubnet** - VIP subnet for GRE (if using GRE connections)
155158
- **Capacity** - capacity in Kbps for each Gateway VM in the pool
156159
- **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.
157160

158-
> [!NOTE]
159-
> 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.
160164
161165
### Settings for tenant overlay networks
162166

0 commit comments

Comments
 (0)