Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

BgpPeerConfig class

Retrieves information about a peer configuration of a Border Gateway Protocol (BGP) router.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class BgpPeerConfig
{
  string  RoutingDomain;
  string  PeerName;
  string  LocalIPAddress;
  string  PeerIPAddress;
  uint32  LocalASN;
  uint32  PeerASN;
  uint32  OperationMode;
  uint32  PeeringMode;
  uint16  HoldTimeSec;
  uint16  IdleHoldTimeSec;
  uint16  Weight;
  uint32  ConnectivityStatus;
  string  IngressPolicyList[];
  string  EgressPolicyList[];
  uint32  MaxAllowedPrefix;
  boolean RouteReflectorClient;
};

Members

The BgpPeerConfig class has these types of members:

Properties

The BgpPeerConfig class has these properties.

ConnectivityStatus
Data type: uint32
Access type: Read-only

Gets the status of the peer connection.

Windows 8 and Windows Server 2012:  The data type of this parameter was changed from a string in Windows 8.1 and Windows Server 2012 R2.

EgressPolicyList
Data type: string array
Access type: Read-only

Gets the list of policy IDs that are applied to outgoing BGP route advertisements

HoldTimeSec
Data type: uint16
Access type: Read-only

Gets the value that indicates when a BGP Session expires, in seconds, do to a lack of response from the peer.

IdleHoldTimeSec
Data type: uint16
Access type: Read-only

Gets the value that indicates when a BGP Session expires, in seconds, do to a lack of activity.

Windows 8 and Windows Server 2012:  This parameter is not available before Windows 8.1 and Windows Server 2012 R2.

IngressPolicyList
Data type: string array
Access type: Read-only

Gets the list of policy IDs that are applied to incoming BGP route advertisements.

LocalASN
Data type: uint32
Access type: Read-only

Gets the local Autonomous System Number (ASN) of the BGP router instance that connects with the peer.

LocalIPAddress
Data type: string
Access type: Read-only

Gets the local IP address of the BGP router.

MaxAllowedPrefix
Data type: uint32
Access type: Read-only

Gets the maximum number of IPv4 / IPv6 network prefixes that a neighbor is allowed to learn.

OperationMode
Data type: uint32
Access type: Read-only

Gets the mode of operation of the BGP router.

PeerASN
Data type: uint32
Access type: Read-only

Gets the ASN of the peer BGP router.

PeeringMode
Data type: uint32
Access type: Read-only

Gets the peering mode, which indicates whether manual peering mode is enabled for the peer.

PeerIPAddress
Data type: string
Access type: Read-only

Gets the IP address of the peer BGP router.

PeerName
Data type: string
Access type: Read-only

Gets the user defined alphanumeric ID for the peer.

RouteReflectorClient
Data type: boolean
Access type: Read-only

Whether peer is a client peer or non-client peer.

Windows Server 2012 R2, Windows 8.1, Windows Server 2012, and Windows 8:  This property is not supported before Windows 10 Technical Preview and Windows Server Technical Preview.

RoutingDomain
Data type: string
Access type: Read-only

Gets the user defined alphanumeric ID of the BGP routing domain.

Note  This property is only used with multi-tenant deployments.

Weight
Data type: uint16
Access type: Read-only

Gets the administrative preferences that are assigned to peer routes.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

\root\Microsoft\Windows\RemoteAccess

MOF

RAMgmtPSProvider.Mof

DLL

RAMgmtPSProvider.dll

See also

RAMgmtPSProvider Provider Classes

 

 

Community Additions

Show:
© 2014 Microsoft