Get-BgpPeer
Get-BgpPeer
Gets configuration information for BGP peers.
Syntax
Parameter Set: Get1
Get-BgpPeer [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detaillierte Beschreibung
The Get-BgpPeer cmdlet gets configuration information for Border Gateway Protocol (BGP) peers. You can specify peers to get by using names or routing domains.
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 |
-Name<String[]>
Specifies an array of names. The cmdlet gets configuration information for the named peers.
Aliasse |
PeerList,PeerId,PeerName |
Erforderlich? |
false |
Position? |
2 |
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 multitenant 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 |
<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: Get configuration information for a peer
This command gets configuration information for the peer named TenantSite17.
PS C:\> Get-BgpPeer -Name "TenantSite17"
Example 2: Get configuration information for all peers
This command gets the configuration information for all peers.
PS C:\> Get-BgpPeer
Example 3: View formatted configuration information
This command gets configuration information for all peers, and then passes them to the Format-List cmdlet by using the pipeline operator. That cmdlet formats the output to the console. For more information, type Get-Help Format-List.
PS C:\> Get-BgpPeer "TenantSite17" | Format-List
Example 4: Get configuration information for all peers in a routing domain
This command gets configuration information for all peers of the specified routing domain. This domain contains only a single peer named Tenant46.
PS C:\> Get-BgpPeer -RoutingDomain "Rd001"