Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-BgpPeer

Add-BgpPeer

ps_bgppeer_v1.0.cdxml

Synopsis

Adds a BGP peer to the current router.

Syntax

Add-BgpPeer [-Name] [-AsJob] [-CimSession] [-HoldTimeSec] [-IdleHoldTimeSec] [-LocalASN] [-MaxAllowedPrefix] [-OperationMode] [-PassThru] [-PeeringMode] [-RoutingDomain] [-ThrottleLimit] [-Weight] [-LocalIPAddress] [-PeerASN] [-PeerIPAddress] [<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 <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

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 <SwitchParameter>

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

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#BgpPeerConfig

Notes

None

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
PeerName            LocalIPAddress      PeerIPAddress       PeerASN             OperationMode       ConnectivityStatus
--------            --------------      -------------       -------             -------------       ------------------
TenantSite22        192.168.1.10        10.1.1.10           64512               Mixed               Connecting


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 
PeerName            LocalIPAddress      PeerIPAddress       PeerASN             OperationMode       ConnectivityStatus
--------            --------------      -------------       -------             -------------       ------------------
TenantSite24        192.168.1.10        10.1.1.10           64512               Server              Stopped


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"
PeerName            LocalIPAddress      PeerIPAddress       PeerASN             OperationMode       ConnectivityStatus
--------            --------------      -------------       -------             -------------       ------------------
Tenant19            10.1.1.10           192.168.1.2         64513               Mixed               Connecting


Online Version
Get-BgpPeer
Remove-BgpPeer
Set-BgpPeer
Start-BgpPeer
Stop-BgpPeer