Add-BgpRouter
Add-BgpRouter
Adds a BGP router.
Syntax
Parameter Set: Add0
Add-BgpRouter -BgpIdentifier <IPAddress> -LocalASN <UInt32> [-AsJob] [-CimSession <CimSession[]> ] [-CompareMEDAcrossASN <Boolean> ] [-DefaultGatewayRouting <Boolean> ] [-IPv6Routing <IPv6RoutingState> ] [-LocalIPv6Address <IPAddress> ] [-PassThru] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Add-BgpRouter cmdlet adds a Border Gateway Protocol (BGP) router. 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.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-BgpIdentifier<IPAddress>
Specifies the Internet IPv4 address of a local BGP router.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
-CompareMEDAcrossASN<Boolean>
Indicates whether the BGP router compares Multi-Exit Discriminator (MED) values across different autonomous systems (AS).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DefaultGatewayRouting<Boolean>
Indicates whether the cmdlet enables routing of the unresolvable routes to the default gateway.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IPv6Routing<IPv6RoutingState>
Specifies the state of IPv6 routing for the BGP router. The acceptable values for this parameter are:
-- Enabled
-- Disabled
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LocalASN<UInt32>
Specifies the local autonomous system number (ASN) for the local router.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LocalIPv6Address<IPAddress>
Specifies the Internet IPv6 address of a local BGP router. This parameter specifies the global or site-local Internet IPv6 address for the local BGP router. The BGP router uses this IP address as the next hop value in the IPv6 route advertisements.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
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 tenant. The ID of a routing domain is a user-defined alphanumeric string. A routing domain ID must be unique.
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#BgpRouterConfig
Examples
Example 1: Add a local BGP router
This command adds a local BGP router for a tenant. The command specifies the IP address and ASN of the local router.
PS C:\> Add-BgpRouter -BgpIdentifier "192.168.1.10" -LocalASN 64522 -PassThru
Example 2: Add a local BGP router for a routing domain
This command adds a local BGP router in a multi-tenant environment for the routing domain named Rd_001. The command specifies a local BGP router that has the IP address 14.1.1.10, and specifies the BGP router instance that has the local autonomous system number 64522.
PS C:\> Add-BgpRouter -RoutingDomain "Rd_001" -BgpIdentifier "10.1.1.10" -LocalASN 64522 -PassThru