Start-BgpPeer
Starts routing sessions for BGP peers.
Syntax
Start-BgpPeer
[-RoutingDomain <String>]
[-Name] <String[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Start-BgpPeer cmdlet starts routing sessions for Border Gateway Protocol (BGP) peers. Use the Stop-BgpPeer cmdlet to stop a routing session. By default, when you add a peer by using the Add-BgpPeer cmdlet, exchange of route information begins immediately. If you add a peer in manual peering mode, use this cmdlet to start the session.
Examples
Example 1: Start a routing session
PS C:\> Start-BgpPeer -Name "Site17"This command starts a BGP routing session for the BGP router named Site17.
Example 2: Start a routing session in a multitenant environment
PS C:\> Start-BgpPeer -Name "Tenant22" -RoutingDomain "Rd001"This command starts a routing session for the peer named Tenant22 in the specified routing domain of a multitenant environment.
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 |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies an array of names. The cmdlet starts routing sessions for the named peers.
| Type: | String[] |
| Aliases: | PeerList, PeerId, PeerName |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RoutingDomain
Specifies the name of the routing domain as a string. The name is a unique, for the multitenant gateway, user-defined alphanumeric string.
| Type: | String |
| Aliases: | RoutingDomainName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ThrottleLimit
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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
String[]