Create logical networks for Azure Stack HCI

Applies to: Azure Stack HCI, version 23H2

This article describes how to create or add logical networks for your Azure Stack HCI cluster.

Prerequisites

Before you begin, make sure to complete the following prerequisites:

Azure CLI

• Make sure to review and complete the prerequisites. If using a client to connect to your Azure Stack HCI cluster, see Connect to the cluster remotely.

• Make sure you have an external VM switch that can be accessed by all the servers in your Azure Stack HCI cluster. By default, an external switch is created during the deployment of your Azure Stack HCI cluster that you can use to associate with the logical network you will create.

  Run the following command to get the name of the external VM switch on your cluster.

  Get-VmSwitch -SwitchType External
  

  Make a note of the name of the switch. You use this information when you create a logical network. Here's a sample output:

  PS C:\Users\hcideployuser> Get-VmSwitch -SwitchType External
  Name                               SwitchType       NetAdapterInterfaceDescription
  ----                               ----------       ----------------------------
  ConvergedSwitch(management_compute_storage) External        Teamed-Interface
  PS C:\Users\hcideployuser>
  

• To create VMs with static IP addresses in your address space, add a logical network with static IP allocation. Reserve an IP range with your network admin and make sure to get the address prefix for this IP range.

Azure portal

The prerequisites for the Azure portal are the same as those for the Azure CLI. See Azure CLI.

Create the logical network

You can create a logical network using either the Azure Command-Line Interface (CLI) or by using the Azure portal.

Azure CLI

Complete the following steps to create a logical network using Azure CLI.

Sign in and set subscription

1. Connect to a server on your Azure Stack HCI system.

2. Sign in. Type:

   az login --use-device-code
   

3. Set your subscription.

   az account set --subscription <Subscription ID>
   

Create logical network via CLI

You can use the az stack-hci-vm network lnet create cmdlet to create a logical network on the VM switch for a DHCP or a static IP configuration. The parameters used to create a DHCP and a static logical network are different.

Create a static logical network via CLI

In this release, you can create virtual machines using a static IP only via the Azure CLI.

Create a static logical network when you want to create virtual machines with network interfaces on these logical networks. Follow these steps in Azure CLI to configure a static logical network:

1. Set the parameters. Here's an example:

   $lnetName = "myhci-lnet-static"
   $vmSwitchName = '"ConvergedSwitch(management_compute_storage)"'
   $subscription = "<Subscription ID>"
   $resource_group = "myhci-rg"
   $customLocationName = "myhci-cl"
   $customLocationID ="/subscriptions/$subscription/resourceGroups/$resource_group/providers/Microsoft.ExtendedLocation/customLocations/$customLocationName"
   $location = "eastus"
   $addressPrefixes = "100.68.180.0/28"
   $gateway = "192.168.200.1"
   $dnsServers = "192.168.200.222"
   

   Note

   For the default VM switch created at the deployment, pass the name string encased in double quotes followed by single quotes. For example, a default VM switch ConvergedSwitch(management_compute_storage) is passed as '"ConvergedSwitch(management_compute_storage)"'.

   For static IP, the required parameters are tabulated as follows:

   Parameters	Description
   name	Name for the logical network that you create for your Azure Stack HCI cluster. Make sure to provide a name that follows the Naming rules for Azure network resources. You can't rename a logical network after it's created.
   vm-switch-name	Name of the external virtual switch on your Azure Stack HCI cluster where you deploy the logical network.
   resource-group	Name of the resource group where you create the logical network. For ease of management, we recommend that you use the same resource group as your Azure Stack HCI cluster.
   subscription	Name or ID of the subscription where your Azure Stack HCI is deployed. This could be another subscription you use for logical network on your Azure Stack HCI cluster.
   custom-location	Use this to provide the custom location associated with your Azure Stack HCI cluster where you're creating this logical network.
   location	Azure regions as specified by az locations.
   vlan	VLAN identifier for Arc VMs. Contact your network admin to get this value. A value of 0 implies that there's no VLAN ID.
   ip-allocation-method	IP address allocation method and could be Dynamic or Static. If this parameter isn't specified, by default the logical network is created with a dynamic configuration.
   address-prefixes	Subnet address in CIDR notation. For example: "192.168.0.0/16".
   dns-servers	List of IPv4 addresses of DNS servers. Specify multiple DNS servers in a space separated format. For example: "10.0.0.5" "10.0.0.10"
   gateway	Ipv4 address of the default gateway.

   Note

   DNS server and gateway must be specified if you're creating a static logical network.

