Get-BgpCustomRoute

Get-BgpCustomRoute

Gets custom route information from the BGP router.

Syntaxe

Parameter Set: Get1
Get-BgpCustomRoute [-AsJob] [-CimSession <CimSession[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Description détaillée

The Get-BgpCustomRoute cmdlet gets custom route information from the Border Gateway Protocol (BGP) routing table. The cmdlet returns the interface and network mask for the custom routes from the BGP routing table. Custom routes are routes that an administrator configures and adds from a routing interface or network mask to the BGP routing table. If the BGP router is in a multitenant deployment, you must specify the RoutingDomain parameter. If the BGP router is not in a multitenant deployment, do not specify the RoutingDomain parameter,

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

-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

<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#BgpCustomNetworkInfo

Exemples

Example 1: Get all custom routes from the BGP router

This command gets all the interfaces and network prefixes for all custom routes from the BGP router.

PS C:\> Get-BgpCustomRoute

Example 2: Get custom routes for a routing domain

This command gets the interfaces and network prefixes for all custom routes from the BGP router for the routing domain named Rd_001 in a multi-tenant environment.

PS C:\> Get-BgpCustomRoute -RoutingDomain "Rd_001"

Rubriques connexes

Add-BgpCustomRoute

Remove-BgpCustomRoute