Configure and manage Azure Route Server

In this article, you learn how to configure and manage Azure Route Server using the Azure portal, PowerShell, or Azure CLI.

Prerequisites

Portal

• An Azure account with an active subscription. Create an account for free.

• A route server.

PowerShell

• An Azure account with an active subscription. Create an account for free.

• A route server.

• Azure Cloud Shell or Azure PowerShell.

  The steps in this article run the Azure PowerShell cmdlets interactively in Azure Cloud Shell. To run the cmdlets in the Cloud Shell, select Open Cloud Shell at the upper-right corner of a code block. Select Copy to copy the code and then paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the Azure portal.

  You can also install Azure PowerShell locally to run the cmdlets. If you run PowerShell locally, sign in to Azure using the Connect-AzAccount cmdlet.

Azure CLI

• An Azure account with an active subscription. Create an account for free.

• A route server.

• Azure Cloud Shell or Azure CLI.

  The steps in this article run the Azure CLI commands interactively in Azure Cloud Shell. To run the commands in the Cloud Shell, select Open Cloud Shell at the upper-right corner of a code block. Select Copy to copy the code, and paste it into Cloud Shell to run it. You can also run the Cloud Shell from within the Azure portal.

  You can also install Azure CLI locally to run the commands. If you run Azure CLI locally, sign in to Azure using the az login command.

Add a peer

In this section, you learn how to add a BGP peering to your route server to peer with a network virtual appliance (NVA).

Portal

1. Go to the route server that you want to peer with an NVA.

2. under Settings, select Peers.

3. Select + Add to add a new peer.

4. On the Add Peer page, enter the following information:

   Setting	Value
   Name	A name to identify the peer. It doesn't have to be the same name of the NVA.
   ASN	The Autonomous System Number (ASN) of the NVA. For more information, see What Autonomous System Numbers (ASNs) can I use?
   IPv4 Address	The private IP address of the NVA.

5. Select Add to save the configuration.

   

   Once the peer NVA is successfully added, you can see it in the list of peers with a Succeeded provisioning state.

   

   To complete the peering setup, you must configure the NVA to establish a BGP session with the route server's peer IPs and ASN. You can find the route server's Peer IPs and ASN in the Overview page:

   

   Important

   We recommend peering each NVA with both route server instances to ensure that virtual network routes are advertised over the NVA connections and achieve high availability.

PowerShell

Use Add-AzRouteServerPeer cmdlet to add a new peer to the route server.

Add-AzRouteServerPeer -PeerName 'myNVA' -PeerAsn '65001' -PeerIp '10.0.0.4' -ResourceGroupName 'myResourceGroup' -RouteServerName 'myRouteServer'

Parameter	Value
-PeerName	A name to identify the peer. It doesn't have to be the same name of the NVA.
-PeerAsn	The Autonomous System Number (ASN) of the NVA. For more information, see What Autonomous System Numbers (ASNs) can I use?
-PeerIp	The private IP address of the NVA.
-ResourceGroupName	The resource group name of your route server.
-RouteServerName	The route server name. This parameter is required when there are more than one route server in the same resource group.

After you successfully add the peer NVA, you must configure the NVA to establish a BGP session with the route server's peer IPs and ASN. Use Get-AzRouteServer cmdlet to find the route server's peer IPs and ASN:

Get-AzRouteServer -ResourceGroupName 'myResourceGroup' -RouteServerName 'myRouteServer'

Parameter	Value
-ResourceGroupName	The resource group name of your route server.
-RouteServerName	The route server name. You need this parameter when there are more than one route server in the same resource group.

Important

We recommend peering each NVA with both route server instances to ensure that virtual network routes are advertised over the NVA connections and achieve high availability.

Azure CLI

Use az network routeserver peering create command to add a new peer to the route server.

az network routeserver peering create --name 'myNVA' --peer-asn '65001' --peer-ip '10.0.0.4' --resource-group 'myResourceGroup' --routeserver 'myRouteServer' 

