Add-BgpPeer

Add-BgpPeer

Adds a new BGP peer.

Syntax

Parameter Set: Add0
Add-BgpPeer [-Name] <String> -LocalIPAddress <IPAddress> -PeerASN <UInt32> -PeerIPAddress <IPAddress> [-CimSession <CimSession[]> ] [-HoldTimeSec <UInt16> ] [-IdleHoldTimeSec <UInt16> ] [-InformationAction <ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <String> ] [-LocalASN <UInt32> ] [-MaxAllowedPrefix <UInt32> ] [-OperationMode <OperationMode> {Mixed | Server} ] [-PassThru] [-PeeringMode <PeeringMode> {Automatic | Manual} ] [-RouteReflectorClient <Boolean> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Weight <UInt16> ] [ <CommonParameters>] [ <WorkflowParameters>]

Detaillierte Beschreibung

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.

Parameter

-CimSession<CimSession[]>

Das Cmdlet wird in einer Remotesitzung oder auf einem Remotecomputer ausgeführt. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, wie z. B. die Ausgabe eines New-CimSession oder Get-CimSession-Cmdlets. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

Aliase	Session
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-HoldTimeSec<UInt16>

Specifies the configured value of HoldTime in seconds after the BGP session expires if no BGP message is received.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-IdleHoldTimeSec<UInt16>

Specifies the configured value of IdleHoldTime in seconds after the BGP Session expires if no BGP message is received.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-InformationAction<ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

Aliase	infa
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-InformationVariable<String>

Specifies a variable in which to store an information event message.

Aliase	iv
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-LocalASN<UInt32>

Specifies the local autonomous systems (AS) number of the BGP router instance for this peer.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-LocalIPAddress<IPAddress>

Specifies the local BGP Router's peering IP Address. It can be IPv4 or IPv6 address type.

Aliase	none
Erforderlich?	true
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-MaxAllowedPrefix<UInt32>

Specifies the maximum number of allowed IPv4 or IPv6 network prefixes that can be learned from the given neighbor.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-Name<String>

Specifies the unique name for the peering with specified BGP neighbor.

Aliase	PeerName,PeerId
Erforderlich?	true
Position?	2
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-OperationMode<OperationMode>

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.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-PassThru

Gibt ein Objekt an, das das Element darstellt, mit dem Sie arbeiten. Dieses Cmdlet generiert standardmäßig keine Ausgabe.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-PeerASN<UInt32>

Specifies the neighbor BGP Router's AS Number.

Aliase	none
Erforderlich?	true
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-PeeringMode<PeeringMode>

Specifies the parameter to configure peering mode for the given peer.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-PeerIPAddress<IPAddress>

Specifies the neighbor BGP router's peering IP address. It can be of IPv4 or IPv6 address type.

Aliase	none
Erforderlich?	true
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-RouteReflectorClient<Boolean>

Specifies whether the current peer is a Route Reflector client peer or non-client peer.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-RoutingDomain<String>

Specifies the user-defined unique alphanumeric identifier for the routing domain.

Aliase	RoutingDomainName
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-ThrottleLimit<Int32>

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.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Weight<UInt16>

Specifies administrative preference assigned to the routes received from this peer.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	true(ByPropertyName)
Platzhalterzeichen akzeptieren?	false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

<WorkflowParameters>

Eingaben

Der Eingabetyp ist der Typ der Objekte, die Sie per Piping an das Cmdlet übergeben können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

• Microsoft.Management.Infrastructure.CimInstance#BgpPeerConfig

Beispiele

Example 1: Add a BGP peer to the BGP router and establish a session

This command adds a BGP peer to the BGP router and automatically starts establishing BGP peering session with that neighbor.

PS C:\> Add-BgpPeer -Name "RedTenantSite1" -LocalIPAddress 192.168.1.10 -PeerIPAddress 14.1.1.10 -PeerASN 64512 -PassThru

Example 2: Add a BGP peer to a BGP router that will listen for incoming connections

This 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.

PS C:\> Add-BgpPeer -Name "RedTenantSite1" -LocalIPAddress 192.168.1.10 -PeerIPAddress 14.1.1.10 -PeerASN 64512  -OperationMode Server -PeeringMode Manual -PassThru

Example 3: Add a BGP peer to a BGP router of a specified routing domain

This 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.

PS C:\> Add-BgpPeer -RoutingDomain Rd_001 -Name BlueTenant1 -LocalIPAddress 14.1.1.10 -PeerIPAddress 192.168.1.2 -PeerASN 64513 -PassThru

Example 4: Add a Route Reflector client BGP peer to a BGP router

This command adds a new Route Reflector client BGP Peer to the BGP Router and automatically starts establishing BGP peering session.

PS C:\> Add-BgpPeer -Name RRClient1 -LocalIPAddress 14.1.1.10 -PeerIPAddress 192.168.1.2 -PeerASN 64513 –PassThru –RouteReflectorClient $true

Verwandte Themen

Get-BgpPeer

Remove-BgpPeer

Set-BgpPeer

Start-BgpPeer

Stop-BgpPeer