Edit

Share via

Add-BgpRouter

Module:
RemoteAccess Module

Adds a BGP router for the specified Tenant ID.

Syntax

Default (Default) 

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

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.

Parameters

-AsJob

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BgpIdentifier

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

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClientToClientReflection

Specifies whether client to client reflection is enabled or disabled.

Parameter properties

Type:ClientToClientReflection
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ClusterId

Specifies the cluster ID of the router reflector.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-CompareMEDAcrossASN

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultGatewayRouting

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv6Routing

Specifies a value that enables or disables IPv6 routing for this BGP router. The acceptable values for this parameter are:

  • Disable
  • Enable

Parameter properties

Type:IPv6RoutingState
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-LocalASN

Specifies the local AS number of the BGP Router instance. See AS numbers by IANA for the list of 32 bit AS numbers.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RouteReflector

Specifies whether BGP router acts as a route reflector.

Parameter properties

Type:RouteReflector
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RoutingDomain

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RoutingDomainName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TransitRouting

Specifies whether transit routing is enabled.

Parameter properties

Type:TransitRouting
Default value:None
Accepted values:Disabled, Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IPAddress

UInt32

Microsoft.PowerShell.Cmdletization.GeneratedTypes.Bgp.IPv6RoutingState

Boolean

String

Nullable<T>

Nullable<T>

Nullable<T>

Nullable<T>

Outputs

CimInstance

CimInstance