Get-​Azure​Rm​Virtual​Network​Gateway​BG​PPeer​Status

Lists an Azure virtual network gateway's BGP peers

Syntax

Get-AzureRmVirtualNetworkGatewayBGPPeerStatus
   [-Peer <String>]
   -ResourceGroupName <String>
   -VirtualNetworkGatewayName <String>
   [<CommonParameters>]

Description

This command enumerates BGP peers an Azure virtual network gateway is configured to peer with. The status of each peer is also given.

Examples

Example 1

PS C:\> Get-AzureRmVirtualNetworkGatewayBgpPeerStatus -ResourceGroupName resourceGroup -VirtualNetworkGatewayName gatewayName

Asn               : 65515
ConnectedDuration : 9.01:04:53.5768637
LocalAddress      : 10.1.0.254
MessagesReceived  : 14893
MessagesSent      : 14900
Neighbor          : 10.0.0.254
RoutesReceived    : 1
State             : Connected

Retrieves BGP peers for the Azure virtual network gateway named gatewayName in resource group resourceGroup.

This example output shows one connected BGP peer, with an IP of 10.0.0.254.

Required Parameters

-ResourceGroupName

Virtual network gateway resource group's name

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VirtualNetworkGatewayName

Virtual network gateway name

Type:String
Aliases:ResourceName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Peer

IP of the peer to retrieve status for

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Inputs

System.String

Outputs

Microsoft.Azure.Commands.Network.Models.PSBGPPeerStatus[]