Remove-BgpPeer
Remove-BgpPeer
Removes BGP peers from a router.
Syntaxe
Parameter Set: Remove2
Remove-BgpPeer [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Description détaillée
The Remove-BgpPeer cmdlet removes Border Gateway Protocol (BGP) peers from a BGP router. Specify a peer to remove by using its name. This cmdlet does not uninstall the peer router software. When you remove a peer, the router removes all information collected from the peer.
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 |
-Force
Force la commande à s’exécuter sans demander confirmation à l’utilisateur.
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 |
-Name<String[]>
Specifies an array of names. The cmdlet removes the named peers.
Alias |
PeerList,PeerId,PeerName |
Obligatoire ? |
true |
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 |
-Confirm
Votre confirmation sera requise avant l’exécution de l’applet de commande.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l’entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-WhatIf
Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
false |
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.
Exemples
Example 1: Remove specified peers
This command removes the peers named TenantSite22 and TenantSite23. This command does not specify the Force parameter, so it prompts you before it removes the peers.
PS C:\> Remove-BgpPeer -Name TenantSite22,TenantSite23
Example 2: Remove all peers
This command gets all the peers by using the Get-BgpPeer cmdlet, and passes them to the current cmdlet by using the pipeline operator. The command removes all the peers. Because the command specifies the Force parameter, it does not prompt you for confirmation before it removes the peers.
PS C:\> Get-BgpPeer | Remove-BgpPeer -Force
Example 3: Remove all peers in a routing domain
This command removes the peer named Tenant16 in the routing domain Rd001 without prompting you for confirmation.
PS C:\> Remove-BgpPeer -Name "Tenant16" -Force -RoutingDomain "Rd001"