Parameter	Value
--name	A name to identify the peer. It doesn't have to be the same name of the NVA.
--peer-asn	The Autonomous System Number (ASN) of the NVA. For more information, see What Autonomous System Numbers (ASNs) can I use?
--peer-ip	The private IP address of the NVA.
--resource-group	The resource group name of your route server.
--routeserver	The route server name.

After you successfully add the peer NVA, you must configure the NVA to establish a BGP session with the route server's peer IPs and ASN. Use az network routeserver show command to find the route server's peer IPs and ASN:

az network routeserver show --name 'myRouteServer' --resource-group 'myResourceGroup' 

Parameter	Value
--name	The route server name.
--resource-group	The resource group name of your route server.

Important

We recommend peering each NVA with both route server instances to ensure that virtual network routes are advertised over the NVA connections and achieve high availability.

Configure route exchange

In this section, you learn how to enable exchanging routes between your route server and the virtual network gateway (ExpressRoute or VPN) that exists in the same virtual network.

Important

The Azure VPN gateway must be configured in active-active mode and have the ASN set to 65515. It's not a requirement to have BGP enabled on the VPN gateway to communicate with the route server.

Warning

When you create or delete a route server in a virtual network that contains a virtual network gateway (ExpressRoute or VPN), expect downtime until the operation is complete. If you have an ExpressRoute circuit connected to the virtual network where you're creating or deleting the route server, the downtime doesn't affect the ExpressRoute circuit or its connections to other virtual networks.

Portal

1. Go to the route server that you want to configure.

2. Under Settings, select Configuration.

3. Select Enabled for the Branch-to-branch setting and then select Save.

   

PowerShell

Use Update-AzRouteServer cmdlet to enable or disable route exchange between the route server and the virtual network gateway.

Update-AzRouteServer -RouteServerName 'myRouteServer' -ResourceGroupName 'myResourceGroup' -AllowBranchToBranchTraffic 1

Parameter	Value
-RouteServerName	The route server name.
-ResourceGroupName	The resource group name of your route server.
-AllowBranchToBranchTraffic	The route exchange parameter. Accepted values: 1 and 0.

To disable route exchange, set the -AllowBranchToBranchTraffic parameter to 0.

Use Get-AzRouteServer cmdlet to verify the configuration.

Azure CLI

Use az network routeserver update command to enable or disable route exchange between the route server and the virtual network gateway.

az network routeserver peering show --name 'myRouteServer' --resource-group 'myResourceGroup' --allow-b2b-traffic true

Parameter	Value
--name	The route server name.
--resource-group	The resource group name of your route server.
--allow-b2b-traffic	The route exchange parameter. Accepted values: true and false.

To disable route exchange, set the --allow-b2b-traffic parameter to false.

Use az network routeserver show command to verify the configuration.

Configure routing preference

In this section, you learn how to configure route preference to influence the route learning and selection of your route server.

Portal

1. Go to the route server that you want to configure.

2. Under Settings, select Configuration.

3. Select the routing preference that you want. Available options: ExpressRoute (default), VPN, and ASPath.

4. Select Save

   

PowerShell

Use Update-AzRouteServer cmdlet to configure the routing preference setting of your route server.

Update-AzRouteServer -RouteServerName 'myRouteServer' -ResourceGroupName 'myResourceGroup' -HubRoutingPreference 'ASPath'

Parameter	Value
-RouteServerName	The route server name.
-ResourceGroupName	The resource group name of your route server.
-HubRoutingPreference	The routing preference. Accepted values: ExpressRoute (default), VpnGateway, and ASPath.

Use Get-AzRouteServer cmdlet to verify the configuration.

Azure CLI

Use az network routeserver update command to configure the routing preference setting of your route server.

az network routeserver peering show --name 'myRouteServer' --resource-group 'myResourceGroup' --hub-routing-preference 'ASPath'

Parameter	Value
--name	The route server name.
--resource-group	The resource group name of your route server.
--hub-routing-preference	The routing preference. Accepted values: ExpressRoute (default), VpnGateway, and ASPath.

Use az network routeserver show command to verify the configuration.

View a peer

In this section, you learn how to view the details of a peer.

Portal

1. Go to the route server that you want to peer with an NVA.

2. under Settings, select Peers.

