Get-BgpCustomRoute
Get-BgpCustomRoute
Gets custom route information from the BGP router.
Syntax
Parameter Set: Get1
Get-BgpCustomRoute [-AsJob] [-CimSession <CimSession[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
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,
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
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.
Aliases |
RoutingDomainName |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#BgpCustomNetworkInfo
Examples
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"