Add-Bgp Router

Module:
remoteaccess
Adds a BGP router for the specified Tenant ID.

Syntax 

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

Description

The Add-BgpRouter cmdlet adds a new Border Gateway Protocol (BGP) router for the given tenant. This cmdlet returns error information if errors occur while adding the BGP router.

Examples

Example 1: Add a local BGP router 

PS C:\>Add-BgpRouter -BgpIdentifier 10.1.1.10-LocalASN 64522 -PassThru
RoutingDomain            : 
BgpIdentifier            : 192.168.1.10
LocalASN                 : 64522
CompareMEDAcrossASN      : False
DefaultGatewayRouting    : False
IPv6Routing              : Disabled
LocalIPv6Address         : 
PeerName                 : 
PolicyName               : 
TransitRouting           : Disabled
RouteReflector           : Disabled
ClusterId                : 
ClientToClientReflection :

This command adds a local BGP router.

Example 2: Add a local BGP router for a specified routing domain 

PS C:\>Add-BgpRouter -RoutingDomain Rd_001 -BgpIdentifier 10.1.1.10 -LocalASN 64522 -PassThru
RoutingDomain            : Rd_001
BgpIdentifier            : 10.1.1.10
LocalASN                 : 64522
CompareMEDAcrossASN      : False
DefaultGatewayRouting    : False
IPv6Routing              : Disabled
LocalIPv6Address         : 
PeerName                 : 
PolicyName               : 
TransitRouting           : Disabled
RouteReflector           : Disabled
ClusterId                :
ClientToClientReflection:

This command adds a local BGP router for the specified routing domain in a multi-tenant environment.

Example 3: Add a local BGP router and make it a Route Reflector 

PS C:\>Add-BgpRouter -BgpIdentifier 10.1.1.10 -LocalASN 64522 -RouteReflector Enabled -ClusterId 1234 -TransitRouting Enabled -ClientToClientReflection Disabled -PassThru
RoutingDomain                   : 
BgpIdentifier                   : 10.1.1.10
LocalASN                        : 64522
CompareMEDAcrossASN             : False
DefaultGatewayRouting           : False
IPv6Routing                     : Disabled
LocalIPv6Address                : 
PeerName                        : 
PolicyName                      : 
TransitRouting                  : 
EnabledRouteReflector           : Enabled
ClusterId                       : 1234
ClientToClientReflection        : Disabled

This command adds a local BGP router.

Required Parameters

-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
-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

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
-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 or disabled.

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 router reflector.

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

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

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

Indicates whether 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 a value that enables or disables IPv6 routing for this BGP router. The acceptable values for this parameter are:

  • Disable
  • Enable
Type: IPv6RoutingState
Parameter Sets: Disabled, Enabled
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. This value is 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 acts as a route reflector.

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

Specifies the maximum number of concurrent connections that can be established to run this command. If you omit this parameter or enter a value of 0, the default value, 32, is used.

The throttle limit applies only to the current command, not to the session or to the computer.

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

Outputs

Microsoft.Management.Infrastructure.CimInstance#BgpRouterConfig