Remove-BgpCustomRoute

Remove-BgpCustomRoute

Removes custom routes from the BGP router.

Syntaxe

Parameter Set: Remove2
Remove-BgpCustomRoute [-AsJob] [-CimSession <CimSession[]> ] [-Force] [-Interface <String[]> ] [-Network <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Description détaillée

The Remove-BgpCustomRoute cmdlet removes Classless InterDomain Routing (CIDR) prefixes or interfaces for custom routes from the Border Gateway Protocol (BGP) routing table. When you remove a custom route, the BGP router can no longer use the information from the CIDR network or interface to distribute routing information between autonomous systems (AS). In addition, the BGP router sends route withdrawal messages to peers to remove the previously advertised custom routes that you remove.

You must specify at least one of the Interface or Network parameters.

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

-Interface<String[]>

Specifies an array of names of router interfaces. The cmdlet removes the static routes for these interfaces from the BGP routing table.

Alias

none

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

-Network<String[]>

Specifies an array of network prefixes, in Classless InterDomain Routing (CIDR) notation. For IPv4 networks, you must specify the network prefix and its network mask. The cmdlet removes the routing information for the network prefixes from the BGP routing table.

Alias

DestinationNetwork

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

-RoutingDomain<String>

Specifies the name, as a string, of a routing domain. The name of a routing domain is a unique 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 a network prefix

This command removes the network prefix of a custom network from the BGP routing table.

PS C:\> Remove-BgpCustomRoute -Network "172.23.90.0/29"

Example 2: Remove the interface for a routing domain

This command removes the router interface named VS01 from the BGP routing table for the routing domain named Rd_002.

PS C:\> Remove-BgpCustomRoute -Interface "VS01" -RoutingDomain Rd_002

Rubriques connexes

Add-BgpCustomRoute

Add-BgpCustomRoute