Add-Bgp
Syntax
Add-BgpPeer
[-Name] <String>
-LocalIPAddress <IPAddress>
-PeerIPAddress <IPAddress>
[-LocalASN <UInt32>]
-PeerASN <UInt32>
[-OperationMode <OperationMode>]
[-PeeringMode <PeeringMode>]
[-HoldTimeSec <UInt16>]
[-IdleHoldTimeSec <UInt16>]
[-MaxAllowedPrefix <UInt32>]
[-PassThru]
[-RoutingDomain <String>]
[-Weight <UInt16>]
[-RouteReflectorClient <Boolean>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]Description
The Add-BgpPeer cmdlet adds a new peer to the Border Gateway Protocol (BGP router). This cmdlet returns error information if errors occur while adding the peer configuration.
Examples
Example 1: Add a BGP peer to the BGP router and establish a session
PS C:\>Add-BgpPeer -Name "RedTenantSite1" -LocalIPAddress 192.168.1.10 -PeerIPAddress 14.1.1.10 -PeerASN 64512 -PassThru
PeerName LocalIPAddress PeerIPAddress PeerASN OperationMode ConnectivityStatus
-------- -------------- ------------- ------- ------------- ------------------
RedTenantSite1 192.168.1.10 14.1.1.10 64512 Mixed ConnectingThis command adds a BGP peer to the BGP router and automatically starts establishing BGP peering session with that neighbor.
Example 2: Add a BGP peer to a BGP router that will listen for incoming connections
PS C:\>Add-BgpPeer -Name "RedTenantSite1" -LocalIPAddress 192.168.1.10 -PeerIPAddress 14.1.1.10 -PeerASN 64512 -OperationMode Server -PeeringMode Manual -PassThru
PeerName LocalIPAddress PeerIPAddress PeerASN OperationMode ConnectivityStatus
-------- -------------- ------------- ------- ------------- ------------------
RedTenantSite1 192.168.1.10 14.1.1.10 64512 Server StoppedThis command adds a new BGP Peer to the BGP router which will listen for incoming connections from neighbor. PeeringMode is set to Manual, so unless this peering is started manually, the incoming connections requests will be dropped.
Example 3: Add a BGP peer to a BGP router of a specified routing domain
PS C:\>Add-BgpPeer -RoutingDomain Rd_001 -Name BlueTenant1 -LocalIPAddress 14.1.1.10 -PeerIPAddress 192.168.1.2 -PeerASN 64513 -PassThru
PeerName LocalIPAddress PeerIPAddress PeerASN OperationMode ConnectivityStatus
-------- -------------- ------------- ------- ------------- ------------------
BlueTenant1 14.1.1.10 192.168.1.2 64513 Mixed ConnectingThis command adds a new BGP Peer to the BGP Router of the specified routing domain in Multi-tenant environment and automatically starts establishing BGP peering session.
Example 4: Add a Route Reflector client BGP peer to a BGP router
PS C:\>Add-BgpPeer -Name RRClient1 -LocalIPAddress 14.1.1.10 -PeerIPAddress 192.168.1.2 -PeerASN 64513 -PassThru -RouteReflectorClient $true
PeerName LocalIPAddress PeerIPAddress PeerASN OperationMode ConnectivityStatus
-------- -------------- ------------- ------- ------------- ------------------
RRClient1 14.1.1.10 192.168.1.2 64513 Mixed ConnectedThis command adds a new Route Reflector client BGP Peer to the BGP Router and automatically starts establishing BGP peering session.
Required Parameters
Specifies the local BGP Router's peering IP Address. It can be IPv4 or IPv6 address type.
| Type: | IPAddress |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the unique name for the peering with specified BGP neighbor.
| Type: | String |
| Aliases: | PeerName, PeerId |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the neighbor BGP Router's AS Number.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the neighbor BGP router's peering IP address. It can be of IPv4 or IPv6 address type.
| Type: | IPAddress |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Optional Parameters
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the configured value of HoldTime in seconds after the BGP session expires if no BGP message is received.
| Type: | UInt16 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the configured value of IdleHoldTime in seconds after the BGP Session expires if no BGP message is received.
| Type: | UInt16 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the local autonomous systems (AS) number of the BGP router instance for this peer.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the maximum number of allowed IPv4 or IPv6 network prefixes that can be learned from the given neighbor.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the BGP Router's mode of operation. Operating modes include:
- Peering Initiator as well as peering acceptor
- Only acting as a passive peering request acceptor.
| Type: | OperationMode |
| Parameter Sets: | Mixed, Server |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the parameter to configure peering mode for the given peer.
| Type: | PeeringMode |
| Parameter Sets: | Automatic, Manual |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies whether the current peer is a Route Reflector client peer or non-client peer.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the user-defined unique alphanumeric identifier for the routing domain.
| Type: | String |
| Aliases: | RoutingDomainName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used. The throttle limit applies only to the current command, not to the session or to the computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies administrative preference assigned to the routes received from this peer.
| Type: | UInt16 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Outputs
Microsoft.Management.Infrastructure.CimInstance#BgpPeerConfig