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>]
Detaillierte Beschreibung
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.
Parameter
-AsJob
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-CimSession<CimSession[]>
Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.
Aliasse |
Session |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
180 |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-IdleHoldTimeSec<UInt16>
Specifies the time in seconds for which the BGP Peer stays in an idle state after an unsuccessful peer connection attempt.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-LocalASN<UInt32>
Specifies the ASN for the local router.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-LocalIPAddress<IPAddress>
Specifies the IP address that the local router uses for the peer connection.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-MaxAllowedPrefix<UInt32>
Specifies the maximum number of network prefixes that this router learns from its peer.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-Name<String>
Specifies a name. Provide a unique name for this peer within the routing domain.
Aliasse |
PeerName,PeerId |
Erforderlich? |
true |
Position? |
2 |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-OperationMode<OperationMode>
Specifies the BGP router mode of operation. Die folgenden Werte für diesen Parameter sind zulässig:
-- Mixed. The peer both initiates and accepts requests.
-- Server. The peer only accepts requests.
The default value is Mixed.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-PassThru
Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-PeerASN<UInt32>
Specifies the ASN for the peer.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-PeeringMode<PeeringMode>
Specifies the peering mode for the peer. Die folgenden Werte für diesen Parameter sind zulässig:
-- 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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-PeerIPAddress<IPAddress>
Specifies the IP address of the peer.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
RoutingDomainName |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-ThrottleLimit<Int32>
Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0
eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Eingaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden 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 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"