Get-BgpPeer
Get-BgpPeer
Gets configuration information for BGP peers.
Syntaxe
Parameter Set: Get1
Get-BgpPeer [[-Name] <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Description détaillée
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.
Paramètres
-AsJob
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-CimSession<CimSession[]>
Exécute l’applet de commande dans une session à distance ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, comme la sortie d’une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session active sur l’ordinateur local.
Alias |
Session |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Name<String[]>
Specifies an array of names. The cmdlet gets configuration information for the named peers.
Alias |
PeerList,PeerId,PeerName |
Obligatoire ? |
false |
Position ? |
2 |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
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.
Alias |
RoutingDomainName |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
True (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-ThrottleLimit<Int32>
Spécifie le nombre maximal d’opérations simultanées qui peuvent être établies pour exécuter cette applet de commande. Si ce paramètre est omis ou si la valeur 0
est entrée, Windows PowerShell ® calcule une limitation optimale pour l’applet de commande en fonction du nombre d’applets de commande CIM qui s’exécutent sur l’ordinateur. La limitation s’applique seulement à l’applet de commande actuelle, et non pas à la session ni à l’ordinateur.
Alias |
none |
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entrées
Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.
Sorties
Le type de sortie est le type des objets émis par l’applet de commande.
- Microsoft.Management.Infrastructure.CimInstance#BgpPeerConfig[]
Exemples
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"