3. In the list of peers, you can see the name, ASN, IP address, and provisioning state of any of the configured peers.

   

PowerShell

Use Get-AzRouteServerPeer cmdlet to view a route server peering.

Get-AzRouteServerPeer -PeerName 'myNVA' -ResourceGroupName 'myResourceGroup' -RouteServerName 'myRouteServer'

Parameter	Value
-PeerName	The peer name.
-ResourceGroupName	The resource group name of your route server.
-RouteServerName	The route server name.

Azure CLI

Use az network routeserver peering show command to view a route server peering.

az network routeserver peering show --name 'myNVA' --resource-group 'myResourceGroup' --routeserver 'myRouteServer' 

Parameter	Value
--name	The peer name.
--resource-group	The resource group name of your route server.
--routeserver	The route server name.

View advertised and learned routes

In this section, you learn how to view the route server's advertised and learned routes.

Portal

Use PowerShell or Azure CLI to view the advertised and learned routes.

PowerShell

Use the Get-AzRouteServerPeerAdvertisedRoute cmdlet to view routes advertised by a route server.

Get-AzRouteServerPeerAdvertisedRoute -PeerName 'myNVA' -ResourceGroupName 'myResourceGroup' -RouteServerName 'myRouteServer'

Use the Get-AzRouteServerPeerLearnedRoute cmdlet to view routes learned by a route server.

Get-AzRouteServerPeerLearnedRoute -PeerName 'myNVA' -ResourceGroupName 'myResourceGroup' -RouteServerName 'myRouteServer'

Parameter	Value
-PeerName	The peer name.
-ResourceGroupName	The resource group name of your route server.
-RouteServerName	The route server name.

Azure CLI

Use the az network routeserver peering list-advertised-routes command to view routes advertised by a route server.

az network routeserver peering list-advertised-routes --name 'myNVA' --resource-group 'myResourceGroup' --routeserver 'myRouteServer' 

Use the az network routeserver peering list-learned-routes command to view routes learned by a route server.

az network routeserver peering list-learned-routes --name 'myNVA' --resource-group 'myResourceGroup' --routeserver 'myRouteServer' 

Parameter	Value
--name	The peer name.
--resource-group	The resource group name of your route server.
--routeserver	The route server name.

Delete a peer

In this section, you learn how to delete an existing peering with a network virtual appliance (NVA).

Portal

1. Go to the route server that you want to delete its NVA peering.

2. under Settings, select Peers.

3. Select the ellipses ... next to the peer that you want to delete, and then select Delete.

   

PowerShell

Use Remove-AzRouteServerPeer cmdlet to delete a route server peering.

Get-AzRouteServerPeer -PeerName 'myNVA' -ResourceGroupName 'myResourceGroup' -RouteServerName 'myRouteServer'

Parameter	Value
-PeerName	The peer name.
-ResourceGroupName	The resource group name of your route server.
-RouteServerName	The route server name.

Azure CLI

Use az network routeserver peering delete command to delete a route server peering.

az network routeserver peering delete --name 'myNVA' --resource-group 'myResourceGroup' --routeserver 'myRouteServer' 

Parameter	Value
--name	The peer name.
--resource-group	The resource group name of your route server.
--routeserver	The route server name.

Delete a route server

In this section, you learn how to delete an existing route server.

Portal

1. Go to the route server that you want to delete.

2. Select Delete from the Overview page.

3. Select Confirm to delete the route server.

   

PowerShell

Use Remove-AzRouteServer cmdlet to delete a route server.

Remove-AzRouteServer -RouteServerName 'myRouteServer' -ResourceGroupName 'myResourceGroup'

Parameter	Value
-RouteServerName	The route server name.
-ResourceGroupName	The resource group name of your route server.

Azure CLI

Use az network routeserver delete command to delete a route server.

az network routeserver delete --name 'myRouteServer' --resource-group 'myResourceGroup'

Parameter	Value
--name	The route server name.
--resource-group	The resource group name of your route server.

Related content

• Create a route server using the Azure portal
• Configure BGP peering between a route server and (NVA)
• Monitor Azure Route Server