external help file | Module Name | ms.date | online version | schema | title |
---|---|---|---|---|---|
PS_BgpRouter_v1.0.cdxml-help.xml |
RemoteAccess |
12/05/2017 |
2.0.0 |
Get-BgpRouter |
Gets configuration information for BGP routers.
Get-BgpRouter [-RoutingDomain <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
[<CommonParameters>]
The Get-BgpRouter cmdlet gets router configuration information for Border Gateway Protocol (BGP) routers. In a multitenant deployment, the cmdlet adds a BGP router for the routing domain or a tenant. In a non-multitenant deployment, the cmdlet configures the BGP router for the local computer. In a multitenant deployment, you must specify the RoutingDomain parameter. In a non-multitenant deployment, do not specify the RoutingDomain parameter.
PS C:\> Get-BgpRouter
RoutingDomain :
BgpIdentifier : 192.168.1.10
LocalASN : 64513
CompareMEDAcrossASN : False
DefaultGatewayRouting : False
IPv6Routing : Disabled
LocalIPv6Address :
PeerName :
PolicyName :
This command gets the configuration information of the local BGP router.
PS C:\> Get-BgpRouter -RoutingDomain "Rd_001"
RoutingDomain : Rd_001
BgpIdentifier : 172.22.226.39
LocalASN : 64522
CompareMEDAcrossASN : False
DefaultGatewayRouting : False
IPv6Routing : Disabled
LocalIPv6Address :
PeerName : {Tenant01}
PolicyName :
This command gets the configuration information of the BGP router for the routing domain that has the ID Rd_001.
ps_cimcommon_asjob
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies an name, as a string, of a routing domain. The name of a routing domain is a unique user-defined alphanumeric string.
Type: String[]
Parameter Sets: (All)
Aliases: RoutingDomainName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).