Set-Bgp Router

Module:
remoteaccess
Updates the configuration of the local BGP router for the specified tenant ID.

Syntax 

Set-BgpRouter
   [-BgpIdentifier <IPAddress>]
   [-LocalASN <UInt32>]
   [-CompareMEDAcrossASN <Boolean>]
   [-DefaultGatewayRouting <Boolean>]
   [-IPv6Routing <IPv6RoutingState>]
   [-RoutingDomain <String>]
   [-PassThru]
   [-Force]
   [-LocalIPv6Address <IPAddress>]
   [-TransitRouting <TransitRouting>]
   [-RouteReflector <RouteReflector>]
   [-ClusterId <UInt32>]
   [-ClientToClientReflection <ClientToClientReflection>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-BgpRouter cmdlet updates the local Border Gateway Protocol (BGP) router configuration. Error information will be returned if errors occur while modifying the BGP router configuration.

Examples

Example 1: Set the local BGP router with confirmation 

PS C:\>Set-BgpRouter -LocalASN 64513 -PassThru
Confirm
One or more BGP peering sessions are active. Applying changes will restart these sessions. Do you want to continue? 
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y

RoutingDomain         : 
BgpIdentifier         : 192.168.1.10
LocalASN              : 64513
CompareMEDAcrossASN   : False
DefaultGatewayRouting : False
IPv6Routing           : Disabled
LocalIPv6Address      : 
PeerName              : 
PolicyName            :

This command prompts the user for confirmation and on confirmation from user, updates, and then modifies the configuration of the local BGP router and restarts all the active BGP peerings.

Example 2: Update and modify the local BGP router 

PS C:\>Set-BgpRouter -LocalASN 64513 -Force -PassThru
RoutingDomain         : 
BgpIdentifier         : 192.168.1.10
LocalASN              : 64513
CompareMEDAcrossASN   : False
DefaultGatewayRouting : False
IPv6Routing           : Disabled
LocalIPv6Address      : 
PeerName              : 
PolicyName            :

This command updates and modifies the configuration of the local BGP router and restarts all the active BGP Peerings.

Example 3: Update and modify the configuration of a BGP router for the specified routing domain 

PS C:\>Set-BgpRouter -RoutingDomain Rd_001 -BgpIdentifier 14.1.1.10 -LocalASN 64522 -PassThru
RoutingDomain         : Rd_001
BgpIdentifier         : 14.1.1.10
LocalASN              : 64522
CompareMEDAcrossASN   : False
DefaultGatewayRouting : False
IPv6Routing           : Disabled
LocalIPv6Address      : 
PeerName              : 
PolicyName            :

This command updates and modifies the configuration of the BGP router for the specified routing domain in Multi-tenant environment and restarts all the active BGP peerings.

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BgpIdentifier

Specifies the local BGP Router Identifier. The acceptable value for this parameter is an IPv4 address.

Type: IPAddress
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ClientToClientReflection

Specifies whether client to client reflection is enabled.

Type: ClientToClientReflection
Parameter Sets: Disabled, Enabled
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ClusterId

Specifies the cluster ID of the cluster.

Type: UInt32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-CompareMEDAcrossASN

Indicates that comparison of Microsoft Enterprise Desktop (MED) values across different autonomous systems (AS) is enabled.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DefaultGatewayRouting

Indicates that routing of the unresolvable routes to the default (Internet) gateway is enabled or disabled.

Type: Boolean
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IPv6Routing

Specifies whether to enable or disable IPv6 routing for this BGP router.

Type: IPv6RoutingState
Parameter Sets: Disabled, Enabled
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LocalASN

Specifies the local AS Number of the BGP Router instance.

Type: UInt32
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LocalIPv6Address

Specifies the local BGP router's global or site-local IPv6 Address, which is to be used as the NEXT-HOP value in the IPv6 route advertisements.

Type: IPAddress
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.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RouteReflector

Specifies whether BGP router will act as a RouteReflector.

Type: RouteReflector
Parameter Sets: Disabled, Enabled
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-RoutingDomain

Specifies the user-defined unique alphanumeric identifier for the routing domain.

Type: String
Aliases: RoutingDomainName
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ThrottleLimit
Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TransitRouting

Specifies whether Transit routing is enabled.

Type: TransitRouting
Parameter Sets: Disabled, Enabled
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#BgpRouterConfig