Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-BgpRouter

Add-BgpRouter

ps_bgprouter_v1.0.cdxml

Synopsis

Adds a BGP router.

Syntax

Add-BgpRouter [-AsJob] [-CimSession] [-CompareMEDAcrossASN] [-DefaultGatewayRouting] [-IPv6Routing] [-LocalIPv6Address] [-PassThru] [-RoutingDomain] [-ThrottleLimit] [-BgpIdentifier] [-LocalASN] [<CommonParameters>]

Detailed Description

The Add-BgpRouter cmdlet adds a Border Gateway Protocol (BGP) router. In a multitenant deployment, the cmdlet adds a BGP router for the routing domain or a tenant. In a non-multitenant deployment, the cmdlet configures the BGP router for the local computer. In a multitenant deployment, you must specify the RoutingDomain parameter. In a non-multitenant deployment, do not specify the RoutingDomain parameter.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-BgpIdentifier <IPAddress>

Specifies the Internet IPv4 address of a local BGP router.

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

-CompareMEDAcrossASN <Boolean>

Indicates whether the BGP router compares Multi-Exit Discriminator (MED) values across different autonomous systems (AS).

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

-IPv6Routing <IPv6RoutingState>

Specifies the state of IPv6 routing for the BGP router. The acceptable values for this parameter are:  -- Enabled -- Disabled

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-LocalASN <UInt32>

Specifies the local autonomous system number (ASN) for the local router.

Aliases

None

Required?

true

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

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 tenant. The ID of a routing domain is a user-defined alphanumeric string. A routing domain ID 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

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#BgpRouterConfig

Notes

None

Examples

Example 1: Add a local BGP router

This command adds a local BGP router for a tenant. The command specifies the IP address and ASN of the local router.

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



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


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

This command adds a local BGP router in a multi-tenant environment for the routing domain named Rd_001. The command specifies a local BGP router that has the IP address 14.1.1.10, and specifies the BGP router instance that has the local autonomous system number 64522.

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            :




Online Version
Get-BgpRouter
Set-BgpRouter
Remove-BgpRouter