Add-SCBGPPeer

Adds a BFP peer to the router.

Syntax

Add-SCBGPPeer [-VMNetworkGateway] <VMNetworkGateway> [-Description <String>] [-JobVariable <String>]
 [-Name <String>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-PROTipID <Guid>]
 -PeerASN <UInt32> -PeerIPAddress <String> [-RunAsynchronously] [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Description

The Add-SCBGPPeer cmdlet adds a Border Gateway Protocol (BGP) peer to the router.

Examples

Example 1: Adds a BGP Peer to a virtual machine network gateway

PS C:\> $VmNetworkGateway = Get-SCVMNetworkGateway -Name "VMGateway01"
PS C:\> Add-SCBGPPeer -Name "10.81.81.81" -PeerIPAddress "10.81.81.81" -PeerASN 2000  -VMNetworkGateway $VmNetworkGateway

The first command gets a virtual machine network gateway by using the Get-SCVMNetworkGateway cmdlet.

The second command adds the BGP Peer to the virtual machine network gateway stored in $VmNetworkGateway.

Parameters

-Description

Specifies a description for the BGP peer.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of a Virtual Machine Manager (VMM) object.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PeerASN

Specifies the ASN for the peer.

Type:UInt32
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PeerIPAddress

Specifies the IP address of the peer.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-VMNetworkGateway

Specifies a virtual machine network gateway object.

To obtain a VMNetworkGateway object, use the Get-SCVMNetworkGateway cmdlet.

Type:VMNetworkGateway
Required:True
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False