2. Create a static logical network. Run the following cmdlet:

   az stack-hci-vm network lnet create --subscription $subscription --resource-group $resource_group --custom-location $customLocationID --location $location --name $lnetName --vm-switch-name $vmSwitchName --ip-allocation-method "Static" --address-prefixes $addressPrefixes --gateway $gateway --dns-servers $dnsServers     
   

   Here's a sample output:

   {
     "extendedLocation": {
       "name": "/subscriptions/<Subscription ID>resourceGroups/myhci-rg/providers/Microsoft.ExtendedLocation/customLocations/myhci-cl",
       "type": "CustomLocation"
     },
     "id": "/subscriptions/<Subscription ID>resourceGroups/myhci-rg/providers/Microsoft.AzureStackHCI/logicalnetworks/myhci-lnet-static",
     "location": "eastus",
     "name": "myhci-lnet-static",
     "properties": {
       "dhcpOptions": {
         "dnsServers": [
           "192.168.200.222"
         ]
       },
       "provisioningState": "Succeeded",
       "status": {},
       "subnets": [
         {
           "name": "myhci-lnet-static",
           "properties": {
             "addressPrefix": "192.168.201.0/24",
             "addressPrefixes": null,
             "ipAllocationMethod": "Static",
             "ipConfigurationReferences": null,
             "ipPools": null,
             "routeTable": {
               "etag": null,
               "name": null,
               "properties": {
                 "routes": [
                   {
                     "name": "myhci-lnet-static-default-route",
                     "properties": {
                       "addressPrefix": "0.0.0.0/0",
                       "nextHopIpAddress": "192.168.200.1"
                     }
                   }
                 ]
               },
               "type": null
             },
             "vlan": null
           }
         }
       ],
       "vmSwitchName": "ConvergedSwitch(management_compute_storage)"
     },
     "resourceGroup": "myhci-rg",
     "systemData": {
       "createdAt": "2023-11-02T16:38:18.460150+00:00",
       "createdBy": "guspinto@contoso.com",
       "createdByType": "User",
       "lastModifiedAt": "2023-11-02T16:40:22.996281+00:00",
       "lastModifiedBy": "319f651f-7ddb-4fc6-9857-7aef9250bd05",
       "lastModifiedByType": "Application"
     },
     "tags": null,
     "type": "microsoft.azurestackhci/logicalnetworks"
   }
   

Once the logical network creation is complete, you're ready to create virtual machines with network interfaces on these logical networks.

Create a DHCP logical network via CLI

Create a DHCP logical network when the underlying network to which you want to connect your virtual machines has DHCP.

Follow these steps to configure a DHCP logical network:

1. Set the parameters. Here's an example using the default external switch:

   $lnetName = "myhci-lnet-dhcp"
   $vSwitchName = "ConvergedSwitch(management_compute_storage)"
   $subscription = "<subscription-id>"
   $resourceGroup = "myhci-rg"
   $customLocationName = "myhci-cl"
   $customLocationID = "/subscriptions/$subscription/resourceGroups/$resourceGroup/providers/Microsoft.ExtendedLocation/customLocations/$customLocationName"
   $location = "eastus"
   

   Note

   For the default VM switch created at the deployment, pass the name string encased in double quotes followed by single quotes. For example, a default VM switch ConvergedSwitch(management_compute_storage) is passed as '"ConvergedSwitch(management_compute_storage)"'.

   Here are the parameters that are required to create a DHCP logical network:

   Parameters	Description
   name	Name for the logical network that you create for your Azure Stack HCI cluster. Make sure to provide a name that follows the Rules for Azure resources. You can't rename a logical network after it's created.
   vm-switch-name	Name of the external virtual switch on your Azure Stack HCI cluster where you deploy the logical network.
   resource-group	Name of the resource group where you create the logical network. For ease of management, we recommend that you use the same resource group as your Azure Stack HCI cluster.
   subscription	Name or ID of the subscription where your Azure Stack HCI is deployed. This could be another subscription you use for logical network on your Azure Stack HCI cluster.
   custom-location	Use this to provide the custom location associated with your Azure Stack HCI cluster where you're creating this logical network.
   location	Azure regions as specified by az locations.
   vlan	VLAN identifier for Arc VMs. Contact your network admin to get this value. A value of 0 implies that there's no VLAN ID.

