Article 10/10/2024
1 contributor
Feedback
In this article
In this article, you learn how to configure and manage Azure Route Server using the Azure portal, PowerShell, or Azure CLI.
Prerequisites
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).
Go to the route server that you want to peer with an NVA.
under Settings , select Peers .
Select + Add to add a new peer.
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.
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.
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
-PeerNameA name to identify the peer. It doesn't have to be the same name of the NVA.
-PeerAsnThe Autonomous System Number (ASN) of the NVA. For more information, see What Autonomous System Numbers (ASNs) can I use?
-PeerIpThe private IP address of the NVA.
-ResourceGroupNameThe resource group name of your route server.
-RouteServerNameThe 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
-ResourceGroupNameThe resource group name of your route server.
-RouteServerNameThe 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.
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
--nameA name to identify the peer. It doesn't have to be the same name of the NVA.
--peer-asnThe Autonomous System Number (ASN) of the NVA. For more information, see What Autonomous System Numbers (ASNs) can I use?
--peer-ipThe private IP address of the NVA.
--resource-groupThe resource group name of your route server.
--routeserverThe 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
--nameThe route server name.
--resource-groupThe 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.
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 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.
Go to the route server that you want to configure.
Under Settings , select Configuration .
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
Parameter
Value
-RouteServerNameThe route server name.
-ResourceGroupNameThe resource group name of your route server.
-AllowBranchToBranchTrafficThe 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.
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
--nameThe route server name.
--resource-groupThe resource group name of your route server.
--allow-b2b-trafficThe 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.
In this section, you learn how to configure route preference to influence the route learning and selection of your route server.
Go to the route server that you want to configure.
Under Settings , select Configuration .
Select the routing preference that you want. Available options: ExpressRoute (default), VPN , and ASPath .
Select Save
Use Update-AzRouteServer cmdlet to configure the routing preference setting of your route server.
Update-AzRouteServer -RouteServerName 'myRouteServer' -ResourceGroupName 'myResourceGroup' -HubRoutingPreference 'ASPath'
Parameter
Value
-RouteServerNameThe route server name.
-ResourceGroupNameThe resource group name of your route server.
-HubRoutingPreferenceThe routing preference. Accepted values: ExpressRoute (default), VpnGateway, and 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'
Parameter
Value
--nameThe route server name.
--resource-groupThe resource group name of your route server.
--hub-routing-preferenceThe 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.
Go to the route server that you want to peer with an NVA.
under Settings , select Peers .
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'
Parameter
Value
-PeerNameThe peer name.
-ResourceGroupNameThe resource group name of your route server.
-RouteServerNameThe route server name.
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
--nameThe peer name.
--resource-groupThe resource group name of your route server.
--routeserverThe route server name.
View advertised and learned routes
In this section, you learn how to view the route server's 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'
Parameter
Value
-PeerNameThe peer name.
-ResourceGroupNameThe resource group name of your route server.
-RouteServerNameThe route server name.
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
--nameThe peer name.
--resource-groupThe resource group name of your route server.
--routeserverThe route server name.
Delete a peer
In this section, you learn how to delete an existing peering with a network virtual appliance (NVA).
Go to the route server that you want to delete its NVA peering.
under Settings , select Peers .
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'
Parameter
Value
-PeerNameThe peer name.
-ResourceGroupNameThe resource group name of your route server.
-RouteServerNameThe route server name.
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
--nameThe peer name.
--resource-groupThe resource group name of your route server.
--routeserverThe route server name.
Delete a route server
In this section, you learn how to delete an existing route server.
Go to the route server that you want to delete.
Select Delete from the Overview page.
Select Confirm to delete the route server.
Use Remove-AzRouteServer cmdlet to delete a route server.
Remove-AzRouteServer -RouteServerName 'myRouteServer' -ResourceGroupName 'myResourceGroup'
Parameter
Value
-RouteServerNameThe route server name.
-ResourceGroupNameThe resource group name of your route server.
Use az network routeserver delete command to delete a route server.
az network routeserver delete --name 'myRouteServer' --resource-group 'myResourceGroup'
Parameter
Value
--nameThe route server name.
--resource-groupThe resource group name of your route server.
Related content
