Configure and manage Azure Route Server

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

• A route server.

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

• A route server.

• Azure PowerShell.

  The steps in this article run the Azure PowerShell cmdlets.

  You can install Azure PowerShell locally to run the cmdlets. Sign in to Azure using the Connect-AzAccount -Environment AzureChinaCloud cmdlet.

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

• A route server.

• Azure CLI.

  The steps in this article run the Azure CLI commands.

  You also install Azure CLI locally to run the commands. Sign in to Azure using the az login command.

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:

   Expand table

   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 using its IP addresses and ASN. You can find the route server's IP addresses 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.

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'

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'

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' 

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' 

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.

   

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

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

Use Get-AzRouteServer cmdlet to verify the configuration.

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

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

Use az network routeserver show command to verify the configuration.

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

   

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

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

Use Get-AzRouteServer cmdlet to verify the configuration.

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'

Use az network routeserver show command to verify the configuration.

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.

   

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

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

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' 

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

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'

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' 

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.

   

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

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

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' 

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.

   

Use Remove-AzRouteServer cmdlet to delete a route server.

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

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

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