Get-AzVirtualNetworkGatewayBGPPeerStatus

Reference

Module:: Az.Network

Lists an Azure virtual network gateway's BGP peers

Syntax

PowerShell

Get-AzVirtualNetworkGatewayBGPPeerStatus
   -VirtualNetworkGatewayName <String>
   -ResourceGroupName <String>
   [-Peer <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<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

PowerShell

Get-AzVirtualNetworkGatewayBgpPeerStatus -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.

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Peer

IP of the peer to retrieve status for

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Virtual network gateway resource group's name

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualNetworkGatewayName

Virtual network gateway name

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

Inputs

String

Outputs

PSBGPPeerStatus

Delen via