2. Run the following cmdlet to create a DHCP logical network:

   az stack-hci-vm network lnet create --subscription $subscription --resource-group $resourceGroup --custom-location $customLocationID --location $location --name $lnetName --vm-switch-name $vSwitchName --ip-allocation-method "Dynamic"
   

   Here's a sample output:

   {
     "extendedLocation": {
       "name": "/subscriptions/<Subscription ID>/resourceGroups/myhci-rg/providers/Microsoft.ExtendedLocation/customLocations/myhci-cl",
       "type": "CustomLocation"
     },
     "id": "/subscriptions/<Subscription ID>/resourceGroups/myhci-rg/providers/Microsoft.AzureStackHCI/logicalnetworks/myhci-lnet-dhcp",
     "location": "eastus",
     "name": "myhci-lnet-dhcp",
     "properties": {
       "dhcpOptions": null,
       "provisioningState": "Succeeded",
       "status": {},
       "subnets": [
         {
           "name": "myhci-lnet-dhcp",
           "properties": {
             "addressPrefix": null,
             "addressPrefixes": null,
             "ipAllocationMethod": "Dynamic",
             "ipConfigurationReferences": null,
             "ipPools": null,
             "routeTable": null,
             "vlan": 0
           }
         }
       ],
       "vmSwitchName": "ConvergedSwitch(management_compute_storage)"
     },
     "resourceGroup": "myhci-rg",
     "systemData": {
       "createdAt": "2023-11-02T16:32:51.531198+00:00",
       "createdBy": "guspinto@contoso.com",
       "createdByType": "User",
       "lastModifiedAt": "2023-11-02T23:08:08.462686+00:00",
       "lastModifiedBy": "319f651f-7ddb-4fc6-9857-7aef9250bd05",
       "lastModifiedByType": "Application"
     },
     "tags": null,
     "type": "microsoft.azurestackhci/logicalnetworks"
   }
   

Azure portal

Complete the following steps to create a logical network using Azure portal.

1. In the left pane, under Resources, select Logical networks.

   

2. In the right pane, select Create logical network.

   

3. On the Create logical network page, on the Basics tab:

   • Select the Azure subscription name.
   • Select the associated resource group name.
   • Provide a logical network name. Make sure to provide a name that follows the Rules for Azure resources. You can't rename a logical network after it's created.
   • Enter the virtual switch name that you saved earlier.
   • The geographic region is automatically set to the region where you registered your cluster.
   • The custom location is automatically populated from the cluster.

   When complete, select Next: Network Configuration.

   

Create a static logical network via portal

1. On the Network configuration tab, select Static and then enter the following:

   • IPv4 address space (previously reserved).
   • IP pools (if used).
   • Default gateway address.
   • DNS server address.
   • VLAN ID (if used).

   When complete, select Review + Create.

   

2. On the Review + Create tab, review network settings and then select Create:

   

Create a DHCP logical network via portal

1. On the Network Configuration tab, select DHCP, and then select Review + Create.

2. Enter VLAN ID if used.

   

3. On the Review + Create tab, review settings and then select Create:

   

Deploy the logical network via portal

These steps are the same for both static and DHCP network deployments.

1. Verify the network deployment job was submitted:

   

2. Verify that the deployment is in progress:

   

3. Verify the deployment job has successfully completed and then select either Pin to dashboard or Go to resource group:

   

4. In the resource group, select Overview and then verify the logical network is created and listed on the Resources tab:

   

Next steps

• Create Arc virtual machines on Azure Stack HCI