Get-AzureRmVirtualNetworkGatewayBGPPeerStatus

NAME Get-AzureRmVirtualNetworkGatewayBGPPeerStatus



SYNOPSIS

Lists an Azure virtual network gateway's BGP peers





SYNTAX

Get-AzureRmVirtualNetworkGatewayBGPPeerStatus [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-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.





PARAMETERS

-AsJob [<SwitchParameter>]

Run cmdlet in the background



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Peer <String>

IP of the peer to retrieve status for



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Virtual network gateway resource group's name



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VirtualNetworkGatewayName <String>

Virtual network gateway name



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String







OUTPUTS

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







NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... peerstatus