Get-NsxLogicalRouterBgpNeighbour

NAME Get-NsxLogicalRouterBgpNeighbour



SYNOPSIS

Returns BGP neighbours from the specified NSX LogicalRouter BGP

configuration.





SYNTAX

Get-NsxLogicalRouterBgpNeighbour [-LogicalRouterRouting] <XmlElement> [[-Network] <String>] [[-IpAddress]

<IPAddress>] [[-RemoteAS] <Int32>] [<CommonParameters>]





DESCRIPTION

An NSX Logical Router is a distributed routing function implemented within

the ESXi kernel, and optimised for east west routing.



Logical Routers perform ipv4 and ipv6 routing functions for connected

networks and support both static and dynamic routing via OSPF and BGP.



The Get-NsxLogicalRouterBgpNeighbour cmdlet retrieves the BGP neighbours from the

BGP configuration specified.





PARAMETERS

-LogicalRouterRouting <XmlElement>



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Network <String>



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-IpAddress <IPAddress>



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RemoteAS <Int32>



Required? false

Position? 4

Default value 0

Accept pipeline input? false

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get all BGP neighbours defined on LogicalRouter01



PS C:\\> Get-NsxLogicalRouter LogicalRouter01 | Get-NsxLogicalRouterRouting | Get-NsxLogicalRouterBgpNeighbour









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get BGP neighbour 1.1.1.1 defined on LogicalRouter01



PS C:\\> Get-NsxLogicalRouter LogicalRouter01 | Get-NsxLogicalRouterRouting | Get-NsxLogicalRouterBgpNeighbour

-IpAddress 1.1.1.1









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get all BGP neighbours with Remote AS 1234 defined on LogicalRouter01



PS C:\\> Get-NsxLogicalRouter LogicalRouter01 | Get-NsxLogicalRouterRouting | Get-NsxLogicalRouterBgpNeighbour |

where-object { $_.RemoteAS -eq '1234' }











RELATED LINKS