Get-BgpCustomRoute
Gets custom route information from the BGP router.
Syntax
RoutingDomain
Get-BgpCustomRoute
[-RoutingDomain <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
AllRoutingDomains
Get-BgpCustomRoute
[-AllRoutingDomains]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
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,
Examples
Example 1: Get all custom routes from the BGP router
PS C:\> Get-BgpCustomRoute
Interface : {Ethernet}
Network : {172.23.90.0/29}
This command gets all the interfaces and network prefixes for all custom routes from the BGP router.
Example 2: Get custom routes for a routing ___domain
PS C:\> Get-BgpCustomRoute -RoutingDomain "Rd_001"
Interface : {VS1}
Network :
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.
Parameters
-AllRoutingDomains
Use this command to retrieve details about all routing domains.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AllRoutingDomains
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RoutingDomain
Specifies the name, as a string, of a routing ___domain. The name of a routing ___domain is a unique user-defined alphanumeric string.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RoutingDomainName |
Parameter sets
RoutingDomain
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ThrottleLimit
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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.