Add-BgpPeer
Add-BgpPeer
Adds a BGP peer to the current router.
Syntax
Parameter Set: Add0
Add-BgpPeer [-Name] <String> -LocalIPAddress <IPAddress> -PeerASN <UInt32> -PeerIPAddress <IPAddress> [-AsJob] [-CimSession <CimSession[]> ] [-HoldTimeSec <UInt16> ] [-IdleHoldTimeSec <UInt16> ] [-LocalASN <UInt32> ] [-MaxAllowedPrefix <UInt32> ] [-OperationMode <OperationMode> ] [-PassThru] [-PeeringMode <PeeringMode> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Weight <UInt16> ] [ <CommonParameters>]
Detailed Description
The Add-BgpPeer cmdlet adds a Border Gateway Protocol (BGP) peer to the current router. Specify the following values for the peer:
-- A name for the peer router
-- IP address that the router uses with the peer
-- Autonomous system number (ASN) for the peer router
You can also specify the following values:
-- ASN for the local router
-- Maximum number of network prefixes that the local router instance can learn from this peer
-- Preference assigned to routes received from this peer
-- Operation mode and peering mode
-- Hold time, in seconds
Exchange of route information begins when the peering session begins. If the peering mode is Automatic, the session begins when you add the peer. If you specify a value of Manual for the PeeringMode parameter, use the Start-BgpPeer cmdlet to start the peer session.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HoldTimeSec<UInt16>
Specifies the hold time, in seconds. If this computer does not receive any messages from the peer within this period, the session expires.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
180 |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IdleHoldTimeSec<UInt16>
Specifies the time in seconds for which the BGP Peer stays in an idle state after an unsuccessful peer connection attempt.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LocalASN<UInt32>
Specifies the ASN for the local router.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LocalIPAddress<IPAddress>
Specifies the IP address that the local router uses for the peer connection.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MaxAllowedPrefix<UInt32>
Specifies the maximum number of network prefixes that this router learns from its peer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a name. Provide a unique name for this peer within the routing domain.
Aliases |
PeerName,PeerId |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperationMode<OperationMode>
Specifies the BGP router mode of operation. The acceptable values for this parameter are:
-- Mixed. The peer both initiates and accepts requests.
-- Server. The peer only accepts requests.
The default value is Mixed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PeerASN<UInt32>
Specifies the ASN for the peer.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PeeringMode<PeeringMode>
Specifies the peering mode for the peer. The acceptable values for this parameter are:
-- Automatic. Starts peering attempts automatically when added.
-- Manual. Starts peering attempts after you start the session by using the Start-BgpPeer cmdlet.
The default value is Automatic.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PeerIPAddress<IPAddress>
Specifies the IP address of the peer.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-RoutingDomain<String>
Specifies the name of the routing domain as a string. The name is a unique, for the multi-tenant gateway, user-defined alphanumeric string.
Aliases |
RoutingDomainName |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Weight<UInt16>
Specifies the preference, as an integer, assigned to routes received from this peer. Higher values have higher priority. The default value is 32768.
Aliases |
none |
Required? |
false |
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#BgpPeerConfig
Examples
Example 1: Add a peer
This command adds a BGP peer, named TenantSite22, to the router. The command specifies the IP addresses for the router and the peer, and the peer ASN. The command selects the default value of Automatic for the peering mode. The command includes the PassThru parameter, so it passes the new object to the console.
PS C:\> Add-BgpPeer -Name "TenantSite22" -LocalIPAddress 192.168.1.10 -PeerASN 64512 -PeerIPAddress 10.1.1.10 -PassThru
Example 2: Add a peer that uses manual peering mode
This command adds a BGP peer, named TenantSite24, to the router. The command specifies the IP addresses for the router and the peer, and the peer ASN. The command specifies the PeeringMode and OperationsMode parameters. Because the command specifies a value of Manual for the PeeringMode parameter, the router drops incoming connections until you start the peering. The command includes the PassThru parameter, so it passes the new object to the console.
PS C:\> Add-BgpPeer -Name "TenantSite23" -LocalIPAddress 192.168.1.10 -PeerASN 64512 -PeerIPAddress 10.1.1.10 -OperationMode Server -PassThru -PeeringMode Manual
Example 3: Add a peer and specify a routing domain
This command adds a BGP peer, named Tenant19, to the router. The command specifies the IP addresses for the router and the peer, and the peer ASN. The command also specifies the routing domain as RD001. The command includes the PassThru parameter, so it passes the new object to the console.
PS C:\> Add-BgpPeer -Name "Tenant19" -LocalIPAddress 10.1.1.10 -PeerASN 64513 -PeerIPAddress 192.168.1.2 -PassThru -RoutingDomain "RD001"