Add-BgpRouter

Windows Server Technical Preview and Windows 10

Add-BgpRouter

Adds a BGP router for the specified Tenant ID.

Syntax

Parameter Set: Add0
Add-BgpRouter -BgpIdentifier <IPAddress> -LocalASN <UInt32> [-CimSession <CimSession[]> ] [-ClientToClientReflection <ClientToClientReflection> ] [-ClusterId <UInt32> ] [-CompareMEDAcrossASN <Boolean> ] [-DefaultGatewayRouting <Boolean> ] [-Force] [-InformationAction <ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <String> ] [-IPv6Routing <IPv6RoutingState> {Disabled | Enabled} ] [-LocalIPv6Address <IPAddress> ] [-PassThru] [-RouteReflector <RouteReflector> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-TransitRouting <TransitRouting> ] [ <CommonParameters>] [ <WorkflowParameters>]




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

Parameters

-BgpIdentifier<IPAddress>

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


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

-ClientToClientReflection<ClientToClientReflection>

Specifies whether client to client reflection is enabled or disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-ClusterId<UInt32>

Specifies the cluster ID of the router reflector.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-CompareMEDAcrossASN<Boolean>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-DefaultGatewayRouting<Boolean>

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


Aliases

none

Required?

false

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InformationAction<ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend


Aliases

infa

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InformationVariable<String>

Specifies a variable in which to store an information event message.


Aliases

iv

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv6Routing<IPv6RoutingState>

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

-- Disable
-- Enable


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-LocalASN<UInt32>

Specifies the local AS Number of the BGP Router instance.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-LocalIPv6Address<IPAddress>

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.


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

-RouteReflector<RouteReflector>

Specifies whether BGP router acts as a route reflector.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

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


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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TransitRouting<TransitRouting>

Specifies whether transit routing is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

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

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

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.


PS C:\> Add-BgpRouter -BgpIdentifier 10.1.1.10-LocalASN 64522 -PassThru

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

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


PS C:\> Add-BgpRouter -RoutingDomain Rd_001 -BgpIdentifier 10.1.1.10 -LocalASN 64522 -PassThru

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

This command adds a local BGP router.


PS C:\> Add-BgpRouter -BgpIdentifier 10.1.1.10 -LocalASN 64522 –RouteReflector Enabled –ClusterId 1234 –TransitRouting Enabled –ClientToClientReflection Disabled -PassThru

Related topics

Community Additions

ADD
Show: