Set-BgpRouter
Set-BgpRouter
Modifies the local BGP router configuration.
Syntax
Parameter Set: Set3
Set-BgpRouter [-AsJob] [-BgpIdentifier <IPAddress> ] [-CimSession <CimSession[]> ] [-CompareMEDAcrossASN <Boolean> ] [-DefaultGatewayRouting <Boolean> ] [-Force] [-IPv6Routing <IPv6RoutingState> ] [-LocalASN <UInt32> ] [-LocalIPv6Address <IPAddress> ] [-PassThru] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-BgpRouter cmdlet modifies the configuration of the local Border Gateway Protocol (BGP) router for a tenant. You can modify the IPv4 address of a local BGP router, specify whether the BGP router compares Multi-Exit Discriminator (MED) values across different autonomous systems, and specify whether the cmdlet enables routing of the unresolvable routes to the default gateway. You can also modify the state of IPv6 routing for the BGP router and the IPv6 address of a local BGP router.
Use the Get-BgpRouter cmdlet to see the current settings.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-BgpIdentifier<IPAddress>
Specifies the IPv4 address of a local BGP router.
Aliases |
none |
Required? |
false |
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.
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 |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IPv6Routing<IPv6RoutingState>
Specifies the state of IPv6 routing for the BGP router. The acceptable values for this parameter are:
-- Enable
-- Disable
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LocalASN<UInt32>
Specifies the autonomous system number (ASN) for the local router.
Aliases |
none |
Required? |
false |
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 routing domain. The name of a routing domain is a user-defined alphanumeric string. It 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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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: Modify the configuration of the local BGP router
This command modifies the configuration of the local BGP router and restarts all the active BGP peerings. The command specifies that the ASN of the local BGP router instance is 64513. The command prompts the user for confirmation before it modifies the configuration of the router. The command includes the PassThru parameter, so the command sends a BgpRouterConfig object to the console.
PS C:\> Set-BgpRouter -LocalASN 64513 -PassThru
Example 2: Modify the configuration of the local BGP router without confirmation
This command modifies the configuration of the local BGP router and restarts all the active BGP peerings. The command specifies that the ASN of the local BGP router instance is 64513. The command does not prompt the user for confirmation before it modifies the configuration of the router.
PS C:\> Set-BgpRouter -LocalASN 64513 -Force -PassThru
Example 3: Modify the configuration of a BGP router in a routing domain
This command modifies the configuration of the BGP router for the routing domain named Rd_001. The command specifies the IP address of the local BGP router for the routing domain, and it specifies that the ASN of the local BGP router instance is 64522.
PS C:\> Set-BgpRouter -RoutingDomain "Rd_001" -BgpIdentifier 10.1.1.10 -LocalASN 64522 -PassThru