Share via

Get-SCBGPPeer

  • Reference
Module:
VirtualMachineManager

Gets configuration information for a BGP peer.

Syntax

Get-SCBGPPeer
   [-VMMServer <ServerConnection>]
   [-Name <String>]
   -VMNetworkGateway <VMNetworkGateway>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCBGPPeer
   [-VMMServer <ServerConnection>]
   [-Name <String>]
   -ID <Guid>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Get-SCBGPPeer cmdlet gets configuration information for a Border Gateway Protocol (BGP) peer.

Examples

Example 1: Get a BGP Peer by its name

PS C:\> $BgpPeer = Get-SCBGPPeer -Name "10.10.10.100"

This command gets the BGP Peer by its name.

Parameters

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

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

-Name

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

Type:String
Position:Named
Default value:None
Required:False
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
Position:Named
Default value:None
Required:False
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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMNetworkGateway

Specifies a virtual machine network gateway object.

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

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